state

Method Name: call

Parameter: method - Text, data - Bytes, at - BlockHash

Return Type: Bytes​

  • interface: api.rpc.state.call

  • jsonrpc: state_call

The call method performs a call to a builtin on the chain for the given parameters extrinsic and at.

Method Name: getChildKeys

Parameter: childStorageKey - StorageKey, childDefinition - StorageKey, childType - u32, key - StorageKey, at - BlockHash

Return Type: Bytes​

  • interface: api.rpc.state.getChildKeys

  • jsonrpc: state_getChildKeys

The getChildKeys method retrieves the keys with prefix of a specific child storage for the given parameters childStorageKey, childDefinition, childType, key and at.

Method Name: getChildReadProof

Parameter: childStorageKey - StorageKey, childDefinition - StorageKey, childType - u32, key - StorageKey, at - BlockHash

Return Type: ReadProof​

  • interface: api.rpc.state.getChildReadProof

  • jsonrpc: state_getChildReadProof

The getChildReadProof method returns proof of storage for child key entries at a specific block state for the given parameters childStorageKey, childDefinition, childType, key and at.

Method Name: getChildStorage

Parameter: childStorageKey - StorageKey, childDefinition - StorageKey, childType - u32, key - StorageKey, at - BlockHash

Return Type: StorageData​

  • interface: api.rpc.state.getChildStorage

  • jsonrpc: state_getChildStorage

The getChildStorage method retrieves the child storage for a key for the given parameters childStorageKey, childDefinition, childType, key and at.

Method Name: getChildStorageHash

Parameter: childStorageKey - StorageKey, childDefinition - StorageKey, childType - u32, key - StorageKey, at - BlockHash

Return Type: Hash​

  • interface: api.rpc.state.getChildStorageHash

  • jsonrpc: state_getChildStorageHash

The getChildStorageHash method retrieves the child storage hash for the given parameters childStorageKey, childDefinition, childType, key and at.

Method Name: getChildStorageSize

Parameter: childStorageKey - StorageKey, childDefinition - StorageKey, childType - u32, key - StorageKey, at - BlockHash

Return Type: u64​

  • interface: api.rpc.state.getChildStorageSize

  • jsonrpc: state_getChildStorageSize

The getChildStorageSize method retrieves the child storage size for the given parameters childStorageKey, childDefinition, childType, key and at.

Method Name: getKeys

Parameter: key - StorageKey, at - BlockHash

Return Type: Vec<StorageKey>

  • interface: api.rpc.state.getKeys

  • jsonrpc: state_getKeys

The getKeys method retrieves the keys with a certain prefix for the given parameters key and at.

Method Name: getKeysPaged

Parameter: key - StorageKey, count - u32, startKey - StorageKey, at - BlockHash

Return Type: Vec<StorageKey>

  • interface: api.rpc.state.getKeysPaged

  • jsonrpc: state_getKeysPaged

The getKeysPaged method returns the keys with prefix with pagination support for the given parameters key, count, startKey, and at.

Method Name: getMetadata

Parameter: at - BlockHash

Return Type: Metadata​

  • interface: api.rpc.state.getMetadata

  • jsonrpc: state_getMetadata

The getMetadata method returns the runtime metadata for the given parameter

Method Name: getPairs

Parameter: prefix: StorageKey, at - BlockHash

Return Type: Vec<KeyValue>​

  • interface: api.rpc.state.getPairs

  • jsonrpc: state_getPairs

The getPairs method returns the keys with prefix, leave empty to get all the keys (deprecated: Use getKeysPaged) for the given parameters prefix and at.

Method Name: getReadProof

Parameter: keys - Vec<StorageKey>, at - BlockHash

Return Type: ReadProof​

  • interface: api.rpc.state.getReadProof

  • jsonrpc: state_getReadProof

The getReadProof method returns proof of storage entries at a specific block state for the given parameters keys and at.

Method Name: getRuntimeVersion

Parameter: at - BlockHash

Return Type: RuntimeVersion​

  • interface: api.rpc.state.getRuntimeVersion

  • jsonrpc: state_getRuntimeVersion

The getRuntimeVersion method gets the runtime version for the given parameter

Method Name: getStorage

Parameter: key - StorageKey,at - BlockHash

Return Type: StorageData​

  • interface: api.rpc.state.getStorage

  • jsonrpc: state_getStorage

The getStorage method retrieves the storage for a key for the given parameters key and at.

Method Name: getStorageHash

Parameter: key - StorageKey,at - BlockHash

Return Type: Hash​

  • interface: api.rpc.state.getStorageHash

  • jsonrpc: state_getStorageHash

The getStorage method retrieves the storage hash for the given parameters key and at.

Method Name: getStorageSize

Parameter: key - StorageKey,at - BlockHash

Return Type: u64​

  • interface: api.rpc.state.getStorageSize

  • jsonrpc: state_getStorageSize

The getStorageSize method retrieves the storage size for the given parameters key and at.

Method Name: queryStorage

Parameter: keys - Vec<StorageKey>, fromBlock - Hash, toBlock - BlockHash

Return Type: Vec<StorageChangeSet>

  • interface: api.rpc.state.queryStorage

  • jsonrpc: state_queryStorage

The queryStorage method query historical storage entries (by key) starting from a start block for the given parameters keys, fromBlock and toBlock.

Method Name: queryStorageAt

Parameter: keys - Vec<StorageKey>, at - BlockHash

Return Type: Vec<StorageChangeSet>

  • interface: api.rpc.state.queryStorageAt

  • jsonrpc: state_queryStorageAt

The queryStorageAt method query storage entries (by key) starting at block hash given as the second parameter for the given parameters keys and at.

Method Name: subscribeRuntimeVersion

Parameter: -

Return Type: RuntimeVersion​

  • interface: api.rpc.state.subscribeRuntimeVersion

  • jsonrpc: state_subscribeRuntimeVersion

The subscribeRuntimeVersion method retrieves the runtime version via subscription

Method Name: subscribeStorage

Parameter: block - Hash, targets - Option<Text>, storageKeys - Option<Text>, methods - Option<Text>

Return Type: TraceBlockResponse​

  • interface: api.rpc.state.traceBlock

  • jsonrpc: state_traceBlock

The traceBlock method provides a way to trace the re-execution of a single block for the given parameters block, targets, storageKeys, and methods.

Method Name: trieMigrationStatus

Parameter: at - BlockHash

Return Type: MigrationStatusResult​

  • interface: api.rpc.state.trieMigrationStatus

  • jsonrpc: state_trieMigrationStatus

The trieMigrationStatus method checks the current migration state for the given parameter at.

Last updated