NEAR Protocol EXPERIMENTAL Light Client Proof API

openapi: 3.0.3
info:
  description: Low-latency indexed account, token, and public-key lookup APIs for wallets and explorers. Embedded portal clients may forward an optional `apiKey` query parameter, but the public FastNEAR API does not require it.
  title: FastNEAR accounts EXPERIMENTAL Light Client Proof API
  version: 3.0.3
servers:
- description: Mainnet
  url: https://api.fastnear.com
- description: Testnet
  url: https://test.api.fastnear.com
tags:
- name: EXPERIMENTAL Light Client Proof
paths:
  /EXPERIMENTAL_light_client_proof:
    post:
      description: Returns the proofs for a transaction execution.
      operationId: EXPERIMENTAL_light_client_proof
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonRpcRequest_for_EXPERIMENTAL_light_client_proof'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonRpcResponse_for_RpcLightClientExecutionProofResponse_and_RpcLightClientProofError'
      tags:
      - EXPERIMENTAL Light Client Proof
components:
  schemas:
    MissingTrieValueContext:
      description: Contexts in which `StorageError::MissingTrieValue` error might occur.
      oneOf:
      - description: Missing trie value when reading from TrieIterator.
        enum:
        - TrieIterator
        type: string
      - description: Missing trie value when reading from TriePrefetchingStorage.
        enum:
        - TriePrefetchingStorage
        type: string
      - description: Missing trie value when reading from TrieMemoryPartialStorage.
        enum:
        - TrieMemoryPartialStorage
        type: string
      - description: Missing trie value when reading from TrieStorage.
        enum:
        - TrieStorage
        type: string
    MissingTrieValue:
      properties:
        context:
          $ref: '#/components/schemas/MissingTrieValueContext'
        hash:
          $ref: '#/components/schemas/CryptoHash'
      required:
      - context
      - hash
      type: object
    PrepareError:
      description: Error that can occur while preparing or executing Wasm smart-contract.
      oneOf:
      - description: Error happened while serializing the module.
        enum:
        - Serialization
        type: string
      - description: Error happened while deserializing the module.
        enum:
        - Deserialization
        type: string
      - description: Internal memory declaration has been found in the module.
        enum:
        - InternalMemoryDeclared
        type: string
      - description: 'Gas instrumentation failed.


          This most likely indicates the module isn''t valid.'
        enum:
        - GasInstrumentation
        type: string
      - description: 'Stack instrumentation failed.


          This  most likely indicates the module isn''t valid.'
        enum:
        - StackHeightInstrumentation
        type: string
      - description: 'Error happened during instantiation.


          This might indicate that `start` function trapped, or module isn''t

          instantiable and/or un-linkable.'
        enum:
        - Instantiate
        type: string
      - description: Error creating memory.
        enum:
        - Memory
        type: string
      - description: Contract contains too many functions.
        enum:
        - TooManyFunctions
        type: string
      - description: Contract contains too many locals.
        enum:
        - TooManyLocals
        type: string
      - description: Contract contains too many tables.
        enum:
        - TooManyTables
        type: string
      - description: Contract contains too many table elements.
        enum:
        - TooManyTableElements
        type: string
      - description: A function body in the contract exceeds the size limit.
        enum:
        - FunctionBodyTooLarge
        type: string
      - description: The instrumented code exceeds the size limit.
        enum:
        - InstrumentedCodeTooLarge
        type: string
      - description: A function contains too many basic blocks.
        enum:
        - TooManyBlocksPerFunction
        type: string
      - description: A contract contains too many basic blocks.
        enum:
        - TooManyBlocksPerContract
        type: string
      - description: Contract declares too many entries in the wasm type section.
        enum:
        - TooManyTypes
        type: string
      - description: All contract functions combined have more than `max_params_per_contract` parameters.
        enum:
        - TooManyParamsPerFunction
        type: string
      - description: A function has more than `max_params_per_function` parameters.
        enum:
        - TooManyParamsPerContract
        type: string
      - description: 'A function''s max operand-stack size (in bytes) exceeds

          `max_operand_stack_bytes_per_function`.'
        enum:
        - OperandStackTooLarge
        type: string
    RpcLightClientProofError:
      oneOf:
      - properties:
          info:
            type: object
          name:
            enum:
            - UNKNOWN_BLOCK
            type: string
        required:
        - name
        - info
        type: object
      - properties:
          info:
            properties:
              execution_outcome_shard_id:
                $ref: '#/components/schemas/ShardId'
              number_or_shards:
                format: uint
                minimum: 0
                type: integer
            required:
            - number_or_shards
            - execution_outcome_shard_id
            type: object
          name:
            enum:
            - INCONSISTENT_STATE
            type: string
        required:
        - name
        - info
        type: object
      - properties:
          info:
            properties:
              transaction_or_receipt_id:
                $ref: '#/components/schemas/CryptoHash'
            required:
            - transaction_or_receipt_id
            type: object
          name:
            enum:
            - NOT_CONFIRMED
            type: string
        required:
        - name
        - info
        type: object
      - properties:
          info:
            properties:
              transaction_or_receipt_id:
                $ref: '#/components/schemas/CryptoHash'
            required:
            - transaction_or_receipt_id
            type: object
          name:
            enum:
            - UNKNOWN_TRANSACTION_OR_RECEIPT
            type: string
        required:
        - name
        - info
        type: object
      - properties:
          info:
            properties:
              shard_id:
                $ref: '#/components/schemas/ShardId'
              transaction_or_receipt_id:
                $ref: '#/components/schemas/CryptoHash'
            required:
            - transaction_or_receipt_id
            - shard_id
            type: object
          name:
            enum:
            - UNAVAILABLE_SHARD
            type: string
        required:
        - name
        - info
        type: object
      - properties:
          info:
            properties:
              error_message:
                type: string
            required:
            - error_message
            type: object
          name:
            enum:
            - INTERNAL_ERROR
            type: string
        required:
        - name
        - info
        type: object
    NearToken:
      type: string
    BlockHeaderInnerLiteView:
      description: A part of a state for the current head of a light client. More info [here](https://nomicon.io/ChainSpec/LightClient).
      properties:
        block_merkle_root:
          allOf:
          - $ref: '#/components/schemas/CryptoHash'
          description: The merkle root of all the block hashes
        epoch_id:
          allOf:
          - $ref: '#/components/schemas/CryptoHash'
          description: The epoch to which the block that is the current known head belongs
        height:
          format: uint64
          minimum: 0
          type: integer
        next_bp_hash:
          allOf:
          - $ref: '#/components/schemas/CryptoHash'
          description: The hash of the block producers set for the next epoch
        next_epoch_id:
          allOf:
          - $ref: '#/components/schemas/CryptoHash'
          description: The epoch that will follow the current epoch
        outcome_root:
          $ref: '#/components/schemas/CryptoHash'
        prev_state_root:
          $ref: '#/components/schemas/CryptoHash'
        timestamp:
          description: Legacy json number. Should not be used.
          format: uint64
          minimum: 0
          type: integer
        timestamp_nanosec:
          type: string
      required:
      - height
      - epoch_id
      - next_epoch_id
      - prev_state_root
      - outcome_root
      - timestamp
      - timestamp_nanosec
      - next_bp_hash
      - block_merkle_root
      type: object
    ExecutionStatusView:
      oneOf:
      - description: The execution is pending or unknown.
        enum:
        - Unknown
        type: string
      - additionalProperties: false
        description: The execution has failed.
        properties:
          Failure:
            $ref: '#/components/schemas/TxExecutionError'
        required:
        - Failure
        type: object
      - additionalProperties: false
        description: The final action succeeded and returned some value or an empty vec encoded in base64.
        properties:
          SuccessValue:
            type: string
        required:
        - SuccessValue
        type: object
      - additionalProperties: false
        description: 'The final action of the receipt returned a promise or the signed transaction was converted

          to a receipt. Contains the receipt_id of the generated receipt.'
        properties:
          SuccessReceiptId:
            $ref: '#/components/schemas/CryptoHash'
        required:
        - SuccessReceiptId
        type: object
    RpcLightClientExecutionProofRequest:
      oneOf:
      - properties:
          sender_id:
            $ref: '#/components/schemas/AccountId'
          transaction_hash:
            $ref: '#/components/schemas/CryptoHash'
          type:
            enum:
            - transaction
            type: string
        required:
        - type
        - transaction_hash
        - sender_id
        type: object
      - properties:
          receipt_id:
            $ref: '#/components/schemas/CryptoHash'
          receiver_id:
            $ref: '#/components/schemas/AccountId'
          type:
            enum:
            - receipt
            type: string
        required:
        - type
        - receipt_id
        - receiver_id
        type: object
      properties:
        light_client_head:
          $ref: '#/components/schemas/CryptoHash'
      required:
      - light_client_head
      title: RpcLightClientExecutionProofRequest
      type: object
    AccountId:
      $schema: https://json-schema.org/draft/2020-12/schema
      description: 'NEAR Account Identifier.


        This is a unique, syntactically valid, human-readable account identifier on the NEAR network.


        [See the crate-level docs for information about validation.](index.html#account-id-rules)


        Also see [Error kind precedence](AccountId#error-kind-precedence).


        ## Examples


        ```

        use near_account_id::AccountId;


        let alice: AccountId = "alice.near".parse().unwrap();


        assert!("ƒelicia.near".parse::<AccountId>().is_err()); // (ƒ is not f)

        ```'
      title: AccountId
      type: string
    NearGas:
      format: uint64
      minimum: 0
      type: integer
    TxExecutionError:
      description: Error returned in the ExecutionOutcome in case of failure
      oneOf:
      - additionalProperties: false
        description: An error happened during Action execution
        properties:
          ActionError:
            $ref: '#/components/schemas/ActionError'
        required:
        - ActionError
        type: object
      - additionalProperties: false
        description: An error happened during Transaction execution
        properties:
          InvalidTxError:
            $ref: '#/components/schemas/InvalidTxError'
        required:
        - InvalidTxError
        type: object
    ExecutionOutcomeView:
      properties:
        executor_id:
          allOf:
          - $ref: '#/components/schemas/AccountId'
          description: 'The id of the account on which the execution happens. For transaction this is signer_id,

            for receipt this is receiver_id.'
        gas_burnt:
          allOf:
          - $ref: '#/components/schemas/NearGas'
          description: The amount of the gas burnt by the given transaction or receipt.
        logs:
          description: Logs from this transaction or receipt.
          items:
            type: string
          type: array
        metadata:
          allOf:
          - $ref: '#/components/schemas/ExecutionMetadataView'
          default:
            version: 1
          description: Execution metadata, versioned
        receipt_ids:
          description: Receipt IDs generated by this transaction or receipt.
          items:
            $ref: '#/components/schemas/CryptoHash'
          type: array
        status:
          allOf:
          - $ref: '#/components/schemas/ExecutionStatusView'
          description: Execution status. Contains the result in case of successful execution.
        tokens_burnt:
          allOf:
          - $ref: '#/components/schemas/NearToken'
          description: 'The amount of tokens burnt corresponding to the burnt gas amount.

            This value doesn''t always equal to the `gas_burnt` multiplied by the gas price, because

            the prepaid gas price might be lower than the actual gas price and it creates a deficit.

            `tokens_burnt` also contains the penalty subtracted from refunds, while

            `gas_burnt` only contains the gas that we actually burn for the execution.'
      required:
      - logs
      - receipt_ids
      - gas_burnt
      - tokens_burnt
      - executor_id
      - status
      type: object
    HostError:
      oneOf:
      - description: String encoding is bad UTF-16 sequence
        enum:
        - BadUTF16
        type: string
      - description: String encoding is bad UTF-8 sequence
        enum:
        - BadUTF8
        type: string
      - description: Exceeded the prepaid gas
        enum:
        - GasExceeded
        type: string
      - description: Exceeded the maximum amount of gas allowed to burn per contract
        enum:
        - GasLimitExceeded
        type: string
      - description: Exceeded the account balance
        enum:
        - BalanceExceeded
        type: string
      - description: Tried to call an empty method name
        enum:
        - EmptyMethodName
        type: string
      - additionalProperties: false
        description: Smart contract panicked
        properties:
          GuestPanic:
            properties:
              panic_msg:
                type: string
            required:
            - panic_msg
            type: object
        required:
        - GuestPanic
        type: object
      - description: IntegerOverflow happened during a contract execution
        enum:
        - IntegerOverflow
        type: string
      - additionalProperties: false
        description: '`promise_idx` does not correspond to existing promises'
        properties:
          InvalidPromiseIndex:
            properties:
              promise_idx:
                format: uint64
                minimum: 0
                type: integer
            required:
            - promise_idx
            type: object
        required:
        - InvalidPromiseIndex
        type: object
      - description: Actions can only be appended to non-joint promise.
        enum:
        - CannotAppendActionToJointPromise
        type: string
      - description: Returning joint promise is currently prohibited
        enum:
        - CannotReturnJointPromise
        type: string
      - additionalProperties: false
        description: Accessed invalid promise result index
        properties:
          InvalidPromiseResultIndex:
            properties:
              result_idx:
                format: uint64
                minimum: 0
                type: integer
            required:
            - result_idx
            type: object
        required:
        - InvalidPromiseResultIndex
        type: object
      - additionalProperties: false
        description: Accessed invalid register id
        properties:
          InvalidRegisterId:
            properties:
              register_id:
                format: uint64
                minimum: 0
                type: integer
            required:
            - register_id
            type: object
        required:
        - InvalidRegisterId
        type: object
      - additionalProperties: false
        description: Iterator `iterator_index` was invalidated after its creation by performing a mutable operation on trie
        properties:
          IteratorWasInvalidated:
            properties:
              iterator_index:
                format: uint64
                minimum: 0
                type: integer
            required:
            - iterator_index
            type: object
        required:
        - IteratorWasInvalidated
        type: object
      - description: Accessed memory outside the bounds
        enum:
        - MemoryAccessViolation
        type: string
      - additionalProperties: false
        description: VM Logic returned an invalid receipt index
        properties:
          InvalidReceiptIndex:
            properties:
              receipt_index:
                format: uint64
                minimum: 0
                type: integer
            required:
            - receipt_index
            type: object
        required:
        - InvalidReceiptIndex
        type: object
      - additionalProperties: false
        description: Iterator index `iterator_index` does not exist
        properties:
          InvalidIteratorIndex:
            properties:
              iterator_index:
                format: uint64
                minimum: 0
                type: integer
            required:
            - iterator_index
            type: object
        required:
        - InvalidIteratorIndex
        type: object
      - description: VM Logic returned an invalid account id
        enum:
        - InvalidAccountId
        type: string
      - description: VM Logic returned an invalid method name
        enum:
        - InvalidMethodName
        type: string
      - description: VM Logic provided an invalid public key
        enum:
        - InvalidPublicKey
        type: string
      - additionalProperties: false
        description: '`method_name` is not allowed in view calls'
        properties:
          ProhibitedInView:
            properties:
              method_name:
                type: string
            required:
            - method_name
            type: object
        required:
        - ProhibitedInView
        type: object
      - additionalProperties: false
        description: The total number of logs will exceed the limit.
        properties:
          NumberOfLogsExceeded:
            properties:
              limit:
                format: uint64
                minimum: 0
                type: integer
            required:
            - limit
            type: object
        required:
        - NumberOfLogsExceeded
        type: object
      - additionalProperties: false
        description: The storage key length exceeded the limit.
        properties:
          KeyLengthExceeded:
            properties:
              length:
                format: uint64
                minimum: 0
                type: integer
              limit:
                format: uint64
                minimum: 0
                type: integer
            required:
            - length
            - limit
            type: object
        required:
        - KeyLengthExceeded
        type: object
      - additionalProperties: false
        description: The storage value length exceeded the limit.
        properties:
          ValueLengthExceeded:
            properties:
              length:
                format: uint64
                minimum: 0
                type: integer
              limit:
                format: uint64
                minimum: 0
                type: integer
            required:
            - length
            - limit
            type: object
        required:
        - ValueLengthExceeded
        type: object
      - additionalProperties: false
        description: The total log length exceeded the limit.
        properties:
          TotalLogLengthExceeded:
            properties:
              length:
                format: uint64
                minimum: 0
                type: integer
              limit:
                format: uint64
                minimum: 0
                type: integer
            required:
            - length
            - limit
            type: object
        required:
        - TotalLogLengthExceeded
        type: object
      - additionalProperties: false
        description: The maximum number of promises within a FunctionCall exceeded the limit.
        properties:
          NumberPromisesExceeded:
            properties:
              limit:
                format: uint64
                minimum: 0
                type: integer
              number_of_promises:
                format: uint64
                minimum: 0
                type: integer
            required:
            - number_of_promises
            - limit
            type: object
        required:
        - NumberPromisesExceeded
        type: object
      - additionalProperties: false
        description: The maximum number of input data dependencies exceeded the limit.
        properties:
          NumberInputDataDependenciesExceeded:
            properties:
              limit:
                format: uint64
                minimum: 0
                type: integer
              number_of_input_data_dependencies:
                format: uint64
                minimum: 0
                type: integer
            required:
            - number_of_input_data_dependencies
            - limit
            type: object
        required:
        - NumberInputDataDependenciesExceeded
        type: object
      - additionalProperties: false
        description: The returned value length exceeded the limit.
        properties:
          ReturnedValueLengthExceeded:
            properties:
              length:
                format: uint64
                minimum: 0
                type: integer
              limit:
                format: uint64
                minimum: 0
                type: integer
            required:
            - length
            - limit
            type: object
        required:
        - ReturnedValueLengthExceeded
        type: object
      - additionalProperties: false
        description: The contract size for DeployContract action exceeded the limit.
        properties:
          ContractSizeExceeded:
            properties:
              limit:
                format: uint64
                minimum: 0
                type: integer
              size:
                format: uint64
                minimum: 0
                type: integer
            required:
            - size
            - limit
            type: object
        required:
        - ContractSizeExceeded
        type: object
      - additionalProperties: false
        description: The host function was deprecated.
        properties:
          Deprecated:
            properties:
              method_name:
                type: string
            required:
            - method_name
            type: object
        required:
        - Deprecated
        type: object
      - additionalProperties: false
        description: General errors for ECDSA recover.
        properties:
          ECRecoverError:
            properties:
              msg:
                type: string
            required:
            - msg
            type: object
        required:
        - ECRecoverError
        type: object
      - additionalProperties: false
        description: 'Invalid input to alt_bn128 family of functions (e.g., point which isn''t

          on the curve).'
        properties:
          AltBn128InvalidInput:
            properties:
              msg:
                type: string
            required:
            - msg
            type: object
        required:
        - AltBn128InvalidInput
        type: object
      - additionalProperties: false
        description: 'Invalid input to ed25519 signature verification function (e.g. signature cannot be

          derived from bytes).'
        properties:
          Ed25519VerifyInvalidInput:
            properties:
              msg:
                type: string
            required:
            - msg
            type: object
        required:
        - Ed25519VerifyInvalidInput
        type: object
      - additionalProperties: false
        description: 'Input length mismatch for p256 signature verification (signature is not 64

          bytes or public key is not 33 bytes). Parse failures of otherwise

          well-sized inputs return 0 from the host function instead of aborting.'
        properties:
          P256VerifyInvalidInput:
            properties:
              msg:
                type: string
            required:
            - msg
            type: object
        required:
        - P256VerifyInvalidInput
        type: object
    StorageError:
      description: 'Errors which may occur during working with trie storages, storing

        trie values (trie nodes and state values) by their hashes.'
      oneOf:
      - description: Key-value db internal failure
        enum:
        - StorageInternalError
        type: string
      - additionalProperties: false
        description: Requested trie value by its hash which is missing in storage.
        properties:
          MissingTrieValue:
            $ref: '#/components/schemas/MissingTrieValue'
        required:
        - MissingTrieValue
        type: object
      - description: 'Found trie node which shouldn''t be part of state. Raised during

          validation of state sync parts where incorrect node was passed.

          TODO (#8997): consider including hash of trie node.'
        enum:
        - UnexpectedTrieValue
        type: string
      - additionalProperties: false
        description: 'Either invalid state or key-value db is corrupted.

          For PartialStorage it cannot be corrupted.

          Error message is unreliable and for debugging purposes only. It''s also probably ok to

          panic in every place that produces this error.

          We can check if db is corrupted by verifying everything in the state trie.'
        properties:
          StorageInconsistentState:
            type: string
        required:
        - StorageInconsistentState
        type: object
      - additionalProperties: false
        description: 'Flat storage error, meaning that it doesn''t support some block anymore.

          We guarantee that such block cannot become final, thus block processing

          must resume normally.'
        properties:
          FlatStorageBlockNotSupported:
            type: string
        required:
        - FlatStorageBlockNotSupported
        type: object
      - additionalProperties: false
        description: In-memory trie could not be loaded for some reason.
        properties:
          MemTrieLoadingError:
            type: string
        required:
        - MemTrieLoadingError
        type: object
    ExecutionOutcomeWithIdView:
      properties:
        block_hash:
          $ref: '#/components/schemas/CryptoHash'
        id:
          $ref: '#/components/schemas/CryptoHash'
        outcome:
          $ref: '#/components/schemas/ExecutionOutcomeView'
        proof:
          items:
            $ref: '#/components/schemas/MerklePathItem'
          type: array
      required:
      - proof
      - block_hash
      - id
      - outcome
      type: object
    MerklePathItem:
      properties:
        direction:
          $ref: '#/components/schemas/Direction'
        hash:
          $ref: '#/components/schemas/CryptoHash'
      required:
      - hash
      - direction
      type: object
    InvalidAccessKeyError:
      oneOf:
      - additionalProperties: false
        description: The access key identified by the `public_key` doesn't exist for the account
        properties:
          AccessKeyNotFound:
            properties:
              account_id:
                $ref: '#/components/schemas/AccountId'
              public_key:
                $ref: '#/components/schemas/PublicKey'
            required:
            - account_id
            - public_key
            type: object
        required:
        - AccessKeyNotFound
        type: object
      - additionalProperties: false
        description: Transaction `receiver_id` doesn't match the access key receiver_id
        properties:
          ReceiverMismatch:
            properties:
              ak_receiver:
                type: string
              tx_receiver:
                $ref: '#/components/schemas/AccountId'
            required:
            - tx_receiver
            - ak_receiver
            type: object
        required:
        - ReceiverMismatch
        type: object
      - additionalProperties: false
        description: Transaction method name isn't allowed by the access key
        properties:
          MethodNameMismatch:
            properties:
              method_name:
                type: string
            required:
            - method_name
            type: object
        required:
        - MethodNameMismatch
        type: object
      - description: Transaction requires a full permission access key.
        enum:
        - RequiresFullAccess
        type: string
      - additionalProperties: false
        description: Access Key does not have enough allowance to cover transaction cost
        properties:
          NotEnoughAllowance:
            properties:
              account_id:
                $ref: '#/components/schemas/AccountId'
              allowance:
                $ref: '#/components/schemas/NearToken'
              cost:
                $ref: '#/components/schemas/NearToken'
              public_key:
                $ref: '#/components/schemas/PublicKey'
            required:
            - account_id
            - public_key
            - allowance
            - cost
            type: object
        required:
        - NotEnoughAllowance
        type: object
      - description: Having a deposit with a function call action is not allowed with a function call access key.
        enum:
        - DepositWithFunctionCall
        type: string
      - description: 'Gas keys track nonces per index in dedicated storage, which a plain

          access key nonce does not select, so a gas key must sign a `DelegateV2`

          with a gas key nonce instead.'
        enum:
        - DelegateActionRequiresNonGasKey
        type: string
      - description: A delegate action with a gas key nonce must be signed by a gas key.
        enum:
        - DelegateActionRequiresGasKey
        type: string
    JsonRpcResponse_for_RpcLightClientExecutionProofResponse_and_RpcLightClientProofError:
      oneOf:
      - properties:
          result:
            $ref: '#/components/schemas/RpcLightClientExecutionProofResponse'
        required:
        - result
        type: object
      - properties:
          error:
            $ref: '#/components/schemas/ErrorWrapper_for_RpcLightClientProofError'
        required:
        - error
        type: object
      properties:
        id:
          type: string
        jsonrpc:
          type: string
      required:
      - jsonrpc
      - id
      title: JsonRpcResponse_for_RpcLightClientExecutionProofResponse_and_RpcLightClientProofError
      type: object
    InternalError:
      oneOf:
      - properties:
          info:
            properties:
              error_message:
                type: string
            required:
            - error_message
            type: object
          name:
            enum:
            - INTERNAL_ERROR
       

# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/near/refs/heads/main/openapi/near-experimental-light-client-proof-api-openapi.yml