Skip to content
openapi-v1.yaml 117 KiB
Newer Older
        required: false
        schema:
          type: string
          description: Block identifier, as the block height or block hash.
          format: unsignedInteger or $hex
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StakingProgress'
        "400":
          description: invalid blockId supplied for at query param
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /pallets/{palletId}/errors:
    get:
      tags:
      - pallets
      summary: Get a list of errors for a pallet.
      description: Returns a list of error item metadata for error items of the
        specified palletId.
      parameters:
      - name: palletId
        in: path
        description: 'Name or index of the pallet to read error metadata for. Note: the pallet name must match what is
          specified in the runtime metadata.'
        required: true
        schema:
          type: string
      - name: onlyIds
        in: query
        description: Only return the names (IDs) of the error items instead of every error's metadata.
        required: false
        schema:
          type: boolean
      - name: at
        in: query
        description: Block at which to retrieve a list of
          the pallet's error items.
        required: false
        schema:
          type: string
          description: Block identifier, as the block height or block hash.
          format: unsignedInteger or $hex
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                description: Pallet info and Array of errorItemIds.
                items:
                  $ref: '#/components/schemas/PalletErrors'
        "400":
          description: invalid blockId supplied for at query param
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        "404":
          description: could not find pallet with palletId
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /pallets/{palletId}/errors/{errorItemId}:
    get:
      tags:
      - pallets
      summary: Get the value of an error item.
      description: Returns the value stored under the errorItemId.
      parameters:
      - name: palletId
        in: path
        description: 'Name or index of the pallet to read error metadata for. Note: the pallet name must match what is
          specified in the runtime metadata.'
        required: true
        schema:
          type: string
      - name: errorItemId
        in: path
        description: Id of the error item to query for.
        required: true
        schema:
          type: string
      - name: at
        in: query
        description: Block at which to query the error item at.
        required: false
        schema:
          type: string
          description: Block identifier, as the block height or block hash.
          format: unsignedInteger or $hex
      - name: metadata
        in: query
        description: Include the error items metadata (including documentation)
          if set to true.
        required: false
        schema:
          default: false
          type: boolean
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PalletErrorsItem'
        "400":
          description: invalid blockId supplied for at query param
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        "404":
          description: could not find resource with with id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /runtime/metadata:
    get:
      tags:
      - runtime
      summary: Get the runtime metadata in decoded, JSON form.
      description: >-
       Returns the runtime metadata as a JSON object.
       Substrate Reference:
       - FRAME Support: https://crates.parity.io/frame_support/metadata/index.html
       - Knowledge Base: https://substrate.dev/docs/en/knowledgebase/runtime/metadata
      parameters:
      - name: at
        in: query
        description: Block at which to retrieve the metadata at.
        required: false
        schema:
          type: string
          description: Block identifier, as the block height or block hash.
          format: unsignedInteger or $hex
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                description: Response is dependent on the runtime metadata contents.
  /runtime/code:
    get:
      tags:
      - runtime
      summary: Get the runtime wasm blob.
      description: Returns the runtime Wasm blob in hex format.
      parameters:
      - name: at
        in: query
        description: Block at which to retrieve the runtime wasm blob at.
        required: false
        schema:
          type: string
          description: Block identifier, as the block height or block hash.
          format: unsignedInteger or $hex
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeCode'
  /runtime/spec:
    get:
      tags:
      - runtime
      summary: Get version information of the Substrate runtime.
      description: Returns version information related to the runtime.
      parameters:
      - name: at
        in: query
        description: Block at which to retrieve runtime version information at.
        required: false
        schema:
          type: string
          description: Block identifier, as the block height or block hash.
          format: unsignedInteger or $hex
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeSpec'
  /pallets/{palletId}/storage:
    get:
      tags:
      - pallets
      summary: Get a list of storage items for a pallet.
      description: Returns a list of storage item metadata for storage items of the
        specified palletId.
      parameters:
      - name: palletId
        in: path
        description: 'Name or index of the pallet to query the storage of. Note: the pallet name must match what is
          specified in the runtime metadata.'
        required: true
        schema:
          type: string
      - name: adjustMetadataV13
        in: query
David's avatar
David committed
        description: Instruct sidecar to return `StorageEntryType` in the V13 metadata
          format rather than V14. This is a **temporary** flag to allow existing systems to migrate.
Tarik Gul's avatar
Tarik Gul committed
          It will be deprecated and then removed in the future.
        required: false
        schema:
          type: boolean
      - name: onlyIds
        in: query
        description: Only return the names (IDs) of the storage items instead of all of each storage
          item's metadata.
        required: false
        schema:
          type: boolean
      - name: at
        in: query
        description: Block at which to retrieve a list of
          the pallet's storage items.
        required: false
        schema:
          type: string
          description: Block identifier, as the block height or block hash.
          format: unsignedInteger or $hex
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                description: Pallet info and Array of storageItemIds.
                items:
                  $ref: '#/components/schemas/PalletStorage'
        "400":
          description: invalid blockId supplied for at query param
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        "404":
          description: could not find pallet with palletId
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /pallets/{palletId}/storage/{storageItemId}:
    get:
      tags:
      - pallets
      summary: Get the value of a storage item.
      description: Returns the value stored under the storageItemId. If it is a
        map, query param key1 is required. If the storage item is double map
        query params key1 and key2 are required.
      parameters:
      - name: palletId
        in: path
        description: 'Name or index of the pallet to query the storage of. Note: pallet name aligns with
          pallet name as specified in runtime metadata.'
        required: true
        schema:
          type: string
      - name: storageItemId
        in: path
        description: Id of the storage item to query for.
        required: true
        schema:
          type: string
      - name: adjustMetadataV13
        in: query
David's avatar
David committed
        description: Instruct sidecar to return `StorageEntryType` in the V13 metadata
          format rather than V14. This is a **temporary** flag to allow existing systems to migrate.
Tarik Gul's avatar
Tarik Gul committed
          It will be deprecated and then removed in the future.
        required: false
        schema:
          type: boolean
      - name: keys
        description: Set of N keys used for querying a storage map. It should be queried using the 
          following format - ?keys[]=key1&keys[]=key2. Order matters, as it will determine the 
          order the keys are passed into the storage calls.
          type: array
          items:
            type: string
          description: An array of storage keys.
      - name: at
        in: query
        description: Block at which to query the storage item at.
        required: false
        schema:
          type: string
          description: Block identifier, as the block height or block hash.
          format: unsignedInteger or $hex
      - name: metadata
        in: query
        description: Include the storage items metadata (including documentation)
          if set to true.
        required: false
        schema:
          default: false
          type: boolean
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PalletStorageItem'
        "400":
          description: invalid blockId supplied for at query param
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        "404":
          description: could not find resource with with id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    get:
      tags:
      - paras
      summary: |
        List all registered paras (parathreads & parachains).
      description: Returns all registered parachains and parathreads with lifecycle info.
      parameters:
      - name: at
        in: query
        description: Block at which to retrieve paras list at.
        required: false
        schema:
          type: string
          description: Block identifier, as the block height or block hash.
          format: unsignedInteger or $hex
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Paras'
  /paras/leases/current:
    get:
      tags:
      - paras
      summary: |
        Get general information about the current lease period.
      description: |
        Returns an overview of the current lease period, including lease holders.
      parameters:
      - name: at
        in: query
        description: Block at which to retrieve current lease period info at.
        required: false
        schema:
          type: string
          description: Block identifier, as the block height or block hash.
          format: unsignedInteger or $hex
      - name: currentLeaseHolders
        in: query
        description: |
          Wether or not to include the `currentLeaseHolders` property. Inclusion
          of the property will likely result in a larger payload and increased
          response time.
        required: false
        schema:
          type: boolean
          default: true
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParasLeasesCurrent'
  /paras/auctions/current:
    get:
      tags:
      - paras
      summary: |
        Get the status of the current auction.
      description: |
        Returns an overview of the current auction. There is only one auction
        at a time. If there is no auction most fields will be `null`. If the current
        auction phase is in `vrfDelay` and you are looking to retrieve the latest winning
        bids, it is advised to query one block before `finishEnd` in the `endingPeriod` phase
        for that auction as there technically are no winners during the `vrfDelay` and thus
      parameters:
      - name: at
        in: query
        description: Block at which to retrieve auction progress at.
        required: false
        schema:
          type: string
          description: Block identifier, as the block height or block hash.
          format: unsignedInteger or $hex
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParasAuctionsCurrent'
    get:
      tags:
      - paras
      summary: |
        List all stored crowdloans.
      description: |
        Returns a list of all the crowdloans and their associated paraIds.
      parameters:
      - name: at
        in: query
        description: Block at which to retrieve the list of paraIds that have crowdloans at.
        required: false
        schema:
          type: string
          description: Block identifier, as the block height or block hash.
          format: unsignedInteger or $hex
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParasCrowdloans'
  /paras/{paraId}/crowdloan-info:
David's avatar
David committed
      summary: |
        Get crowdloan information for a `paraId`.
      description: |
        Returns crowdloan's `fundInfo` and the set of `leasePeriods` the crowdloan`
        covers.
      parameters:
      - name: paraId
        in: path
        description: paraId to query the crowdloan information of.
        required: true
        schema:
          type: number
      - name: at
        in: query
        description: Block at which to retrieve info at.
        required: false
        schema:
          type: string
          description: Block identifier, as the block height or block hash.
          format: unsignedInteger or $hex
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParasCrowdloanInfo'
  /paras/{paraId}/lease-info:
    get:
      tags:
      - paras
      summary: |
        Get current and future leases as well as the lifecycle stage for a given `paraId`.
      description: |
        Returns a list of leases that belong to the `paraId` as well as the
        `paraId`'s current lifecycle stage.
      parameters:
      - name: paraId
        in: path
        description: paraId to query the crowdloan information of.
        required: true
        schema:
          type: number
      - name: at
        in: query
        description: Block at which to retrieve para's leases at.
        required: false
        schema:
          type: string
          description: Block identifier, as the block height or block hash.
          format: unsignedInteger or $hex
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParasLeaseInfo'
  /paras/head/included-candidates:
    get:
      tags:
      - paras
      summary: |
        Get the heads of the included (backed and considered available) parachain candidates at the 
        specified block height or at the most recent finalized head otherwise.
      description: |
        Returns an object with all the parachain id's as keys, and their headers as values.
      parameters:
      - name: at
        in: query
        description: Block at which to retrieve para's heads at.
        required: false
        schema:
          type: string
          description: Block identifier, as the block height or block hash.
          format: unsignedInteger or $hex
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParasHeaders'
  /paras/head/backed-candidates:
    get:
      tags:
      - paras
      summary: |
        Get the heads of the backed parachain candidates at the specified block height or at the most recent finalized head otherwise.
      description: |
        Returns an object with all the parachain id's as keys, and their headers as values.
      parameters:
      - name: at
        in: query
        description: Block at which to retrieve para's heads at.
        required: false
        schema:
          type: string
          description: Block identifier, as the block height or block hash.
          format: unsignedInteger or $hex
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParasHeaders'
  /experimental/blocks/head/traces:
    get:
      tags:
      - trace
      summary: |
        [Experimental - subject to breaking change.] Get traces for the most
        recently finalized block.
      description: |
        Returns traces (spans and events) of the most recently finalized block from
        RPC `state_straceBlock`. Consult the [RPC docs](https://github.com/paritytech/substrate/blob/aba876001651506f85c14baf26e006b36092e1a0/client/rpc-api/src/state/mod.rs#L140)
        for conceptual info.
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlocksTrace'
  /experimental/blocks/{blockId}/traces:
    get:
      tags:
      - trace
      summary: |
        [Experimental - subject to breaking change.] Get traces for the given `blockId`.
      description: |
        Returns traces (spans and events) of the specified block from
        RPC `state_straceBlock`. Consult the [RPC docs](https://github.com/paritytech/substrate/blob/aba876001651506f85c14baf26e006b36092e1a0/client/rpc-api/src/state/mod.rs#L140) for conceptual info.
      parameters:
      - name: blockId
        in: path
        description: Block identifier, as the block height or block hash.
        required: true
        schema:
          pattern: 'a-km-zA-HJ-NP-Z1-9{8,64}'
          type: string
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlocksTrace'
  /experimental/blocks/head/traces/operations:
    get:
      tags:
      - trace
      summary: |
        [Experimental - subject to breaking change.] Get the operations from the
        most recently finalized block.
      description: |
        Returns the operations from the most recently finalized block. Operations
        represent one side of a balance change. For example if Alice transfers
        100unit to Bob there will be two operations; 1) Alice - 100 2) Bob + 100.

        Given account A and A's balance at block k0 (Ak0), if we sum all the
        operations for A from block k1 through kn against Ak0, we will end up
        with A's balance at block kn (Akn). Thus, operations can be used to audit
        that balances change as expected.

        This is useful for Substrate based chains because the advanced business
        logic can make it difficult to ensure auditable balance reconciliation
        based purely on events. Instead of using events one can use the
        operations given from this endpoint.

        Note - each operation corresponds to a delta of a single field of the
        `system::AccountData` storage item (i.e `free`, `reserved`, `misc_frozen`
        and `fee_frozen`).
        Note - operations are assigned a block execution phase (and extrinsic index
        for those in the apply extrinsic phase) based on an "action group". For
        example all the operations for 1 extrinsic will be in the same action group.
        The action groups can optionally be fetched with the `action` query param
        for closer auditing.
        Note - There are no 0 value operations (e.g. a transfer of 0, or a
        transfer to itself)

        To learn more about operation and action group creation please consult
        [this diagram](https://docs.google.com/drawings/d/1vZoJo9jaXlz0LmrdTOgHck9_1LsfuQPRmTr-5g1tOis/edit?usp=sharing)
      parameters:
      - name: actions
        in: query
        description: Whether or not to include action groups.
        required: false
        schema:
          type: boolean
          default: false
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlocksTraceOperations'
  /experimental/blocks/{blockId}/traces/operations:
    get:
      tags:
      - trace
      summary: |
        [Experimental - subject to breaking change.] Get the operations from the
        specified block.
      description: |
        Returns the operations from the most recently finalized block. Operations
        represent one side of a balance change. For example if Alice transfers
        100unit to Bob there will be two operations; 1) Alice - 100 2) Bob + 100.

        Given account A and A's balance at block k0 (Ak0), if we sum all the
        operations for A from block k1 through kn against Ak0, we will end up
        with A's balance at block kn (Akn). Thus, operations can be used to audit
        that balances change as expected.

        This is useful for Substrate based chains because the advanced business
        logic can make it difficult to ensure auditable balance reconciliation
        based purely on events. Instead of using events one can use the
        operations given from this endpoint.

        Note - each operation corresponds to a delta of a single field of the
        `system::AccountData` storage item (i.e `free`, `reserved`, `misc_frozen`
        and `fee_frozen`).
        Note - operations are assigned a block execution phase (and extrinsic index
        for those in the apply extrinsic phase) based on an "action group". For
        example all the operations for 1 extrinsic will be in the same action group.
        The action groups can optionally be fetched with the `action` query param
        for closer auditing.
        Note - There are no 0 value operations (e.g. a transfer of 0, or a
        transfer to itself)

        To learn more about operation and action group creation please consult
        [this diagram](https://docs.google.com/drawings/d/1vZoJo9jaXlz0LmrdTOgHck9_1LsfuQPRmTr-5g1tOis/edit?usp=sharing)
      parameters:
      - name: blockId
        in: path
        description: Block identifier, as the block height or block hash.
        required: true
        schema:
          pattern: 'a-km-zA-HJ-NP-Z1-9{8,64}'
          type: string
      - name: actions
        in: query
        description: Whether or not to include action groups.
        required: false
        schema:
          type: boolean
          default: false
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlocksTraceOperations'
    AccountAssetsApproval:
        at:
          $ref: '#/components/schemas/BlockIdentifiers'
          description: The amount of funds approved for the balance transfer from the owner
            to some delegated target.
          format: unsignedInteger
          description: The amount reserved on the owner's account to hold this item in storage.
          format: unsignedInteger
    AccountAssetsBalances:
      type: object
      properties:
        at:
          $ref: '#/components/schemas/BlockIdentifiers'
        assets:
          type: array
          description: An array of queried assets.
          items:
            $ref: '#/components/schemas/AssetsBalance'
    AccountBalanceInfo:
      type: object
      properties:
        at:
          $ref: '#/components/schemas/BlockIdentifiers'
        nonce:
          type: string
          description: Account nonce.
          format: unsignedInteger
        tokenSymbol:
          type: string
          description: Token symbol of the balances displayed in this response.
          format: unsignedInteger
        free:
          type: string
          description: Free balance of the account. Not equivalent to _spendable_
            balance. This is the only balance that matters in terms of most operations
            on tokens.
          format: unsignedInteger
        reserved:
          type: string
          description: Reserved balance of the account.
          format: unsignedInteger
        miscFrozen:
          type: string
          description: The amount that `free` may not drop below when withdrawing
            for anything except transaction fee payment.
          format: unsignedInteger
        feeFrozen:
          type: string
          description: The amount that `free` may not drop below when withdrawing
            specifically for transaction fee payment.
          format: unsignedInteger
        locks:
          type: array
          description: Array of locks on a balance. There can be many of these on
            an account and they "overlap", so the same balance is frozen by multiple
            locks
          items:
            $ref: '#/components/schemas/BalanceLock'
    AccountConvert:
      type: object
      properties:
        ss58Prefix:
          type: string
          description: SS58 prefix based on which the account ID or Public Key (hex) is converted to an SS58 address.
          format: unsignedInteger
        network:
          type: string
          description: The network based on which the returned address is encoded. It depends on the prefix
            that was given as a query param.
        address:
          type: string
          description: The returned SS58 address which is the result of the conversion
            of the account ID or Public Key (hex).
        accountId:
          type: string
          description: The given account ID or Public Key (hex) that is converted to an SS58 address.
        scheme:
          type: string
          description: The cryptographic scheme/algorithm used to encode the given account ID or Public Key (hex).
        publicKey:
          type: boolean
          description: Whether the given path parameter is a Public Key (hex) or not.
    AccountStakingInfo:
Tarik Gul's avatar
Tarik Gul committed
      type: object
      properties:
        at:
          $ref: '#/components/schemas/BlockIdentifiers'
        rewardDestination:
          type: string
          description: The account to which rewards will be paid. Can be 'Staked' (Stash
            account, adding to the amount at stake), 'Stash' (Stash address, not
            adding to the amount at stake), or 'Controller' (Controller address).
          format: ss58
          enum:
          - Staked
          - Stash
          - Controller
        controller:
          type: string
          description: Controller address for the given Stash.
          format: ss58
        numSlashingSpans:
          type: string
          description: Number of slashing spans on Stash account; `null` if provided address
            is not a Controller.
          format: unsignedInteger
        nominations:
          $ref: '#/components/schemas/Nominations'
        stakingLedger:
          $ref: '#/components/schemas/StakingLedger'
      description: >-
        Note: Runtime versions of Kusama less than 1062 will either have `lastReward` in place of
        `claimedRewards`, or no field at all. This is related to changes in reward distribution. See: [Lazy Payouts](https://github.com/paritytech/substrate/pull/4474), [Simple Payouts](https://github.com/paritytech/substrate/pull/5406)
    AccountStakingPayouts:
      type: object
      properties:
        at:
          $ref: '#/components/schemas/BlockIdentifiers'
        erasPayouts:
Tarik Gul's avatar
Tarik Gul committed
          type: array
          items:
            type: object
            properties:
              era:
                type: string
                format: unsignedInteger
                description: Era this information is associated with.
              totalEraRewardPoints:
                type: string
                format: unsignedInteger
                description: Total reward points for the era. Equals the sum of
                  reward points for all the validators in the set.
              totalEraPayout:
                type: string
                format: unsignedInteger
                description: Total payout for the era. Validators split the payout
                  based on the portion of `totalEraRewardPoints` they have.
              payouts:
                $ref: '#/components/schemas/Payouts'
    AccountValidation:
      type: object
      properties:
        isValid:
          type: boolean
          description: Whether the given address is valid ss58 formatted.
        ss58Prefix:
          type: string
          description: SS58 prefix of the given address. If the address is a valid
            base58 format, but incorrect ss58, a prefix for the given address will still be returned.
          format: unsignedInteger
        network:
          type: string
          description: The network based on which the given address is encoded.
        accountId:
          type: string
          description: The account id of the given address.
    AccountVestingInfo:
      type: object
      description: Sidecar version's <= v10.0.0 have a`vesting` return value that defaults to an object for
David's avatar
David committed
        when there is no available vesting-info data. It also returns a `VestingInfo` as an object.
        For Sidecar >=11.0.0, that value will now default as an array when there is no value, and `Vec<PalletsPalletVestingInfo>`
        is returned when there is.
      properties:
        at:
          $ref: '#/components/schemas/BlockIdentifiers'
        vesting:
David's avatar
David committed
          items:
            $ref: '#/components/schemas/VestingSchedule'
Tarik Gul's avatar
Tarik Gul committed
    AssetsBalance:
      type: object
      properties:
        assetId:
          type: string
          description: The identifier of the asset.
          format: unsignedInteger
David's avatar
David committed
        balance:
Tarik Gul's avatar
Tarik Gul committed
          type: string
          description: The balance of the asset.
          format: unsignedInteger
David's avatar
David committed
        isFrozen:
Tarik Gul's avatar
Tarik Gul committed
          type: boolean
          description: Whether the asset is frozen for non-admin transfers.
David's avatar
David committed
        isSufficient:
Tarik Gul's avatar
Tarik Gul committed
          type: boolean
          description: Whether a non-zero balance of this asset is a deposit of sufficient
            value to account for the state bloat associated with its balance storage. If set to
            `true`, then non-zero balances may be stored without a `consumer` reference (and thus
            an ED in the Balances pallet or whatever else is used to control user-account state
            growth).
    AssetInfo:
      type: object
      properties:
        owner:
          type: string
          description: Owner of the assets privileges.
          format: SS58
David's avatar
David committed
        issuer:
Tarik Gul's avatar
Tarik Gul committed
          type: string
          description: The `AccountId` able to mint tokens.
          format: SS58
David's avatar
David committed
        admin:
Tarik Gul's avatar
Tarik Gul committed
          type: string
          description: The `AccountId` that can thaw tokens, force transfers and burn token from
            any account.
          format: SS58
David's avatar
David committed
        freezer:
Tarik Gul's avatar
Tarik Gul committed
          type: string
          description: The `AccountId` that can freeze tokens.
          format: SS58
David's avatar
David committed
        supply:
Tarik Gul's avatar
Tarik Gul committed
          type: string
          description: The total supply across accounts.
          format: unsignedInteger
David's avatar
David committed
        deposit:
Tarik Gul's avatar
Tarik Gul committed
          type: string
          description: The balance deposited for this. This pays for the data stored.
          format: unsignedInteger
David's avatar
David committed
        minBalance:
Tarik Gul's avatar
Tarik Gul committed
          type: string
          description: The ED for virtual accounts.
          format: unsignedInteger
David's avatar
David committed
        isSufficient:
Tarik Gul's avatar
Tarik Gul committed
          type: boolean
          description: If `true`, then any account with this asset is given a provider reference. Otherwise, it
            requires a consumer reference.
David's avatar
David committed
        accounts:
Tarik Gul's avatar
Tarik Gul committed
          type: string
          description: The total number of accounts.
          format: unsignedInteger
David's avatar
David committed
        sufficients:
Tarik Gul's avatar
Tarik Gul committed
          type: string
          description: The total number of accounts for which is placed a self-sufficient reference.
David's avatar
David committed
        approvals:
Tarik Gul's avatar
Tarik Gul committed
          type: string
          description: The total number of approvals.
          format: unsignedInteger
        isFrozen:
          type: boolean
          description: Whether the asset is frozen for non-admin transfers.
    AssetMetadata:
      type: object
      properties:
David's avatar
David committed
        deposit:
Tarik Gul's avatar
Tarik Gul committed
          type: string
          description: The balance deposited for this metadata. This pays for the data
            stored in this struct.
          format: unsignedInteger
David's avatar
David committed
        name:
Tarik Gul's avatar
Tarik Gul committed
          type: string
          description: The user friendly name of this asset.
          format: $hex
David's avatar
David committed
        symbol:
Tarik Gul's avatar
Tarik Gul committed
          type: string
          description: The ticker symbol for this asset.
          format: $hex
        decimals:
          type: string
          description: The number of decimals this asset uses to represent one unit.
          format: unsignedInteger
David's avatar
David committed
        isFrozen:
Tarik Gul's avatar
Tarik Gul committed
          type: boolean
          description: Whether the asset metadata may be changed by a non Force origin.
          description: An identifier for this lock. Only one lock may be in existence
            for each identifier.
        amount:
          description: The amount below which the free balance may not drop with this
            lock in effect.
          format: unsignedInteger
          description: Reasons for withdrawing balance.
          enum:
          - Fee = 0
          - Misc = 1
          - All = 2
    Block:
      type: object
      properties:
        hash:
          description: The block's hash.
          format: hex