Skip to content
openapi-v1.yaml 95 KiB
Newer Older
      - paras
      summary: |
        [Experimental - subject to breaking change.] 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'
  /experimental/paras/auctions/current:
    get:
      tags:
      - paras
      summary: |
        [Experimental - subject to breaking change.] Get the status of the current
        auction.
      description: |
        Returns an overview of the current of auction. There is only one auction
        at a time. If there is no auction most fields will be `null`.
      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'
  /experimental/paras/crowdloans:
    get:
      tags:
      - paras
      summary: |
        [Experimental - subject to breaking change.] 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'
  /experimental/paras/{paraId}/crowdloan-info:
    get:
      tags:
      - paras
      summary: |
        [Experimental - subject to breaking change.] 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'
  /experimental/paras/{paraId}/lease-info:
    get:
      tags:
      - paras
      summary: |
        [Experimental - subject to breaking change.] 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'
  /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'
    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
    AccountVestingInfo:
      type: object
      description: Sidecar version's <= v10.0.0 have a`vesting` return value that defaults to an object for
        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:
          type: array
          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
        balance: 
          type: string
          description: The balance of the asset.
          format: unsignedInteger
        isFrozen: 
          type: boolean
          description: Whether the asset is frozen for non-admin transfers.
        isSufficient: 
          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
        issuer: 
          type: string
          description: The `AccountId` able to mint tokens.
          format: SS58
        admin: 
          type: string
          description: The `AccountId` that can thaw tokens, force transfers and burn token from
            any account.
          format: SS58
        freezer: 
          type: string
          description: The `AccountId` that can freeze tokens.
          format: SS58
        supply: 
          type: string
          description: The total supply across accounts.
          format: unsignedInteger
        deposit: 
          type: string
          description: The balance deposited for this. This pays for the data stored.
          format: unsignedInteger
        minBalance: 
          type: string
          description: The ED for virtual accounts.
          format: unsignedInteger
        isSufficient: 
          type: boolean
          description: If `true`, then any account with this asset is given a provider reference. Otherwise, it
            requires a consumer reference.
        accounts: 
          type: string
          description: The total number of accounts.
          format: unsignedInteger
        sufficients: 
          type: string
          description: The total number of accounts for which is placed a self-sufficient reference.
        approvals: 
          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:
        deposit: 
          type: string
          description: The balance deposited for this metadata. This pays for the data
            stored in this struct.
          format: unsignedInteger
        name: 
          type: string
          description: The user friendly name of this asset.
          format: $hex
        symbol: 
          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
        isFrozen: 
          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
        number:
          type: string
          description: The block's height.
          format: unsignedInteger
        parentHash:
          type: string
          description: The hash of the parent block.
          format: hex
        stateRoot:
          type: string
          description: The state root after executing this block.
          format: hex
        extrinsicRoot:
          type: string
          description: The Merkle root of the extrinsics.
          format: hex
        authorId:
          type: string
          description: The account ID of the block author (may be undefined for some
            chains).
          format: ss58
        logs:
            $ref: '#/components/schemas/DigestItem'
          description: Array of `DigestItem`s associated with the block.
        onInitialize:
          $ref: '#/components/schemas/BlockInitialize'
        extrinsics:
          type: array
          description: Array of extrinsics (inherents and transactions) within the
            block.
          items:
            $ref: '#/components/schemas/Extrinsic'
        onFinalize:
          $ref: '#/components/schemas/BlockFinalize'
        finalized:
          type: boolean
          description: >-
            A boolean identifying whether the block is finalized or not. 
            Note: on chains that do not have deterministic finality this field is omitted.
      description: >-
        Note: Block finalization does not correspond to consensus, i.e. whether
        the block is in the canonical chain. It denotes the finalization of block
        _construction._
    BlockFinalize:
            $ref: '#/components/schemas/SanitizedEvent'
      description: Object with an array of `SanitizedEvent`s that occurred during
        block construction finalization with the `method` and `data` for each.
    BlockHeader:
          description: The hash of the parent block.
          format: hex
        number:
          description: The block's height.
          format: unsignedInteger
          description: The state root after executing this block.
          format: hex
        extrinsicRoot:
          description: The Merkle root of the extrinsics.
          format: hex
        digest:
          type: object
          properties: 
            logs:
              type: array
              items:
                $ref: '#/components/schemas/DigestItem'
              description: Array of `DigestItem`s associated with the block.
    BlockIdentifiers:
      type: object
      properties:
        hash:
          type: string
          description: The block's hash.
          format: hex
        height:
          type: string
          description: The block's height.
          format: unsignedInteger
      description: Block number and hash at which the call was made.
        events:
          type: array
          items:
            $ref: '#/components/schemas/SanitizedEvent'
      description: Object with an array of `SanitizedEvent`s that occurred during
        block initialization with the `method` and `data` for each.
    BlocksTrace:
      type: object
      properties:
        at:
          $ref: '#/components/schemas/BlockIdentifiers'
        blockHash:
        events:
          type: array
          items:
            $ref: '#/components/schemas/TraceEvent'
        parentHash:
            $ref: '#/components/schemas/TraceSpan'
        storageKeys:
          type: string
          description: Hex encoded storage keys used to filter events.
        tracingTargets:
          type: string
          description: Targets used to filter spans and events.
    BlocksTraceOperations:
        at:
          $ref: '#/components/schemas/BlockIdentifiers'
        operations:
            $ref: '#/components/schemas/Operation'
    ChainType:
      type: object
      description: Type of the chain. It will return one of the following enum variants as a key. Live, Development, Local, or Custom. Each variant will have a value as null except when the ChainType is Custom, it will return a string. 
      properties:
        live: 
          type: string
          nullable: true
          default: null
        development:
          type: string
          nullable: true
          default: null
        local: 
          type: string
          nullable: true
          default: null
        custom:
          type: string
      example: "{\"live\": null}"
          format: unsignedInteger
        value:
          type: array
          items:
            type: string
    ElectionStatus:
        status:
          type: object
          description: >-
            [Deprecated](Works for polkadot runtimes before v0.8.30).

            Era election status: either `Close: null` or `Open: <BlockNumber>`.
            A status of `Close` indicates that the submission window for solutions
            from off-chain Phragmen is not open. A status of `Open` indicates that the
            submission window for off-chain Phragmen solutions has been open since
            BlockNumber. N.B. when the submission window is open, certain
            extrinsics are not allowed because they would mutate the state that the
            off-chain Phragmen calculation relies on for calculating results.
        toggleEstimate:
          description: Upper bound estimate of the block height at which the `status`
            will switch.
          format: unsignedInteger
      description: Information about the off-chain election. Not included in response when
        `forceEra.isForceNone`.
    Error:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
    ExtrinsicMethod:
      type: object
      properties:
        pallet:
          type: string
Zeke Mostov's avatar
Zeke Mostov committed
        methodName:
          type: string
      description: Extrinsic method
    Extrinsic:
      type: object
      properties:
        method:
          $ref: '#/components/schemas/ExtrinsicMethod'
        signature:
          $ref: '#/components/schemas/Signature'
        nonce:
          type: string
          description: Account nonce, if applicable.
          format: unsignedInteger
        args:
          type: object
          description: >-
            Object of arguments keyed by parameter name. Note: if you are expecting an [`OpaqueCall`](https://substrate.dev/rustdocs/v2.0.0/pallet_multisig/type.OpaqueCall.html)
            and it is not decoded in the response (i.e. it is just a hex string), then Sidecar was
            not able to decode it and likely that it is not a valid call for the runtime.
        tip:
          type: string
          description: Any tip added to the transaction.
          format: unsignedInteger
        hash:
          type: string
          description: The transaction's hash.
          format: hex
        info:
          $ref: '#/components/schemas/RuntimeDispatchInfo'
        era:
          $ref: '#/components/schemas/GenericExtrinsicEra'
        events:
          type: array
          description: An array of `SanitizedEvent`s that occurred during extrinsic
            execution.
          items:
            $ref: '#/components/schemas/SanitizedEvent'
        success:
          type: boolean
          description: Whether or not the extrinsic succeeded.
        paysFee:
          type: boolean
          description: Whether the extrinsic requires a fee. Careful! This field relates
            to whether or not the extrinsic requires a fee if called as a transaction.
            Block authors could insert the extrinsic as an inherent in the block
            and not pay a fee. Always check that `paysFee` is `true` and that the
            extrinsic is signed when reconciling old blocks.
    ExtrinsicIndex:
      type: object
      properties:
        at:
          $ref: '#/components/schemas/BlockIdentifiers'
        extrinsic:
          $ref: '#/components/schemas/Extrinsic'
      description: A single extrinsic at a given block.
        verifier:
          type: string
        deposit:
          type: string
          format: unsignedInteger
          format: unsignedInteger
        end:
          format: unsignedInteger
        cap:
          format: unsignedInteger
        lastConstribution:
          enum:
          - preEnding
          - ending
        firstPeriod:
          type: string
          format: unsignedInteger
          format: unsignedInteger
        trieIndex:
          type: string
          format: unsignedInteger
    GenericExtrinsicEra:
      type: object
      description: |
        The return value for era can either be `mortalEra`, or `immortalEra` and is represented as an enum in substrate. `immortalEra` meaning 
        the transaction is valid forever. `mortalEra` consists of a tuple containing a period and phase.
        ex: `"{"mortalEra": ["64", "11"]}"`. The Period is the period of validity from the block hash found in the signing material. 
        The Phase is the period that this transaction's lifetime begins (and, importantly, 
        implies which block hash is included in the signature material).
      properties:
        mortalEra:  
          type: array
          items: 
            type: string
          description: Tuple of a Phase, and Period. Each item in the array will be a string formatted as an integer. 
        immortalEra:
          type: string
          description: Hardcoded constant '0x00'.
          format: hex
      example: "{\"mortalEra\":[\"64\", \"11\"]}"
    NodeNetwork:
      type: object
      properties:
        nodeRoles:
          $ref: '#/components/schemas/NodeRole'
        numPeers:
          type: string
          description: Number of peers the node is connected to.
          format: unsignedInteger
        isSyncing:
          type: boolean
          description: Whether or not the node is syncing. `False` indicates that the node is in sync.
        shouldHavePeers:
          type: boolean
          description: Whether or not the node should be connected to peers. Might be false
            for local chains or when running without discovery.
        localPeerId:
          type: string
          description: Local copy of the `PeerId`.
        localListenAddresses:
          type: array
          description: Multiaddresses that the local node is listening on. The addresses
            include a trailing `/p2p/` with the local PeerId, and are thus suitable
            to be passed to `system_addReservedPeer` or as a bootnode address for
            example.
          items:
            type: string
        peersInfo:
          type: array
          items:
            $ref: '#/components/schemas/PeerInfo'
    NodeRole:
      type: string
      description: Role of this node. (N.B. Sentry nodes are being deprecated.)
      enum:
      - Full
      - LightClient
      - Authority
      - Sentry
    NodeVersion:
          description: Node's binary version.
        clientImplName:
          description: Node's implementation name.
        chain:
          description: Node's chain name.
      description: Version information of the node.
    Nominations:
          type: array
          items:
            type: string
          description: The targets of the nomination.
        submittedIn:
          type: string
          format: unsignedInteger
          description: >-
             The era the nominations were submitted. (Except for initial
             nominations which are considered submitted at era 0.)
        suppressed:
          type: boolean
          description: Whether the nominations have been suppressed.
    OnboardingAs:
      type: string
      enum:
      - parachain
      - parathread
      description: |
        This property only shows up when `paraLifecycle=onboarding`. It
        describes if a particular para is onboarding as a `parachain` or a
        `parathread`.
    Operation:
        phase:
          $ref: '#/components/schemas/OperationPhase'
        parentSpanId:
          $ref: '#/components/schemas/SpanId'
        primarySpanId:
          $ref: '#/components/schemas/SpanId'
        eventIndex:
          type: string
          format: unsignedInteger
          description: Index of the underlying trace event.
        address:
          type: string
          description: |
           Account this operation affects. Note - this will be an object like
           `{ id: address }` if the network uses `MultiAddress`
        storage:
          type: object
          properties:
            pallet:
              type: string
            item:
              type: string
            field1:
              type: string
              description: |
                A field of the storage item. (i.e `system::Account::get(address).data`)
            field2:
              type: string
              description: |
                A field of the struct described by field1 (i.e
                `system::Account::get(address).data.free`)
        amount:
          $ref: '#/components/schemas/OperationAmount'
    OperationAmount:
          type: string
          format: unsignedInteger
        currency:
          $ref: '#/components/schemas/OperationAmountCurrency'
    OperationAmountCurrency:
      type: object
      properties:
        symbol:
          type: string
          example: KSM
    OperationPhase: