From 8128dbffc58660fee3f46f9444361838ae1f6126 Mon Sep 17 00:00:00 2001 From: Aryan Tikarya Date: Wed, 4 Feb 2026 14:56:02 +0530 Subject: [PATCH] add openrpc snap files --- src/rpc/mod.rs | 14 +- .../forest__rpc__tests__rpc__v0.snap | 7431 +++++++++++++++++ .../forest__rpc__tests__rpc__v1.snap | 7402 ++++++++++++++++ .../forest__rpc__tests__rpc__v2.snap | 2113 +++++ 4 files changed, 16949 insertions(+), 11 deletions(-) create mode 100644 src/rpc/snapshots/forest__rpc__tests__rpc__v0.snap create mode 100644 src/rpc/snapshots/forest__rpc__tests__rpc__v1.snap create mode 100644 src/rpc/snapshots/forest__rpc__tests__rpc__v2.snap diff --git a/src/rpc/mod.rs b/src/rpc/mod.rs index 6986ae7e05aa..75a0a5cfbba0 100644 --- a/src/rpc/mod.rs +++ b/src/rpc/mod.rs @@ -797,18 +797,10 @@ mod tests { // `cargo test --lib -- --exact 'rpc::tests::openrpc'` // `cargo insta review` #[test] - #[ignore = "https://github.com/ChainSafe/forest/issues/4032"] fn openrpc() { - for path in [ApiPaths::V0, ApiPaths::V1] { - let _spec = super::openrpc(path, None); - // TODO(forest): https://github.com/ChainSafe/forest/issues/4032 - // this is disabled because it causes lots of merge - // conflicts. - // We should consider re-enabling it when our RPC is - // more stable. - // (We still run this test to make sure we're not - // violating other invariants) - insta::assert_yaml_snapshot!(_spec); + for path in [ApiPaths::V0, ApiPaths::V1, ApiPaths::V2] { + let spec = super::openrpc(path, None); + insta::assert_yaml_snapshot!(path.path(), spec); } } diff --git a/src/rpc/snapshots/forest__rpc__tests__rpc__v0.snap b/src/rpc/snapshots/forest__rpc__tests__rpc__v0.snap new file mode 100644 index 000000000000..8be4b233eee0 --- /dev/null +++ b/src/rpc/snapshots/forest__rpc__tests__rpc__v0.snap @@ -0,0 +1,7431 @@ +--- +source: src/rpc/mod.rs +expression: spec +--- +openrpc: 1.3.2 +info: + title: forest + version: 0.31.1 +methods: + - name: Filecoin.AuthNew + params: + - name: permissions + required: true + schema: + type: + - array + - "null" + items: + type: string + - name: expiration_secs + required: true + schema: + type: + - integer + - "null" + format: int64 + result: + name: Filecoin.AuthNew.Result + required: true + schema: + $ref: "#/components/schemas/Base64String" + paramStructure: by-position + - name: Filecoin.AuthVerify + params: + - name: header_raw + required: true + schema: + type: string + result: + name: Filecoin.AuthVerify.Result + required: false + schema: + type: + - array + - "null" + items: + type: string + paramStructure: by-position + - name: Filecoin.BeaconGetEntry + params: + - name: first + required: true + schema: + type: integer + format: int64 + result: + name: Filecoin.BeaconGetEntry.Result + required: true + schema: + $ref: "#/components/schemas/BeaconEntry" + paramStructure: by-position + - name: Forest.SnapshotGC + params: + - name: blocking + required: true + schema: + type: boolean + result: + name: Forest.SnapshotGC.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.ChainExport + params: + - name: params + required: true + schema: + $ref: "#/components/schemas/ChainExportParams" + result: + name: Filecoin.ChainExport.Result + required: true + schema: + $ref: "#/components/schemas/ApiExportResult" + paramStructure: by-position + - name: Filecoin.ChainGetBlock + description: Returns the block with the specified CID. + params: + - name: blockCid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetBlock.Result + required: true + schema: + $ref: "#/components/schemas/BlockHeader" + paramStructure: by-position + - name: Filecoin.ChainGetBlockMessages + description: Returns all messages from the specified block. + params: + - name: blockCid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetBlockMessages.Result + required: true + schema: + $ref: "#/components/schemas/BlockMessages" + paramStructure: by-position + - name: Filecoin.ChainGetEvents + description: Returns the events under the given event AMT root CID. + params: + - name: rootCid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetEvents.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Event" + paramStructure: by-position + - name: Filecoin.ChainGetGenesis + params: [] + result: + name: Filecoin.ChainGetGenesis.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/Tipset" + - type: "null" + paramStructure: by-position + - name: Filecoin.ChainGetMessage + description: Returns the message with the specified CID. + params: + - name: messageCid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetMessage.Result + required: true + schema: + $ref: "#/components/schemas/FlattenedApiMessage" + paramStructure: by-position + - name: Filecoin.ChainGetMessagesInTipset + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetMessagesInTipset.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/ApiMessage" + paramStructure: by-position + - name: Forest.ChainGetMinBaseFee + params: + - name: lookback + required: true + schema: + type: integer + format: uint32 + minimum: 0 + result: + name: Forest.ChainGetMinBaseFee.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.ChainGetParentMessages + description: Returns the messages included in the blocks of the parent tipset. + params: + - name: blockCid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetParentMessages.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/ApiMessage" + paramStructure: by-position + - name: Filecoin.ChainGetParentReceipts + description: Returns the message receipts included in the blocks of the parent tipset. + params: + - name: blockCid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetParentReceipts.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/ApiReceipt" + paramStructure: by-position + - name: Filecoin.ChainGetPath + description: Returns the path between the two specified tipsets. + params: + - name: from + required: true + schema: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + - name: to + required: true + schema: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + result: + name: Filecoin.ChainGetPath.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/PathChange" + paramStructure: by-position + - name: Filecoin.ChainGetTipSet + description: Returns the tipset with the specified CID. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetTipSet.Result + required: true + schema: + $ref: "#/components/schemas/Tipset" + paramStructure: by-position + - name: Filecoin.ChainGetTipSetAfterHeight + description: "Looks back and returns the tipset at the specified epoch.\n If there are no blocks at the given epoch,\n returns the first non-nil tipset at a later epoch." + params: + - name: height + required: true + schema: + type: integer + format: int64 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetTipSetAfterHeight.Result + required: true + schema: + $ref: "#/components/schemas/Tipset" + paramStructure: by-position + - name: Filecoin.ChainGetTipSetByHeight + description: Returns the tipset at the specified height. + params: + - name: height + required: true + schema: + type: integer + format: int64 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetTipSetByHeight.Result + required: true + schema: + $ref: "#/components/schemas/Tipset" + paramStructure: by-position + - name: Filecoin.ChainHasObj + description: Checks if a given CID exists in the chain blockstore. + params: + - name: cid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainHasObj.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: Filecoin.ChainHead + description: Returns the chain head (heaviest tipset). + params: [] + result: + name: Filecoin.ChainHead.Result + required: true + schema: + $ref: "#/components/schemas/Tipset" + paramStructure: by-position + - name: Filecoin.ChainReadObj + description: Reads IPLD nodes referenced by the specified CID from the chain blockstore and returns raw bytes. + params: + - name: cid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainReadObj.Result + required: true + schema: + $ref: "#/components/schemas/Base64String" + paramStructure: by-position + - name: Filecoin.ChainSetHead + params: + - name: tsk + required: true + schema: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + result: + name: Filecoin.ChainSetHead.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.ChainStatObj + params: + - name: obj_cid + required: true + schema: + $ref: "#/components/schemas/Cid" + - name: base_cid + required: true + schema: + anyOf: + - $ref: "#/components/schemas/Cid" + - type: "null" + result: + name: Filecoin.ChainStatObj.Result + required: true + schema: + $ref: "#/components/schemas/ObjStat" + paramStructure: by-position + - name: Filecoin.ChainTipSetWeight + description: Returns the weight of the specified tipset. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainTipSetWeight.Result + required: true + schema: + $ref: "#/components/schemas/BigInt" + paramStructure: by-position + - name: Forest.ChainExport + params: + - name: params + required: true + schema: + $ref: "#/components/schemas/ForestChainExportParams" + result: + name: Forest.ChainExport.Result + required: true + schema: + $ref: "#/components/schemas/ApiExportResult" + paramStructure: by-position + - name: Forest.ChainExportDiff + params: + - name: params + required: true + schema: + $ref: "#/components/schemas/ForestChainExportDiffParams" + result: + name: Forest.ChainExportDiff.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Forest.ChainExportStatus + params: [] + result: + name: Forest.ChainExportStatus.Result + required: true + schema: + $ref: "#/components/schemas/ApiExportStatus" + paramStructure: by-position + - name: Forest.ChainExportCancel + params: [] + result: + name: Forest.ChainExportCancel.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: Forest.ChainGetTipsetByParentState + params: + - name: parentState + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Forest.ChainGetTipsetByParentState.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/Tipset" + - type: "null" + paramStructure: by-position + - name: Filecoin.Session + params: [] + result: + name: Filecoin.Session.Result + required: true + schema: + type: string + format: uuid + paramStructure: by-position + - name: Filecoin.Shutdown + params: [] + result: + name: Filecoin.Shutdown.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.StartTime + params: [] + result: + name: Filecoin.StartTime.Result + required: true + schema: + type: string + format: date-time + paramStructure: by-position + - name: Filecoin.Version + params: [] + result: + name: Filecoin.Version.Result + required: true + schema: + $ref: "#/components/schemas/PublicVersion" + paramStructure: by-position + - name: Filecoin.EthAccounts + params: [] + result: + name: Filecoin.EthAccounts.Result + required: false + schema: + type: + - array + - "null" + items: + type: string + paramStructure: by-position + - name: eth_accounts + params: [] + result: + name: eth_accounts.Result + required: false + schema: + type: + - array + - "null" + items: + type: string + paramStructure: by-position + - name: Filecoin.EthAddressToFilecoinAddress + description: Converts an EthAddress into an f410 Filecoin Address + params: + - name: ethAddress + required: true + schema: + $ref: "#/components/schemas/EthAddress" + result: + name: Filecoin.EthAddressToFilecoinAddress.Result + required: true + schema: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.FilecoinAddressToEthAddress + description: Converts any Filecoin address to an EthAddress + params: + - name: filecoinAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: blockParam + required: true + schema: + anyOf: + - $ref: "#/components/schemas/BlockNumberOrPredefined" + - type: "null" + result: + name: Filecoin.FilecoinAddressToEthAddress.Result + required: true + schema: + $ref: "#/components/schemas/EthAddress" + paramStructure: by-position + - name: Filecoin.EthBlockNumber + params: [] + result: + name: Filecoin.EthBlockNumber.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: eth_blockNumber + params: [] + result: + name: eth_blockNumber.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: Filecoin.EthCall + params: + - name: tx + required: true + schema: + $ref: "#/components/schemas/EthCallMessage" + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: Filecoin.EthCall.Result + required: true + schema: + $ref: "#/components/schemas/EthBytes" + paramStructure: by-position + - name: eth_call + params: + - name: tx + required: true + schema: + $ref: "#/components/schemas/EthCallMessage" + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: eth_call.Result + required: true + schema: + $ref: "#/components/schemas/EthBytes" + paramStructure: by-position + - name: Filecoin.EthChainId + params: [] + result: + name: Filecoin.EthChainId.Result + required: true + schema: + type: string + paramStructure: by-position + - name: eth_chainId + params: [] + result: + name: eth_chainId.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.EthEstimateGas + params: + - name: tx + required: true + schema: + $ref: "#/components/schemas/EthCallMessage" + - name: blockParam + required: true + schema: + anyOf: + - $ref: "#/components/schemas/BlockNumberOrHash" + - type: "null" + result: + name: Filecoin.EthEstimateGas.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: eth_estimateGas + params: + - name: tx + required: true + schema: + $ref: "#/components/schemas/EthCallMessage" + - name: blockParam + required: true + schema: + anyOf: + - $ref: "#/components/schemas/BlockNumberOrHash" + - type: "null" + result: + name: eth_estimateGas.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: Filecoin.EthFeeHistory + params: + - name: blockCount + required: true + schema: + $ref: "#/components/schemas/EthUint64" + - name: newestBlockNumber + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrPredefined" + - name: rewardPercentiles + required: true + schema: + type: + - array + - "null" + items: + type: number + format: double + result: + name: Filecoin.EthFeeHistory.Result + required: true + schema: + $ref: "#/components/schemas/EthFeeHistoryResult" + paramStructure: by-position + - name: eth_feeHistory + params: + - name: blockCount + required: true + schema: + $ref: "#/components/schemas/EthUint64" + - name: newestBlockNumber + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrPredefined" + - name: rewardPercentiles + required: true + schema: + type: + - array + - "null" + items: + type: number + format: double + result: + name: eth_feeHistory.Result + required: true + schema: + $ref: "#/components/schemas/EthFeeHistoryResult" + paramStructure: by-position + - name: Filecoin.EthGasPrice + description: Returns the current gas price in attoFIL + params: [] + result: + name: Filecoin.EthGasPrice.Result + required: true + schema: + $ref: "#/components/schemas/EthBigInt" + paramStructure: by-position + - name: eth_gasPrice + description: Returns the current gas price in attoFIL + params: [] + result: + name: eth_gasPrice.Result + required: true + schema: + $ref: "#/components/schemas/EthBigInt" + paramStructure: by-position + - name: Filecoin.EthGetBalance + description: Returns the balance of an Ethereum address at the specified block state + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: Filecoin.EthGetBalance.Result + required: true + schema: + $ref: "#/components/schemas/EthBigInt" + paramStructure: by-position + - name: eth_getBalance + description: Returns the balance of an Ethereum address at the specified block state + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: eth_getBalance.Result + required: true + schema: + $ref: "#/components/schemas/EthBigInt" + paramStructure: by-position + - name: Filecoin.EthGetBlockByHash + params: + - name: blockHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: fullTxInfo + required: true + schema: + type: boolean + result: + name: Filecoin.EthGetBlockByHash.Result + required: true + schema: + $ref: "#/components/schemas/Block" + paramStructure: by-position + - name: eth_getBlockByHash + params: + - name: blockHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: fullTxInfo + required: true + schema: + type: boolean + result: + name: eth_getBlockByHash.Result + required: true + schema: + $ref: "#/components/schemas/Block" + paramStructure: by-position + - name: Filecoin.EthGetBlockByNumber + description: Retrieves a block by its number or a special tag. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrPredefined" + - name: fullTxInfo + required: true + schema: + type: boolean + result: + name: Filecoin.EthGetBlockByNumber.Result + required: true + schema: + $ref: "#/components/schemas/Block" + paramStructure: by-position + - name: eth_getBlockByNumber + description: Retrieves a block by its number or a special tag. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrPredefined" + - name: fullTxInfo + required: true + schema: + type: boolean + result: + name: eth_getBlockByNumber.Result + required: true + schema: + $ref: "#/components/schemas/Block" + paramStructure: by-position + - name: Filecoin.EthGetBlockReceipts + description: "Retrieves all transaction receipts for a block by its number, hash or a special tag." + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: Filecoin.EthGetBlockReceipts.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthTxReceipt" + paramStructure: by-position + - name: eth_getBlockReceipts + description: "Retrieves all transaction receipts for a block by its number, hash or a special tag." + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: eth_getBlockReceipts.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthTxReceipt" + paramStructure: by-position + - name: Filecoin.EthGetBlockReceiptsLimited + description: "Retrieves all transaction receipts for a block identified by its number, hash or a special tag along with an optional limit on the chain epoch for state resolution." + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + - name: limit + required: true + schema: + type: integer + format: int64 + result: + name: Filecoin.EthGetBlockReceiptsLimited.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthTxReceipt" + paramStructure: by-position + - name: eth_getBlockReceiptsLimited + description: "Retrieves all transaction receipts for a block identified by its number, hash or a special tag along with an optional limit on the chain epoch for state resolution." + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + - name: limit + required: true + schema: + type: integer + format: int64 + result: + name: eth_getBlockReceiptsLimited.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthTxReceipt" + paramStructure: by-position + - name: Filecoin.EthGetBlockTransactionCountByHash + params: + - name: blockHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: Filecoin.EthGetBlockTransactionCountByHash.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: eth_getBlockTransactionCountByHash + params: + - name: blockHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: eth_getBlockTransactionCountByHash.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: Filecoin.EthGetBlockTransactionCountByNumber + description: Returns the number of transactions in a block identified by its block number. + params: + - name: blockNumber + required: true + schema: + $ref: "#/components/schemas/EthInt64" + result: + name: Filecoin.EthGetBlockTransactionCountByNumber.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: eth_getBlockTransactionCountByNumber + description: Returns the number of transactions in a block identified by its block number. + params: + - name: blockNumber + required: true + schema: + $ref: "#/components/schemas/EthInt64" + result: + name: eth_getBlockTransactionCountByNumber.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: Filecoin.EthGetCode + description: "Retrieves the contract code at a specific address and block state, identified by its number, hash, or a special tag." + params: + - name: ethAddress + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: blockNumberOrHash + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: Filecoin.EthGetCode.Result + required: true + schema: + $ref: "#/components/schemas/EthBytes" + paramStructure: by-position + - name: eth_getCode + description: "Retrieves the contract code at a specific address and block state, identified by its number, hash, or a special tag." + params: + - name: ethAddress + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: blockNumberOrHash + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: eth_getCode.Result + required: true + schema: + $ref: "#/components/schemas/EthBytes" + paramStructure: by-position + - name: Filecoin.EthGetLogs + params: + - name: ethFilter + required: true + schema: + $ref: "#/components/schemas/EthFilterSpec" + result: + name: Filecoin.EthGetLogs.Result + required: true + schema: + $ref: "#/components/schemas/EthFilterResult" + paramStructure: by-position + - name: eth_getLogs + params: + - name: ethFilter + required: true + schema: + $ref: "#/components/schemas/EthFilterSpec" + result: + name: eth_getLogs.Result + required: true + schema: + $ref: "#/components/schemas/EthFilterResult" + paramStructure: by-position + - name: Filecoin.EthGetFilterLogs + params: + - name: filterId + required: true + schema: + $ref: "#/components/schemas/FilterID" + result: + name: Filecoin.EthGetFilterLogs.Result + required: true + schema: + $ref: "#/components/schemas/EthFilterResult" + paramStructure: by-position + - name: eth_getFilterLogs + params: + - name: filterId + required: true + schema: + $ref: "#/components/schemas/FilterID" + result: + name: eth_getFilterLogs.Result + required: true + schema: + $ref: "#/components/schemas/EthFilterResult" + paramStructure: by-position + - name: Filecoin.EthGetFilterChanges + description: Returns event logs which occurred since the last poll + params: + - name: filterId + required: true + schema: + $ref: "#/components/schemas/FilterID" + result: + name: Filecoin.EthGetFilterChanges.Result + required: true + schema: + $ref: "#/components/schemas/EthFilterResult" + paramStructure: by-position + - name: eth_getFilterChanges + description: Returns event logs which occurred since the last poll + params: + - name: filterId + required: true + schema: + $ref: "#/components/schemas/FilterID" + result: + name: eth_getFilterChanges.Result + required: true + schema: + $ref: "#/components/schemas/EthFilterResult" + paramStructure: by-position + - name: Filecoin.EthGetMessageCidByTransactionHash + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: Filecoin.EthGetMessageCidByTransactionHash.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/Cid" + - type: "null" + paramStructure: by-position + - name: eth_getMessageCidByTransactionHash + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: eth_getMessageCidByTransactionHash.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/Cid" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthGetStorageAt + description: "Retrieves the storage value at a specific position for a contract\n at a given block state, identified by its number, hash, or a special tag." + params: + - name: ethAddress + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: position + required: true + schema: + $ref: "#/components/schemas/EthBytes" + - name: blockNumberOrHash + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: Filecoin.EthGetStorageAt.Result + required: true + schema: + $ref: "#/components/schemas/EthBytes" + paramStructure: by-position + - name: eth_getStorageAt + description: "Retrieves the storage value at a specific position for a contract\n at a given block state, identified by its number, hash, or a special tag." + params: + - name: ethAddress + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: position + required: true + schema: + $ref: "#/components/schemas/EthBytes" + - name: blockNumberOrHash + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: eth_getStorageAt.Result + required: true + schema: + $ref: "#/components/schemas/EthBytes" + paramStructure: by-position + - name: Filecoin.EthGetTransactionByHash + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: Filecoin.EthGetTransactionByHash.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionByHash + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: eth_getTransactionByHash.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthGetTransactionByHashLimited + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: limit + required: true + schema: + type: integer + format: int64 + result: + name: Filecoin.EthGetTransactionByHashLimited.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionByHashLimited + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: limit + required: true + schema: + type: integer + format: int64 + result: + name: eth_getTransactionByHashLimited.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthGetTransactionCount + params: + - name: sender + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: Filecoin.EthGetTransactionCount.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: eth_getTransactionCount + params: + - name: sender + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: eth_getTransactionCount.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: Filecoin.EthGetTransactionHashByCid + params: + - name: cid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.EthGetTransactionHashByCid.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/EthHash" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionHashByCid + params: + - name: cid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: eth_getTransactionHashByCid.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/EthHash" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthGetTransactionByBlockNumberAndIndex + description: Retrieves a transaction by its block number and index. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrPredefined" + - name: txIndex + required: true + schema: + $ref: "#/components/schemas/EthUint64" + result: + name: Filecoin.EthGetTransactionByBlockNumberAndIndex.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionByBlockNumberAndIndex + description: Retrieves a transaction by its block number and index. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrPredefined" + - name: txIndex + required: true + schema: + $ref: "#/components/schemas/EthUint64" + result: + name: eth_getTransactionByBlockNumberAndIndex.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthGetTransactionByBlockHashAndIndex + params: + - name: blockHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: txIndex + required: true + schema: + $ref: "#/components/schemas/EthUint64" + result: + name: Filecoin.EthGetTransactionByBlockHashAndIndex.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionByBlockHashAndIndex + params: + - name: blockHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: txIndex + required: true + schema: + $ref: "#/components/schemas/EthUint64" + result: + name: eth_getTransactionByBlockHashAndIndex.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthMaxPriorityFeePerGas + params: [] + result: + name: Filecoin.EthMaxPriorityFeePerGas.Result + required: true + schema: + $ref: "#/components/schemas/EthBigInt" + paramStructure: by-position + - name: eth_maxPriorityFeePerGas + params: [] + result: + name: eth_maxPriorityFeePerGas.Result + required: true + schema: + $ref: "#/components/schemas/EthBigInt" + paramStructure: by-position + - name: Filecoin.EthProtocolVersion + params: [] + result: + name: Filecoin.EthProtocolVersion.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: eth_protocolVersion + params: [] + result: + name: eth_protocolVersion.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: Filecoin.EthGetTransactionReceipt + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: Filecoin.EthGetTransactionReceipt.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/EthTxReceipt" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionReceipt + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: eth_getTransactionReceipt.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/EthTxReceipt" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthGetTransactionReceiptLimited + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: limit + required: true + schema: + type: integer + format: int64 + result: + name: Filecoin.EthGetTransactionReceiptLimited.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/EthTxReceipt" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionReceiptLimited + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: limit + required: true + schema: + type: integer + format: int64 + result: + name: eth_getTransactionReceiptLimited.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/EthTxReceipt" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthNewFilter + params: + - name: filterSpec + required: true + schema: + $ref: "#/components/schemas/EthFilterSpec" + result: + name: Filecoin.EthNewFilter.Result + required: true + schema: + $ref: "#/components/schemas/FilterID" + paramStructure: by-position + - name: eth_newFilter + params: + - name: filterSpec + required: true + schema: + $ref: "#/components/schemas/EthFilterSpec" + result: + name: eth_newFilter.Result + required: true + schema: + $ref: "#/components/schemas/FilterID" + paramStructure: by-position + - name: Filecoin.EthNewPendingTransactionFilter + params: [] + result: + name: Filecoin.EthNewPendingTransactionFilter.Result + required: true + schema: + $ref: "#/components/schemas/FilterID" + paramStructure: by-position + - name: eth_newPendingTransactionFilter + params: [] + result: + name: eth_newPendingTransactionFilter.Result + required: true + schema: + $ref: "#/components/schemas/FilterID" + paramStructure: by-position + - name: Filecoin.EthNewBlockFilter + params: [] + result: + name: Filecoin.EthNewBlockFilter.Result + required: true + schema: + $ref: "#/components/schemas/FilterID" + paramStructure: by-position + - name: eth_newBlockFilter + params: [] + result: + name: eth_newBlockFilter.Result + required: true + schema: + $ref: "#/components/schemas/FilterID" + paramStructure: by-position + - name: Filecoin.EthUninstallFilter + params: + - name: filterId + required: true + schema: + $ref: "#/components/schemas/FilterID" + result: + name: Filecoin.EthUninstallFilter.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: eth_uninstallFilter + params: + - name: filterId + required: true + schema: + $ref: "#/components/schemas/FilterID" + result: + name: eth_uninstallFilter.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: Filecoin.EthUnsubscribe + params: [] + result: + name: Filecoin.EthUnsubscribe.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: eth_unsubscribe + params: [] + result: + name: eth_unsubscribe.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.EthSubscribe + params: [] + result: + name: Filecoin.EthSubscribe.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: eth_subscribe + params: [] + result: + name: eth_subscribe.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.EthSyncing + params: [] + result: + name: Filecoin.EthSyncing.Result + required: true + schema: + $ref: "#/components/schemas/EthSyncingResultLotusJson" + paramStructure: by-position + - name: eth_syncing + params: [] + result: + name: eth_syncing.Result + required: true + schema: + $ref: "#/components/schemas/EthSyncingResultLotusJson" + paramStructure: by-position + - name: Filecoin.EthTraceBlock + description: Returns traces created at given block. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + result: + name: Filecoin.EthTraceBlock.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthBlockTrace" + paramStructure: by-position + - name: trace_block + description: Returns traces created at given block. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + result: + name: trace_block.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthBlockTrace" + paramStructure: by-position + - name: Filecoin.EthTraceFilter + description: Returns the traces for transactions matching the filter criteria. + params: + - name: filter + required: true + schema: + $ref: "#/components/schemas/EthTraceFilterCriteria" + result: + name: Filecoin.EthTraceFilter.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthBlockTrace" + paramStructure: by-position + - name: trace_filter + description: Returns the traces for transactions matching the filter criteria. + params: + - name: filter + required: true + schema: + $ref: "#/components/schemas/EthTraceFilterCriteria" + result: + name: trace_filter.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthBlockTrace" + paramStructure: by-position + - name: Filecoin.EthTraceTransaction + description: Returns the traces for a specific transaction. + params: + - name: txHash + required: true + schema: + type: string + result: + name: Filecoin.EthTraceTransaction.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthBlockTrace" + paramStructure: by-position + - name: trace_transaction + description: Returns the traces for a specific transaction. + params: + - name: txHash + required: true + schema: + type: string + result: + name: trace_transaction.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthBlockTrace" + paramStructure: by-position + - name: Filecoin.EthTraceReplayBlockTransactions + description: Replays all transactions in a block returning the requested traces for each transaction. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + - name: traceTypes + required: true + schema: + type: + - array + - "null" + items: + type: string + result: + name: Filecoin.EthTraceReplayBlockTransactions.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthReplayBlockTransactionTrace" + paramStructure: by-position + - name: trace_replayBlockTransactions + description: Replays all transactions in a block returning the requested traces for each transaction. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + - name: traceTypes + required: true + schema: + type: + - array + - "null" + items: + type: string + result: + name: trace_replayBlockTransactions.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthReplayBlockTransactionTrace" + paramStructure: by-position + - name: Filecoin.Web3ClientVersion + params: [] + result: + name: Filecoin.Web3ClientVersion.Result + required: true + schema: + type: string + paramStructure: by-position + - name: web3_clientVersion + params: [] + result: + name: web3_clientVersion.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.EthSendRawTransaction + params: + - name: rawTx + required: true + schema: + $ref: "#/components/schemas/EthBytes" + result: + name: Filecoin.EthSendRawTransaction.Result + required: true + schema: + $ref: "#/components/schemas/EthHash" + paramStructure: by-position + - name: eth_sendRawTransaction + params: + - name: rawTx + required: true + schema: + $ref: "#/components/schemas/EthBytes" + result: + name: eth_sendRawTransaction.Result + required: true + schema: + $ref: "#/components/schemas/EthHash" + paramStructure: by-position + - name: Filecoin.GasEstimateFeeCap + description: Returns the estimated fee cap for the given parameters. + params: + - name: message + required: true + schema: + $ref: "#/components/schemas/Message" + - name: maxQueueBlocks + required: true + schema: + type: integer + format: int64 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.GasEstimateFeeCap.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.GasEstimateGasLimit + description: Returns the estimated gas limit for the given parameters. + params: + - name: message + required: true + schema: + $ref: "#/components/schemas/Message" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.GasEstimateGasLimit.Result + required: true + schema: + type: integer + format: int64 + paramStructure: by-position + - name: Filecoin.GasEstimateGasPremium + description: Returns the estimated gas premium for the given parameters. + params: + - name: numberOfBlocksToInclude + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: senderAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: gasLimit + required: true + schema: + type: integer + format: int64 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.GasEstimateGasPremium.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.GasEstimateMessageGas + description: Returns the estimated gas for the given parameters. + params: + - name: message + required: true + schema: + $ref: "#/components/schemas/Message" + - name: messageSendSpec + required: true + schema: + anyOf: + - $ref: "#/components/schemas/MessageSendSpec" + - type: "null" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.GasEstimateMessageGas.Result + required: true + schema: + $ref: "#/components/schemas/FlattenedApiMessage" + paramStructure: by-position + - name: Filecoin.MarketAddBalance + params: + - name: wallet + required: true + schema: + $ref: "#/components/schemas/Address" + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: amount + required: true + schema: + $ref: "#/components/schemas/BigInt" + result: + name: Filecoin.MarketAddBalance.Result + required: true + schema: + $ref: "#/components/schemas/Cid" + paramStructure: by-position + - name: Filecoin.MinerCreateBlock + description: "Fills and signs a block template on behalf of the given miner, returning a suitable block header." + params: + - name: blockTemplate + required: true + schema: + $ref: "#/components/schemas/BlockTemplate" + result: + name: Filecoin.MinerCreateBlock.Result + required: true + schema: + $ref: "#/components/schemas/BlockMessage" + paramStructure: by-position + - name: Filecoin.MinerGetBaseInfo + description: "Retrieves the Miner Actor at the given address and tipset, returning basic information such as power and mining eligibility." + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: epoch + required: true + schema: + type: integer + format: int64 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.MinerGetBaseInfo.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/MiningBaseInfo" + - type: "null" + paramStructure: by-position + - name: Filecoin.MpoolBatchPush + description: Adds a set of signed messages to the message pool. + params: + - name: messages + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/SignedMessage" + result: + name: Filecoin.MpoolBatchPush.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + paramStructure: by-position + - name: Filecoin.MpoolBatchPushUntrusted + description: Adds a set of messages to the message pool with additional verification checks. + params: + - name: messages + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/SignedMessage" + result: + name: Filecoin.MpoolBatchPushUntrusted.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + paramStructure: by-position + - name: Filecoin.MpoolGetNonce + description: Returns the current nonce for the specified address. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + result: + name: Filecoin.MpoolGetNonce.Result + required: true + schema: + type: integer + format: uint64 + minimum: 0 + paramStructure: by-position + - name: Filecoin.MpoolPending + description: Returns the pending messages for a given tipset. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.MpoolPending.Result + required: true + schema: + type: array + items: + $ref: "#/components/schemas/SignedMessage" + paramStructure: by-position + - name: Filecoin.MpoolPush + description: Adds a signed message to the message pool. + params: + - name: message + required: true + schema: + $ref: "#/components/schemas/SignedMessage" + result: + name: Filecoin.MpoolPush.Result + required: true + schema: + $ref: "#/components/schemas/Cid" + paramStructure: by-position + - name: Filecoin.MpoolPushMessage + description: "Assigns a nonce, signs, and pushes a message to the mempool." + params: + - name: message + required: true + schema: + $ref: "#/components/schemas/Message" + - name: sendSpec + required: true + schema: + anyOf: + - $ref: "#/components/schemas/MessageSendSpec" + - type: "null" + result: + name: Filecoin.MpoolPushMessage.Result + required: true + schema: + $ref: "#/components/schemas/SignedMessage" + paramStructure: by-position + - name: Filecoin.MpoolPushUntrusted + description: Adds a message to the message pool with verification checks. + params: + - name: message + required: true + schema: + $ref: "#/components/schemas/SignedMessage" + result: + name: Filecoin.MpoolPushUntrusted.Result + required: true + schema: + $ref: "#/components/schemas/Cid" + paramStructure: by-position + - name: Filecoin.MpoolSelect + description: Returns a list of pending messages for inclusion in the next block. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + - name: ticketQuality + required: true + schema: + type: number + format: double + result: + name: Filecoin.MpoolSelect.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/SignedMessage" + paramStructure: by-position + - name: Filecoin.MsigGetAvailableBalance + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipset_key + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.MsigGetAvailableBalance.Result + required: true + schema: + $ref: "#/components/schemas/TokenAmount" + paramStructure: by-position + - name: Filecoin.MsigGetPending + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipset_key + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.MsigGetPending.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Transaction" + paramStructure: by-position + - name: Filecoin.MsigGetVested + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: start_tsk + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + - name: end_tsk + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.MsigGetVested.Result + required: true + schema: + $ref: "#/components/schemas/BigInt" + paramStructure: by-position + - name: Filecoin.MsigGetVestingSchedule + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tsk + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.MsigGetVestingSchedule.Result + required: true + schema: + $ref: "#/components/schemas/MsigVesting" + paramStructure: by-position + - name: Filecoin.NetAddrsListen + description: Returns a list of listening addresses and the peer ID. + params: [] + result: + name: Filecoin.NetAddrsListen.Result + required: true + schema: + $ref: "#/components/schemas/AddrInfo" + paramStructure: by-position + - name: Filecoin.NetAgentVersion + description: Returns the agent version string. + params: + - name: peerId + required: true + schema: + type: string + result: + name: Filecoin.NetAgentVersion.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.NetAutoNatStatus + params: [] + result: + name: Filecoin.NetAutoNatStatus.Result + required: true + schema: + $ref: "#/components/schemas/NatStatusResult" + paramStructure: by-position + - name: Filecoin.NetConnect + description: Connects to a specified peer. + params: + - name: peerAddressInfo + required: true + schema: + $ref: "#/components/schemas/AddrInfo" + result: + name: Filecoin.NetConnect.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.NetDisconnect + description: Disconnects from the specified peer. + params: + - name: peerId + required: true + schema: + type: string + result: + name: Filecoin.NetDisconnect.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.NetFindPeer + params: + - name: peer_id + required: true + schema: + type: string + result: + name: Filecoin.NetFindPeer.Result + required: true + schema: + $ref: "#/components/schemas/AddrInfo" + paramStructure: by-position + - name: Forest.NetInfo + params: [] + result: + name: Forest.NetInfo.Result + required: true + schema: + $ref: "#/components/schemas/NetInfoResult" + paramStructure: by-position + - name: Filecoin.NetListening + params: [] + result: + name: Filecoin.NetListening.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: net_listening + params: [] + result: + name: net_listening.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: Filecoin.NetPeers + description: Returns a list of currently connected peers. + params: [] + result: + name: Filecoin.NetPeers.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/AddrInfo" + paramStructure: by-position + - name: Filecoin.NetProtectAdd + description: Protects a peer from having its connection(s) pruned in the event the libp2p host reaches its maximum number of peers. + params: + - name: peerIdList + required: true + schema: + type: + - array + - "null" + items: + type: string + result: + name: Filecoin.NetProtectAdd.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.NetProtectList + description: Returns the current list of protected peers. + params: [] + result: + name: Filecoin.NetProtectList.Result + required: false + schema: + type: + - array + - "null" + items: + type: string + paramStructure: by-position + - name: Filecoin.NetProtectRemove + description: Remove a peer from the protected list. + params: + - name: peerIdList + required: true + schema: + type: + - array + - "null" + items: + type: string + result: + name: Filecoin.NetProtectRemove.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.NetVersion + params: [] + result: + name: Filecoin.NetVersion.Result + required: true + schema: + type: string + paramStructure: by-position + - name: net_version + params: [] + result: + name: net_version.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.NodeStatus + params: [] + result: + name: Filecoin.NodeStatus.Result + required: true + schema: + $ref: "#/components/schemas/NodeStatusResult" + paramStructure: by-position + - name: Filecoin.StateAccountKey + description: Returns the public key address for the given ID address (secp and bls accounts). + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateAccountKey.Result + required: true + schema: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.StateCall + description: "Runs the given message and returns its result without persisting changes. The message is applied to the tipset's parent state." + params: + - name: message + required: true + schema: + $ref: "#/components/schemas/Message" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateCall.Result + required: true + schema: + $ref: "#/components/schemas/ApiInvocResult" + paramStructure: by-position + - name: Filecoin.StateCirculatingSupply + description: Returns the exact circulating supply of Filecoin at the given tipset. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateCirculatingSupply.Result + required: true + schema: + $ref: "#/components/schemas/TokenAmount" + paramStructure: by-position + - name: Forest.StateCompute + params: + - name: epoch + required: true + schema: + type: integer + format: int64 + - name: n_epochs + required: true + schema: + type: + - integer + - "null" + format: uint + minimum: 1 + result: + name: Forest.StateCompute.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/ForestComputeStateOutput" + paramStructure: by-position + - name: Filecoin.StateCompute + description: Applies the given messages on the given tipset + params: + - name: height + required: true + schema: + type: integer + format: int64 + - name: messages + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Message" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateCompute.Result + required: true + schema: + $ref: "#/components/schemas/ComputeStateOutput" + paramStructure: by-position + - name: Filecoin.StateDealProviderCollateralBounds + description: "Returns the minimum and maximum collateral a storage provider can issue, based on deal size and verified status." + params: + - name: size + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: verified + required: true + schema: + type: boolean + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateDealProviderCollateralBounds.Result + required: true + schema: + $ref: "#/components/schemas/DealCollateralBounds" + paramStructure: by-position + - name: Forest.StateFetchRoot + params: + - name: root_cid + required: true + schema: + $ref: "#/components/schemas/Cid" + - name: save_to_file + required: true + schema: + type: + - string + - "null" + result: + name: Forest.StateFetchRoot.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.StateGetActor + description: Returns the nonce and balance for the specified actor. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetActor.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ActorState" + - type: "null" + paramStructure: by-position + - name: Filecoin.StateGetAllAllocations + description: Returns all allocations available in the verified registry actor. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetAllAllocations.Result + required: true + schema: + type: object + additionalProperties: false + patternProperties: + "^\\d+$": + $ref: "#/components/schemas/Allocation" + paramStructure: by-position + - name: Filecoin.StateGetAllClaims + description: Returns all claims available in the verified registry actor. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetAllClaims.Result + required: true + schema: + type: object + additionalProperties: false + patternProperties: + "^\\d+$": + $ref: "#/components/schemas/ClaimLotusJson" + paramStructure: by-position + - name: Filecoin.StateGetAllocation + description: Returns the allocation for a given address and allocation ID. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: allocationId + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetAllocation.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/Allocation" + - type: "null" + paramStructure: by-position + - name: Filecoin.StateGetAllocationForPendingDeal + description: Returns the allocation for the specified pending deal. Returns null if no pending allocation is found. + params: + - name: dealId + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetAllocationForPendingDeal.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/Allocation" + - type: "null" + paramStructure: by-position + - name: Filecoin.StateGetAllocationIdForPendingDeal + description: Returns the allocation ID for the specified pending deal. + params: + - name: dealId + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetAllocationIdForPendingDeal.Result + required: true + schema: + type: integer + format: uint64 + minimum: 0 + paramStructure: by-position + - name: Filecoin.StateGetAllocations + description: Returns all allocations for a given client. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetAllocations.Result + required: true + schema: + type: object + additionalProperties: false + patternProperties: + "^\\d+$": + $ref: "#/components/schemas/Allocation" + paramStructure: by-position + - name: Filecoin.StateGetBeaconEntry + description: Returns the beacon entries for the specified epoch. + params: + - name: epoch + required: true + schema: + type: integer + format: int64 + result: + name: Filecoin.StateGetBeaconEntry.Result + required: true + schema: + $ref: "#/components/schemas/BeaconEntry" + paramStructure: by-position + - name: Filecoin.StateGetClaim + description: Returns the claim for a given address and claim ID. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: claimId + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetClaim.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ClaimLotusJson" + - type: "null" + paramStructure: by-position + - name: Filecoin.StateGetClaims + description: Returns all claims for a given provider. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetClaims.Result + required: true + schema: + type: object + additionalProperties: false + patternProperties: + "^\\d+$": + $ref: "#/components/schemas/ClaimLotusJson" + paramStructure: by-position + - name: Filecoin.StateGetNetworkParams + description: Returns current network parameters. + params: [] + result: + name: Filecoin.StateGetNetworkParams.Result + required: true + schema: + $ref: "#/components/schemas/NetworkParams" + paramStructure: by-position + - name: Filecoin.StateGetRandomnessDigestFromBeacon + description: Samples the beacon for randomness. + params: + - name: randEpoch + required: true + schema: + type: integer + format: int64 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetRandomnessDigestFromBeacon.Result + required: true + schema: + $ref: "#/components/schemas/Base64String" + paramStructure: by-position + - name: Filecoin.StateGetRandomnessDigestFromTickets + description: Samples the chain for randomness. + params: + - name: randEpoch + required: true + schema: + type: integer + format: int64 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetRandomnessDigestFromTickets.Result + required: true + schema: + $ref: "#/components/schemas/Base64String" + paramStructure: by-position + - name: Filecoin.StateGetRandomnessFromBeacon + description: "Returns the beacon entry for the specified Filecoin epoch. If unavailable, the call blocks until it becomes available." + params: + - name: personalization + required: true + schema: + type: integer + format: int64 + - name: randEpoch + required: true + schema: + type: integer + format: int64 + - name: entropy + required: true + schema: + $ref: "#/components/schemas/Base64String" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetRandomnessFromBeacon.Result + required: true + schema: + $ref: "#/components/schemas/Base64String" + paramStructure: by-position + - name: Filecoin.StateGetRandomnessFromTickets + description: Samples the chain for randomness. + params: + - name: personalization + required: true + schema: + type: integer + format: int64 + - name: randEpoch + required: true + schema: + type: integer + format: int64 + - name: entropy + required: true + schema: + $ref: "#/components/schemas/Base64String" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetRandomnessFromTickets.Result + required: true + schema: + $ref: "#/components/schemas/Base64String" + paramStructure: by-position + - name: Filecoin.StateGetReceipt + params: + - name: cid + required: true + schema: + $ref: "#/components/schemas/Cid" + - name: tipset_key + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetReceipt.Result + required: true + schema: + $ref: "#/components/schemas/Receipt" + paramStructure: by-position + - name: Filecoin.StateListActors + description: Returns the addresses of every actor in the state. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateListActors.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.StateListMessages + description: Returns all messages with a matching to or from address up to the given height. + params: + - name: messageFilter + required: true + schema: + $ref: "#/components/schemas/MessageFilter" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + - name: maxHeight + required: true + schema: + type: integer + format: int64 + result: + name: Filecoin.StateListMessages.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + paramStructure: by-position + - name: Filecoin.StateListMiners + description: Returns the addresses of every miner with claimed power in the Power Actor. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateListMiners.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.StateLookupID + description: Retrieves the ID address of the given address. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateLookupID.Result + required: true + schema: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.StateLookupRobustAddress + description: "Returns the public key address for non-account addresses (e.g., multisig, miners)." + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateLookupRobustAddress.Result + required: true + schema: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.StateMarketBalance + description: Returns the Escrow and Locked balances of the specified address in the Storage Market. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMarketBalance.Result + required: true + schema: + $ref: "#/components/schemas/MarketBalance" + paramStructure: by-position + - name: Filecoin.StateMarketDeals + description: Returns information about every deal in the Storage Market. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMarketDeals.Result + required: true + schema: + type: object + additionalProperties: + $ref: "#/components/schemas/ApiMarketDeal" + paramStructure: by-position + - name: Filecoin.StateMarketParticipants + description: Returns the Escrow and Locked balances of all participants in the Storage Market. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMarketParticipants.Result + required: true + schema: + type: object + additionalProperties: + $ref: "#/components/schemas/MarketBalance" + paramStructure: by-position + - name: Filecoin.StateMarketStorageDeal + description: Returns information about the specified deal. + params: + - name: dealId + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMarketStorageDeal.Result + required: true + schema: + $ref: "#/components/schemas/ApiMarketDeal" + paramStructure: by-position + - name: Filecoin.StateMinerActiveSectors + description: Returns information about sectors actively proven by a given miner. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerActiveSectors.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/SectorOnChainInfo" + paramStructure: by-position + - name: Filecoin.StateMinerAllocated + description: Returns a bitfield containing all sector numbers marked as allocated to the provided miner ID. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerAllocated.Result + required: true + schema: + $ref: "#/components/schemas/BitField" + paramStructure: by-position + - name: Filecoin.StateMinerAvailableBalance + description: "Returns the portion of a miner's balance available for withdrawal or spending." + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerAvailableBalance.Result + required: true + schema: + $ref: "#/components/schemas/TokenAmount" + paramStructure: by-position + - name: Filecoin.StateMinerDeadlines + description: Returns all proving deadlines for the given miner. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerDeadlines.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/ApiDeadline" + paramStructure: by-position + - name: Filecoin.StateMinerFaults + description: Returns a bitfield of the faulty sectors for the given miner. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerFaults.Result + required: true + schema: + $ref: "#/components/schemas/BitField" + paramStructure: by-position + - name: Filecoin.StateMinerInfo + description: Returns information about the specified miner. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerInfo.Result + required: true + schema: + $ref: "#/components/schemas/MinerInfo" + paramStructure: by-position + - name: Filecoin.StateMinerInitialPledgeCollateral + description: "Returns the initial pledge collateral for the specified miner's sector." + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: sectorPreCommitInfo + required: true + schema: + $ref: "#/components/schemas/SectorPreCommitInfo" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerInitialPledgeCollateral.Result + required: true + schema: + $ref: "#/components/schemas/TokenAmount" + paramStructure: by-position + - name: Filecoin.StateMinerPartitions + description: Returns all partitions in the specified deadline. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: deadlineIndex + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerPartitions.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/MinerPartitions" + paramStructure: by-position + - name: Filecoin.StateMinerPower + description: Returns the power of the specified miner. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerPower.Result + required: true + schema: + $ref: "#/components/schemas/MinerPower" + paramStructure: by-position + - name: Filecoin.StateMinerPreCommitDepositForPower + description: Returns the sector precommit deposit for the specified miner. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: sectorPreCommitInfo + required: true + schema: + $ref: "#/components/schemas/SectorPreCommitInfo" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerPreCommitDepositForPower.Result + required: true + schema: + $ref: "#/components/schemas/TokenAmount" + paramStructure: by-position + - name: Filecoin.StateMinerProvingDeadline + description: Calculates the deadline and related details for a given epoch during a proving period. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerProvingDeadline.Result + required: true + schema: + $ref: "#/components/schemas/ApiDeadlineInfo" + paramStructure: by-position + - name: Filecoin.StateMinerRecoveries + description: Returns a bitfield of recovering sectors for the given miner. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerRecoveries.Result + required: true + schema: + $ref: "#/components/schemas/BitField" + paramStructure: by-position + - name: Filecoin.StateMinerSectorAllocated + description: Checks if a sector number is marked as allocated. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: sectorNumber + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerSectorAllocated.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: Filecoin.StateMinerSectorCount + description: "Returns the number of sectors in a miner's sector and proving sets." + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerSectorCount.Result + required: true + schema: + $ref: "#/components/schemas/MinerSectors" + paramStructure: by-position + - name: Filecoin.StateMinerSectors + description: "Returns information about the given miner's sectors. If no filter is provided, all sectors are included." + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: sectors + required: true + schema: + anyOf: + - $ref: "#/components/schemas/BitField" + - type: "null" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerSectors.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/SectorOnChainInfo" + paramStructure: by-position + - name: Filecoin.StateNetworkName + params: [] + result: + name: Filecoin.StateNetworkName.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.StateNetworkVersion + description: Returns the network version at the given tipset. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateNetworkVersion.Result + required: true + schema: + $ref: "#/components/schemas/NetworkVersion" + paramStructure: by-position + - name: Forest.StateActorInfo + description: Returns the builtin actor information for the current network. + params: [] + result: + name: Forest.StateActorInfo.Result + required: true + schema: + $ref: "#/components/schemas/StateActorCodeCidsOutput" + paramStructure: by-position + - name: Filecoin.StateReadState + description: Returns the state of the specified actor. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateReadState.Result + required: true + schema: + $ref: "#/components/schemas/ApiActorState" + paramStructure: by-position + - name: Filecoin.StateDecodeParams + description: Decode the provided method params. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: method + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: params + required: true + schema: + $ref: "#/components/schemas/Base64String" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateDecodeParams.Result + required: true + schema: true + paramStructure: by-position + - name: Filecoin.StateReplay + description: "Replays a given message, assuming it was included in a block in the specified tipset." + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + - name: messageCid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateReplay.Result + required: true + schema: + $ref: "#/components/schemas/ApiInvocResult" + paramStructure: by-position + - name: Filecoin.StateSearchMsg + description: Returns the receipt and tipset the specified message was included in. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + - name: messageCid + required: true + schema: + $ref: "#/components/schemas/Cid" + - name: lookBackLimit + required: true + schema: + type: integer + format: int64 + - name: allowReplaced + required: true + schema: + type: boolean + result: + name: Filecoin.StateSearchMsg.Result + required: true + schema: + $ref: "#/components/schemas/MessageLookup" + paramStructure: by-position + - name: Filecoin.StateSearchMsgLimited + description: "Looks back up to limit epochs in the chain for a message, and returns its receipt and the tipset where it was executed." + params: + - name: message_cid + required: true + schema: + $ref: "#/components/schemas/Cid" + - name: look_back_limit + required: true + schema: + type: integer + format: int64 + result: + name: Filecoin.StateSearchMsgLimited.Result + required: true + schema: + $ref: "#/components/schemas/MessageLookup" + paramStructure: by-position + - name: Filecoin.StateSectorExpiration + description: Returns the epoch at which the specified sector will expire. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: sectorNumber + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateSectorExpiration.Result + required: true + schema: + $ref: "#/components/schemas/SectorExpiration" + paramStructure: by-position + - name: Filecoin.StateSectorGetInfo + description: "Returns on-chain information for the specified miner's sector. Returns null if not found. Use StateSectorExpiration for accurate expiration epochs." + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: sectorNumber + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateSectorGetInfo.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/SectorOnChainInfo" + - type: "null" + paramStructure: by-position + - name: Filecoin.StateSectorPartition + description: Finds the deadline/partition for the specified sector. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: sectorNumber + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateSectorPartition.Result + required: true + schema: + $ref: "#/components/schemas/SectorLocation" + paramStructure: by-position + - name: Filecoin.StateSectorPreCommitInfo + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: sectorNumber + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateSectorPreCommitInfo.Result + required: true + schema: + $ref: "#/components/schemas/SectorPreCommitOnChainInfo" + paramStructure: by-position + - name: Filecoin.StateVerifiedClientStatus + description: Returns the data cap for the given address. Returns null if no entry exists in the data cap table. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateVerifiedClientStatus.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/BigInt" + - type: "null" + paramStructure: by-position + - name: Filecoin.StateVerifiedRegistryRootKey + description: "Returns the address of the Verified Registry's root key." + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateVerifiedRegistryRootKey.Result + required: true + schema: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.StateVerifierStatus + description: Returns the data cap for the given address. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateVerifierStatus.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/BigInt" + - type: "null" + paramStructure: by-position + - name: Filecoin.StateVMCirculatingSupplyInternal + description: "Returns an approximation of Filecoin's circulating supply at the given tipset." + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateVMCirculatingSupplyInternal.Result + required: true + schema: + $ref: "#/components/schemas/CirculatingSupply" + paramStructure: by-position + - name: Filecoin.StateWaitMsg + params: + - name: messageCid + required: true + schema: + $ref: "#/components/schemas/Cid" + - name: confidence + required: true + schema: + type: integer + format: int64 + result: + name: Filecoin.StateWaitMsg.Result + required: true + schema: + $ref: "#/components/schemas/MessageLookup" + paramStructure: by-position + - name: Filecoin.StateMinerInitialPledgeForSector + params: + - name: sector_duration + required: true + schema: + type: integer + format: int64 + - name: sector_size + required: true + schema: + $ref: "#/components/schemas/SectorSize" + - name: verified_size + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipset_key + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerInitialPledgeForSector.Result + required: true + schema: + $ref: "#/components/schemas/TokenAmount" + paramStructure: by-position + - name: Filecoin.SyncCheckBad + params: + - name: cid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.SyncCheckBad.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.SyncMarkBad + params: + - name: cid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.SyncMarkBad.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Forest.SyncSnapshotProgress + description: "Returns the snapshot download progress. Return Null if the tracking isn't started" + params: [] + result: + name: Forest.SyncSnapshotProgress.Result + required: true + schema: + $ref: "#/components/schemas/SnapshotProgressState" + paramStructure: by-position + - name: Forest.SyncStatus + description: Returns the current sync status of the node. + params: [] + result: + name: Forest.SyncStatus.Result + required: true + schema: + $ref: "#/components/schemas/SyncStatusReport" + paramStructure: by-position + - name: Filecoin.SyncSubmitBlock + description: Submits a newly created block to the network. + params: + - name: block + required: true + schema: + $ref: "#/components/schemas/GossipBlock" + result: + name: Filecoin.SyncSubmitBlock.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.WalletBalance + description: Returns the balance of a wallet. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + result: + name: Filecoin.WalletBalance.Result + required: true + schema: + $ref: "#/components/schemas/TokenAmount" + paramStructure: by-position + - name: Filecoin.WalletDefaultAddress + params: [] + result: + name: Filecoin.WalletDefaultAddress.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/Address" + - type: "null" + paramStructure: by-position + - name: Filecoin.WalletDelete + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + result: + name: Filecoin.WalletDelete.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.WalletExport + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + result: + name: Filecoin.WalletExport.Result + required: true + schema: + $ref: "#/components/schemas/KeyInfo" + paramStructure: by-position + - name: Filecoin.WalletHas + description: Indicates whether the given address exists in the wallet. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + result: + name: Filecoin.WalletHas.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: Filecoin.WalletImport + params: + - name: key + required: true + schema: + $ref: "#/components/schemas/KeyInfo" + result: + name: Filecoin.WalletImport.Result + required: true + schema: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.WalletList + description: Returns a list of all addresses in the wallet. + params: [] + result: + name: Filecoin.WalletList.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.WalletNew + params: + - name: signature_type + required: true + schema: + $ref: "#/components/schemas/SignatureTypeLotusJson" + result: + name: Filecoin.WalletNew.Result + required: true + schema: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.WalletSetDefault + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + result: + name: Filecoin.WalletSetDefault.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.WalletSign + description: Signs the given bytes using the specified address. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: message + required: true + schema: + $ref: "#/components/schemas/Base64String" + result: + name: Filecoin.WalletSign.Result + required: true + schema: + $ref: "#/components/schemas/Signature" + paramStructure: by-position + - name: Filecoin.WalletSignMessage + description: Signs the given message using the specified address. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: message + required: true + schema: + $ref: "#/components/schemas/Message" + result: + name: Filecoin.WalletSignMessage.Result + required: true + schema: + $ref: "#/components/schemas/SignedMessage" + paramStructure: by-position + - name: Filecoin.WalletValidateAddress + params: + - name: address + required: true + schema: + type: string + result: + name: Filecoin.WalletValidateAddress.Result + required: true + schema: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.WalletVerify + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: message + required: true + schema: + $ref: "#/components/schemas/Base64String" + - name: signature + required: true + schema: + $ref: "#/components/schemas/Signature" + result: + name: Filecoin.WalletVerify.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: F3.GetRawNetworkName + params: [] + result: + name: F3.GetRawNetworkName.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.F3GetCertificate + params: + - name: instance + required: true + schema: + type: integer + format: uint64 + minimum: 0 + result: + name: Filecoin.F3GetCertificate.Result + required: true + schema: + $ref: "#/components/schemas/FinalityCertificate" + paramStructure: by-position + - name: Filecoin.F3GetECPowerTable + params: + - name: tipset_key + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.F3GetECPowerTable.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/F3PowerEntryLotusJson" + paramStructure: by-position + - name: Filecoin.F3GetF3PowerTable + params: + - name: tipset_key + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.F3GetF3PowerTable.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/F3PowerEntryLotusJson" + paramStructure: by-position + - name: Filecoin.F3GetF3PowerTableByInstance + description: Gets the power table (committee) used to validate the specified instance + params: + - name: instance + required: true + schema: + type: integer + format: uint64 + minimum: 0 + result: + name: Filecoin.F3GetF3PowerTableByInstance.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/F3PowerEntryLotusJson" + paramStructure: by-position + - name: Filecoin.F3IsRunning + params: [] + result: + name: Filecoin.F3IsRunning.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: Filecoin.F3GetProgress + params: [] + result: + name: Filecoin.F3GetProgress.Result + required: true + schema: + $ref: "#/components/schemas/F3InstanceProgress" + paramStructure: by-position + - name: Filecoin.F3GetManifest + params: [] + result: + name: Filecoin.F3GetManifest.Result + required: true + schema: + $ref: "#/components/schemas/F3Manifest" + paramStructure: by-position + - name: Filecoin.F3ListParticipants + params: [] + result: + name: Filecoin.F3ListParticipants.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/F3Participant" + paramStructure: by-position + - name: Filecoin.F3GetLatestCertificate + params: [] + result: + name: Filecoin.F3GetLatestCertificate.Result + required: true + schema: + $ref: "#/components/schemas/FinalityCertificate" + paramStructure: by-position + - name: Filecoin.F3GetOrRenewParticipationTicket + params: + - name: miner_address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: previous_lease_ticket + required: true + schema: + $ref: "#/components/schemas/Base64String" + - name: instances + required: true + schema: + type: integer + format: uint64 + minimum: 0 + result: + name: Filecoin.F3GetOrRenewParticipationTicket.Result + required: true + schema: + $ref: "#/components/schemas/Base64String" + paramStructure: by-position + - name: Filecoin.F3Participate + params: + - name: lease_ticket + required: true + schema: + $ref: "#/components/schemas/Base64String" + result: + name: Filecoin.F3Participate.Result + required: true + schema: + $ref: "#/components/schemas/ApiF3ParticipationLease" + paramStructure: by-position + - name: F3.ExportLatestSnapshot + description: Exports the latest F3 snapshot to the specified path and returns its CID + params: + - name: path + required: true + schema: + type: string + result: + name: F3.ExportLatestSnapshot.Result + required: true + schema: + $ref: "#/components/schemas/Cid" + paramStructure: by-position + - name: F3.GetHead + params: [] + result: + name: F3.GetHead.Result + required: true + schema: + $ref: "#/components/schemas/F3TipSet" + paramStructure: by-position + - name: F3.GetParent + params: + - name: tipset_key + required: true + schema: + $ref: "#/components/schemas/F3TipSetKey" + result: + name: F3.GetParent.Result + required: true + schema: + $ref: "#/components/schemas/F3TipSet" + paramStructure: by-position + - name: F3.GetParticipatingMinerIDs + params: [] + result: + name: F3.GetParticipatingMinerIDs.Result + required: false + schema: + type: + - array + - "null" + items: + type: integer + format: uint64 + minimum: 0 + paramStructure: by-position + - name: F3.GetPowerTable + params: + - name: tipset_key + required: true + schema: + $ref: "#/components/schemas/F3TipSetKey" + result: + name: F3.GetPowerTable.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/F3PowerEntryLotusJson" + paramStructure: by-position + - name: F3.GetTipset + params: + - name: tipset_key + required: true + schema: + $ref: "#/components/schemas/F3TipSetKey" + result: + name: F3.GetTipset.Result + required: true + schema: + $ref: "#/components/schemas/F3TipSet" + paramStructure: by-position + - name: F3.GetTipsetByEpoch + params: + - name: epoch + required: true + schema: + type: integer + format: int64 + result: + name: F3.GetTipsetByEpoch.Result + required: true + schema: + $ref: "#/components/schemas/F3TipSet" + paramStructure: by-position + - name: F3.Finalize + params: + - name: tipset_key + required: true + schema: + $ref: "#/components/schemas/F3TipSetKey" + result: + name: F3.Finalize.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: F3.ProtectPeer + params: + - name: peer_id + required: true + schema: + type: string + result: + name: F3.ProtectPeer.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: F3.SignMessage + params: + - name: pubkey + required: true + schema: + $ref: "#/components/schemas/Base64String" + - name: message + required: true + schema: + $ref: "#/components/schemas/Base64String" + result: + name: F3.SignMessage.Result + required: true + schema: + $ref: "#/components/schemas/Signature" + paramStructure: by-position + - name: Filecoin.GetActorEventsRaw + description: "Returns all user-programmed and built-in actor events that match the given filter. Results may be limited by MaxFilterResults, MaxFilterHeightRange, and the node's available historical data." + params: + - name: eventFilter + required: true + schema: + anyOf: + - $ref: "#/components/schemas/ActorEventFilter" + - type: "null" + result: + name: Filecoin.GetActorEventsRaw.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/ActorEvent" + paramStructure: by-position +components: + schemas: + ActorEvent: + type: object + properties: + emitter: + $ref: "#/components/schemas/Address" + entries: + type: array + items: + $ref: "#/components/schemas/EventEntry" + height: + type: integer + format: int64 + msgCid: + $ref: "#/components/schemas/Cid" + reverted: + type: boolean + tipsetKey: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + required: + - entries + - emitter + - reverted + - height + - tipsetKey + - msgCid + ActorEventBlock: + type: object + properties: + codec: + type: integer + format: uint64 + minimum: 0 + value: + $ref: "#/components/schemas/Base64String" + required: + - codec + - value + ActorEventFilter: + type: object + properties: + addresses: + type: array + items: + $ref: "#/components/schemas/Address" + fields: + type: object + additionalProperties: + type: array + items: + $ref: "#/components/schemas/ActorEventBlock" + fromHeight: + type: + - integer + - "null" + format: int64 + tipsetKey: + anyOf: + - $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + - type: "null" + toHeight: + type: + - integer + - "null" + format: int64 + ActorState: + type: object + properties: + Balance: + $ref: "#/components/schemas/TokenAmount" + Code: + $ref: "#/components/schemas/Cid" + DelegatedAddress: + $ref: "#/components/schemas/Nullable_Address" + Head: + $ref: "#/components/schemas/Cid" + Nonce: + type: integer + format: uint64 + minimum: 0 + required: + - Code + - Head + - Nonce + - Balance + ActorTrace: + type: object + properties: + Id: + type: integer + format: uint64 + minimum: 0 + State: + $ref: "#/components/schemas/ActorState" + required: + - Id + - State + AddrInfo: + type: object + properties: + Addrs: + type: array + items: + type: string + uniqueItems: true + ID: + type: string + required: + - ID + - Addrs + Address: + type: string + Allocation: + type: object + properties: + Client: + type: integer + format: uint64 + minimum: 0 + Data: + $ref: "#/components/schemas/Cid" + Expiration: + type: integer + format: int64 + Provider: + type: integer + format: uint64 + minimum: 0 + Size: + type: integer + format: uint64 + minimum: 0 + TermMax: + type: integer + format: int64 + TermMin: + type: integer + format: int64 + required: + - Client + - Provider + - Data + - Size + - TermMin + - TermMax + - Expiration + ApiActorState: + type: object + properties: + Balance: + $ref: "#/components/schemas/TokenAmount" + Code: + $ref: "#/components/schemas/Cid" + State: true + required: + - Balance + - Code + - State + ApiDeadline: + type: object + properties: + DailyFee: + $ref: "#/components/schemas/TokenAmount" + DisputableProofCount: + type: integer + format: uint64 + minimum: 0 + PostSubmissions: + $ref: "#/components/schemas/BitField" + required: + - PostSubmissions + - DisputableProofCount + - DailyFee + ApiDeadlineInfo: + type: string + ApiDealProposal: + type: object + properties: + Client: + $ref: "#/components/schemas/Address" + ClientCollateral: + $ref: "#/components/schemas/TokenAmount" + EndEpoch: + type: integer + format: int64 + Label: + type: string + PieceCID: + $ref: "#/components/schemas/Cid" + PieceSize: + type: integer + format: uint64 + minimum: 0 + Provider: + $ref: "#/components/schemas/Address" + ProviderCollateral: + $ref: "#/components/schemas/TokenAmount" + StartEpoch: + type: integer + format: int64 + StoragePricePerEpoch: + $ref: "#/components/schemas/TokenAmount" + VerifiedDeal: + type: boolean + required: + - PieceCID + - PieceSize + - VerifiedDeal + - Client + - Provider + - Label + - StartEpoch + - EndEpoch + - StoragePricePerEpoch + - ProviderCollateral + - ClientCollateral + ApiDealState: + type: object + properties: + LastUpdatedEpoch: + type: integer + format: int64 + SectorNumber: + type: integer + format: uint64 + minimum: 0 + SectorStartEpoch: + type: integer + format: int64 + SlashEpoch: + type: integer + format: int64 + required: + - SectorStartEpoch + - LastUpdatedEpoch + - SlashEpoch + - SectorNumber + ApiEthTx: + type: object + properties: + accessList: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthHash" + blockHash: + $ref: "#/components/schemas/EthHash" + blockNumber: + $ref: "#/components/schemas/EthUint64" + chainId: + $ref: "#/components/schemas/EthUint64" + from: + $ref: "#/components/schemas/EthAddress" + gas: + $ref: "#/components/schemas/EthUint64" + gasPrice: + anyOf: + - $ref: "#/components/schemas/EthBigInt" + - type: "null" + hash: + $ref: "#/components/schemas/EthHash" + input: + $ref: "#/components/schemas/EthBytes" + maxFeePerGas: + anyOf: + - $ref: "#/components/schemas/EthBigInt" + - type: "null" + maxPriorityFeePerGas: + anyOf: + - $ref: "#/components/schemas/EthBigInt" + - type: "null" + nonce: + $ref: "#/components/schemas/EthUint64" + r: + $ref: "#/components/schemas/EthBigInt" + s: + $ref: "#/components/schemas/EthBigInt" + to: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + transactionIndex: + $ref: "#/components/schemas/EthUint64" + type: + $ref: "#/components/schemas/EthUint64" + v: + $ref: "#/components/schemas/EthBigInt" + value: + $ref: "#/components/schemas/EthBigInt" + required: + - chainId + - nonce + - hash + - blockHash + - blockNumber + - transactionIndex + - from + - value + - type + - input + - gas + - v + - r + - s + ApiExportResult: + oneOf: + - type: string + enum: + - Cancelled + - type: object + properties: + Done: + type: + - string + - "null" + additionalProperties: false + required: + - Done + ApiExportStatus: + type: object + properties: + cancelled: + type: boolean + exporting: + type: boolean + progress: + type: number + format: double + start_time: + type: + - string + - "null" + format: date-time + required: + - progress + - exporting + - cancelled + ApiF3ParticipationLease: + description: "defines the lease granted to a storage provider for\nparticipating in F3 consensus, detailing the session identifier, issuer,\nsubject, and the expiration instance." + type: object + properties: + FromInstance: + description: specifies the instance ID from which this lease is valid. + type: integer + format: uint64 + minimum: 0 + Issuer: + description: the identity of the node that issued the lease. + type: string + MinerID: + description: the actor ID of the miner that holds the lease. + type: integer + format: uint64 + minimum: 0 + Network: + description: the name of the network this lease belongs to. + type: string + ValidityTerm: + description: specifies the number of instances for which the lease remains valid from the FromInstance. + type: integer + format: uint64 + minimum: 0 + required: + - Network + - Issuer + - MinerID + - FromInstance + - ValidityTerm + ApiInvocResult: + type: object + properties: + Duration: + type: integer + format: uint64 + minimum: 0 + Error: + type: string + ExecutionTrace: + anyOf: + - $ref: "#/components/schemas/ExecutionTrace" + - type: "null" + GasCost: + $ref: "#/components/schemas/MessageGasCost" + Msg: + $ref: "#/components/schemas/Message" + MsgCid: + $ref: "#/components/schemas/Cid" + MsgRct: + $ref: "#/components/schemas/Nullable_Receipt" + required: + - MsgCid + - Msg + - MsgRct + - Error + - Duration + - GasCost + ApiMarketDeal: + type: object + properties: + Proposal: + $ref: "#/components/schemas/ApiDealProposal" + State: + $ref: "#/components/schemas/ApiDealState" + required: + - Proposal + - State + ApiMessage: + type: object + properties: + Cid: + $ref: "#/components/schemas/Cid" + Message: + $ref: "#/components/schemas/Message" + required: + - Cid + - Message + ApiReceipt: + type: object + properties: + EventsRoot: + $ref: "#/components/schemas/Nullable_Cid" + ExitCode: + $ref: "#/components/schemas/ExitCode" + GasUsed: + type: integer + format: uint64 + minimum: 0 + Return: + $ref: "#/components/schemas/Base64String" + required: + - ExitCode + - Return + - GasUsed + - EventsRoot + Base64String: + type: + - string + - "null" + BeaconEntry: + type: object + properties: + Data: + $ref: "#/components/schemas/Base64String" + Round: + type: integer + format: uint64 + minimum: 0 + required: + - Round + - Data + BeneficiaryTerm: + type: object + properties: + Expiration: + description: "The epoch at which the beneficiary's rights expire and revert to the owner" + type: integer + format: int64 + Quota: + description: "The total amount the current beneficiary can withdraw. Monotonic, but reset when beneficiary changes." + $ref: "#/components/schemas/TokenAmount" + UsedQuota: + description: The amount of quota the current beneficiary has already withdrawn + $ref: "#/components/schemas/TokenAmount" + required: + - Quota + - UsedQuota + - Expiration + BigInt: + type: string + BitField: + type: + - array + - "null" + items: + type: integer + format: uint8 + maximum: 255 + minimum: 0 + Block: + type: object + properties: + baseFeePerGas: + $ref: "#/components/schemas/EthBigInt" + difficulty: + $ref: "#/components/schemas/EthUint64" + extraData: + $ref: "#/components/schemas/EthBytes" + gasLimit: + $ref: "#/components/schemas/EthUint64" + gasUsed: + $ref: "#/components/schemas/EthUint64" + hash: + $ref: "#/components/schemas/EthHash" + logsBloom: + $ref: "#/components/schemas/Bloom" + miner: + $ref: "#/components/schemas/EthAddress" + mixHash: + $ref: "#/components/schemas/EthHash" + nonce: + $ref: "#/components/schemas/Nonce" + number: + $ref: "#/components/schemas/EthUint64" + parentHash: + $ref: "#/components/schemas/EthHash" + receiptsRoot: + $ref: "#/components/schemas/EthHash" + sha3Uncles: + $ref: "#/components/schemas/EthHash" + size: + $ref: "#/components/schemas/EthUint64" + stateRoot: + $ref: "#/components/schemas/EthHash" + timestamp: + $ref: "#/components/schemas/EthUint64" + totalDifficulty: + $ref: "#/components/schemas/EthUint64" + transactions: + $ref: "#/components/schemas/Transactions" + transactionsRoot: + $ref: "#/components/schemas/EthHash" + uncles: + type: array + items: + $ref: "#/components/schemas/EthHash" + required: + - hash + - parentHash + - sha3Uncles + - miner + - stateRoot + - transactionsRoot + - receiptsRoot + - logsBloom + - difficulty + - totalDifficulty + - number + - gasLimit + - gasUsed + - timestamp + - extraData + - mixHash + - nonce + - baseFeePerGas + - size + - transactions + - uncles + BlockHash: + type: object + properties: + blockHash: + $ref: "#/components/schemas/EthHash" + requireCanonical: + type: boolean + required: + - blockHash + - requireCanonical + BlockHeader: + type: object + properties: + BLSAggregate: + $ref: "#/components/schemas/Nullable_Signature" + BeaconEntries: + $ref: "#/components/schemas/Nullable_Array_of_BeaconEntry" + BlockSig: + $ref: "#/components/schemas/Nullable_Signature" + ElectionProof: + $ref: "#/components/schemas/Nullable_ElectionProof" + ForkSignaling: + type: integer + format: uint64 + minimum: 0 + Height: + type: integer + format: int64 + Messages: + $ref: "#/components/schemas/Cid" + Miner: + $ref: "#/components/schemas/Address" + ParentBaseFee: + $ref: "#/components/schemas/TokenAmount" + ParentMessageReceipts: + $ref: "#/components/schemas/Cid" + ParentStateRoot: + $ref: "#/components/schemas/Cid" + ParentWeight: + $ref: "#/components/schemas/BigInt" + Parents: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + Ticket: + $ref: "#/components/schemas/Nullable_Ticket" + Timestamp: + type: integer + format: uint64 + minimum: 0 + WinPoStProof: + $ref: "#/components/schemas/Nullable_Array_of_PoStProof" + required: + - Miner + - BeaconEntries + - WinPoStProof + - Parents + - ParentWeight + - Height + - ParentStateRoot + - ParentMessageReceipts + - Messages + - Timestamp + - ForkSignaling + - ParentBaseFee + BlockMessage: + type: object + properties: + BlsMessages: + $ref: "#/components/schemas/Nullable_Array_of_Cid" + Header: + $ref: "#/components/schemas/BlockHeader" + SecpkMessages: + $ref: "#/components/schemas/Nullable_Array_of_Cid" + required: + - Header + - BlsMessages + - SecpkMessages + BlockMessages: + type: object + properties: + BlsMessages: + $ref: "#/components/schemas/Nullable_Array_of_Message" + Cids: + $ref: "#/components/schemas/Nullable_Array_of_Cid" + SecpkMessages: + $ref: "#/components/schemas/Nullable_Array_of_SignedMessage" + required: + - BlsMessages + - SecpkMessages + - Cids + BlockNumber: + type: object + properties: + blockNumber: + $ref: "#/components/schemas/EthInt64" + required: + - blockNumber + BlockNumberOrHash: + anyOf: + - type: string + - $ref: "#/components/schemas/EthInt64" + - $ref: "#/components/schemas/EthHash" + - $ref: "#/components/schemas/BlockNumber" + - $ref: "#/components/schemas/BlockHash" + BlockNumberOrPredefined: + anyOf: + - type: string + - $ref: "#/components/schemas/EthInt64" + BlockTemplate: + type: object + properties: + BeaconValues: + $ref: "#/components/schemas/Nullable_Array_of_BeaconEntry" + Epoch: + $ref: "#/components/schemas/int64" + Eproof: + $ref: "#/components/schemas/ElectionProof" + Messages: + $ref: "#/components/schemas/Nullable_Array_of_SignedMessage" + Miner: + $ref: "#/components/schemas/Address" + Parents: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + Ticket: + $ref: "#/components/schemas/Ticket" + Timestamp: + type: integer + format: uint64 + minimum: 0 + WinningPoStProof: + $ref: "#/components/schemas/Nullable_Array_of_PoStProof" + required: + - Miner + - Parents + - Ticket + - Eproof + - BeaconValues + - Messages + - Epoch + - Timestamp + - WinningPoStProof + Bloom: + type: string + CertificateExchangeConfig: + type: object + properties: + ClientRequestTimeout: + type: integer + format: uint64 + minimum: 0 + MaximumPollInterval: + type: integer + format: uint64 + minimum: 0 + MinimumPollInterval: + type: integer + format: uint64 + minimum: 0 + ServerRequestTimeout: + type: integer + format: uint64 + minimum: 0 + required: + - ClientRequestTimeout + - ServerRequestTimeout + - MinimumPollInterval + - MaximumPollInterval + ChainExchangeConfig: + type: object + properties: + MaxChainLength: + type: integer + format: uint + minimum: 0 + MaxDiscoveredChainsPerInstance: + type: integer + format: uint + minimum: 0 + MaxInstanceLookahead: + type: integer + format: uint + minimum: 0 + MaxTimestampAge: + type: integer + format: uint64 + minimum: 0 + MaxWantedChainsPerInstance: + type: integer + format: uint + minimum: 0 + RebroadcastInterval: + type: integer + format: uint64 + minimum: 0 + SubscriptionBufferSize: + type: integer + format: uint + minimum: 0 + required: + - SubscriptionBufferSize + - MaxChainLength + - MaxInstanceLookahead + - MaxDiscoveredChainsPerInstance + - MaxWantedChainsPerInstance + - RebroadcastInterval + - MaxTimestampAge + ChainExportParams: + type: object + properties: + dry_run: + type: boolean + epoch: + type: integer + format: int64 + output_path: + type: string + recent_roots: + type: integer + format: int64 + skip_checksum: + type: boolean + tipset_keys: + $ref: "#/components/schemas/Nullable_Array_of_Cid" + required: + - epoch + - recent_roots + - output_path + - tipset_keys + - skip_checksum + - dry_run + Cid: + type: object + properties: + /: + type: string + required: + - / + CirculatingSupply: + type: object + properties: + FilBurnt: + $ref: "#/components/schemas/TokenAmount" + FilCirculating: + $ref: "#/components/schemas/TokenAmount" + FilLocked: + $ref: "#/components/schemas/TokenAmount" + FilMined: + $ref: "#/components/schemas/TokenAmount" + FilReserveDisbursed: + $ref: "#/components/schemas/TokenAmount" + FilVested: + $ref: "#/components/schemas/TokenAmount" + required: + - FilVested + - FilMined + - FilBurnt + - FilLocked + - FilCirculating + - FilReserveDisbursed + Claim: + type: object + properties: + QualityAdjPower: + description: "Sum of quality adjusted power for a miner's sectors." + $ref: "#/components/schemas/BigInt" + RawBytePower: + description: "Sum of raw byte power for a miner's sectors." + $ref: "#/components/schemas/BigInt" + required: + - RawBytePower + - QualityAdjPower + ClaimLotusJson: + type: object + properties: + Client: + type: integer + format: uint64 + minimum: 0 + Data: + $ref: "#/components/schemas/Cid" + Provider: + type: integer + format: uint64 + minimum: 0 + Sector: + type: integer + format: uint64 + minimum: 0 + Size: + type: integer + format: uint64 + minimum: 0 + TermMax: + type: integer + format: int64 + TermMin: + type: integer + format: int64 + TermStart: + type: integer + format: int64 + required: + - Provider + - Client + - Data + - Size + - TermMin + - TermMax + - TermStart + - Sector + ComputeStateOutput: + type: object + properties: + Root: + $ref: "#/components/schemas/Cid" + Trace: + $ref: "#/components/schemas/ApiInvocResult" + required: + - Root + - Trace + DealCollateralBounds: + type: object + properties: + Max: + $ref: "#/components/schemas/TokenAmount" + Min: + $ref: "#/components/schemas/TokenAmount" + required: + - Min + - Max + ECTipSet: + type: object + properties: + Commitments: + type: string + Epoch: + type: integer + format: int64 + Key: + type: string + PowerTable: + type: string + required: + - Key + - Epoch + - PowerTable + - Commitments + EcConfig: + type: object + properties: + BaseDecisionBackoffTable: + type: array + items: + type: number + format: double + DelayMultiplier: + type: number + format: double + Finality: + type: integer + format: int64 + Finalize: + type: boolean + HeadLookback: + type: integer + format: int64 + Period: + type: integer + format: uint64 + minimum: 0 + required: + - Period + - Finality + - DelayMultiplier + - BaseDecisionBackoffTable + - HeadLookback + - Finalize + ElectionProof: + type: object + properties: + VRFProof: + $ref: "#/components/schemas/Base64String" + WinCount: + type: integer + format: int64 + required: + - VRFProof + - WinCount + EthAddress: + type: string + EthAddressList: + description: "Represents an [`EthAddress`] or a collection of thereof. This allows the caller to either use,\ne.g., `0x1234...` or `[\"0x1234...\", \"0x5678...\"]` as the address parameter." + anyOf: + - type: array + items: + $ref: "#/components/schemas/EthAddress" + - $ref: "#/components/schemas/EthAddress" + EthBigInt: + type: string + EthBlockTrace: + type: object + properties: + action: + $ref: "#/components/schemas/TraceAction" + blockHash: + $ref: "#/components/schemas/EthHash" + blockNumber: + type: integer + format: int64 + error: + type: + - string + - "null" + result: + $ref: "#/components/schemas/TraceResult" + subtraces: + type: integer + format: int64 + traceAddress: + type: array + items: + type: integer + format: int64 + transactionHash: + $ref: "#/components/schemas/EthHash" + transactionPosition: + type: integer + format: int64 + type: + type: string + required: + - type + - subtraces + - traceAddress + - action + - result + - blockHash + - blockNumber + - transactionHash + - transactionPosition + EthBytes: + type: string + EthCallMessage: + type: object + properties: + data: + anyOf: + - $ref: "#/components/schemas/EthBytes" + - type: "null" + from: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + gas: + anyOf: + - $ref: "#/components/schemas/EthUint64" + - type: "null" + gasPrice: + anyOf: + - $ref: "#/components/schemas/EthBigInt" + - type: "null" + to: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + value: + anyOf: + - $ref: "#/components/schemas/EthBigInt" + - type: "null" + EthCallTraceAction: + type: object + properties: + callType: + type: string + from: + $ref: "#/components/schemas/EthAddress" + gas: + $ref: "#/components/schemas/EthUint64" + input: + $ref: "#/components/schemas/EthBytes" + to: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + value: + $ref: "#/components/schemas/EthBigInt" + required: + - callType + - from + - gas + - value + - input + EthCallTraceResult: + type: object + properties: + gasUsed: + $ref: "#/components/schemas/EthUint64" + output: + $ref: "#/components/schemas/EthBytes" + required: + - gasUsed + - output + EthCreateTraceAction: + type: object + properties: + from: + $ref: "#/components/schemas/EthAddress" + gas: + $ref: "#/components/schemas/EthUint64" + init: + $ref: "#/components/schemas/EthBytes" + value: + $ref: "#/components/schemas/EthBigInt" + required: + - from + - gas + - value + - init + EthCreateTraceResult: + type: object + properties: + address: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + code: + $ref: "#/components/schemas/EthBytes" + gasUsed: + $ref: "#/components/schemas/EthUint64" + required: + - gasUsed + - code + EthFeeHistoryResult: + type: object + properties: + baseFeePerGas: + type: array + items: + $ref: "#/components/schemas/EthBigInt" + gasUsedRatio: + type: array + items: + type: number + format: double + oldestBlock: + $ref: "#/components/schemas/EthUint64" + reward: + type: + - array + - "null" + items: + type: array + items: + $ref: "#/components/schemas/EthBigInt" + required: + - oldestBlock + - baseFeePerGas + - gasUsedRatio + EthFilterResult: + description: "`EthFilterResult` represents the response from executing a filter:\n- A list of block hashes\n- A list of transaction hashes\n- Or a list of logs" + anyOf: + - type: array + items: + $ref: "#/components/schemas/EthHash" + - type: array + items: + $ref: "#/components/schemas/EthLog" + EthFilterSpec: + description: "Represents a filter specification for querying Ethereum event logs.\nThis struct can be used to specify criteria for filtering Ethereum event logs based on block range,\naddress, topics, and block hash. It is useful for making requests to Ethereum nodes to fetch logs\nthat match certain conditions.\n\n# Fields\n\n* `from_block` - Optional field interpreted as an epoch (in hex):\n - `\"latest\"`: latest mined block.\n - `\"earliest\"`: first block.\n - `\"pending\"`: blocks that have not yet been mined.\n If omitted, the default value is `\"latest\"`.\n This field is skipped during serialization if `None`.\n\n* `to_block` - Optional field interpreted as an epoch (in hex):\n - `\"latest\"`: latest mined block.\n - `\"earliest\"`: first block.\n - `\"pending\"`: blocks that have not yet been mined.\n If omitted, the default value is `\"latest\"`.\n This field is skipped during serialization if `None`.\n\n* `address` - Optional field interpreted as Actor address or a list of addresses (`Vec`) from which event logs should originate.\n If the filter needs to match a single address, it can be specified as a single element vector.\n This field is required and cannot be omitted.\n\n* `topics` - List of topics (`EthTopicSpec`) to be matched in the event logs. \n\n* `block_hash` - Optional field specifying a block hash (`Hash`)\n Restricts event logs returned to those emitted from messages contained in this tipset. When `block_hash` is provided,\n neither `from_block` nor `to_block` can be specified.\n This field is skipped during serialization if `None`.\n [the spec](https://github.com/filecoin-project/lotus/blob/475139ff95407ed9d55d3a2ef87e28da66512937/chain/types/ethtypes/eth_types.go#L602-L627)." + type: object + properties: + address: + anyOf: + - $ref: "#/components/schemas/EthAddressList" + - type: "null" + blockHash: + anyOf: + - $ref: "#/components/schemas/EthHash" + - type: "null" + fromBlock: + type: + - string + - "null" + toBlock: + type: + - string + - "null" + topics: + anyOf: + - $ref: "#/components/schemas/EthTopicSpec" + - type: "null" + EthHash: + type: string + EthHashList: + description: "`EthHashList` represents a topic filter that can take one of two forms:\n- `List`: Matches if the hash is present in the vector.\n- `Single`: An optional hash, where:\n - `Some(hash)`: Matches exactly this hash.\n - `None`: Acts as a wildcard." + anyOf: + - type: array + items: + $ref: "#/components/schemas/EthHash" + - anyOf: + - $ref: "#/components/schemas/EthHash" + - type: "null" + EthInt64: + type: string + EthLog: + description: Represents the results of an event filter execution. + type: object + properties: + address: + description: The address of the actor that produced the event log. + $ref: "#/components/schemas/EthAddress" + blockHash: + description: The hash of the tipset containing the message that produced the log. + $ref: "#/components/schemas/EthHash" + blockNumber: + description: The epoch of the tipset containing the message. + $ref: "#/components/schemas/EthUint64" + data: + description: "The value of the event log, excluding topics." + $ref: "#/components/schemas/EthBytes" + logIndex: + description: "The index of the event log in the sequence of events produced by the message execution.\n(this is the index in the events AMT on the message receipt)" + $ref: "#/components/schemas/EthUint64" + removed: + description: Indicates whether the log was removed due to a chain reorganization. + type: boolean + topics: + description: List of topics associated with the event log. + type: array + items: + $ref: "#/components/schemas/EthHash" + transactionHash: + description: The hash of the RLP message that produced the event log. + $ref: "#/components/schemas/EthHash" + transactionIndex: + description: "The index in the tipset of the transaction that produced the event log.\nThe index corresponds to the sequence of messages produced by `ChainGetParentMessages`" + $ref: "#/components/schemas/EthUint64" + required: + - address + - data + - topics + - removed + - logIndex + - transactionIndex + - transactionHash + - blockHash + - blockNumber + EthReplayBlockTransactionTrace: + type: object + properties: + output: + $ref: "#/components/schemas/EthBytes" + stateDiff: + type: + - string + - "null" + trace: + type: array + items: + $ref: "#/components/schemas/EthTrace" + transactionHash: + $ref: "#/components/schemas/EthHash" + vmTrace: + type: + - string + - "null" + required: + - output + - trace + - transactionHash + EthSyncingResultLotusJson: + anyOf: + - type: boolean + - type: object + properties: + currentblock: + type: integer + format: int64 + highestblock: + type: integer + format: int64 + startingblock: + type: integer + format: int64 + required: + - startingblock + - currentblock + - highestblock + EthTopicSpec: + type: array + items: + $ref: "#/components/schemas/EthHashList" + EthTrace: + type: object + properties: + action: + $ref: "#/components/schemas/TraceAction" + error: + type: + - string + - "null" + result: + $ref: "#/components/schemas/TraceResult" + subtraces: + type: integer + format: int64 + traceAddress: + type: array + items: + type: integer + format: int64 + type: + type: string + required: + - type + - subtraces + - traceAddress + - action + - result + EthTraceFilterCriteria: + type: object + properties: + after: + description: "After specifies the offset for pagination of trace results. The number of traces to skip before returning results.\nOptional, default: None." + anyOf: + - $ref: "#/components/schemas/EthUint64" + - type: "null" + count: + description: "Limits the number of traces returned.\nOptional, default: all traces." + anyOf: + - $ref: "#/components/schemas/EthUint64" + - type: "null" + fromAddress: + description: "Actor address or a list of addresses from which transactions that generate traces should originate.\nOptional, default: None.\nThe JSON decoding must treat a string as equivalent to an array with one value, for example\n\"0x8888f1f195afa192cfee86069858\" must be decoded as [ \"0x8888f1f195afa192cfee86069858\" ]" + anyOf: + - $ref: "#/components/schemas/EthAddressList" + - type: "null" + fromBlock: + description: "Interpreted as an epoch (in hex) or one of \"latest\" for last mined block, \"pending\" for not yet committed messages.\nOptional, default: \"latest\".\nNote: \"earliest\" is not a permitted value." + type: + - string + - "null" + toAddress: + description: "Actor address or a list of addresses to which transactions that generate traces are sent.\nOptional, default: None.\nThe JSON decoding must treat a string as equivalent to an array with one value, for example\n\"0x8888f1f195afa192cfee86069858\" must be decoded as [ \"0x8888f1f195afa192cfee86069858\" ]" + anyOf: + - $ref: "#/components/schemas/EthAddressList" + - type: "null" + toBlock: + description: "Interpreted as an epoch (in hex) or one of \"latest\" for last mined block, \"pending\" for not yet committed messages.\nOptional, default: \"latest\".\nNote: \"earliest\" is not a permitted value." + type: + - string + - "null" + EthTxReceipt: + type: object + properties: + blockHash: + $ref: "#/components/schemas/EthHash" + blockNumber: + $ref: "#/components/schemas/EthUint64" + contractAddress: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + cumulativeGasUsed: + $ref: "#/components/schemas/EthUint64" + effectiveGasPrice: + $ref: "#/components/schemas/EthBigInt" + from: + $ref: "#/components/schemas/EthAddress" + gasUsed: + $ref: "#/components/schemas/EthUint64" + logs: + type: array + items: + $ref: "#/components/schemas/EthLog" + logsBloom: + $ref: "#/components/schemas/EthBytes" + root: + $ref: "#/components/schemas/EthHash" + status: + $ref: "#/components/schemas/EthUint64" + to: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + transactionHash: + $ref: "#/components/schemas/EthHash" + transactionIndex: + $ref: "#/components/schemas/EthUint64" + type: + $ref: "#/components/schemas/EthUint64" + required: + - transactionHash + - transactionIndex + - blockHash + - blockNumber + - from + - root + - status + - cumulativeGasUsed + - gasUsed + - effectiveGasPrice + - logsBloom + - logs + - type + EthUint64: + type: string + Event: + type: object + properties: + Emitter: + description: Actor ID + type: integer + format: uint64 + minimum: 0 + Entries: + type: array + items: + $ref: "#/components/schemas/EventEntry" + required: + - Emitter + - Entries + EventEntry: + type: object + properties: + Codec: + type: integer + format: uint64 + minimum: 0 + Flags: + type: integer + format: uint64 + minimum: 0 + Key: + type: string + Value: + $ref: "#/components/schemas/Base64String" + required: + - Flags + - Key + - Codec + - Value + ExecutionTrace: + type: object + properties: + GasCharges: + type: array + items: + $ref: "#/components/schemas/GasTrace" + InvokedActor: + anyOf: + - $ref: "#/components/schemas/ActorTrace" + - type: "null" + Msg: + $ref: "#/components/schemas/MessageTrace" + MsgRct: + $ref: "#/components/schemas/ReturnTrace" + Subcalls: + $ref: "#/components/schemas/Nullable_Array_of_ExecutionTrace" + required: + - Msg + - MsgRct + - GasCharges + - Subcalls + ExitCode: + description: "`Newtype` wrapper for the FVM `ExitCode`.\n\n# Examples\n```\n# use forest::doctest_private::ExitCode;\nlet fvm2_success = fvm_shared2::error::ExitCode::new(0);\nlet fvm3_success = fvm_shared3::error::ExitCode::new(0);\n\nlet shim_from_v2 = ExitCode::from(fvm2_success);\nlet shim_from_v3 = ExitCode::from(fvm3_success);\n\nassert_eq!(shim_from_v2, shim_from_v3);\nassert_eq!(shim_from_v2, fvm2_success.into());\nassert_eq!(shim_from_v3, fvm3_success.into());\n```" + type: integer + format: uint32 + minimum: 0 + ExtBlockNumberOrHash: + anyOf: + - type: string + - $ref: "#/components/schemas/EthInt64" + - $ref: "#/components/schemas/EthHash" + - $ref: "#/components/schemas/BlockNumber" + - $ref: "#/components/schemas/BlockHash" + ExtendedSectorInfo: + type: object + properties: + SealProof: + $ref: "#/components/schemas/int64" + SealedCID: + $ref: "#/components/schemas/Cid" + SectorKey: + $ref: "#/components/schemas/Nullable_Cid" + SectorNumber: + type: integer + format: uint64 + minimum: 0 + required: + - SealProof + - SectorNumber + - SectorKey + - SealedCID + F3InstanceProgress: + type: object + properties: + ID: + type: integer + format: uint64 + minimum: 0 + Input: + $ref: "#/components/schemas/Nullable_Array_of_ECTipSet" + Phase: + type: integer + format: uint8 + maximum: 255 + minimum: 0 + Round: + type: integer + format: uint64 + minimum: 0 + required: + - ID + - Round + - Phase + F3Manifest: + type: object + properties: + BootstrapEpoch: + type: integer + format: int64 + CatchUpAlignment: + type: integer + format: uint64 + minimum: 0 + CertificateExchange: + $ref: "#/components/schemas/CertificateExchangeConfig" + ChainExchange: + $ref: "#/components/schemas/ChainExchangeConfig" + CommitteeLookback: + type: integer + format: uint64 + minimum: 0 + EC: + $ref: "#/components/schemas/EcConfig" + Gpbft: + $ref: "#/components/schemas/GpbftConfig" + InitialInstance: + type: integer + format: uint64 + minimum: 0 + InitialPowerTable: + type: string + NetworkName: + type: string + PartialMessageManager: + $ref: "#/components/schemas/PartialMessageManagerConfig" + ProtocolVersion: + type: integer + format: uint64 + minimum: 0 + PubSub: + $ref: "#/components/schemas/PubSubConfig" + required: + - ProtocolVersion + - InitialInstance + - BootstrapEpoch + - NetworkName + - InitialPowerTable + - CommitteeLookback + - CatchUpAlignment + - Gpbft + - EC + - CertificateExchange + - PubSub + - ChainExchange + - PartialMessageManager + F3Participant: + type: object + properties: + FromInstance: + type: integer + format: uint64 + minimum: 0 + MinerID: + type: integer + format: uint64 + minimum: 0 + ValidityTerm: + type: integer + format: uint64 + minimum: 0 + required: + - MinerID + - FromInstance + - ValidityTerm + F3PowerEntryLotusJson: + type: object + properties: + ID: + type: integer + format: uint64 + minimum: 0 + Power: + type: string + PubKey: + type: string + required: + - ID + - Power + - PubKey + F3TipSet: + type: object + properties: + beacon: + description: "The verifiable oracle randomness used to elect this block's author leader" + type: string + epoch: + description: "The period in which a new block is generated.\nThere may be multiple rounds in an epoch." + type: integer + format: int64 + key: + $ref: "#/components/schemas/F3TipSetKey" + timestamp: + description: "Block creation time, in seconds since the Unix epoch" + type: integer + format: uint64 + minimum: 0 + required: + - key + - beacon + - epoch + - timestamp + F3TipSetKey: + description: TipSetKey is the canonically ordered concatenation of the block CIDs in a tipset. + type: string + FilecoinSnapshotVersion: + type: string + enum: + - V1 + - V2 + FilterID: + $ref: "#/components/schemas/EthHash" + FinalityCertificate: + type: object + properties: + ECChain: + $ref: "#/components/schemas/NonEmpty_Array_of_ECTipSet" + GPBFTInstance: + type: integer + format: uint64 + minimum: 0 + PowerTableDelta: + $ref: "#/components/schemas/Nullable_Array_of_PowerTableDelta" + Signature: + type: string + Signers: + type: array + items: + type: integer + format: uint8 + maximum: 255 + minimum: 0 + SupplementalData: + $ref: "#/components/schemas/SupplementalData" + required: + - GPBFTInstance + - ECChain + - SupplementalData + - Signers + - Signature + FlattenedApiMessage: + type: object + properties: + CID: + $ref: "#/components/schemas/Cid" + From: + $ref: "#/components/schemas/Address" + GasFeeCap: + $ref: "#/components/schemas/TokenAmount" + default: "0" + GasLimit: + type: integer + format: uint64 + default: 0 + minimum: 0 + GasPremium: + $ref: "#/components/schemas/TokenAmount" + default: "0" + Method: + type: integer + format: uint64 + default: 0 + minimum: 0 + Nonce: + type: integer + format: uint64 + default: 0 + minimum: 0 + Params: + $ref: "#/components/schemas/Nullable_Base64String" + To: + $ref: "#/components/schemas/Address" + Value: + $ref: "#/components/schemas/TokenAmount" + default: "0" + Version: + type: integer + format: uint64 + default: 0 + minimum: 0 + required: + - To + - From + - CID + ForestChainExportDiffParams: + type: object + properties: + depth: + type: integer + format: int64 + from: + type: integer + format: int64 + output_path: + type: string + to: + type: integer + format: int64 + required: + - from + - to + - depth + - output_path + ForestChainExportParams: + type: object + properties: + dry_run: + type: boolean + epoch: + type: integer + format: int64 + output_path: + type: string + recent_roots: + type: integer + format: int64 + skip_checksum: + type: boolean + tipset_keys: + $ref: "#/components/schemas/Nullable_Array_of_Cid" + version: + $ref: "#/components/schemas/FilecoinSnapshotVersion" + required: + - version + - epoch + - recent_roots + - output_path + - tipset_keys + - skip_checksum + - dry_run + ForestComputeStateOutput: + type: object + properties: + Epoch: + type: integer + format: int64 + StateRoot: + $ref: "#/components/schemas/Cid" + TipsetKey: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + required: + - StateRoot + - Epoch + - TipsetKey + ForkSyncInfo: + description: Contains information about a specific chain/fork the node is actively tracking or syncing. + type: object + properties: + last_updated: + description: Last time status for this fork was updated. + type: + - string + - "null" + format: date-time + stage: + description: The current stage of processing for this fork. + $ref: "#/components/schemas/ForkSyncStage" + start_time: + description: When processing for this fork started. + type: + - string + - "null" + format: date-time + target_epoch: + description: The target epoch for this synchronization task. + type: integer + format: int64 + target_sync_epoch_start: + description: "The lowest epoch that still needs processing (fetching or validating) for this target.\nThis helps indicate the start of the current sync range." + type: integer + format: int64 + target_tipset_key: + description: The target tipset key for this synchronization task. + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + validated_chain_head_epoch: + description: "The epoch of the heaviest fully validated tipset on the node's main chain.\nThis shows overall node progress, distinct from fork-specific progress." + type: integer + format: int64 + required: + - target_tipset_key + - target_epoch + - target_sync_epoch_start + - stage + - validated_chain_head_epoch + ForkSyncStage: + description: Represents the stage of processing for a specific chain fork being tracked. + oneOf: + - description: Fetching necessary block headers for this fork. + type: string + const: FetchingHeaders + - description: Validating tipsets and messages for this fork. + type: string + const: ValidatingTipsets + - description: "This fork sync process is complete (e.g., reached target, merged, or deemed invalid)." + type: string + const: Complete + - description: "Progress is stalled, potentially waiting for dependencies." + type: string + const: Stalled + - description: An error occurred processing this specific fork. + type: string + const: Error + ForkUpgradeParams: + type: object + properties: + BreezeGasTampingDuration: + type: integer + format: int64 + UpgradeAssemblyHeight: + type: integer + format: int64 + UpgradeBreezeHeight: + type: integer + format: int64 + UpgradeCalicoHeight: + type: integer + format: int64 + UpgradeChocolateHeight: + type: integer + format: int64 + UpgradeClausHeight: + type: integer + format: int64 + UpgradeDragonHeight: + type: integer + format: int64 + UpgradeHyggeHeight: + type: integer + format: int64 + UpgradeHyperdriveHeight: + type: integer + format: int64 + UpgradeIgnitionHeight: + type: integer + format: int64 + UpgradeKumquatHeight: + type: integer + format: int64 + UpgradeLiftoffHeight: + type: integer + format: int64 + UpgradeLightningHeight: + type: integer + format: int64 + UpgradeNorwegianHeight: + type: integer + format: int64 + UpgradeOhSnapHeight: + type: integer + format: int64 + UpgradeOrangeHeight: + type: integer + format: int64 + UpgradePersianHeight: + type: integer + format: int64 + UpgradePhoenixHeight: + type: integer + format: int64 + UpgradeRefuelHeight: + type: integer + format: int64 + UpgradeSharkHeight: + type: integer + format: int64 + UpgradeSkyrHeight: + type: integer + format: int64 + UpgradeSmokeHeight: + type: integer + format: int64 + UpgradeTapeHeight: + type: integer + format: int64 + UpgradeTeepHeight: + type: integer + format: int64 + UpgradeThunderHeight: + type: integer + format: int64 + UpgradeTockHeight: + type: integer + format: int64 + UpgradeTrustHeight: + type: integer + format: int64 + UpgradeTuktukHeight: + type: integer + format: int64 + UpgradeTurboHeight: + type: integer + format: int64 + UpgradeWaffleHeight: + type: integer + format: int64 + UpgradeWatermelonHeight: + type: integer + format: int64 + required: + - UpgradeSmokeHeight + - UpgradeBreezeHeight + - UpgradeIgnitionHeight + - UpgradeLiftoffHeight + - UpgradeAssemblyHeight + - UpgradeRefuelHeight + - UpgradeTapeHeight + - UpgradeKumquatHeight + - BreezeGasTampingDuration + - UpgradeCalicoHeight + - UpgradePersianHeight + - UpgradeOrangeHeight + - UpgradeClausHeight + - UpgradeTrustHeight + - UpgradeNorwegianHeight + - UpgradeTurboHeight + - UpgradeHyperdriveHeight + - UpgradeChocolateHeight + - UpgradeOhSnapHeight + - UpgradeSkyrHeight + - UpgradeSharkHeight + - UpgradeHyggeHeight + - UpgradeLightningHeight + - UpgradeThunderHeight + - UpgradeWatermelonHeight + - UpgradeDragonHeight + - UpgradePhoenixHeight + - UpgradeWaffleHeight + - UpgradeTuktukHeight + - UpgradeTeepHeight + - UpgradeTockHeight + GasTrace: + type: object + properties: + Name: + type: string + cg: + type: integer + format: uint64 + minimum: 0 + sg: + type: integer + format: uint64 + minimum: 0 + tg: + type: integer + format: uint64 + minimum: 0 + tt: + type: integer + format: uint64 + minimum: 0 + required: + - Name + - tg + - cg + - sg + - tt + GossipBlock: + type: object + properties: + BlsMessages: + $ref: "#/components/schemas/Cid" + Header: + $ref: "#/components/schemas/BlockHeader" + SecpkMessages: + $ref: "#/components/schemas/Cid" + required: + - Header + - BlsMessages + - SecpkMessages + GpbftConfig: + type: object + properties: + ChainProposedLength: + type: integer + format: uint + minimum: 0 + Delta: + type: integer + format: uint64 + minimum: 0 + DeltaBackOffExponent: + type: number + format: double + MaxLookaheadRounds: + type: integer + format: uint64 + minimum: 0 + QualityDeltaMultiplier: + type: number + format: double + RebroadcastBackoffBase: + type: integer + format: uint64 + minimum: 0 + RebroadcastBackoffExponent: + type: number + format: double + RebroadcastBackoffMax: + type: integer + format: uint64 + minimum: 0 + RebroadcastBackoffSpread: + type: number + format: double + required: + - Delta + - DeltaBackOffExponent + - QualityDeltaMultiplier + - MaxLookaheadRounds + - ChainProposedLength + - RebroadcastBackoffBase + - RebroadcastBackoffExponent + - RebroadcastBackoffSpread + - RebroadcastBackoffMax + KeyInfo: + type: object + properties: + PrivateKey: + $ref: "#/components/schemas/Base64String" + Type: + $ref: "#/components/schemas/SignatureTypeLotusJson" + required: + - Type + - PrivateKey + Map_of_Cid: + type: object + additionalProperties: + $ref: "#/components/schemas/Cid" + MarketBalance: + description: External format for returning market balance from state. + type: object + properties: + Escrow: + $ref: "#/components/schemas/TokenAmount" + Locked: + $ref: "#/components/schemas/TokenAmount" + required: + - Escrow + - Locked + Message: + type: object + properties: + From: + $ref: "#/components/schemas/Address" + GasFeeCap: + $ref: "#/components/schemas/TokenAmount" + default: "0" + GasLimit: + type: integer + format: uint64 + default: 0 + minimum: 0 + GasPremium: + $ref: "#/components/schemas/TokenAmount" + default: "0" + Method: + type: integer + format: uint64 + default: 0 + minimum: 0 + Nonce: + type: integer + format: uint64 + default: 0 + minimum: 0 + Params: + $ref: "#/components/schemas/Nullable_Base64String" + To: + $ref: "#/components/schemas/Address" + Value: + $ref: "#/components/schemas/TokenAmount" + default: "0" + Version: + type: integer + format: uint64 + default: 0 + minimum: 0 + required: + - To + - From + MessageFilter: + type: object + properties: + From: + $ref: "#/components/schemas/Nullable_Address" + To: + $ref: "#/components/schemas/Nullable_Address" + required: + - From + - To + MessageGasCost: + type: object + properties: + BaseFeeBurn: + $ref: "#/components/schemas/TokenAmount" + GasUsed: + $ref: "#/components/schemas/TokenAmount" + Message: + $ref: "#/components/schemas/Nullable_Cid" + MinerPenalty: + $ref: "#/components/schemas/TokenAmount" + MinerTip: + $ref: "#/components/schemas/TokenAmount" + OverEstimationBurn: + $ref: "#/components/schemas/TokenAmount" + Refund: + $ref: "#/components/schemas/TokenAmount" + TotalCost: + $ref: "#/components/schemas/TokenAmount" + required: + - Message + - GasUsed + - BaseFeeBurn + - OverEstimationBurn + - MinerPenalty + - MinerTip + - Refund + - TotalCost + MessageLookup: + type: object + properties: + Height: + type: integer + format: int64 + Message: + $ref: "#/components/schemas/Cid" + Receipt: + $ref: "#/components/schemas/Receipt" + ReturnDec: true + TipSet: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + required: + - Receipt + - TipSet + - Height + - Message + - ReturnDec + MessageSendSpec: + type: object + properties: + MaxFee: + $ref: "#/components/schemas/TokenAmount" + MaximizeFeeCap: + type: boolean + MsgUuid: + type: string + format: uuid + required: + - MaxFee + - MsgUuid + - MaximizeFeeCap + MessageTrace: + type: object + properties: + From: + $ref: "#/components/schemas/Address" + GasLimit: + type: + - integer + - "null" + format: uint64 + minimum: 0 + Method: + type: integer + format: uint64 + minimum: 0 + Params: + $ref: "#/components/schemas/Base64String" + ParamsCodec: + type: integer + format: uint64 + minimum: 0 + ReadOnly: + type: + - boolean + - "null" + To: + $ref: "#/components/schemas/Address" + Value: + $ref: "#/components/schemas/TokenAmount" + required: + - From + - To + - Value + - Method + - Params + - ParamsCodec + MinerInfo: + type: object + properties: + Beneficiary: + $ref: "#/components/schemas/Address" + BeneficiaryTerm: + $ref: "#/components/schemas/BeneficiaryTerm" + ConsensusFaultElapsed: + type: integer + format: int64 + ControlAddresses: + $ref: "#/components/schemas/Nullable_Array_of_Address" + Multiaddrs: + $ref: "#/components/schemas/Nullable_Array_of_Base64String" + NewWorker: + $ref: "#/components/schemas/Nullable_Address" + Owner: + $ref: "#/components/schemas/Address" + PeerId: + $ref: "#/components/schemas/Nullable_string" + PendingBeneficiaryTerm: + $ref: "#/components/schemas/Nullable_PendingBeneficiaryChange" + PendingOwnerAddress: + $ref: "#/components/schemas/Nullable_Address" + SectorSize: + $ref: "#/components/schemas/SectorSize" + WindowPoStPartitionSectors: + type: integer + format: uint64 + minimum: 0 + WindowPoStProofType: + type: string + Worker: + $ref: "#/components/schemas/Address" + WorkerChangeEpoch: + type: integer + format: int64 + required: + - Owner + - Worker + - NewWorker + - ControlAddresses + - WorkerChangeEpoch + - PeerId + - Multiaddrs + - WindowPoStProofType + - SectorSize + - WindowPoStPartitionSectors + - ConsensusFaultElapsed + - PendingOwnerAddress + - Beneficiary + - BeneficiaryTerm + - PendingBeneficiaryTerm + MinerPartitions: + type: object + properties: + ActiveSectors: + $ref: "#/components/schemas/BitField" + AllSectors: + $ref: "#/components/schemas/BitField" + FaultySectors: + $ref: "#/components/schemas/BitField" + LiveSectors: + $ref: "#/components/schemas/BitField" + RecoveringSectors: + $ref: "#/components/schemas/BitField" + required: + - AllSectors + - FaultySectors + - RecoveringSectors + - LiveSectors + - ActiveSectors + MinerPower: + type: object + properties: + HasMinPower: + type: boolean + MinerPower: + $ref: "#/components/schemas/Claim" + TotalPower: + $ref: "#/components/schemas/Claim" + required: + - MinerPower + - TotalPower + - HasMinPower + MinerSectors: + type: object + properties: + Active: + type: integer + format: uint64 + minimum: 0 + Faulty: + type: integer + format: uint64 + minimum: 0 + Live: + type: integer + format: uint64 + minimum: 0 + required: + - Live + - Active + - Faulty + MiningBaseInfo: + type: object + properties: + BeaconEntries: + $ref: "#/components/schemas/Nullable_Array_of_BeaconEntry" + EligibleForMining: + type: boolean + MinerPower: + $ref: "#/components/schemas/BigInt" + NetworkPower: + $ref: "#/components/schemas/BigInt" + PrevBeaconEntry: + $ref: "#/components/schemas/BeaconEntry" + SectorSize: + type: integer + format: uint64 + minimum: 0 + Sectors: + $ref: "#/components/schemas/Nullable_Array_of_ExtendedSectorInfo" + WorkerKey: + $ref: "#/components/schemas/Address" + required: + - MinerPower + - NetworkPower + - Sectors + - WorkerKey + - SectorSize + - PrevBeaconEntry + - BeaconEntries + - EligibleForMining + MsigVesting: + type: object + properties: + InitialBalance: + $ref: "#/components/schemas/BigInt" + StartEpoch: + type: integer + format: int64 + UnlockDuration: + type: integer + format: int64 + required: + - InitialBalance + - StartEpoch + - UnlockDuration + NatStatusResult: + type: object + properties: + PublicAddrs: + type: + - array + - "null" + items: + type: string + Reachability: + type: integer + format: int32 + required: + - Reachability + NetInfoResult: + type: object + properties: + num_connections: + type: integer + format: uint32 + minimum: 0 + num_established: + type: integer + format: uint32 + minimum: 0 + num_peers: + type: integer + format: uint + minimum: 0 + num_pending: + type: integer + format: uint32 + minimum: 0 + num_pending_incoming: + type: integer + format: uint32 + minimum: 0 + num_pending_outgoing: + type: integer + format: uint32 + minimum: 0 + required: + - num_peers + - num_connections + - num_pending + - num_pending_incoming + - num_pending_outgoing + - num_established + NetworkParams: + type: object + properties: + BlockDelaySecs: + type: integer + format: uint64 + minimum: 0 + ConsensusMinerMinPower: + $ref: "#/components/schemas/BigInt" + Eip155ChainID: + type: integer + format: uint64 + minimum: 0 + ForkUpgradeParams: + $ref: "#/components/schemas/ForkUpgradeParams" + NetworkName: + type: string + PreCommitChallengeDelay: + type: integer + format: int64 + required: + - NetworkName + - BlockDelaySecs + - ConsensusMinerMinPower + - PreCommitChallengeDelay + - ForkUpgradeParams + - Eip155ChainID + NetworkVersion: + description: "Specifies the network version\n\n# Examples\n```\n# use forest::doctest_private::NetworkVersion;\nlet v0 = NetworkVersion::V0;\n\n// dereference to convert to FVM4\nassert_eq!(fvm_shared4::version::NetworkVersion::V0, *v0);\n\n// use `.into()` when FVM3 has to be specified.\nassert_eq!(fvm_shared3::version::NetworkVersion::V0, v0.into());\n\n// use `.into()` when FVM2 has to be specified.\nassert_eq!(fvm_shared2::version::NetworkVersion::V0, v0.into());\n```" + type: integer + format: uint32 + minimum: 0 + NodeChainStatus: + type: object + properties: + blocks_per_tipset_last_100: + type: number + format: double + blocks_per_tipset_last_finality: + type: number + format: double + required: + - blocks_per_tipset_last_100 + - blocks_per_tipset_last_finality + NodePeerStatus: + type: object + properties: + peers_to_publish_blocks: + type: integer + format: uint32 + minimum: 0 + peers_to_publish_msgs: + type: integer + format: uint32 + minimum: 0 + required: + - peers_to_publish_msgs + - peers_to_publish_blocks + NodeStatusResult: + type: object + properties: + chain_status: + $ref: "#/components/schemas/NodeChainStatus" + peer_status: + $ref: "#/components/schemas/NodePeerStatus" + sync_status: + $ref: "#/components/schemas/NodeSyncStatus" + required: + - sync_status + - peer_status + - chain_status + NodeSyncStatus: + type: object + properties: + behind: + type: integer + format: uint64 + minimum: 0 + epoch: + type: integer + format: uint64 + minimum: 0 + required: + - epoch + - behind + NodeSyncStatus2: + description: Represents the overall synchronization status of the Forest node. + oneOf: + - description: "Node is initializing, status not yet determined." + type: string + const: Initializing + - description: Node is significantly behind the network head and actively downloading/validating. + type: string + const: Syncing + - description: "Node is close to the network head, within the `SYNCED_EPOCH_THRESHOLD`." + type: string + const: Synced + - description: An error occurred during the sync process. + type: string + const: Error + - description: Node is configured to not sync (offline mode). + type: string + const: Offline + NonEmpty_Array_of_BlockHeader: + type: array + items: + $ref: "#/components/schemas/BlockHeader" + minItems: 1 + NonEmpty_Array_of_Cid: + type: array + items: + $ref: "#/components/schemas/Cid" + minItems: 1 + NonEmpty_Array_of_ECTipSet: + type: array + items: + $ref: "#/components/schemas/ECTipSet" + minItems: 1 + Nonce: + type: string + Nullable_Address: + anyOf: + - $ref: "#/components/schemas/Address" + - type: "null" + Nullable_Array_of_Address: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Address" + Nullable_Array_of_Base64String: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Base64String" + Nullable_Array_of_BeaconEntry: + type: + - array + - "null" + items: + $ref: "#/components/schemas/BeaconEntry" + Nullable_Array_of_Cid: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + Nullable_Array_of_ECTipSet: + type: + - array + - "null" + items: + $ref: "#/components/schemas/ECTipSet" + Nullable_Array_of_ExecutionTrace: + type: + - array + - "null" + items: + $ref: "#/components/schemas/ExecutionTrace" + Nullable_Array_of_ExtendedSectorInfo: + type: + - array + - "null" + items: + $ref: "#/components/schemas/ExtendedSectorInfo" + Nullable_Array_of_Message: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Message" + Nullable_Array_of_PoStProof: + type: + - array + - "null" + items: + $ref: "#/components/schemas/PoStProof" + Nullable_Array_of_PowerTableDelta: + type: + - array + - "null" + items: + $ref: "#/components/schemas/PowerTableDelta" + Nullable_Array_of_SignedMessage: + type: + - array + - "null" + items: + $ref: "#/components/schemas/SignedMessage" + Nullable_Array_of_uint64: + type: + - array + - "null" + items: + type: integer + format: uint64 + minimum: 0 + Nullable_Base64String: + anyOf: + - $ref: "#/components/schemas/Base64String" + - type: "null" + Nullable_Cid: + anyOf: + - $ref: "#/components/schemas/Cid" + - type: "null" + Nullable_ElectionProof: + anyOf: + - $ref: "#/components/schemas/ElectionProof" + - type: "null" + Nullable_PendingBeneficiaryChange: + anyOf: + - $ref: "#/components/schemas/PendingBeneficiaryChange" + - type: "null" + Nullable_Receipt: + anyOf: + - $ref: "#/components/schemas/Receipt" + - type: "null" + Nullable_Signature: + anyOf: + - $ref: "#/components/schemas/Signature" + - type: "null" + Nullable_Ticket: + anyOf: + - $ref: "#/components/schemas/Ticket" + - type: "null" + Nullable_TokenAmount: + anyOf: + - $ref: "#/components/schemas/TokenAmount" + - type: "null" + Nullable_string: + type: + - string + - "null" + ObjStat: + type: object + properties: + Links: + type: integer + format: uint + minimum: 0 + Size: + type: integer + format: uint + minimum: 0 + required: + - Size + - Links + PartialMessageManagerConfig: + type: object + properties: + CompletedMessagesBufferSize: + type: integer + format: int32 + MaxBufferedMessagesPerInstance: + type: integer + format: int32 + MaxCachedValidatedMessagesPerInstance: + type: integer + format: int32 + PendingChainBroadcastsBufferSize: + type: integer + format: int32 + PendingDiscoveredChainsBufferSize: + type: integer + format: int32 + PendingInstanceRemovalBufferSize: + type: integer + format: int32 + PendingPartialMessagesBufferSize: + type: integer + format: int32 + required: + - PendingDiscoveredChainsBufferSize + - PendingPartialMessagesBufferSize + - PendingChainBroadcastsBufferSize + - PendingInstanceRemovalBufferSize + - CompletedMessagesBufferSize + - MaxBufferedMessagesPerInstance + - MaxCachedValidatedMessagesPerInstance + PathChange: + oneOf: + - type: object + properties: + Type: + type: string + const: revert + Val: + $ref: "#/components/schemas/Tipset" + required: + - Type + - Val + - type: object + properties: + Type: + type: string + const: apply + Val: + $ref: "#/components/schemas/Tipset" + required: + - Type + - Val + PendingBeneficiaryChange: + type: object + properties: + ApprovedByBeneficiary: + type: boolean + ApprovedByNominee: + type: boolean + NewBeneficiary: + $ref: "#/components/schemas/Address" + NewExpiration: + type: integer + format: int64 + NewQuota: + $ref: "#/components/schemas/TokenAmount" + required: + - NewBeneficiary + - NewQuota + - NewExpiration + - ApprovedByBeneficiary + - ApprovedByNominee + PoStProof: + type: object + properties: + PoStProof: + $ref: "#/components/schemas/int64" + ProofBytes: + $ref: "#/components/schemas/Base64String" + required: + - PoStProof + - ProofBytes + PowerTableDelta: + type: object + properties: + ParticipantID: + type: integer + format: uint64 + minimum: 0 + PowerDelta: + type: string + SigningKey: + type: string + required: + - ParticipantID + - PowerDelta + - SigningKey + PubSubConfig: + type: object + properties: + ChainCompressionEnabled: + type: boolean + CompressionEnabled: + type: boolean + GMessageSubscriptionBufferSize: + type: integer + format: int32 + ValidatedMessageBufferSize: + type: integer + format: int32 + required: + - CompressionEnabled + - ChainCompressionEnabled + - GMessageSubscriptionBufferSize + - ValidatedMessageBufferSize + PublicVersion: + description: Represents the current version of the API. + type: object + properties: + APIVersion: + $ref: "#/components/schemas/ShiftingVersion" + BlockDelay: + type: integer + format: uint32 + minimum: 0 + Version: + type: string + required: + - Version + - APIVersion + - BlockDelay + Receipt: + type: object + properties: + EventsRoot: + $ref: "#/components/schemas/Nullable_Cid" + default: ~ + ExitCode: + type: integer + format: uint32 + minimum: 0 + GasUsed: + type: integer + format: uint64 + minimum: 0 + Return: + $ref: "#/components/schemas/Base64String" + required: + - ExitCode + - Return + - GasUsed + ReturnTrace: + type: object + properties: + ExitCode: + $ref: "#/components/schemas/ExitCode" + Return: + $ref: "#/components/schemas/Base64String" + ReturnCodec: + type: integer + format: uint64 + minimum: 0 + required: + - ExitCode + - Return + - ReturnCodec + SectorExpiration: + type: object + properties: + Early: + type: integer + format: int64 + OnTime: + type: integer + format: int64 + required: + - OnTime + - Early + SectorLocation: + type: object + properties: + Deadline: + type: integer + format: uint64 + minimum: 0 + Partition: + type: integer + format: uint64 + minimum: 0 + required: + - Deadline + - Partition + SectorOnChainInfo: + type: object + properties: + Activation: + description: Epoch during which the sector proof was accepted + type: integer + format: int64 + DailyFee: + description: "The total fee payable per day for this sector. The value of this field is set at the time of\nsector activation, extension and whenever a sector's `QAP` is changed. This fee is payable for\nthe lifetime of the sector and is aggregated in the deadline's `daily_fee` field.\n\nThis field is not included in the serialized form of the struct prior to the activation of\nFIP-0100, and is added as the 16th element of the array after that point only for new sectors\nor sectors that are updated after that point. For old sectors, the value of this field will\nalways be zero." + $ref: "#/components/schemas/TokenAmount" + DealWeight: + description: Integral of active deals over sector lifetime + $ref: "#/components/schemas/BigInt" + ExpectedDayReward: + description: "Expected one day projection of reward for sector computed at activation\ntime" + $ref: "#/components/schemas/Nullable_TokenAmount" + ExpectedStoragePledge: + description: "Expected twenty day projection of reward for sector computed at\nactivation time" + $ref: "#/components/schemas/Nullable_TokenAmount" + Expiration: + description: Epoch during which the sector expires + type: integer + format: int64 + Flags: + description: "Additional flags, see [`fil_actor_miner_state::v12::SectorOnChainInfoFlags`]" + type: integer + format: uint32 + minimum: 0 + InitialPledge: + description: Pledge collected to commit this sector + $ref: "#/components/schemas/TokenAmount" + PowerBaseEpoch: + description: "Epoch at which this sector's power was most recently updated" + type: integer + format: int64 + ReplacedDayReward: + $ref: "#/components/schemas/Nullable_TokenAmount" + SealProof: + description: The seal proof type implies the PoSt proofs + type: integer + format: int64 + SealedCID: + description: "`CommR`" + $ref: "#/components/schemas/Cid" + SectorKeyCID: + $ref: "#/components/schemas/Nullable_Cid" + SectorNumber: + type: integer + format: uint64 + minimum: 0 + VerifiedDealWeight: + description: Integral of active verified deals over sector lifetime + $ref: "#/components/schemas/BigInt" + required: + - SectorNumber + - SealProof + - SealedCID + - Activation + - Expiration + - Flags + - DealWeight + - VerifiedDealWeight + - InitialPledge + - ExpectedDayReward + - PowerBaseEpoch + - ExpectedStoragePledge + - ReplacedDayReward + - SectorKeyCID + - DailyFee + SectorPreCommitInfo: + type: object + properties: + DealIDs: + $ref: "#/components/schemas/Nullable_Array_of_uint64" + Expiration: + type: integer + format: int64 + SealProof: + $ref: "#/components/schemas/int64" + SealRandEpoch: + type: integer + format: int64 + SealedCID: + $ref: "#/components/schemas/Cid" + SectorNumber: + type: integer + format: uint64 + minimum: 0 + UnsealedCid: + $ref: "#/components/schemas/Nullable_Cid" + required: + - SealProof + - SectorNumber + - SealedCID + - SealRandEpoch + - DealIDs + - Expiration + - UnsealedCid + SectorPreCommitOnChainInfo: + type: object + properties: + Info: + $ref: "#/components/schemas/SectorPreCommitInfo" + PreCommitDeposit: + $ref: "#/components/schemas/TokenAmount" + PreCommitEpoch: + type: integer + format: int64 + required: + - Info + - PreCommitDeposit + - PreCommitEpoch + SectorSize: + type: integer + format: uint64 + minimum: 0 + ShiftingVersion: + description: "Integer based value on version information. Highest order bits for Major,\nMid order for Minor and lowest for Patch." + type: integer + format: uint32 + minimum: 0 + Signature: + type: object + properties: + Data: + $ref: "#/components/schemas/Base64String" + Type: + $ref: "#/components/schemas/SignatureTypeLotusJson" + required: + - Type + - Data + SignatureType: + description: Signature variants for Filecoin signatures. + type: string + enum: + - Secp256k1 + - Bls + - Delegated + SignatureTypeLotusJson: + anyOf: + - type: integer + format: uint8 + maximum: 255 + minimum: 0 + - $ref: "#/components/schemas/SignatureType" + SignedMessage: + type: object + properties: + CID: + $ref: "#/components/schemas/Nullable_Cid" + Message: + $ref: "#/components/schemas/Message" + Signature: + $ref: "#/components/schemas/Signature" + required: + - Message + - Signature + SnapshotProgressState: + oneOf: + - type: string + enum: + - Initializing + - Completed + - NotRequired + - type: object + properties: + InProgress: + type: object + properties: + message: + type: string + required: + - message + additionalProperties: false + required: + - InProgress + StateActorCodeCidsOutput: + type: object + properties: + ActorCids: + $ref: "#/components/schemas/Map_of_Cid" + ActorVersion: + type: string + Bundle: + $ref: "#/components/schemas/Cid" + Manifest: + $ref: "#/components/schemas/Cid" + NetworkVersion: + $ref: "#/components/schemas/NetworkVersion" + NetworkVersionRevision: + type: integer + format: int64 + required: + - NetworkVersion + - NetworkVersionRevision + - ActorVersion + - Manifest + - Bundle + - ActorCids + SupplementalData: + type: object + properties: + Commitments: + type: string + PowerTable: + type: string + required: + - Commitments + - PowerTable + SyncStatusReport: + description: "Contains information about the current status of the node's synchronization process." + type: object + properties: + active_forks: + description: List of active fork synchronization tasks the node is currently handling. + type: array + items: + $ref: "#/components/schemas/ForkSyncInfo" + current_head_epoch: + description: "The epoch of the heaviest validated tipset on the node's main chain." + type: integer + format: int64 + current_head_key: + description: The tipset key of the current heaviest validated tipset. + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + epochs_behind: + description: "Estimated number of epochs the node is behind the network head.\nCan be negative if the node is slightly ahead, due to estimation variance." + type: integer + format: int64 + last_updated: + description: Last time this status report was generated. + type: string + format: date-time + network_head_epoch: + type: integer + format: int64 + node_start_time: + description: When the node process started. + type: string + format: date-time + status: + description: "Overall status of the node's synchronization." + $ref: "#/components/schemas/NodeSyncStatus2" + required: + - status + - current_head_epoch + - current_head_key + - network_head_epoch + - epochs_behind + - active_forks + - node_start_time + - last_updated + Ticket: + type: object + properties: + VRFProof: + $ref: "#/components/schemas/Base64String" + required: + - VRFProof + Tipset: + $ref: "#/components/schemas/TipsetInner" + TipsetInner: + type: object + properties: + Blocks: + $ref: "#/components/schemas/NonEmpty_Array_of_BlockHeader" + Cids: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + Height: + type: integer + format: int64 + required: + - Cids + - Blocks + - Height + TokenAmount: + $ref: "#/components/schemas/BigInt" + TraceAction: + anyOf: + - $ref: "#/components/schemas/EthCallTraceAction" + - $ref: "#/components/schemas/EthCreateTraceAction" + TraceResult: + anyOf: + - $ref: "#/components/schemas/EthCallTraceResult" + - $ref: "#/components/schemas/EthCreateTraceResult" + Transaction: + type: object + properties: + Approved: + $ref: "#/components/schemas/Nullable_Array_of_Address" + ID: + type: integer + format: int64 + Method: + type: integer + format: uint64 + minimum: 0 + Params: + $ref: "#/components/schemas/Base64String" + To: + $ref: "#/components/schemas/Address" + Value: + $ref: "#/components/schemas/TokenAmount" + required: + - ID + - To + - Value + - Method + - Params + - Approved + Transactions: + anyOf: + - type: array + items: + type: string + - type: array + items: + $ref: "#/components/schemas/ApiEthTx" + int64: + type: integer + format: int64 diff --git a/src/rpc/snapshots/forest__rpc__tests__rpc__v1.snap b/src/rpc/snapshots/forest__rpc__tests__rpc__v1.snap new file mode 100644 index 000000000000..7ff3ee0b564f --- /dev/null +++ b/src/rpc/snapshots/forest__rpc__tests__rpc__v1.snap @@ -0,0 +1,7402 @@ +--- +source: src/rpc/mod.rs +expression: spec +--- +openrpc: 1.3.2 +info: + title: forest + version: 0.31.1 +methods: + - name: Filecoin.AuthNew + params: + - name: permissions + required: true + schema: + type: + - array + - "null" + items: + type: string + - name: expiration_secs + required: true + schema: + type: + - integer + - "null" + format: int64 + result: + name: Filecoin.AuthNew.Result + required: true + schema: + $ref: "#/components/schemas/Base64String" + paramStructure: by-position + - name: Filecoin.AuthVerify + params: + - name: header_raw + required: true + schema: + type: string + result: + name: Filecoin.AuthVerify.Result + required: false + schema: + type: + - array + - "null" + items: + type: string + paramStructure: by-position + - name: Forest.SnapshotGC + params: + - name: blocking + required: true + schema: + type: boolean + result: + name: Forest.SnapshotGC.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.ChainExport + params: + - name: params + required: true + schema: + $ref: "#/components/schemas/ChainExportParams" + result: + name: Filecoin.ChainExport.Result + required: true + schema: + $ref: "#/components/schemas/ApiExportResult" + paramStructure: by-position + - name: Filecoin.ChainGetBlock + description: Returns the block with the specified CID. + params: + - name: blockCid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetBlock.Result + required: true + schema: + $ref: "#/components/schemas/BlockHeader" + paramStructure: by-position + - name: Filecoin.ChainGetBlockMessages + description: Returns all messages from the specified block. + params: + - name: blockCid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetBlockMessages.Result + required: true + schema: + $ref: "#/components/schemas/BlockMessages" + paramStructure: by-position + - name: Filecoin.ChainGetEvents + description: Returns the events under the given event AMT root CID. + params: + - name: rootCid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetEvents.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Event" + paramStructure: by-position + - name: Filecoin.ChainGetGenesis + params: [] + result: + name: Filecoin.ChainGetGenesis.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/Tipset" + - type: "null" + paramStructure: by-position + - name: Filecoin.ChainGetFinalizedTipSet + description: "Returns the latest F3 finalized tipset, or falls back to EC finality if F3 is not operational on the node or if the F3 finalized tipset is further back than EC finalized tipset." + params: [] + result: + name: Filecoin.ChainGetFinalizedTipSet.Result + required: true + schema: + $ref: "#/components/schemas/Tipset" + paramStructure: by-position + - name: Filecoin.ChainGetMessage + description: Returns the message with the specified CID. + params: + - name: messageCid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetMessage.Result + required: true + schema: + $ref: "#/components/schemas/FlattenedApiMessage" + paramStructure: by-position + - name: Filecoin.ChainGetMessagesInTipset + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetMessagesInTipset.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/ApiMessage" + paramStructure: by-position + - name: Forest.ChainGetMinBaseFee + params: + - name: lookback + required: true + schema: + type: integer + format: uint32 + minimum: 0 + result: + name: Forest.ChainGetMinBaseFee.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.ChainGetParentMessages + description: Returns the messages included in the blocks of the parent tipset. + params: + - name: blockCid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetParentMessages.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/ApiMessage" + paramStructure: by-position + - name: Filecoin.ChainGetParentReceipts + description: Returns the message receipts included in the blocks of the parent tipset. + params: + - name: blockCid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetParentReceipts.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/ApiReceipt" + paramStructure: by-position + - name: Filecoin.ChainGetPath + description: Returns the path between the two specified tipsets. + params: + - name: from + required: true + schema: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + - name: to + required: true + schema: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + result: + name: Filecoin.ChainGetPath.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/PathChange" + paramStructure: by-position + - name: Filecoin.ChainGetTipSet + description: Returns the tipset with the specified CID. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetTipSet.Result + required: true + schema: + $ref: "#/components/schemas/Tipset" + paramStructure: by-position + - name: Filecoin.ChainGetTipSetAfterHeight + description: "Looks back and returns the tipset at the specified epoch.\n If there are no blocks at the given epoch,\n returns the first non-nil tipset at a later epoch." + params: + - name: height + required: true + schema: + type: integer + format: int64 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetTipSetAfterHeight.Result + required: true + schema: + $ref: "#/components/schemas/Tipset" + paramStructure: by-position + - name: Filecoin.ChainGetTipSetByHeight + description: Returns the tipset at the specified height. + params: + - name: height + required: true + schema: + type: integer + format: int64 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainGetTipSetByHeight.Result + required: true + schema: + $ref: "#/components/schemas/Tipset" + paramStructure: by-position + - name: Filecoin.ChainHasObj + description: Checks if a given CID exists in the chain blockstore. + params: + - name: cid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainHasObj.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: Filecoin.ChainHead + description: Returns the chain head (heaviest tipset). + params: [] + result: + name: Filecoin.ChainHead.Result + required: true + schema: + $ref: "#/components/schemas/Tipset" + paramStructure: by-position + - name: Filecoin.ChainReadObj + description: Reads IPLD nodes referenced by the specified CID from the chain blockstore and returns raw bytes. + params: + - name: cid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainReadObj.Result + required: true + schema: + $ref: "#/components/schemas/Base64String" + paramStructure: by-position + - name: Filecoin.ChainSetHead + params: + - name: tsk + required: true + schema: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + result: + name: Filecoin.ChainSetHead.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.ChainStatObj + params: + - name: obj_cid + required: true + schema: + $ref: "#/components/schemas/Cid" + - name: base_cid + required: true + schema: + anyOf: + - $ref: "#/components/schemas/Cid" + - type: "null" + result: + name: Filecoin.ChainStatObj.Result + required: true + schema: + $ref: "#/components/schemas/ObjStat" + paramStructure: by-position + - name: Filecoin.ChainTipSetWeight + description: Returns the weight of the specified tipset. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.ChainTipSetWeight.Result + required: true + schema: + $ref: "#/components/schemas/BigInt" + paramStructure: by-position + - name: Forest.ChainExport + params: + - name: params + required: true + schema: + $ref: "#/components/schemas/ForestChainExportParams" + result: + name: Forest.ChainExport.Result + required: true + schema: + $ref: "#/components/schemas/ApiExportResult" + paramStructure: by-position + - name: Forest.ChainExportDiff + params: + - name: params + required: true + schema: + $ref: "#/components/schemas/ForestChainExportDiffParams" + result: + name: Forest.ChainExportDiff.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Forest.ChainExportStatus + params: [] + result: + name: Forest.ChainExportStatus.Result + required: true + schema: + $ref: "#/components/schemas/ApiExportStatus" + paramStructure: by-position + - name: Forest.ChainExportCancel + params: [] + result: + name: Forest.ChainExportCancel.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: Forest.ChainGetTipsetByParentState + params: + - name: parentState + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Forest.ChainGetTipsetByParentState.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/Tipset" + - type: "null" + paramStructure: by-position + - name: Filecoin.Session + params: [] + result: + name: Filecoin.Session.Result + required: true + schema: + type: string + format: uuid + paramStructure: by-position + - name: Filecoin.Shutdown + params: [] + result: + name: Filecoin.Shutdown.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.StartTime + params: [] + result: + name: Filecoin.StartTime.Result + required: true + schema: + type: string + format: date-time + paramStructure: by-position + - name: Filecoin.Version + params: [] + result: + name: Filecoin.Version.Result + required: true + schema: + $ref: "#/components/schemas/PublicVersion" + paramStructure: by-position + - name: Filecoin.EthAccounts + params: [] + result: + name: Filecoin.EthAccounts.Result + required: false + schema: + type: + - array + - "null" + items: + type: string + paramStructure: by-position + - name: eth_accounts + params: [] + result: + name: eth_accounts.Result + required: false + schema: + type: + - array + - "null" + items: + type: string + paramStructure: by-position + - name: Filecoin.EthAddressToFilecoinAddress + description: Converts an EthAddress into an f410 Filecoin Address + params: + - name: ethAddress + required: true + schema: + $ref: "#/components/schemas/EthAddress" + result: + name: Filecoin.EthAddressToFilecoinAddress.Result + required: true + schema: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.FilecoinAddressToEthAddress + description: Converts any Filecoin address to an EthAddress + params: + - name: filecoinAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: blockParam + required: true + schema: + anyOf: + - $ref: "#/components/schemas/BlockNumberOrPredefined" + - type: "null" + result: + name: Filecoin.FilecoinAddressToEthAddress.Result + required: true + schema: + $ref: "#/components/schemas/EthAddress" + paramStructure: by-position + - name: Filecoin.EthBlockNumber + params: [] + result: + name: Filecoin.EthBlockNumber.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: eth_blockNumber + params: [] + result: + name: eth_blockNumber.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: Filecoin.EthCall + params: + - name: tx + required: true + schema: + $ref: "#/components/schemas/EthCallMessage" + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: Filecoin.EthCall.Result + required: true + schema: + $ref: "#/components/schemas/EthBytes" + paramStructure: by-position + - name: eth_call + params: + - name: tx + required: true + schema: + $ref: "#/components/schemas/EthCallMessage" + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: eth_call.Result + required: true + schema: + $ref: "#/components/schemas/EthBytes" + paramStructure: by-position + - name: Filecoin.EthChainId + params: [] + result: + name: Filecoin.EthChainId.Result + required: true + schema: + type: string + paramStructure: by-position + - name: eth_chainId + params: [] + result: + name: eth_chainId.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.EthEstimateGas + params: + - name: tx + required: true + schema: + $ref: "#/components/schemas/EthCallMessage" + - name: blockParam + required: true + schema: + anyOf: + - $ref: "#/components/schemas/BlockNumberOrHash" + - type: "null" + result: + name: Filecoin.EthEstimateGas.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: eth_estimateGas + params: + - name: tx + required: true + schema: + $ref: "#/components/schemas/EthCallMessage" + - name: blockParam + required: true + schema: + anyOf: + - $ref: "#/components/schemas/BlockNumberOrHash" + - type: "null" + result: + name: eth_estimateGas.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: Filecoin.EthFeeHistory + params: + - name: blockCount + required: true + schema: + $ref: "#/components/schemas/EthUint64" + - name: newestBlockNumber + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrPredefined" + - name: rewardPercentiles + required: true + schema: + type: + - array + - "null" + items: + type: number + format: double + result: + name: Filecoin.EthFeeHistory.Result + required: true + schema: + $ref: "#/components/schemas/EthFeeHistoryResult" + paramStructure: by-position + - name: eth_feeHistory + params: + - name: blockCount + required: true + schema: + $ref: "#/components/schemas/EthUint64" + - name: newestBlockNumber + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrPredefined" + - name: rewardPercentiles + required: true + schema: + type: + - array + - "null" + items: + type: number + format: double + result: + name: eth_feeHistory.Result + required: true + schema: + $ref: "#/components/schemas/EthFeeHistoryResult" + paramStructure: by-position + - name: Filecoin.EthGasPrice + description: Returns the current gas price in attoFIL + params: [] + result: + name: Filecoin.EthGasPrice.Result + required: true + schema: + $ref: "#/components/schemas/EthBigInt" + paramStructure: by-position + - name: eth_gasPrice + description: Returns the current gas price in attoFIL + params: [] + result: + name: eth_gasPrice.Result + required: true + schema: + $ref: "#/components/schemas/EthBigInt" + paramStructure: by-position + - name: Filecoin.EthGetBalance + description: Returns the balance of an Ethereum address at the specified block state + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: Filecoin.EthGetBalance.Result + required: true + schema: + $ref: "#/components/schemas/EthBigInt" + paramStructure: by-position + - name: eth_getBalance + description: Returns the balance of an Ethereum address at the specified block state + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: eth_getBalance.Result + required: true + schema: + $ref: "#/components/schemas/EthBigInt" + paramStructure: by-position + - name: Filecoin.EthGetBlockByHash + params: + - name: blockHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: fullTxInfo + required: true + schema: + type: boolean + result: + name: Filecoin.EthGetBlockByHash.Result + required: true + schema: + $ref: "#/components/schemas/Block" + paramStructure: by-position + - name: eth_getBlockByHash + params: + - name: blockHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: fullTxInfo + required: true + schema: + type: boolean + result: + name: eth_getBlockByHash.Result + required: true + schema: + $ref: "#/components/schemas/Block" + paramStructure: by-position + - name: Filecoin.EthGetBlockByNumber + description: Retrieves a block by its number or a special tag. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrPredefined" + - name: fullTxInfo + required: true + schema: + type: boolean + result: + name: Filecoin.EthGetBlockByNumber.Result + required: true + schema: + $ref: "#/components/schemas/Block" + paramStructure: by-position + - name: eth_getBlockByNumber + description: Retrieves a block by its number or a special tag. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrPredefined" + - name: fullTxInfo + required: true + schema: + type: boolean + result: + name: eth_getBlockByNumber.Result + required: true + schema: + $ref: "#/components/schemas/Block" + paramStructure: by-position + - name: Filecoin.EthGetBlockReceipts + description: "Retrieves all transaction receipts for a block by its number, hash or a special tag." + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: Filecoin.EthGetBlockReceipts.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthTxReceipt" + paramStructure: by-position + - name: eth_getBlockReceipts + description: "Retrieves all transaction receipts for a block by its number, hash or a special tag." + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: eth_getBlockReceipts.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthTxReceipt" + paramStructure: by-position + - name: Filecoin.EthGetBlockReceiptsLimited + description: "Retrieves all transaction receipts for a block identified by its number, hash or a special tag along with an optional limit on the chain epoch for state resolution." + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + - name: limit + required: true + schema: + type: integer + format: int64 + result: + name: Filecoin.EthGetBlockReceiptsLimited.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthTxReceipt" + paramStructure: by-position + - name: eth_getBlockReceiptsLimited + description: "Retrieves all transaction receipts for a block identified by its number, hash or a special tag along with an optional limit on the chain epoch for state resolution." + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + - name: limit + required: true + schema: + type: integer + format: int64 + result: + name: eth_getBlockReceiptsLimited.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthTxReceipt" + paramStructure: by-position + - name: Filecoin.EthGetBlockTransactionCountByHash + params: + - name: blockHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: Filecoin.EthGetBlockTransactionCountByHash.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: eth_getBlockTransactionCountByHash + params: + - name: blockHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: eth_getBlockTransactionCountByHash.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: Filecoin.EthGetBlockTransactionCountByNumber + description: Returns the number of transactions in a block identified by its block number. + params: + - name: blockNumber + required: true + schema: + $ref: "#/components/schemas/EthInt64" + result: + name: Filecoin.EthGetBlockTransactionCountByNumber.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: eth_getBlockTransactionCountByNumber + description: Returns the number of transactions in a block identified by its block number. + params: + - name: blockNumber + required: true + schema: + $ref: "#/components/schemas/EthInt64" + result: + name: eth_getBlockTransactionCountByNumber.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: Filecoin.EthGetCode + description: "Retrieves the contract code at a specific address and block state, identified by its number, hash, or a special tag." + params: + - name: ethAddress + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: blockNumberOrHash + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: Filecoin.EthGetCode.Result + required: true + schema: + $ref: "#/components/schemas/EthBytes" + paramStructure: by-position + - name: eth_getCode + description: "Retrieves the contract code at a specific address and block state, identified by its number, hash, or a special tag." + params: + - name: ethAddress + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: blockNumberOrHash + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: eth_getCode.Result + required: true + schema: + $ref: "#/components/schemas/EthBytes" + paramStructure: by-position + - name: Filecoin.EthGetLogs + params: + - name: ethFilter + required: true + schema: + $ref: "#/components/schemas/EthFilterSpec" + result: + name: Filecoin.EthGetLogs.Result + required: true + schema: + $ref: "#/components/schemas/EthFilterResult" + paramStructure: by-position + - name: eth_getLogs + params: + - name: ethFilter + required: true + schema: + $ref: "#/components/schemas/EthFilterSpec" + result: + name: eth_getLogs.Result + required: true + schema: + $ref: "#/components/schemas/EthFilterResult" + paramStructure: by-position + - name: Filecoin.EthGetFilterLogs + params: + - name: filterId + required: true + schema: + $ref: "#/components/schemas/FilterID" + result: + name: Filecoin.EthGetFilterLogs.Result + required: true + schema: + $ref: "#/components/schemas/EthFilterResult" + paramStructure: by-position + - name: eth_getFilterLogs + params: + - name: filterId + required: true + schema: + $ref: "#/components/schemas/FilterID" + result: + name: eth_getFilterLogs.Result + required: true + schema: + $ref: "#/components/schemas/EthFilterResult" + paramStructure: by-position + - name: Filecoin.EthGetFilterChanges + description: Returns event logs which occurred since the last poll + params: + - name: filterId + required: true + schema: + $ref: "#/components/schemas/FilterID" + result: + name: Filecoin.EthGetFilterChanges.Result + required: true + schema: + $ref: "#/components/schemas/EthFilterResult" + paramStructure: by-position + - name: eth_getFilterChanges + description: Returns event logs which occurred since the last poll + params: + - name: filterId + required: true + schema: + $ref: "#/components/schemas/FilterID" + result: + name: eth_getFilterChanges.Result + required: true + schema: + $ref: "#/components/schemas/EthFilterResult" + paramStructure: by-position + - name: Filecoin.EthGetMessageCidByTransactionHash + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: Filecoin.EthGetMessageCidByTransactionHash.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/Cid" + - type: "null" + paramStructure: by-position + - name: eth_getMessageCidByTransactionHash + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: eth_getMessageCidByTransactionHash.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/Cid" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthGetStorageAt + description: "Retrieves the storage value at a specific position for a contract\n at a given block state, identified by its number, hash, or a special tag." + params: + - name: ethAddress + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: position + required: true + schema: + $ref: "#/components/schemas/EthBytes" + - name: blockNumberOrHash + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: Filecoin.EthGetStorageAt.Result + required: true + schema: + $ref: "#/components/schemas/EthBytes" + paramStructure: by-position + - name: eth_getStorageAt + description: "Retrieves the storage value at a specific position for a contract\n at a given block state, identified by its number, hash, or a special tag." + params: + - name: ethAddress + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: position + required: true + schema: + $ref: "#/components/schemas/EthBytes" + - name: blockNumberOrHash + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: eth_getStorageAt.Result + required: true + schema: + $ref: "#/components/schemas/EthBytes" + paramStructure: by-position + - name: Filecoin.EthGetTransactionByHash + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: Filecoin.EthGetTransactionByHash.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionByHash + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: eth_getTransactionByHash.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthGetTransactionByHashLimited + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: limit + required: true + schema: + type: integer + format: int64 + result: + name: Filecoin.EthGetTransactionByHashLimited.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionByHashLimited + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: limit + required: true + schema: + type: integer + format: int64 + result: + name: eth_getTransactionByHashLimited.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthGetTransactionCount + params: + - name: sender + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: Filecoin.EthGetTransactionCount.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: eth_getTransactionCount + params: + - name: sender + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrHash" + result: + name: eth_getTransactionCount.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: Filecoin.EthGetTransactionHashByCid + params: + - name: cid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.EthGetTransactionHashByCid.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/EthHash" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionHashByCid + params: + - name: cid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: eth_getTransactionHashByCid.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/EthHash" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthGetTransactionByBlockNumberAndIndex + description: Retrieves a transaction by its block number and index. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrPredefined" + - name: txIndex + required: true + schema: + $ref: "#/components/schemas/EthUint64" + result: + name: Filecoin.EthGetTransactionByBlockNumberAndIndex.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionByBlockNumberAndIndex + description: Retrieves a transaction by its block number and index. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrPredefined" + - name: txIndex + required: true + schema: + $ref: "#/components/schemas/EthUint64" + result: + name: eth_getTransactionByBlockNumberAndIndex.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthGetTransactionByBlockHashAndIndex + params: + - name: blockHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: txIndex + required: true + schema: + $ref: "#/components/schemas/EthUint64" + result: + name: Filecoin.EthGetTransactionByBlockHashAndIndex.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionByBlockHashAndIndex + params: + - name: blockHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: txIndex + required: true + schema: + $ref: "#/components/schemas/EthUint64" + result: + name: eth_getTransactionByBlockHashAndIndex.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthMaxPriorityFeePerGas + params: [] + result: + name: Filecoin.EthMaxPriorityFeePerGas.Result + required: true + schema: + $ref: "#/components/schemas/EthBigInt" + paramStructure: by-position + - name: eth_maxPriorityFeePerGas + params: [] + result: + name: eth_maxPriorityFeePerGas.Result + required: true + schema: + $ref: "#/components/schemas/EthBigInt" + paramStructure: by-position + - name: Filecoin.EthProtocolVersion + params: [] + result: + name: Filecoin.EthProtocolVersion.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: eth_protocolVersion + params: [] + result: + name: eth_protocolVersion.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: Filecoin.EthGetTransactionReceipt + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: Filecoin.EthGetTransactionReceipt.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/EthTxReceipt" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionReceipt + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: eth_getTransactionReceipt.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/EthTxReceipt" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthGetTransactionReceiptLimited + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: limit + required: true + schema: + type: integer + format: int64 + result: + name: Filecoin.EthGetTransactionReceiptLimited.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/EthTxReceipt" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionReceiptLimited + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: limit + required: true + schema: + type: integer + format: int64 + result: + name: eth_getTransactionReceiptLimited.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/EthTxReceipt" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthNewFilter + params: + - name: filterSpec + required: true + schema: + $ref: "#/components/schemas/EthFilterSpec" + result: + name: Filecoin.EthNewFilter.Result + required: true + schema: + $ref: "#/components/schemas/FilterID" + paramStructure: by-position + - name: eth_newFilter + params: + - name: filterSpec + required: true + schema: + $ref: "#/components/schemas/EthFilterSpec" + result: + name: eth_newFilter.Result + required: true + schema: + $ref: "#/components/schemas/FilterID" + paramStructure: by-position + - name: Filecoin.EthNewPendingTransactionFilter + params: [] + result: + name: Filecoin.EthNewPendingTransactionFilter.Result + required: true + schema: + $ref: "#/components/schemas/FilterID" + paramStructure: by-position + - name: eth_newPendingTransactionFilter + params: [] + result: + name: eth_newPendingTransactionFilter.Result + required: true + schema: + $ref: "#/components/schemas/FilterID" + paramStructure: by-position + - name: Filecoin.EthNewBlockFilter + params: [] + result: + name: Filecoin.EthNewBlockFilter.Result + required: true + schema: + $ref: "#/components/schemas/FilterID" + paramStructure: by-position + - name: eth_newBlockFilter + params: [] + result: + name: eth_newBlockFilter.Result + required: true + schema: + $ref: "#/components/schemas/FilterID" + paramStructure: by-position + - name: Filecoin.EthUninstallFilter + params: + - name: filterId + required: true + schema: + $ref: "#/components/schemas/FilterID" + result: + name: Filecoin.EthUninstallFilter.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: eth_uninstallFilter + params: + - name: filterId + required: true + schema: + $ref: "#/components/schemas/FilterID" + result: + name: eth_uninstallFilter.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: Filecoin.EthUnsubscribe + params: [] + result: + name: Filecoin.EthUnsubscribe.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: eth_unsubscribe + params: [] + result: + name: eth_unsubscribe.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.EthSubscribe + params: [] + result: + name: Filecoin.EthSubscribe.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: eth_subscribe + params: [] + result: + name: eth_subscribe.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.EthSyncing + params: [] + result: + name: Filecoin.EthSyncing.Result + required: true + schema: + $ref: "#/components/schemas/EthSyncingResultLotusJson" + paramStructure: by-position + - name: eth_syncing + params: [] + result: + name: eth_syncing.Result + required: true + schema: + $ref: "#/components/schemas/EthSyncingResultLotusJson" + paramStructure: by-position + - name: Filecoin.EthTraceBlock + description: Returns traces created at given block. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + result: + name: Filecoin.EthTraceBlock.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthBlockTrace" + paramStructure: by-position + - name: trace_block + description: Returns traces created at given block. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + result: + name: trace_block.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthBlockTrace" + paramStructure: by-position + - name: Filecoin.EthTraceFilter + description: Returns the traces for transactions matching the filter criteria. + params: + - name: filter + required: true + schema: + $ref: "#/components/schemas/EthTraceFilterCriteria" + result: + name: Filecoin.EthTraceFilter.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthBlockTrace" + paramStructure: by-position + - name: trace_filter + description: Returns the traces for transactions matching the filter criteria. + params: + - name: filter + required: true + schema: + $ref: "#/components/schemas/EthTraceFilterCriteria" + result: + name: trace_filter.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthBlockTrace" + paramStructure: by-position + - name: Filecoin.EthTraceTransaction + description: Returns the traces for a specific transaction. + params: + - name: txHash + required: true + schema: + type: string + result: + name: Filecoin.EthTraceTransaction.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthBlockTrace" + paramStructure: by-position + - name: trace_transaction + description: Returns the traces for a specific transaction. + params: + - name: txHash + required: true + schema: + type: string + result: + name: trace_transaction.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthBlockTrace" + paramStructure: by-position + - name: Filecoin.EthTraceReplayBlockTransactions + description: Replays all transactions in a block returning the requested traces for each transaction. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + - name: traceTypes + required: true + schema: + type: + - array + - "null" + items: + type: string + result: + name: Filecoin.EthTraceReplayBlockTransactions.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthReplayBlockTransactionTrace" + paramStructure: by-position + - name: trace_replayBlockTransactions + description: Replays all transactions in a block returning the requested traces for each transaction. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + - name: traceTypes + required: true + schema: + type: + - array + - "null" + items: + type: string + result: + name: trace_replayBlockTransactions.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthReplayBlockTransactionTrace" + paramStructure: by-position + - name: Filecoin.Web3ClientVersion + params: [] + result: + name: Filecoin.Web3ClientVersion.Result + required: true + schema: + type: string + paramStructure: by-position + - name: web3_clientVersion + params: [] + result: + name: web3_clientVersion.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.EthSendRawTransaction + params: + - name: rawTx + required: true + schema: + $ref: "#/components/schemas/EthBytes" + result: + name: Filecoin.EthSendRawTransaction.Result + required: true + schema: + $ref: "#/components/schemas/EthHash" + paramStructure: by-position + - name: eth_sendRawTransaction + params: + - name: rawTx + required: true + schema: + $ref: "#/components/schemas/EthBytes" + result: + name: eth_sendRawTransaction.Result + required: true + schema: + $ref: "#/components/schemas/EthHash" + paramStructure: by-position + - name: Filecoin.GasEstimateFeeCap + description: Returns the estimated fee cap for the given parameters. + params: + - name: message + required: true + schema: + $ref: "#/components/schemas/Message" + - name: maxQueueBlocks + required: true + schema: + type: integer + format: int64 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.GasEstimateFeeCap.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.GasEstimateGasLimit + description: Returns the estimated gas limit for the given parameters. + params: + - name: message + required: true + schema: + $ref: "#/components/schemas/Message" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.GasEstimateGasLimit.Result + required: true + schema: + type: integer + format: int64 + paramStructure: by-position + - name: Filecoin.GasEstimateGasPremium + description: Returns the estimated gas premium for the given parameters. + params: + - name: numberOfBlocksToInclude + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: senderAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: gasLimit + required: true + schema: + type: integer + format: int64 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.GasEstimateGasPremium.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.GasEstimateMessageGas + description: Returns the estimated gas for the given parameters. + params: + - name: message + required: true + schema: + $ref: "#/components/schemas/Message" + - name: messageSendSpec + required: true + schema: + anyOf: + - $ref: "#/components/schemas/MessageSendSpec" + - type: "null" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.GasEstimateMessageGas.Result + required: true + schema: + $ref: "#/components/schemas/FlattenedApiMessage" + paramStructure: by-position + - name: Filecoin.MarketAddBalance + params: + - name: wallet + required: true + schema: + $ref: "#/components/schemas/Address" + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: amount + required: true + schema: + $ref: "#/components/schemas/BigInt" + result: + name: Filecoin.MarketAddBalance.Result + required: true + schema: + $ref: "#/components/schemas/Cid" + paramStructure: by-position + - name: Filecoin.MinerCreateBlock + description: "Fills and signs a block template on behalf of the given miner, returning a suitable block header." + params: + - name: blockTemplate + required: true + schema: + $ref: "#/components/schemas/BlockTemplate" + result: + name: Filecoin.MinerCreateBlock.Result + required: true + schema: + $ref: "#/components/schemas/BlockMessage" + paramStructure: by-position + - name: Filecoin.MinerGetBaseInfo + description: "Retrieves the Miner Actor at the given address and tipset, returning basic information such as power and mining eligibility." + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: epoch + required: true + schema: + type: integer + format: int64 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.MinerGetBaseInfo.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/MiningBaseInfo" + - type: "null" + paramStructure: by-position + - name: Filecoin.MpoolBatchPush + description: Adds a set of signed messages to the message pool. + params: + - name: messages + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/SignedMessage" + result: + name: Filecoin.MpoolBatchPush.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + paramStructure: by-position + - name: Filecoin.MpoolBatchPushUntrusted + description: Adds a set of messages to the message pool with additional verification checks. + params: + - name: messages + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/SignedMessage" + result: + name: Filecoin.MpoolBatchPushUntrusted.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + paramStructure: by-position + - name: Filecoin.MpoolGetNonce + description: Returns the current nonce for the specified address. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + result: + name: Filecoin.MpoolGetNonce.Result + required: true + schema: + type: integer + format: uint64 + minimum: 0 + paramStructure: by-position + - name: Filecoin.MpoolPending + description: Returns the pending messages for a given tipset. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.MpoolPending.Result + required: true + schema: + type: array + items: + $ref: "#/components/schemas/SignedMessage" + paramStructure: by-position + - name: Filecoin.MpoolPush + description: Adds a signed message to the message pool. + params: + - name: message + required: true + schema: + $ref: "#/components/schemas/SignedMessage" + result: + name: Filecoin.MpoolPush.Result + required: true + schema: + $ref: "#/components/schemas/Cid" + paramStructure: by-position + - name: Filecoin.MpoolPushMessage + description: "Assigns a nonce, signs, and pushes a message to the mempool." + params: + - name: message + required: true + schema: + $ref: "#/components/schemas/Message" + - name: sendSpec + required: true + schema: + anyOf: + - $ref: "#/components/schemas/MessageSendSpec" + - type: "null" + result: + name: Filecoin.MpoolPushMessage.Result + required: true + schema: + $ref: "#/components/schemas/SignedMessage" + paramStructure: by-position + - name: Filecoin.MpoolPushUntrusted + description: Adds a message to the message pool with verification checks. + params: + - name: message + required: true + schema: + $ref: "#/components/schemas/SignedMessage" + result: + name: Filecoin.MpoolPushUntrusted.Result + required: true + schema: + $ref: "#/components/schemas/Cid" + paramStructure: by-position + - name: Filecoin.MpoolSelect + description: Returns a list of pending messages for inclusion in the next block. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + - name: ticketQuality + required: true + schema: + type: number + format: double + result: + name: Filecoin.MpoolSelect.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/SignedMessage" + paramStructure: by-position + - name: Filecoin.MsigGetAvailableBalance + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipset_key + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.MsigGetAvailableBalance.Result + required: true + schema: + $ref: "#/components/schemas/TokenAmount" + paramStructure: by-position + - name: Filecoin.MsigGetPending + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipset_key + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.MsigGetPending.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Transaction" + paramStructure: by-position + - name: Filecoin.MsigGetVested + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: start_tsk + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + - name: end_tsk + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.MsigGetVested.Result + required: true + schema: + $ref: "#/components/schemas/BigInt" + paramStructure: by-position + - name: Filecoin.MsigGetVestingSchedule + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tsk + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.MsigGetVestingSchedule.Result + required: true + schema: + $ref: "#/components/schemas/MsigVesting" + paramStructure: by-position + - name: Filecoin.NetAddrsListen + description: Returns a list of listening addresses and the peer ID. + params: [] + result: + name: Filecoin.NetAddrsListen.Result + required: true + schema: + $ref: "#/components/schemas/AddrInfo" + paramStructure: by-position + - name: Filecoin.NetAgentVersion + description: Returns the agent version string. + params: + - name: peerId + required: true + schema: + type: string + result: + name: Filecoin.NetAgentVersion.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.NetAutoNatStatus + params: [] + result: + name: Filecoin.NetAutoNatStatus.Result + required: true + schema: + $ref: "#/components/schemas/NatStatusResult" + paramStructure: by-position + - name: Filecoin.NetConnect + description: Connects to a specified peer. + params: + - name: peerAddressInfo + required: true + schema: + $ref: "#/components/schemas/AddrInfo" + result: + name: Filecoin.NetConnect.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.NetDisconnect + description: Disconnects from the specified peer. + params: + - name: peerId + required: true + schema: + type: string + result: + name: Filecoin.NetDisconnect.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.NetFindPeer + params: + - name: peer_id + required: true + schema: + type: string + result: + name: Filecoin.NetFindPeer.Result + required: true + schema: + $ref: "#/components/schemas/AddrInfo" + paramStructure: by-position + - name: Forest.NetInfo + params: [] + result: + name: Forest.NetInfo.Result + required: true + schema: + $ref: "#/components/schemas/NetInfoResult" + paramStructure: by-position + - name: Filecoin.NetListening + params: [] + result: + name: Filecoin.NetListening.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: net_listening + params: [] + result: + name: net_listening.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: Filecoin.NetPeers + description: Returns a list of currently connected peers. + params: [] + result: + name: Filecoin.NetPeers.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/AddrInfo" + paramStructure: by-position + - name: Filecoin.NetProtectAdd + description: Protects a peer from having its connection(s) pruned in the event the libp2p host reaches its maximum number of peers. + params: + - name: peerIdList + required: true + schema: + type: + - array + - "null" + items: + type: string + result: + name: Filecoin.NetProtectAdd.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.NetProtectList + description: Returns the current list of protected peers. + params: [] + result: + name: Filecoin.NetProtectList.Result + required: false + schema: + type: + - array + - "null" + items: + type: string + paramStructure: by-position + - name: Filecoin.NetProtectRemove + description: Remove a peer from the protected list. + params: + - name: peerIdList + required: true + schema: + type: + - array + - "null" + items: + type: string + result: + name: Filecoin.NetProtectRemove.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.NetVersion + params: [] + result: + name: Filecoin.NetVersion.Result + required: true + schema: + type: string + paramStructure: by-position + - name: net_version + params: [] + result: + name: net_version.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.NodeStatus + params: [] + result: + name: Filecoin.NodeStatus.Result + required: true + schema: + $ref: "#/components/schemas/NodeStatusResult" + paramStructure: by-position + - name: Filecoin.StateAccountKey + description: Returns the public key address for the given ID address (secp and bls accounts). + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateAccountKey.Result + required: true + schema: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.StateCall + description: "Runs the given message and returns its result without persisting changes. The message is applied to the tipset's parent state." + params: + - name: message + required: true + schema: + $ref: "#/components/schemas/Message" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateCall.Result + required: true + schema: + $ref: "#/components/schemas/ApiInvocResult" + paramStructure: by-position + - name: Filecoin.StateCirculatingSupply + description: Returns the exact circulating supply of Filecoin at the given tipset. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateCirculatingSupply.Result + required: true + schema: + $ref: "#/components/schemas/TokenAmount" + paramStructure: by-position + - name: Forest.StateCompute + params: + - name: epoch + required: true + schema: + type: integer + format: int64 + - name: n_epochs + required: true + schema: + type: + - integer + - "null" + format: uint + minimum: 1 + result: + name: Forest.StateCompute.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/ForestComputeStateOutput" + paramStructure: by-position + - name: Filecoin.StateCompute + description: Applies the given messages on the given tipset + params: + - name: height + required: true + schema: + type: integer + format: int64 + - name: messages + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Message" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateCompute.Result + required: true + schema: + $ref: "#/components/schemas/ComputeStateOutput" + paramStructure: by-position + - name: Filecoin.StateDealProviderCollateralBounds + description: "Returns the minimum and maximum collateral a storage provider can issue, based on deal size and verified status." + params: + - name: size + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: verified + required: true + schema: + type: boolean + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateDealProviderCollateralBounds.Result + required: true + schema: + $ref: "#/components/schemas/DealCollateralBounds" + paramStructure: by-position + - name: Forest.StateFetchRoot + params: + - name: root_cid + required: true + schema: + $ref: "#/components/schemas/Cid" + - name: save_to_file + required: true + schema: + type: + - string + - "null" + result: + name: Forest.StateFetchRoot.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.StateGetActor + description: Returns the nonce and balance for the specified actor. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetActor.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ActorState" + - type: "null" + paramStructure: by-position + - name: Filecoin.StateGetAllAllocations + description: Returns all allocations available in the verified registry actor. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetAllAllocations.Result + required: true + schema: + type: object + additionalProperties: false + patternProperties: + "^\\d+$": + $ref: "#/components/schemas/Allocation" + paramStructure: by-position + - name: Filecoin.StateGetAllClaims + description: Returns all claims available in the verified registry actor. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetAllClaims.Result + required: true + schema: + type: object + additionalProperties: false + patternProperties: + "^\\d+$": + $ref: "#/components/schemas/ClaimLotusJson" + paramStructure: by-position + - name: Filecoin.StateGetAllocation + description: Returns the allocation for a given address and allocation ID. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: allocationId + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetAllocation.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/Allocation" + - type: "null" + paramStructure: by-position + - name: Filecoin.StateGetAllocationForPendingDeal + description: Returns the allocation for the specified pending deal. Returns null if no pending allocation is found. + params: + - name: dealId + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetAllocationForPendingDeal.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/Allocation" + - type: "null" + paramStructure: by-position + - name: Filecoin.StateGetAllocationIdForPendingDeal + description: Returns the allocation ID for the specified pending deal. + params: + - name: dealId + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetAllocationIdForPendingDeal.Result + required: true + schema: + type: integer + format: uint64 + minimum: 0 + paramStructure: by-position + - name: Filecoin.StateGetAllocations + description: Returns all allocations for a given client. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetAllocations.Result + required: true + schema: + type: object + additionalProperties: false + patternProperties: + "^\\d+$": + $ref: "#/components/schemas/Allocation" + paramStructure: by-position + - name: Filecoin.StateGetBeaconEntry + description: Returns the beacon entries for the specified epoch. + params: + - name: epoch + required: true + schema: + type: integer + format: int64 + result: + name: Filecoin.StateGetBeaconEntry.Result + required: true + schema: + $ref: "#/components/schemas/BeaconEntry" + paramStructure: by-position + - name: Filecoin.StateGetClaim + description: Returns the claim for a given address and claim ID. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: claimId + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetClaim.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ClaimLotusJson" + - type: "null" + paramStructure: by-position + - name: Filecoin.StateGetClaims + description: Returns all claims for a given provider. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetClaims.Result + required: true + schema: + type: object + additionalProperties: false + patternProperties: + "^\\d+$": + $ref: "#/components/schemas/ClaimLotusJson" + paramStructure: by-position + - name: Filecoin.StateGetNetworkParams + description: Returns current network parameters. + params: [] + result: + name: Filecoin.StateGetNetworkParams.Result + required: true + schema: + $ref: "#/components/schemas/NetworkParams" + paramStructure: by-position + - name: Filecoin.StateGetRandomnessDigestFromBeacon + description: Samples the beacon for randomness. + params: + - name: randEpoch + required: true + schema: + type: integer + format: int64 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetRandomnessDigestFromBeacon.Result + required: true + schema: + $ref: "#/components/schemas/Base64String" + paramStructure: by-position + - name: Filecoin.StateGetRandomnessDigestFromTickets + description: Samples the chain for randomness. + params: + - name: randEpoch + required: true + schema: + type: integer + format: int64 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetRandomnessDigestFromTickets.Result + required: true + schema: + $ref: "#/components/schemas/Base64String" + paramStructure: by-position + - name: Filecoin.StateGetRandomnessFromBeacon + description: "Returns the beacon entry for the specified Filecoin epoch. If unavailable, the call blocks until it becomes available." + params: + - name: personalization + required: true + schema: + type: integer + format: int64 + - name: randEpoch + required: true + schema: + type: integer + format: int64 + - name: entropy + required: true + schema: + $ref: "#/components/schemas/Base64String" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetRandomnessFromBeacon.Result + required: true + schema: + $ref: "#/components/schemas/Base64String" + paramStructure: by-position + - name: Filecoin.StateGetRandomnessFromTickets + description: Samples the chain for randomness. + params: + - name: personalization + required: true + schema: + type: integer + format: int64 + - name: randEpoch + required: true + schema: + type: integer + format: int64 + - name: entropy + required: true + schema: + $ref: "#/components/schemas/Base64String" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateGetRandomnessFromTickets.Result + required: true + schema: + $ref: "#/components/schemas/Base64String" + paramStructure: by-position + - name: Filecoin.StateListActors + description: Returns the addresses of every actor in the state. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateListActors.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.StateListMessages + description: Returns all messages with a matching to or from address up to the given height. + params: + - name: messageFilter + required: true + schema: + $ref: "#/components/schemas/MessageFilter" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + - name: maxHeight + required: true + schema: + type: integer + format: int64 + result: + name: Filecoin.StateListMessages.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + paramStructure: by-position + - name: Filecoin.StateListMiners + description: Returns the addresses of every miner with claimed power in the Power Actor. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateListMiners.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.StateLookupID + description: Retrieves the ID address of the given address. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateLookupID.Result + required: true + schema: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.StateLookupRobustAddress + description: "Returns the public key address for non-account addresses (e.g., multisig, miners)." + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateLookupRobustAddress.Result + required: true + schema: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.StateMarketBalance + description: Returns the Escrow and Locked balances of the specified address in the Storage Market. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMarketBalance.Result + required: true + schema: + $ref: "#/components/schemas/MarketBalance" + paramStructure: by-position + - name: Filecoin.StateMarketDeals + description: Returns information about every deal in the Storage Market. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMarketDeals.Result + required: true + schema: + type: object + additionalProperties: + $ref: "#/components/schemas/ApiMarketDeal" + paramStructure: by-position + - name: Filecoin.StateMarketParticipants + description: Returns the Escrow and Locked balances of all participants in the Storage Market. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMarketParticipants.Result + required: true + schema: + type: object + additionalProperties: + $ref: "#/components/schemas/MarketBalance" + paramStructure: by-position + - name: Filecoin.StateMarketStorageDeal + description: Returns information about the specified deal. + params: + - name: dealId + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMarketStorageDeal.Result + required: true + schema: + $ref: "#/components/schemas/ApiMarketDeal" + paramStructure: by-position + - name: Filecoin.StateMinerActiveSectors + description: Returns information about sectors actively proven by a given miner. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerActiveSectors.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/SectorOnChainInfo" + paramStructure: by-position + - name: Filecoin.StateMinerAllocated + description: Returns a bitfield containing all sector numbers marked as allocated to the provided miner ID. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerAllocated.Result + required: true + schema: + $ref: "#/components/schemas/BitField" + paramStructure: by-position + - name: Filecoin.StateMinerAvailableBalance + description: "Returns the portion of a miner's balance available for withdrawal or spending." + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerAvailableBalance.Result + required: true + schema: + $ref: "#/components/schemas/TokenAmount" + paramStructure: by-position + - name: Filecoin.StateMinerDeadlines + description: Returns all proving deadlines for the given miner. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerDeadlines.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/ApiDeadline" + paramStructure: by-position + - name: Filecoin.StateMinerFaults + description: Returns a bitfield of the faulty sectors for the given miner. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerFaults.Result + required: true + schema: + $ref: "#/components/schemas/BitField" + paramStructure: by-position + - name: Filecoin.StateMinerInfo + description: Returns information about the specified miner. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerInfo.Result + required: true + schema: + $ref: "#/components/schemas/MinerInfo" + paramStructure: by-position + - name: Filecoin.StateMinerInitialPledgeCollateral + description: "Returns the initial pledge collateral for the specified miner's sector." + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: sectorPreCommitInfo + required: true + schema: + $ref: "#/components/schemas/SectorPreCommitInfo" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerInitialPledgeCollateral.Result + required: true + schema: + $ref: "#/components/schemas/TokenAmount" + paramStructure: by-position + - name: Filecoin.StateMinerPartitions + description: Returns all partitions in the specified deadline. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: deadlineIndex + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerPartitions.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/MinerPartitions" + paramStructure: by-position + - name: Filecoin.StateMinerPower + description: Returns the power of the specified miner. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerPower.Result + required: true + schema: + $ref: "#/components/schemas/MinerPower" + paramStructure: by-position + - name: Filecoin.StateMinerPreCommitDepositForPower + description: Returns the sector precommit deposit for the specified miner. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: sectorPreCommitInfo + required: true + schema: + $ref: "#/components/schemas/SectorPreCommitInfo" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerPreCommitDepositForPower.Result + required: true + schema: + $ref: "#/components/schemas/TokenAmount" + paramStructure: by-position + - name: Filecoin.StateMinerProvingDeadline + description: Calculates the deadline and related details for a given epoch during a proving period. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerProvingDeadline.Result + required: true + schema: + $ref: "#/components/schemas/ApiDeadlineInfo" + paramStructure: by-position + - name: Filecoin.StateMinerRecoveries + description: Returns a bitfield of recovering sectors for the given miner. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerRecoveries.Result + required: true + schema: + $ref: "#/components/schemas/BitField" + paramStructure: by-position + - name: Filecoin.StateMinerSectorAllocated + description: Checks if a sector number is marked as allocated. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: sectorNumber + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerSectorAllocated.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: Filecoin.StateMinerSectorCount + description: "Returns the number of sectors in a miner's sector and proving sets." + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerSectorCount.Result + required: true + schema: + $ref: "#/components/schemas/MinerSectors" + paramStructure: by-position + - name: Filecoin.StateMinerSectors + description: "Returns information about the given miner's sectors. If no filter is provided, all sectors are included." + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: sectors + required: true + schema: + anyOf: + - $ref: "#/components/schemas/BitField" + - type: "null" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerSectors.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/SectorOnChainInfo" + paramStructure: by-position + - name: Filecoin.StateNetworkName + params: [] + result: + name: Filecoin.StateNetworkName.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.StateNetworkVersion + description: Returns the network version at the given tipset. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateNetworkVersion.Result + required: true + schema: + $ref: "#/components/schemas/NetworkVersion" + paramStructure: by-position + - name: Forest.StateActorInfo + description: Returns the builtin actor information for the current network. + params: [] + result: + name: Forest.StateActorInfo.Result + required: true + schema: + $ref: "#/components/schemas/StateActorCodeCidsOutput" + paramStructure: by-position + - name: Filecoin.StateReadState + description: Returns the state of the specified actor. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateReadState.Result + required: true + schema: + $ref: "#/components/schemas/ApiActorState" + paramStructure: by-position + - name: Filecoin.StateDecodeParams + description: Decode the provided method params. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: method + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: params + required: true + schema: + $ref: "#/components/schemas/Base64String" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateDecodeParams.Result + required: true + schema: true + paramStructure: by-position + - name: Filecoin.StateReplay + description: "Replays a given message, assuming it was included in a block in the specified tipset." + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + - name: messageCid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateReplay.Result + required: true + schema: + $ref: "#/components/schemas/ApiInvocResult" + paramStructure: by-position + - name: Filecoin.StateSearchMsg + description: Returns the receipt and tipset the specified message was included in. + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + - name: messageCid + required: true + schema: + $ref: "#/components/schemas/Cid" + - name: lookBackLimit + required: true + schema: + type: integer + format: int64 + - name: allowReplaced + required: true + schema: + type: boolean + result: + name: Filecoin.StateSearchMsg.Result + required: true + schema: + $ref: "#/components/schemas/MessageLookup" + paramStructure: by-position + - name: Filecoin.StateSectorExpiration + description: Returns the epoch at which the specified sector will expire. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: sectorNumber + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateSectorExpiration.Result + required: true + schema: + $ref: "#/components/schemas/SectorExpiration" + paramStructure: by-position + - name: Filecoin.StateSectorGetInfo + description: "Returns on-chain information for the specified miner's sector. Returns null if not found. Use StateSectorExpiration for accurate expiration epochs." + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: sectorNumber + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateSectorGetInfo.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/SectorOnChainInfo" + - type: "null" + paramStructure: by-position + - name: Filecoin.StateSectorPartition + description: Finds the deadline/partition for the specified sector. + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: sectorNumber + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateSectorPartition.Result + required: true + schema: + $ref: "#/components/schemas/SectorLocation" + paramStructure: by-position + - name: Filecoin.StateSectorPreCommitInfo + description: "Returns the PreCommit information for the specified miner's sector. Returns null if not precommitted." + params: + - name: minerAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: sectorNumber + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateSectorPreCommitInfo.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/SectorPreCommitOnChainInfo" + - type: "null" + paramStructure: by-position + - name: Filecoin.StateVerifiedClientStatus + description: Returns the data cap for the given address. Returns null if no entry exists in the data cap table. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateVerifiedClientStatus.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/BigInt" + - type: "null" + paramStructure: by-position + - name: Filecoin.StateVerifiedRegistryRootKey + description: "Returns the address of the Verified Registry's root key." + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateVerifiedRegistryRootKey.Result + required: true + schema: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.StateVerifierStatus + description: Returns the data cap for the given address. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateVerifierStatus.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/BigInt" + - type: "null" + paramStructure: by-position + - name: Filecoin.StateVMCirculatingSupplyInternal + description: "Returns an approximation of Filecoin's circulating supply at the given tipset." + params: + - name: tipsetKey + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateVMCirculatingSupplyInternal.Result + required: true + schema: + $ref: "#/components/schemas/CirculatingSupply" + paramStructure: by-position + - name: Filecoin.StateWaitMsg + description: "StateWaitMsg searches up to limit epochs for a message in the chain. If not found, it blocks until the message appears on-chain and reaches the required confidence depth." + params: + - name: messageCid + required: true + schema: + $ref: "#/components/schemas/Cid" + - name: confidence + required: true + schema: + type: integer + format: int64 + - name: lookbackLimit + required: true + schema: + type: integer + format: int64 + - name: allowReplaced + required: true + schema: + type: boolean + result: + name: Filecoin.StateWaitMsg.Result + required: true + schema: + $ref: "#/components/schemas/MessageLookup" + paramStructure: by-position + - name: Filecoin.StateMinerInitialPledgeForSector + params: + - name: sector_duration + required: true + schema: + type: integer + format: int64 + - name: sector_size + required: true + schema: + $ref: "#/components/schemas/SectorSize" + - name: verified_size + required: true + schema: + type: integer + format: uint64 + minimum: 0 + - name: tipset_key + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.StateMinerInitialPledgeForSector.Result + required: true + schema: + $ref: "#/components/schemas/TokenAmount" + paramStructure: by-position + - name: Filecoin.SyncCheckBad + params: + - name: cid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.SyncCheckBad.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.SyncMarkBad + params: + - name: cid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.SyncMarkBad.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Forest.SyncSnapshotProgress + description: "Returns the snapshot download progress. Return Null if the tracking isn't started" + params: [] + result: + name: Forest.SyncSnapshotProgress.Result + required: true + schema: + $ref: "#/components/schemas/SnapshotProgressState" + paramStructure: by-position + - name: Forest.SyncStatus + description: Returns the current sync status of the node. + params: [] + result: + name: Forest.SyncStatus.Result + required: true + schema: + $ref: "#/components/schemas/SyncStatusReport" + paramStructure: by-position + - name: Filecoin.SyncSubmitBlock + description: Submits a newly created block to the network. + params: + - name: block + required: true + schema: + $ref: "#/components/schemas/GossipBlock" + result: + name: Filecoin.SyncSubmitBlock.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.WalletBalance + description: Returns the balance of a wallet. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + result: + name: Filecoin.WalletBalance.Result + required: true + schema: + $ref: "#/components/schemas/TokenAmount" + paramStructure: by-position + - name: Filecoin.WalletDefaultAddress + params: [] + result: + name: Filecoin.WalletDefaultAddress.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/Address" + - type: "null" + paramStructure: by-position + - name: Filecoin.WalletDelete + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + result: + name: Filecoin.WalletDelete.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.WalletExport + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + result: + name: Filecoin.WalletExport.Result + required: true + schema: + $ref: "#/components/schemas/KeyInfo" + paramStructure: by-position + - name: Filecoin.WalletHas + description: Indicates whether the given address exists in the wallet. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + result: + name: Filecoin.WalletHas.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: Filecoin.WalletImport + params: + - name: key + required: true + schema: + $ref: "#/components/schemas/KeyInfo" + result: + name: Filecoin.WalletImport.Result + required: true + schema: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.WalletList + description: Returns a list of all addresses in the wallet. + params: [] + result: + name: Filecoin.WalletList.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.WalletNew + params: + - name: signature_type + required: true + schema: + $ref: "#/components/schemas/SignatureTypeLotusJson" + result: + name: Filecoin.WalletNew.Result + required: true + schema: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.WalletSetDefault + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + result: + name: Filecoin.WalletSetDefault.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.WalletSign + description: Signs the given bytes using the specified address. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: message + required: true + schema: + $ref: "#/components/schemas/Base64String" + result: + name: Filecoin.WalletSign.Result + required: true + schema: + $ref: "#/components/schemas/Signature" + paramStructure: by-position + - name: Filecoin.WalletSignMessage + description: Signs the given message using the specified address. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: message + required: true + schema: + $ref: "#/components/schemas/Message" + result: + name: Filecoin.WalletSignMessage.Result + required: true + schema: + $ref: "#/components/schemas/SignedMessage" + paramStructure: by-position + - name: Filecoin.WalletValidateAddress + params: + - name: address + required: true + schema: + type: string + result: + name: Filecoin.WalletValidateAddress.Result + required: true + schema: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.WalletVerify + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: message + required: true + schema: + $ref: "#/components/schemas/Base64String" + - name: signature + required: true + schema: + $ref: "#/components/schemas/Signature" + result: + name: Filecoin.WalletVerify.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: F3.GetRawNetworkName + params: [] + result: + name: F3.GetRawNetworkName.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.F3GetCertificate + params: + - name: instance + required: true + schema: + type: integer + format: uint64 + minimum: 0 + result: + name: Filecoin.F3GetCertificate.Result + required: true + schema: + $ref: "#/components/schemas/FinalityCertificate" + paramStructure: by-position + - name: Filecoin.F3GetECPowerTable + params: + - name: tipset_key + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.F3GetECPowerTable.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/F3PowerEntryLotusJson" + paramStructure: by-position + - name: Filecoin.F3GetF3PowerTable + params: + - name: tipset_key + required: true + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.F3GetF3PowerTable.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/F3PowerEntryLotusJson" + paramStructure: by-position + - name: Filecoin.F3GetF3PowerTableByInstance + description: Gets the power table (committee) used to validate the specified instance + params: + - name: instance + required: true + schema: + type: integer + format: uint64 + minimum: 0 + result: + name: Filecoin.F3GetF3PowerTableByInstance.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/F3PowerEntryLotusJson" + paramStructure: by-position + - name: Filecoin.F3IsRunning + params: [] + result: + name: Filecoin.F3IsRunning.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: Filecoin.F3GetProgress + params: [] + result: + name: Filecoin.F3GetProgress.Result + required: true + schema: + $ref: "#/components/schemas/F3InstanceProgress" + paramStructure: by-position + - name: Filecoin.F3GetManifest + params: [] + result: + name: Filecoin.F3GetManifest.Result + required: true + schema: + $ref: "#/components/schemas/F3Manifest" + paramStructure: by-position + - name: Filecoin.F3ListParticipants + params: [] + result: + name: Filecoin.F3ListParticipants.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/F3Participant" + paramStructure: by-position + - name: Filecoin.F3GetLatestCertificate + params: [] + result: + name: Filecoin.F3GetLatestCertificate.Result + required: true + schema: + $ref: "#/components/schemas/FinalityCertificate" + paramStructure: by-position + - name: Filecoin.F3GetOrRenewParticipationTicket + params: + - name: miner_address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: previous_lease_ticket + required: true + schema: + $ref: "#/components/schemas/Base64String" + - name: instances + required: true + schema: + type: integer + format: uint64 + minimum: 0 + result: + name: Filecoin.F3GetOrRenewParticipationTicket.Result + required: true + schema: + $ref: "#/components/schemas/Base64String" + paramStructure: by-position + - name: Filecoin.F3Participate + params: + - name: lease_ticket + required: true + schema: + $ref: "#/components/schemas/Base64String" + result: + name: Filecoin.F3Participate.Result + required: true + schema: + $ref: "#/components/schemas/ApiF3ParticipationLease" + paramStructure: by-position + - name: F3.ExportLatestSnapshot + description: Exports the latest F3 snapshot to the specified path and returns its CID + params: + - name: path + required: true + schema: + type: string + result: + name: F3.ExportLatestSnapshot.Result + required: true + schema: + $ref: "#/components/schemas/Cid" + paramStructure: by-position + - name: F3.GetHead + params: [] + result: + name: F3.GetHead.Result + required: true + schema: + $ref: "#/components/schemas/F3TipSet" + paramStructure: by-position + - name: F3.GetParent + params: + - name: tipset_key + required: true + schema: + $ref: "#/components/schemas/F3TipSetKey" + result: + name: F3.GetParent.Result + required: true + schema: + $ref: "#/components/schemas/F3TipSet" + paramStructure: by-position + - name: F3.GetParticipatingMinerIDs + params: [] + result: + name: F3.GetParticipatingMinerIDs.Result + required: false + schema: + type: + - array + - "null" + items: + type: integer + format: uint64 + minimum: 0 + paramStructure: by-position + - name: F3.GetPowerTable + params: + - name: tipset_key + required: true + schema: + $ref: "#/components/schemas/F3TipSetKey" + result: + name: F3.GetPowerTable.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/F3PowerEntryLotusJson" + paramStructure: by-position + - name: F3.GetTipset + params: + - name: tipset_key + required: true + schema: + $ref: "#/components/schemas/F3TipSetKey" + result: + name: F3.GetTipset.Result + required: true + schema: + $ref: "#/components/schemas/F3TipSet" + paramStructure: by-position + - name: F3.GetTipsetByEpoch + params: + - name: epoch + required: true + schema: + type: integer + format: int64 + result: + name: F3.GetTipsetByEpoch.Result + required: true + schema: + $ref: "#/components/schemas/F3TipSet" + paramStructure: by-position + - name: F3.Finalize + params: + - name: tipset_key + required: true + schema: + $ref: "#/components/schemas/F3TipSetKey" + result: + name: F3.Finalize.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: F3.ProtectPeer + params: + - name: peer_id + required: true + schema: + type: string + result: + name: F3.ProtectPeer.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: F3.SignMessage + params: + - name: pubkey + required: true + schema: + $ref: "#/components/schemas/Base64String" + - name: message + required: true + schema: + $ref: "#/components/schemas/Base64String" + result: + name: F3.SignMessage.Result + required: true + schema: + $ref: "#/components/schemas/Signature" + paramStructure: by-position + - name: Filecoin.GetActorEventsRaw + description: "Returns all user-programmed and built-in actor events that match the given filter. Results may be limited by MaxFilterResults, MaxFilterHeightRange, and the node's available historical data." + params: + - name: eventFilter + required: true + schema: + anyOf: + - $ref: "#/components/schemas/ActorEventFilter" + - type: "null" + result: + name: Filecoin.GetActorEventsRaw.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/ActorEvent" + paramStructure: by-position +components: + schemas: + ActorEvent: + type: object + properties: + emitter: + $ref: "#/components/schemas/Address" + entries: + type: array + items: + $ref: "#/components/schemas/EventEntry" + height: + type: integer + format: int64 + msgCid: + $ref: "#/components/schemas/Cid" + reverted: + type: boolean + tipsetKey: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + required: + - entries + - emitter + - reverted + - height + - tipsetKey + - msgCid + ActorEventBlock: + type: object + properties: + codec: + type: integer + format: uint64 + minimum: 0 + value: + $ref: "#/components/schemas/Base64String" + required: + - codec + - value + ActorEventFilter: + type: object + properties: + addresses: + type: array + items: + $ref: "#/components/schemas/Address" + fields: + type: object + additionalProperties: + type: array + items: + $ref: "#/components/schemas/ActorEventBlock" + fromHeight: + type: + - integer + - "null" + format: int64 + tipsetKey: + anyOf: + - $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + - type: "null" + toHeight: + type: + - integer + - "null" + format: int64 + ActorState: + type: object + properties: + Balance: + $ref: "#/components/schemas/TokenAmount" + Code: + $ref: "#/components/schemas/Cid" + DelegatedAddress: + $ref: "#/components/schemas/Nullable_Address" + Head: + $ref: "#/components/schemas/Cid" + Nonce: + type: integer + format: uint64 + minimum: 0 + required: + - Code + - Head + - Nonce + - Balance + ActorTrace: + type: object + properties: + Id: + type: integer + format: uint64 + minimum: 0 + State: + $ref: "#/components/schemas/ActorState" + required: + - Id + - State + AddrInfo: + type: object + properties: + Addrs: + type: array + items: + type: string + uniqueItems: true + ID: + type: string + required: + - ID + - Addrs + Address: + type: string + Allocation: + type: object + properties: + Client: + type: integer + format: uint64 + minimum: 0 + Data: + $ref: "#/components/schemas/Cid" + Expiration: + type: integer + format: int64 + Provider: + type: integer + format: uint64 + minimum: 0 + Size: + type: integer + format: uint64 + minimum: 0 + TermMax: + type: integer + format: int64 + TermMin: + type: integer + format: int64 + required: + - Client + - Provider + - Data + - Size + - TermMin + - TermMax + - Expiration + ApiActorState: + type: object + properties: + Balance: + $ref: "#/components/schemas/TokenAmount" + Code: + $ref: "#/components/schemas/Cid" + State: true + required: + - Balance + - Code + - State + ApiDeadline: + type: object + properties: + DailyFee: + $ref: "#/components/schemas/TokenAmount" + DisputableProofCount: + type: integer + format: uint64 + minimum: 0 + PostSubmissions: + $ref: "#/components/schemas/BitField" + required: + - PostSubmissions + - DisputableProofCount + - DailyFee + ApiDeadlineInfo: + type: string + ApiDealProposal: + type: object + properties: + Client: + $ref: "#/components/schemas/Address" + ClientCollateral: + $ref: "#/components/schemas/TokenAmount" + EndEpoch: + type: integer + format: int64 + Label: + type: string + PieceCID: + $ref: "#/components/schemas/Cid" + PieceSize: + type: integer + format: uint64 + minimum: 0 + Provider: + $ref: "#/components/schemas/Address" + ProviderCollateral: + $ref: "#/components/schemas/TokenAmount" + StartEpoch: + type: integer + format: int64 + StoragePricePerEpoch: + $ref: "#/components/schemas/TokenAmount" + VerifiedDeal: + type: boolean + required: + - PieceCID + - PieceSize + - VerifiedDeal + - Client + - Provider + - Label + - StartEpoch + - EndEpoch + - StoragePricePerEpoch + - ProviderCollateral + - ClientCollateral + ApiDealState: + type: object + properties: + LastUpdatedEpoch: + type: integer + format: int64 + SectorNumber: + type: integer + format: uint64 + minimum: 0 + SectorStartEpoch: + type: integer + format: int64 + SlashEpoch: + type: integer + format: int64 + required: + - SectorStartEpoch + - LastUpdatedEpoch + - SlashEpoch + - SectorNumber + ApiEthTx: + type: object + properties: + accessList: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthHash" + blockHash: + $ref: "#/components/schemas/EthHash" + blockNumber: + $ref: "#/components/schemas/EthUint64" + chainId: + $ref: "#/components/schemas/EthUint64" + from: + $ref: "#/components/schemas/EthAddress" + gas: + $ref: "#/components/schemas/EthUint64" + gasPrice: + anyOf: + - $ref: "#/components/schemas/EthBigInt" + - type: "null" + hash: + $ref: "#/components/schemas/EthHash" + input: + $ref: "#/components/schemas/EthBytes" + maxFeePerGas: + anyOf: + - $ref: "#/components/schemas/EthBigInt" + - type: "null" + maxPriorityFeePerGas: + anyOf: + - $ref: "#/components/schemas/EthBigInt" + - type: "null" + nonce: + $ref: "#/components/schemas/EthUint64" + r: + $ref: "#/components/schemas/EthBigInt" + s: + $ref: "#/components/schemas/EthBigInt" + to: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + transactionIndex: + $ref: "#/components/schemas/EthUint64" + type: + $ref: "#/components/schemas/EthUint64" + v: + $ref: "#/components/schemas/EthBigInt" + value: + $ref: "#/components/schemas/EthBigInt" + required: + - chainId + - nonce + - hash + - blockHash + - blockNumber + - transactionIndex + - from + - value + - type + - input + - gas + - v + - r + - s + ApiExportResult: + oneOf: + - type: string + enum: + - Cancelled + - type: object + properties: + Done: + type: + - string + - "null" + additionalProperties: false + required: + - Done + ApiExportStatus: + type: object + properties: + cancelled: + type: boolean + exporting: + type: boolean + progress: + type: number + format: double + start_time: + type: + - string + - "null" + format: date-time + required: + - progress + - exporting + - cancelled + ApiF3ParticipationLease: + description: "defines the lease granted to a storage provider for\nparticipating in F3 consensus, detailing the session identifier, issuer,\nsubject, and the expiration instance." + type: object + properties: + FromInstance: + description: specifies the instance ID from which this lease is valid. + type: integer + format: uint64 + minimum: 0 + Issuer: + description: the identity of the node that issued the lease. + type: string + MinerID: + description: the actor ID of the miner that holds the lease. + type: integer + format: uint64 + minimum: 0 + Network: + description: the name of the network this lease belongs to. + type: string + ValidityTerm: + description: specifies the number of instances for which the lease remains valid from the FromInstance. + type: integer + format: uint64 + minimum: 0 + required: + - Network + - Issuer + - MinerID + - FromInstance + - ValidityTerm + ApiInvocResult: + type: object + properties: + Duration: + type: integer + format: uint64 + minimum: 0 + Error: + type: string + ExecutionTrace: + anyOf: + - $ref: "#/components/schemas/ExecutionTrace" + - type: "null" + GasCost: + $ref: "#/components/schemas/MessageGasCost" + Msg: + $ref: "#/components/schemas/Message" + MsgCid: + $ref: "#/components/schemas/Cid" + MsgRct: + $ref: "#/components/schemas/Nullable_Receipt" + required: + - MsgCid + - Msg + - MsgRct + - Error + - Duration + - GasCost + ApiMarketDeal: + type: object + properties: + Proposal: + $ref: "#/components/schemas/ApiDealProposal" + State: + $ref: "#/components/schemas/ApiDealState" + required: + - Proposal + - State + ApiMessage: + type: object + properties: + Cid: + $ref: "#/components/schemas/Cid" + Message: + $ref: "#/components/schemas/Message" + required: + - Cid + - Message + ApiReceipt: + type: object + properties: + EventsRoot: + $ref: "#/components/schemas/Nullable_Cid" + ExitCode: + $ref: "#/components/schemas/ExitCode" + GasUsed: + type: integer + format: uint64 + minimum: 0 + Return: + $ref: "#/components/schemas/Base64String" + required: + - ExitCode + - Return + - GasUsed + - EventsRoot + Base64String: + type: + - string + - "null" + BeaconEntry: + type: object + properties: + Data: + $ref: "#/components/schemas/Base64String" + Round: + type: integer + format: uint64 + minimum: 0 + required: + - Round + - Data + BeneficiaryTerm: + type: object + properties: + Expiration: + description: "The epoch at which the beneficiary's rights expire and revert to the owner" + type: integer + format: int64 + Quota: + description: "The total amount the current beneficiary can withdraw. Monotonic, but reset when beneficiary changes." + $ref: "#/components/schemas/TokenAmount" + UsedQuota: + description: The amount of quota the current beneficiary has already withdrawn + $ref: "#/components/schemas/TokenAmount" + required: + - Quota + - UsedQuota + - Expiration + BigInt: + type: string + BitField: + type: + - array + - "null" + items: + type: integer + format: uint8 + maximum: 255 + minimum: 0 + Block: + type: object + properties: + baseFeePerGas: + $ref: "#/components/schemas/EthBigInt" + difficulty: + $ref: "#/components/schemas/EthUint64" + extraData: + $ref: "#/components/schemas/EthBytes" + gasLimit: + $ref: "#/components/schemas/EthUint64" + gasUsed: + $ref: "#/components/schemas/EthUint64" + hash: + $ref: "#/components/schemas/EthHash" + logsBloom: + $ref: "#/components/schemas/Bloom" + miner: + $ref: "#/components/schemas/EthAddress" + mixHash: + $ref: "#/components/schemas/EthHash" + nonce: + $ref: "#/components/schemas/Nonce" + number: + $ref: "#/components/schemas/EthUint64" + parentHash: + $ref: "#/components/schemas/EthHash" + receiptsRoot: + $ref: "#/components/schemas/EthHash" + sha3Uncles: + $ref: "#/components/schemas/EthHash" + size: + $ref: "#/components/schemas/EthUint64" + stateRoot: + $ref: "#/components/schemas/EthHash" + timestamp: + $ref: "#/components/schemas/EthUint64" + totalDifficulty: + $ref: "#/components/schemas/EthUint64" + transactions: + $ref: "#/components/schemas/Transactions" + transactionsRoot: + $ref: "#/components/schemas/EthHash" + uncles: + type: array + items: + $ref: "#/components/schemas/EthHash" + required: + - hash + - parentHash + - sha3Uncles + - miner + - stateRoot + - transactionsRoot + - receiptsRoot + - logsBloom + - difficulty + - totalDifficulty + - number + - gasLimit + - gasUsed + - timestamp + - extraData + - mixHash + - nonce + - baseFeePerGas + - size + - transactions + - uncles + BlockHash: + type: object + properties: + blockHash: + $ref: "#/components/schemas/EthHash" + requireCanonical: + type: boolean + required: + - blockHash + - requireCanonical + BlockHeader: + type: object + properties: + BLSAggregate: + $ref: "#/components/schemas/Nullable_Signature" + BeaconEntries: + $ref: "#/components/schemas/Nullable_Array_of_BeaconEntry" + BlockSig: + $ref: "#/components/schemas/Nullable_Signature" + ElectionProof: + $ref: "#/components/schemas/Nullable_ElectionProof" + ForkSignaling: + type: integer + format: uint64 + minimum: 0 + Height: + type: integer + format: int64 + Messages: + $ref: "#/components/schemas/Cid" + Miner: + $ref: "#/components/schemas/Address" + ParentBaseFee: + $ref: "#/components/schemas/TokenAmount" + ParentMessageReceipts: + $ref: "#/components/schemas/Cid" + ParentStateRoot: + $ref: "#/components/schemas/Cid" + ParentWeight: + $ref: "#/components/schemas/BigInt" + Parents: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + Ticket: + $ref: "#/components/schemas/Nullable_Ticket" + Timestamp: + type: integer + format: uint64 + minimum: 0 + WinPoStProof: + $ref: "#/components/schemas/Nullable_Array_of_PoStProof" + required: + - Miner + - BeaconEntries + - WinPoStProof + - Parents + - ParentWeight + - Height + - ParentStateRoot + - ParentMessageReceipts + - Messages + - Timestamp + - ForkSignaling + - ParentBaseFee + BlockMessage: + type: object + properties: + BlsMessages: + $ref: "#/components/schemas/Nullable_Array_of_Cid" + Header: + $ref: "#/components/schemas/BlockHeader" + SecpkMessages: + $ref: "#/components/schemas/Nullable_Array_of_Cid" + required: + - Header + - BlsMessages + - SecpkMessages + BlockMessages: + type: object + properties: + BlsMessages: + $ref: "#/components/schemas/Nullable_Array_of_Message" + Cids: + $ref: "#/components/schemas/Nullable_Array_of_Cid" + SecpkMessages: + $ref: "#/components/schemas/Nullable_Array_of_SignedMessage" + required: + - BlsMessages + - SecpkMessages + - Cids + BlockNumber: + type: object + properties: + blockNumber: + $ref: "#/components/schemas/EthInt64" + required: + - blockNumber + BlockNumberOrHash: + anyOf: + - type: string + - $ref: "#/components/schemas/EthInt64" + - $ref: "#/components/schemas/EthHash" + - $ref: "#/components/schemas/BlockNumber" + - $ref: "#/components/schemas/BlockHash" + BlockNumberOrPredefined: + anyOf: + - type: string + - $ref: "#/components/schemas/EthInt64" + BlockTemplate: + type: object + properties: + BeaconValues: + $ref: "#/components/schemas/Nullable_Array_of_BeaconEntry" + Epoch: + $ref: "#/components/schemas/int64" + Eproof: + $ref: "#/components/schemas/ElectionProof" + Messages: + $ref: "#/components/schemas/Nullable_Array_of_SignedMessage" + Miner: + $ref: "#/components/schemas/Address" + Parents: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + Ticket: + $ref: "#/components/schemas/Ticket" + Timestamp: + type: integer + format: uint64 + minimum: 0 + WinningPoStProof: + $ref: "#/components/schemas/Nullable_Array_of_PoStProof" + required: + - Miner + - Parents + - Ticket + - Eproof + - BeaconValues + - Messages + - Epoch + - Timestamp + - WinningPoStProof + Bloom: + type: string + CertificateExchangeConfig: + type: object + properties: + ClientRequestTimeout: + type: integer + format: uint64 + minimum: 0 + MaximumPollInterval: + type: integer + format: uint64 + minimum: 0 + MinimumPollInterval: + type: integer + format: uint64 + minimum: 0 + ServerRequestTimeout: + type: integer + format: uint64 + minimum: 0 + required: + - ClientRequestTimeout + - ServerRequestTimeout + - MinimumPollInterval + - MaximumPollInterval + ChainExchangeConfig: + type: object + properties: + MaxChainLength: + type: integer + format: uint + minimum: 0 + MaxDiscoveredChainsPerInstance: + type: integer + format: uint + minimum: 0 + MaxInstanceLookahead: + type: integer + format: uint + minimum: 0 + MaxTimestampAge: + type: integer + format: uint64 + minimum: 0 + MaxWantedChainsPerInstance: + type: integer + format: uint + minimum: 0 + RebroadcastInterval: + type: integer + format: uint64 + minimum: 0 + SubscriptionBufferSize: + type: integer + format: uint + minimum: 0 + required: + - SubscriptionBufferSize + - MaxChainLength + - MaxInstanceLookahead + - MaxDiscoveredChainsPerInstance + - MaxWantedChainsPerInstance + - RebroadcastInterval + - MaxTimestampAge + ChainExportParams: + type: object + properties: + dry_run: + type: boolean + epoch: + type: integer + format: int64 + output_path: + type: string + recent_roots: + type: integer + format: int64 + skip_checksum: + type: boolean + tipset_keys: + $ref: "#/components/schemas/Nullable_Array_of_Cid" + required: + - epoch + - recent_roots + - output_path + - tipset_keys + - skip_checksum + - dry_run + Cid: + type: object + properties: + /: + type: string + required: + - / + CirculatingSupply: + type: object + properties: + FilBurnt: + $ref: "#/components/schemas/TokenAmount" + FilCirculating: + $ref: "#/components/schemas/TokenAmount" + FilLocked: + $ref: "#/components/schemas/TokenAmount" + FilMined: + $ref: "#/components/schemas/TokenAmount" + FilReserveDisbursed: + $ref: "#/components/schemas/TokenAmount" + FilVested: + $ref: "#/components/schemas/TokenAmount" + required: + - FilVested + - FilMined + - FilBurnt + - FilLocked + - FilCirculating + - FilReserveDisbursed + Claim: + type: object + properties: + QualityAdjPower: + description: "Sum of quality adjusted power for a miner's sectors." + $ref: "#/components/schemas/BigInt" + RawBytePower: + description: "Sum of raw byte power for a miner's sectors." + $ref: "#/components/schemas/BigInt" + required: + - RawBytePower + - QualityAdjPower + ClaimLotusJson: + type: object + properties: + Client: + type: integer + format: uint64 + minimum: 0 + Data: + $ref: "#/components/schemas/Cid" + Provider: + type: integer + format: uint64 + minimum: 0 + Sector: + type: integer + format: uint64 + minimum: 0 + Size: + type: integer + format: uint64 + minimum: 0 + TermMax: + type: integer + format: int64 + TermMin: + type: integer + format: int64 + TermStart: + type: integer + format: int64 + required: + - Provider + - Client + - Data + - Size + - TermMin + - TermMax + - TermStart + - Sector + ComputeStateOutput: + type: object + properties: + Root: + $ref: "#/components/schemas/Cid" + Trace: + $ref: "#/components/schemas/ApiInvocResult" + required: + - Root + - Trace + DealCollateralBounds: + type: object + properties: + Max: + $ref: "#/components/schemas/TokenAmount" + Min: + $ref: "#/components/schemas/TokenAmount" + required: + - Min + - Max + ECTipSet: + type: object + properties: + Commitments: + type: string + Epoch: + type: integer + format: int64 + Key: + type: string + PowerTable: + type: string + required: + - Key + - Epoch + - PowerTable + - Commitments + EcConfig: + type: object + properties: + BaseDecisionBackoffTable: + type: array + items: + type: number + format: double + DelayMultiplier: + type: number + format: double + Finality: + type: integer + format: int64 + Finalize: + type: boolean + HeadLookback: + type: integer + format: int64 + Period: + type: integer + format: uint64 + minimum: 0 + required: + - Period + - Finality + - DelayMultiplier + - BaseDecisionBackoffTable + - HeadLookback + - Finalize + ElectionProof: + type: object + properties: + VRFProof: + $ref: "#/components/schemas/Base64String" + WinCount: + type: integer + format: int64 + required: + - VRFProof + - WinCount + EthAddress: + type: string + EthAddressList: + description: "Represents an [`EthAddress`] or a collection of thereof. This allows the caller to either use,\ne.g., `0x1234...` or `[\"0x1234...\", \"0x5678...\"]` as the address parameter." + anyOf: + - type: array + items: + $ref: "#/components/schemas/EthAddress" + - $ref: "#/components/schemas/EthAddress" + EthBigInt: + type: string + EthBlockTrace: + type: object + properties: + action: + $ref: "#/components/schemas/TraceAction" + blockHash: + $ref: "#/components/schemas/EthHash" + blockNumber: + type: integer + format: int64 + error: + type: + - string + - "null" + result: + $ref: "#/components/schemas/TraceResult" + subtraces: + type: integer + format: int64 + traceAddress: + type: array + items: + type: integer + format: int64 + transactionHash: + $ref: "#/components/schemas/EthHash" + transactionPosition: + type: integer + format: int64 + type: + type: string + required: + - type + - subtraces + - traceAddress + - action + - result + - blockHash + - blockNumber + - transactionHash + - transactionPosition + EthBytes: + type: string + EthCallMessage: + type: object + properties: + data: + anyOf: + - $ref: "#/components/schemas/EthBytes" + - type: "null" + from: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + gas: + anyOf: + - $ref: "#/components/schemas/EthUint64" + - type: "null" + gasPrice: + anyOf: + - $ref: "#/components/schemas/EthBigInt" + - type: "null" + to: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + value: + anyOf: + - $ref: "#/components/schemas/EthBigInt" + - type: "null" + EthCallTraceAction: + type: object + properties: + callType: + type: string + from: + $ref: "#/components/schemas/EthAddress" + gas: + $ref: "#/components/schemas/EthUint64" + input: + $ref: "#/components/schemas/EthBytes" + to: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + value: + $ref: "#/components/schemas/EthBigInt" + required: + - callType + - from + - gas + - value + - input + EthCallTraceResult: + type: object + properties: + gasUsed: + $ref: "#/components/schemas/EthUint64" + output: + $ref: "#/components/schemas/EthBytes" + required: + - gasUsed + - output + EthCreateTraceAction: + type: object + properties: + from: + $ref: "#/components/schemas/EthAddress" + gas: + $ref: "#/components/schemas/EthUint64" + init: + $ref: "#/components/schemas/EthBytes" + value: + $ref: "#/components/schemas/EthBigInt" + required: + - from + - gas + - value + - init + EthCreateTraceResult: + type: object + properties: + address: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + code: + $ref: "#/components/schemas/EthBytes" + gasUsed: + $ref: "#/components/schemas/EthUint64" + required: + - gasUsed + - code + EthFeeHistoryResult: + type: object + properties: + baseFeePerGas: + type: array + items: + $ref: "#/components/schemas/EthBigInt" + gasUsedRatio: + type: array + items: + type: number + format: double + oldestBlock: + $ref: "#/components/schemas/EthUint64" + reward: + type: + - array + - "null" + items: + type: array + items: + $ref: "#/components/schemas/EthBigInt" + required: + - oldestBlock + - baseFeePerGas + - gasUsedRatio + EthFilterResult: + description: "`EthFilterResult` represents the response from executing a filter:\n- A list of block hashes\n- A list of transaction hashes\n- Or a list of logs" + anyOf: + - type: array + items: + $ref: "#/components/schemas/EthHash" + - type: array + items: + $ref: "#/components/schemas/EthLog" + EthFilterSpec: + description: "Represents a filter specification for querying Ethereum event logs.\nThis struct can be used to specify criteria for filtering Ethereum event logs based on block range,\naddress, topics, and block hash. It is useful for making requests to Ethereum nodes to fetch logs\nthat match certain conditions.\n\n# Fields\n\n* `from_block` - Optional field interpreted as an epoch (in hex):\n - `\"latest\"`: latest mined block.\n - `\"earliest\"`: first block.\n - `\"pending\"`: blocks that have not yet been mined.\n If omitted, the default value is `\"latest\"`.\n This field is skipped during serialization if `None`.\n\n* `to_block` - Optional field interpreted as an epoch (in hex):\n - `\"latest\"`: latest mined block.\n - `\"earliest\"`: first block.\n - `\"pending\"`: blocks that have not yet been mined.\n If omitted, the default value is `\"latest\"`.\n This field is skipped during serialization if `None`.\n\n* `address` - Optional field interpreted as Actor address or a list of addresses (`Vec`) from which event logs should originate.\n If the filter needs to match a single address, it can be specified as a single element vector.\n This field is required and cannot be omitted.\n\n* `topics` - List of topics (`EthTopicSpec`) to be matched in the event logs. \n\n* `block_hash` - Optional field specifying a block hash (`Hash`)\n Restricts event logs returned to those emitted from messages contained in this tipset. When `block_hash` is provided,\n neither `from_block` nor `to_block` can be specified.\n This field is skipped during serialization if `None`.\n [the spec](https://github.com/filecoin-project/lotus/blob/475139ff95407ed9d55d3a2ef87e28da66512937/chain/types/ethtypes/eth_types.go#L602-L627)." + type: object + properties: + address: + anyOf: + - $ref: "#/components/schemas/EthAddressList" + - type: "null" + blockHash: + anyOf: + - $ref: "#/components/schemas/EthHash" + - type: "null" + fromBlock: + type: + - string + - "null" + toBlock: + type: + - string + - "null" + topics: + anyOf: + - $ref: "#/components/schemas/EthTopicSpec" + - type: "null" + EthHash: + type: string + EthHashList: + description: "`EthHashList` represents a topic filter that can take one of two forms:\n- `List`: Matches if the hash is present in the vector.\n- `Single`: An optional hash, where:\n - `Some(hash)`: Matches exactly this hash.\n - `None`: Acts as a wildcard." + anyOf: + - type: array + items: + $ref: "#/components/schemas/EthHash" + - anyOf: + - $ref: "#/components/schemas/EthHash" + - type: "null" + EthInt64: + type: string + EthLog: + description: Represents the results of an event filter execution. + type: object + properties: + address: + description: The address of the actor that produced the event log. + $ref: "#/components/schemas/EthAddress" + blockHash: + description: The hash of the tipset containing the message that produced the log. + $ref: "#/components/schemas/EthHash" + blockNumber: + description: The epoch of the tipset containing the message. + $ref: "#/components/schemas/EthUint64" + data: + description: "The value of the event log, excluding topics." + $ref: "#/components/schemas/EthBytes" + logIndex: + description: "The index of the event log in the sequence of events produced by the message execution.\n(this is the index in the events AMT on the message receipt)" + $ref: "#/components/schemas/EthUint64" + removed: + description: Indicates whether the log was removed due to a chain reorganization. + type: boolean + topics: + description: List of topics associated with the event log. + type: array + items: + $ref: "#/components/schemas/EthHash" + transactionHash: + description: The hash of the RLP message that produced the event log. + $ref: "#/components/schemas/EthHash" + transactionIndex: + description: "The index in the tipset of the transaction that produced the event log.\nThe index corresponds to the sequence of messages produced by `ChainGetParentMessages`" + $ref: "#/components/schemas/EthUint64" + required: + - address + - data + - topics + - removed + - logIndex + - transactionIndex + - transactionHash + - blockHash + - blockNumber + EthReplayBlockTransactionTrace: + type: object + properties: + output: + $ref: "#/components/schemas/EthBytes" + stateDiff: + type: + - string + - "null" + trace: + type: array + items: + $ref: "#/components/schemas/EthTrace" + transactionHash: + $ref: "#/components/schemas/EthHash" + vmTrace: + type: + - string + - "null" + required: + - output + - trace + - transactionHash + EthSyncingResultLotusJson: + anyOf: + - type: boolean + - type: object + properties: + currentblock: + type: integer + format: int64 + highestblock: + type: integer + format: int64 + startingblock: + type: integer + format: int64 + required: + - startingblock + - currentblock + - highestblock + EthTopicSpec: + type: array + items: + $ref: "#/components/schemas/EthHashList" + EthTrace: + type: object + properties: + action: + $ref: "#/components/schemas/TraceAction" + error: + type: + - string + - "null" + result: + $ref: "#/components/schemas/TraceResult" + subtraces: + type: integer + format: int64 + traceAddress: + type: array + items: + type: integer + format: int64 + type: + type: string + required: + - type + - subtraces + - traceAddress + - action + - result + EthTraceFilterCriteria: + type: object + properties: + after: + description: "After specifies the offset for pagination of trace results. The number of traces to skip before returning results.\nOptional, default: None." + anyOf: + - $ref: "#/components/schemas/EthUint64" + - type: "null" + count: + description: "Limits the number of traces returned.\nOptional, default: all traces." + anyOf: + - $ref: "#/components/schemas/EthUint64" + - type: "null" + fromAddress: + description: "Actor address or a list of addresses from which transactions that generate traces should originate.\nOptional, default: None.\nThe JSON decoding must treat a string as equivalent to an array with one value, for example\n\"0x8888f1f195afa192cfee86069858\" must be decoded as [ \"0x8888f1f195afa192cfee86069858\" ]" + anyOf: + - $ref: "#/components/schemas/EthAddressList" + - type: "null" + fromBlock: + description: "Interpreted as an epoch (in hex) or one of \"latest\" for last mined block, \"pending\" for not yet committed messages.\nOptional, default: \"latest\".\nNote: \"earliest\" is not a permitted value." + type: + - string + - "null" + toAddress: + description: "Actor address or a list of addresses to which transactions that generate traces are sent.\nOptional, default: None.\nThe JSON decoding must treat a string as equivalent to an array with one value, for example\n\"0x8888f1f195afa192cfee86069858\" must be decoded as [ \"0x8888f1f195afa192cfee86069858\" ]" + anyOf: + - $ref: "#/components/schemas/EthAddressList" + - type: "null" + toBlock: + description: "Interpreted as an epoch (in hex) or one of \"latest\" for last mined block, \"pending\" for not yet committed messages.\nOptional, default: \"latest\".\nNote: \"earliest\" is not a permitted value." + type: + - string + - "null" + EthTxReceipt: + type: object + properties: + blockHash: + $ref: "#/components/schemas/EthHash" + blockNumber: + $ref: "#/components/schemas/EthUint64" + contractAddress: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + cumulativeGasUsed: + $ref: "#/components/schemas/EthUint64" + effectiveGasPrice: + $ref: "#/components/schemas/EthBigInt" + from: + $ref: "#/components/schemas/EthAddress" + gasUsed: + $ref: "#/components/schemas/EthUint64" + logs: + type: array + items: + $ref: "#/components/schemas/EthLog" + logsBloom: + $ref: "#/components/schemas/EthBytes" + root: + $ref: "#/components/schemas/EthHash" + status: + $ref: "#/components/schemas/EthUint64" + to: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + transactionHash: + $ref: "#/components/schemas/EthHash" + transactionIndex: + $ref: "#/components/schemas/EthUint64" + type: + $ref: "#/components/schemas/EthUint64" + required: + - transactionHash + - transactionIndex + - blockHash + - blockNumber + - from + - root + - status + - cumulativeGasUsed + - gasUsed + - effectiveGasPrice + - logsBloom + - logs + - type + EthUint64: + type: string + Event: + type: object + properties: + Emitter: + description: Actor ID + type: integer + format: uint64 + minimum: 0 + Entries: + type: array + items: + $ref: "#/components/schemas/EventEntry" + required: + - Emitter + - Entries + EventEntry: + type: object + properties: + Codec: + type: integer + format: uint64 + minimum: 0 + Flags: + type: integer + format: uint64 + minimum: 0 + Key: + type: string + Value: + $ref: "#/components/schemas/Base64String" + required: + - Flags + - Key + - Codec + - Value + ExecutionTrace: + type: object + properties: + GasCharges: + type: array + items: + $ref: "#/components/schemas/GasTrace" + InvokedActor: + anyOf: + - $ref: "#/components/schemas/ActorTrace" + - type: "null" + Msg: + $ref: "#/components/schemas/MessageTrace" + MsgRct: + $ref: "#/components/schemas/ReturnTrace" + Subcalls: + $ref: "#/components/schemas/Nullable_Array_of_ExecutionTrace" + required: + - Msg + - MsgRct + - GasCharges + - Subcalls + ExitCode: + description: "`Newtype` wrapper for the FVM `ExitCode`.\n\n# Examples\n```\n# use forest::doctest_private::ExitCode;\nlet fvm2_success = fvm_shared2::error::ExitCode::new(0);\nlet fvm3_success = fvm_shared3::error::ExitCode::new(0);\n\nlet shim_from_v2 = ExitCode::from(fvm2_success);\nlet shim_from_v3 = ExitCode::from(fvm3_success);\n\nassert_eq!(shim_from_v2, shim_from_v3);\nassert_eq!(shim_from_v2, fvm2_success.into());\nassert_eq!(shim_from_v3, fvm3_success.into());\n```" + type: integer + format: uint32 + minimum: 0 + ExtBlockNumberOrHash: + anyOf: + - type: string + - $ref: "#/components/schemas/EthInt64" + - $ref: "#/components/schemas/EthHash" + - $ref: "#/components/schemas/BlockNumber" + - $ref: "#/components/schemas/BlockHash" + ExtendedSectorInfo: + type: object + properties: + SealProof: + $ref: "#/components/schemas/int64" + SealedCID: + $ref: "#/components/schemas/Cid" + SectorKey: + $ref: "#/components/schemas/Nullable_Cid" + SectorNumber: + type: integer + format: uint64 + minimum: 0 + required: + - SealProof + - SectorNumber + - SectorKey + - SealedCID + F3InstanceProgress: + type: object + properties: + ID: + type: integer + format: uint64 + minimum: 0 + Input: + $ref: "#/components/schemas/Nullable_Array_of_ECTipSet" + Phase: + type: integer + format: uint8 + maximum: 255 + minimum: 0 + Round: + type: integer + format: uint64 + minimum: 0 + required: + - ID + - Round + - Phase + F3Manifest: + type: object + properties: + BootstrapEpoch: + type: integer + format: int64 + CatchUpAlignment: + type: integer + format: uint64 + minimum: 0 + CertificateExchange: + $ref: "#/components/schemas/CertificateExchangeConfig" + ChainExchange: + $ref: "#/components/schemas/ChainExchangeConfig" + CommitteeLookback: + type: integer + format: uint64 + minimum: 0 + EC: + $ref: "#/components/schemas/EcConfig" + Gpbft: + $ref: "#/components/schemas/GpbftConfig" + InitialInstance: + type: integer + format: uint64 + minimum: 0 + InitialPowerTable: + type: string + NetworkName: + type: string + PartialMessageManager: + $ref: "#/components/schemas/PartialMessageManagerConfig" + ProtocolVersion: + type: integer + format: uint64 + minimum: 0 + PubSub: + $ref: "#/components/schemas/PubSubConfig" + required: + - ProtocolVersion + - InitialInstance + - BootstrapEpoch + - NetworkName + - InitialPowerTable + - CommitteeLookback + - CatchUpAlignment + - Gpbft + - EC + - CertificateExchange + - PubSub + - ChainExchange + - PartialMessageManager + F3Participant: + type: object + properties: + FromInstance: + type: integer + format: uint64 + minimum: 0 + MinerID: + type: integer + format: uint64 + minimum: 0 + ValidityTerm: + type: integer + format: uint64 + minimum: 0 + required: + - MinerID + - FromInstance + - ValidityTerm + F3PowerEntryLotusJson: + type: object + properties: + ID: + type: integer + format: uint64 + minimum: 0 + Power: + type: string + PubKey: + type: string + required: + - ID + - Power + - PubKey + F3TipSet: + type: object + properties: + beacon: + description: "The verifiable oracle randomness used to elect this block's author leader" + type: string + epoch: + description: "The period in which a new block is generated.\nThere may be multiple rounds in an epoch." + type: integer + format: int64 + key: + $ref: "#/components/schemas/F3TipSetKey" + timestamp: + description: "Block creation time, in seconds since the Unix epoch" + type: integer + format: uint64 + minimum: 0 + required: + - key + - beacon + - epoch + - timestamp + F3TipSetKey: + description: TipSetKey is the canonically ordered concatenation of the block CIDs in a tipset. + type: string + FilecoinSnapshotVersion: + type: string + enum: + - V1 + - V2 + FilterID: + $ref: "#/components/schemas/EthHash" + FinalityCertificate: + type: object + properties: + ECChain: + $ref: "#/components/schemas/NonEmpty_Array_of_ECTipSet" + GPBFTInstance: + type: integer + format: uint64 + minimum: 0 + PowerTableDelta: + $ref: "#/components/schemas/Nullable_Array_of_PowerTableDelta" + Signature: + type: string + Signers: + type: array + items: + type: integer + format: uint8 + maximum: 255 + minimum: 0 + SupplementalData: + $ref: "#/components/schemas/SupplementalData" + required: + - GPBFTInstance + - ECChain + - SupplementalData + - Signers + - Signature + FlattenedApiMessage: + type: object + properties: + CID: + $ref: "#/components/schemas/Cid" + From: + $ref: "#/components/schemas/Address" + GasFeeCap: + $ref: "#/components/schemas/TokenAmount" + default: "0" + GasLimit: + type: integer + format: uint64 + default: 0 + minimum: 0 + GasPremium: + $ref: "#/components/schemas/TokenAmount" + default: "0" + Method: + type: integer + format: uint64 + default: 0 + minimum: 0 + Nonce: + type: integer + format: uint64 + default: 0 + minimum: 0 + Params: + $ref: "#/components/schemas/Nullable_Base64String" + To: + $ref: "#/components/schemas/Address" + Value: + $ref: "#/components/schemas/TokenAmount" + default: "0" + Version: + type: integer + format: uint64 + default: 0 + minimum: 0 + required: + - To + - From + - CID + ForestChainExportDiffParams: + type: object + properties: + depth: + type: integer + format: int64 + from: + type: integer + format: int64 + output_path: + type: string + to: + type: integer + format: int64 + required: + - from + - to + - depth + - output_path + ForestChainExportParams: + type: object + properties: + dry_run: + type: boolean + epoch: + type: integer + format: int64 + output_path: + type: string + recent_roots: + type: integer + format: int64 + skip_checksum: + type: boolean + tipset_keys: + $ref: "#/components/schemas/Nullable_Array_of_Cid" + version: + $ref: "#/components/schemas/FilecoinSnapshotVersion" + required: + - version + - epoch + - recent_roots + - output_path + - tipset_keys + - skip_checksum + - dry_run + ForestComputeStateOutput: + type: object + properties: + Epoch: + type: integer + format: int64 + StateRoot: + $ref: "#/components/schemas/Cid" + TipsetKey: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + required: + - StateRoot + - Epoch + - TipsetKey + ForkSyncInfo: + description: Contains information about a specific chain/fork the node is actively tracking or syncing. + type: object + properties: + last_updated: + description: Last time status for this fork was updated. + type: + - string + - "null" + format: date-time + stage: + description: The current stage of processing for this fork. + $ref: "#/components/schemas/ForkSyncStage" + start_time: + description: When processing for this fork started. + type: + - string + - "null" + format: date-time + target_epoch: + description: The target epoch for this synchronization task. + type: integer + format: int64 + target_sync_epoch_start: + description: "The lowest epoch that still needs processing (fetching or validating) for this target.\nThis helps indicate the start of the current sync range." + type: integer + format: int64 + target_tipset_key: + description: The target tipset key for this synchronization task. + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + validated_chain_head_epoch: + description: "The epoch of the heaviest fully validated tipset on the node's main chain.\nThis shows overall node progress, distinct from fork-specific progress." + type: integer + format: int64 + required: + - target_tipset_key + - target_epoch + - target_sync_epoch_start + - stage + - validated_chain_head_epoch + ForkSyncStage: + description: Represents the stage of processing for a specific chain fork being tracked. + oneOf: + - description: Fetching necessary block headers for this fork. + type: string + const: FetchingHeaders + - description: Validating tipsets and messages for this fork. + type: string + const: ValidatingTipsets + - description: "This fork sync process is complete (e.g., reached target, merged, or deemed invalid)." + type: string + const: Complete + - description: "Progress is stalled, potentially waiting for dependencies." + type: string + const: Stalled + - description: An error occurred processing this specific fork. + type: string + const: Error + ForkUpgradeParams: + type: object + properties: + BreezeGasTampingDuration: + type: integer + format: int64 + UpgradeAssemblyHeight: + type: integer + format: int64 + UpgradeBreezeHeight: + type: integer + format: int64 + UpgradeCalicoHeight: + type: integer + format: int64 + UpgradeChocolateHeight: + type: integer + format: int64 + UpgradeClausHeight: + type: integer + format: int64 + UpgradeDragonHeight: + type: integer + format: int64 + UpgradeHyggeHeight: + type: integer + format: int64 + UpgradeHyperdriveHeight: + type: integer + format: int64 + UpgradeIgnitionHeight: + type: integer + format: int64 + UpgradeKumquatHeight: + type: integer + format: int64 + UpgradeLiftoffHeight: + type: integer + format: int64 + UpgradeLightningHeight: + type: integer + format: int64 + UpgradeNorwegianHeight: + type: integer + format: int64 + UpgradeOhSnapHeight: + type: integer + format: int64 + UpgradeOrangeHeight: + type: integer + format: int64 + UpgradePersianHeight: + type: integer + format: int64 + UpgradePhoenixHeight: + type: integer + format: int64 + UpgradeRefuelHeight: + type: integer + format: int64 + UpgradeSharkHeight: + type: integer + format: int64 + UpgradeSkyrHeight: + type: integer + format: int64 + UpgradeSmokeHeight: + type: integer + format: int64 + UpgradeTapeHeight: + type: integer + format: int64 + UpgradeTeepHeight: + type: integer + format: int64 + UpgradeThunderHeight: + type: integer + format: int64 + UpgradeTockHeight: + type: integer + format: int64 + UpgradeTrustHeight: + type: integer + format: int64 + UpgradeTuktukHeight: + type: integer + format: int64 + UpgradeTurboHeight: + type: integer + format: int64 + UpgradeWaffleHeight: + type: integer + format: int64 + UpgradeWatermelonHeight: + type: integer + format: int64 + required: + - UpgradeSmokeHeight + - UpgradeBreezeHeight + - UpgradeIgnitionHeight + - UpgradeLiftoffHeight + - UpgradeAssemblyHeight + - UpgradeRefuelHeight + - UpgradeTapeHeight + - UpgradeKumquatHeight + - BreezeGasTampingDuration + - UpgradeCalicoHeight + - UpgradePersianHeight + - UpgradeOrangeHeight + - UpgradeClausHeight + - UpgradeTrustHeight + - UpgradeNorwegianHeight + - UpgradeTurboHeight + - UpgradeHyperdriveHeight + - UpgradeChocolateHeight + - UpgradeOhSnapHeight + - UpgradeSkyrHeight + - UpgradeSharkHeight + - UpgradeHyggeHeight + - UpgradeLightningHeight + - UpgradeThunderHeight + - UpgradeWatermelonHeight + - UpgradeDragonHeight + - UpgradePhoenixHeight + - UpgradeWaffleHeight + - UpgradeTuktukHeight + - UpgradeTeepHeight + - UpgradeTockHeight + GasTrace: + type: object + properties: + Name: + type: string + cg: + type: integer + format: uint64 + minimum: 0 + sg: + type: integer + format: uint64 + minimum: 0 + tg: + type: integer + format: uint64 + minimum: 0 + tt: + type: integer + format: uint64 + minimum: 0 + required: + - Name + - tg + - cg + - sg + - tt + GossipBlock: + type: object + properties: + BlsMessages: + $ref: "#/components/schemas/Cid" + Header: + $ref: "#/components/schemas/BlockHeader" + SecpkMessages: + $ref: "#/components/schemas/Cid" + required: + - Header + - BlsMessages + - SecpkMessages + GpbftConfig: + type: object + properties: + ChainProposedLength: + type: integer + format: uint + minimum: 0 + Delta: + type: integer + format: uint64 + minimum: 0 + DeltaBackOffExponent: + type: number + format: double + MaxLookaheadRounds: + type: integer + format: uint64 + minimum: 0 + QualityDeltaMultiplier: + type: number + format: double + RebroadcastBackoffBase: + type: integer + format: uint64 + minimum: 0 + RebroadcastBackoffExponent: + type: number + format: double + RebroadcastBackoffMax: + type: integer + format: uint64 + minimum: 0 + RebroadcastBackoffSpread: + type: number + format: double + required: + - Delta + - DeltaBackOffExponent + - QualityDeltaMultiplier + - MaxLookaheadRounds + - ChainProposedLength + - RebroadcastBackoffBase + - RebroadcastBackoffExponent + - RebroadcastBackoffSpread + - RebroadcastBackoffMax + KeyInfo: + type: object + properties: + PrivateKey: + $ref: "#/components/schemas/Base64String" + Type: + $ref: "#/components/schemas/SignatureTypeLotusJson" + required: + - Type + - PrivateKey + Map_of_Cid: + type: object + additionalProperties: + $ref: "#/components/schemas/Cid" + MarketBalance: + description: External format for returning market balance from state. + type: object + properties: + Escrow: + $ref: "#/components/schemas/TokenAmount" + Locked: + $ref: "#/components/schemas/TokenAmount" + required: + - Escrow + - Locked + Message: + type: object + properties: + From: + $ref: "#/components/schemas/Address" + GasFeeCap: + $ref: "#/components/schemas/TokenAmount" + default: "0" + GasLimit: + type: integer + format: uint64 + default: 0 + minimum: 0 + GasPremium: + $ref: "#/components/schemas/TokenAmount" + default: "0" + Method: + type: integer + format: uint64 + default: 0 + minimum: 0 + Nonce: + type: integer + format: uint64 + default: 0 + minimum: 0 + Params: + $ref: "#/components/schemas/Nullable_Base64String" + To: + $ref: "#/components/schemas/Address" + Value: + $ref: "#/components/schemas/TokenAmount" + default: "0" + Version: + type: integer + format: uint64 + default: 0 + minimum: 0 + required: + - To + - From + MessageFilter: + type: object + properties: + From: + $ref: "#/components/schemas/Nullable_Address" + To: + $ref: "#/components/schemas/Nullable_Address" + required: + - From + - To + MessageGasCost: + type: object + properties: + BaseFeeBurn: + $ref: "#/components/schemas/TokenAmount" + GasUsed: + $ref: "#/components/schemas/TokenAmount" + Message: + $ref: "#/components/schemas/Nullable_Cid" + MinerPenalty: + $ref: "#/components/schemas/TokenAmount" + MinerTip: + $ref: "#/components/schemas/TokenAmount" + OverEstimationBurn: + $ref: "#/components/schemas/TokenAmount" + Refund: + $ref: "#/components/schemas/TokenAmount" + TotalCost: + $ref: "#/components/schemas/TokenAmount" + required: + - Message + - GasUsed + - BaseFeeBurn + - OverEstimationBurn + - MinerPenalty + - MinerTip + - Refund + - TotalCost + MessageLookup: + type: object + properties: + Height: + type: integer + format: int64 + Message: + $ref: "#/components/schemas/Cid" + Receipt: + $ref: "#/components/schemas/Receipt" + ReturnDec: true + TipSet: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + required: + - Receipt + - TipSet + - Height + - Message + - ReturnDec + MessageSendSpec: + type: object + properties: + MaxFee: + $ref: "#/components/schemas/TokenAmount" + MaximizeFeeCap: + type: boolean + MsgUuid: + type: string + format: uuid + required: + - MaxFee + - MsgUuid + - MaximizeFeeCap + MessageTrace: + type: object + properties: + From: + $ref: "#/components/schemas/Address" + GasLimit: + type: + - integer + - "null" + format: uint64 + minimum: 0 + Method: + type: integer + format: uint64 + minimum: 0 + Params: + $ref: "#/components/schemas/Base64String" + ParamsCodec: + type: integer + format: uint64 + minimum: 0 + ReadOnly: + type: + - boolean + - "null" + To: + $ref: "#/components/schemas/Address" + Value: + $ref: "#/components/schemas/TokenAmount" + required: + - From + - To + - Value + - Method + - Params + - ParamsCodec + MinerInfo: + type: object + properties: + Beneficiary: + $ref: "#/components/schemas/Address" + BeneficiaryTerm: + $ref: "#/components/schemas/BeneficiaryTerm" + ConsensusFaultElapsed: + type: integer + format: int64 + ControlAddresses: + $ref: "#/components/schemas/Nullable_Array_of_Address" + Multiaddrs: + $ref: "#/components/schemas/Nullable_Array_of_Base64String" + NewWorker: + $ref: "#/components/schemas/Nullable_Address" + Owner: + $ref: "#/components/schemas/Address" + PeerId: + $ref: "#/components/schemas/Nullable_string" + PendingBeneficiaryTerm: + $ref: "#/components/schemas/Nullable_PendingBeneficiaryChange" + PendingOwnerAddress: + $ref: "#/components/schemas/Nullable_Address" + SectorSize: + $ref: "#/components/schemas/SectorSize" + WindowPoStPartitionSectors: + type: integer + format: uint64 + minimum: 0 + WindowPoStProofType: + type: string + Worker: + $ref: "#/components/schemas/Address" + WorkerChangeEpoch: + type: integer + format: int64 + required: + - Owner + - Worker + - NewWorker + - ControlAddresses + - WorkerChangeEpoch + - PeerId + - Multiaddrs + - WindowPoStProofType + - SectorSize + - WindowPoStPartitionSectors + - ConsensusFaultElapsed + - PendingOwnerAddress + - Beneficiary + - BeneficiaryTerm + - PendingBeneficiaryTerm + MinerPartitions: + type: object + properties: + ActiveSectors: + $ref: "#/components/schemas/BitField" + AllSectors: + $ref: "#/components/schemas/BitField" + FaultySectors: + $ref: "#/components/schemas/BitField" + LiveSectors: + $ref: "#/components/schemas/BitField" + RecoveringSectors: + $ref: "#/components/schemas/BitField" + required: + - AllSectors + - FaultySectors + - RecoveringSectors + - LiveSectors + - ActiveSectors + MinerPower: + type: object + properties: + HasMinPower: + type: boolean + MinerPower: + $ref: "#/components/schemas/Claim" + TotalPower: + $ref: "#/components/schemas/Claim" + required: + - MinerPower + - TotalPower + - HasMinPower + MinerSectors: + type: object + properties: + Active: + type: integer + format: uint64 + minimum: 0 + Faulty: + type: integer + format: uint64 + minimum: 0 + Live: + type: integer + format: uint64 + minimum: 0 + required: + - Live + - Active + - Faulty + MiningBaseInfo: + type: object + properties: + BeaconEntries: + $ref: "#/components/schemas/Nullable_Array_of_BeaconEntry" + EligibleForMining: + type: boolean + MinerPower: + $ref: "#/components/schemas/BigInt" + NetworkPower: + $ref: "#/components/schemas/BigInt" + PrevBeaconEntry: + $ref: "#/components/schemas/BeaconEntry" + SectorSize: + type: integer + format: uint64 + minimum: 0 + Sectors: + $ref: "#/components/schemas/Nullable_Array_of_ExtendedSectorInfo" + WorkerKey: + $ref: "#/components/schemas/Address" + required: + - MinerPower + - NetworkPower + - Sectors + - WorkerKey + - SectorSize + - PrevBeaconEntry + - BeaconEntries + - EligibleForMining + MsigVesting: + type: object + properties: + InitialBalance: + $ref: "#/components/schemas/BigInt" + StartEpoch: + type: integer + format: int64 + UnlockDuration: + type: integer + format: int64 + required: + - InitialBalance + - StartEpoch + - UnlockDuration + NatStatusResult: + type: object + properties: + PublicAddrs: + type: + - array + - "null" + items: + type: string + Reachability: + type: integer + format: int32 + required: + - Reachability + NetInfoResult: + type: object + properties: + num_connections: + type: integer + format: uint32 + minimum: 0 + num_established: + type: integer + format: uint32 + minimum: 0 + num_peers: + type: integer + format: uint + minimum: 0 + num_pending: + type: integer + format: uint32 + minimum: 0 + num_pending_incoming: + type: integer + format: uint32 + minimum: 0 + num_pending_outgoing: + type: integer + format: uint32 + minimum: 0 + required: + - num_peers + - num_connections + - num_pending + - num_pending_incoming + - num_pending_outgoing + - num_established + NetworkParams: + type: object + properties: + BlockDelaySecs: + type: integer + format: uint64 + minimum: 0 + ConsensusMinerMinPower: + $ref: "#/components/schemas/BigInt" + Eip155ChainID: + type: integer + format: uint64 + minimum: 0 + ForkUpgradeParams: + $ref: "#/components/schemas/ForkUpgradeParams" + NetworkName: + type: string + PreCommitChallengeDelay: + type: integer + format: int64 + required: + - NetworkName + - BlockDelaySecs + - ConsensusMinerMinPower + - PreCommitChallengeDelay + - ForkUpgradeParams + - Eip155ChainID + NetworkVersion: + description: "Specifies the network version\n\n# Examples\n```\n# use forest::doctest_private::NetworkVersion;\nlet v0 = NetworkVersion::V0;\n\n// dereference to convert to FVM4\nassert_eq!(fvm_shared4::version::NetworkVersion::V0, *v0);\n\n// use `.into()` when FVM3 has to be specified.\nassert_eq!(fvm_shared3::version::NetworkVersion::V0, v0.into());\n\n// use `.into()` when FVM2 has to be specified.\nassert_eq!(fvm_shared2::version::NetworkVersion::V0, v0.into());\n```" + type: integer + format: uint32 + minimum: 0 + NodeChainStatus: + type: object + properties: + blocks_per_tipset_last_100: + type: number + format: double + blocks_per_tipset_last_finality: + type: number + format: double + required: + - blocks_per_tipset_last_100 + - blocks_per_tipset_last_finality + NodePeerStatus: + type: object + properties: + peers_to_publish_blocks: + type: integer + format: uint32 + minimum: 0 + peers_to_publish_msgs: + type: integer + format: uint32 + minimum: 0 + required: + - peers_to_publish_msgs + - peers_to_publish_blocks + NodeStatusResult: + type: object + properties: + chain_status: + $ref: "#/components/schemas/NodeChainStatus" + peer_status: + $ref: "#/components/schemas/NodePeerStatus" + sync_status: + $ref: "#/components/schemas/NodeSyncStatus" + required: + - sync_status + - peer_status + - chain_status + NodeSyncStatus: + type: object + properties: + behind: + type: integer + format: uint64 + minimum: 0 + epoch: + type: integer + format: uint64 + minimum: 0 + required: + - epoch + - behind + NodeSyncStatus2: + description: Represents the overall synchronization status of the Forest node. + oneOf: + - description: "Node is initializing, status not yet determined." + type: string + const: Initializing + - description: Node is significantly behind the network head and actively downloading/validating. + type: string + const: Syncing + - description: "Node is close to the network head, within the `SYNCED_EPOCH_THRESHOLD`." + type: string + const: Synced + - description: An error occurred during the sync process. + type: string + const: Error + - description: Node is configured to not sync (offline mode). + type: string + const: Offline + NonEmpty_Array_of_BlockHeader: + type: array + items: + $ref: "#/components/schemas/BlockHeader" + minItems: 1 + NonEmpty_Array_of_Cid: + type: array + items: + $ref: "#/components/schemas/Cid" + minItems: 1 + NonEmpty_Array_of_ECTipSet: + type: array + items: + $ref: "#/components/schemas/ECTipSet" + minItems: 1 + Nonce: + type: string + Nullable_Address: + anyOf: + - $ref: "#/components/schemas/Address" + - type: "null" + Nullable_Array_of_Address: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Address" + Nullable_Array_of_Base64String: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Base64String" + Nullable_Array_of_BeaconEntry: + type: + - array + - "null" + items: + $ref: "#/components/schemas/BeaconEntry" + Nullable_Array_of_Cid: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Cid" + Nullable_Array_of_ECTipSet: + type: + - array + - "null" + items: + $ref: "#/components/schemas/ECTipSet" + Nullable_Array_of_ExecutionTrace: + type: + - array + - "null" + items: + $ref: "#/components/schemas/ExecutionTrace" + Nullable_Array_of_ExtendedSectorInfo: + type: + - array + - "null" + items: + $ref: "#/components/schemas/ExtendedSectorInfo" + Nullable_Array_of_Message: + type: + - array + - "null" + items: + $ref: "#/components/schemas/Message" + Nullable_Array_of_PoStProof: + type: + - array + - "null" + items: + $ref: "#/components/schemas/PoStProof" + Nullable_Array_of_PowerTableDelta: + type: + - array + - "null" + items: + $ref: "#/components/schemas/PowerTableDelta" + Nullable_Array_of_SignedMessage: + type: + - array + - "null" + items: + $ref: "#/components/schemas/SignedMessage" + Nullable_Array_of_uint64: + type: + - array + - "null" + items: + type: integer + format: uint64 + minimum: 0 + Nullable_Base64String: + anyOf: + - $ref: "#/components/schemas/Base64String" + - type: "null" + Nullable_Cid: + anyOf: + - $ref: "#/components/schemas/Cid" + - type: "null" + Nullable_ElectionProof: + anyOf: + - $ref: "#/components/schemas/ElectionProof" + - type: "null" + Nullable_PendingBeneficiaryChange: + anyOf: + - $ref: "#/components/schemas/PendingBeneficiaryChange" + - type: "null" + Nullable_Receipt: + anyOf: + - $ref: "#/components/schemas/Receipt" + - type: "null" + Nullable_Signature: + anyOf: + - $ref: "#/components/schemas/Signature" + - type: "null" + Nullable_Ticket: + anyOf: + - $ref: "#/components/schemas/Ticket" + - type: "null" + Nullable_TokenAmount: + anyOf: + - $ref: "#/components/schemas/TokenAmount" + - type: "null" + Nullable_string: + type: + - string + - "null" + ObjStat: + type: object + properties: + Links: + type: integer + format: uint + minimum: 0 + Size: + type: integer + format: uint + minimum: 0 + required: + - Size + - Links + PartialMessageManagerConfig: + type: object + properties: + CompletedMessagesBufferSize: + type: integer + format: int32 + MaxBufferedMessagesPerInstance: + type: integer + format: int32 + MaxCachedValidatedMessagesPerInstance: + type: integer + format: int32 + PendingChainBroadcastsBufferSize: + type: integer + format: int32 + PendingDiscoveredChainsBufferSize: + type: integer + format: int32 + PendingInstanceRemovalBufferSize: + type: integer + format: int32 + PendingPartialMessagesBufferSize: + type: integer + format: int32 + required: + - PendingDiscoveredChainsBufferSize + - PendingPartialMessagesBufferSize + - PendingChainBroadcastsBufferSize + - PendingInstanceRemovalBufferSize + - CompletedMessagesBufferSize + - MaxBufferedMessagesPerInstance + - MaxCachedValidatedMessagesPerInstance + PathChange: + oneOf: + - type: object + properties: + Type: + type: string + const: revert + Val: + $ref: "#/components/schemas/Tipset" + required: + - Type + - Val + - type: object + properties: + Type: + type: string + const: apply + Val: + $ref: "#/components/schemas/Tipset" + required: + - Type + - Val + PendingBeneficiaryChange: + type: object + properties: + ApprovedByBeneficiary: + type: boolean + ApprovedByNominee: + type: boolean + NewBeneficiary: + $ref: "#/components/schemas/Address" + NewExpiration: + type: integer + format: int64 + NewQuota: + $ref: "#/components/schemas/TokenAmount" + required: + - NewBeneficiary + - NewQuota + - NewExpiration + - ApprovedByBeneficiary + - ApprovedByNominee + PoStProof: + type: object + properties: + PoStProof: + $ref: "#/components/schemas/int64" + ProofBytes: + $ref: "#/components/schemas/Base64String" + required: + - PoStProof + - ProofBytes + PowerTableDelta: + type: object + properties: + ParticipantID: + type: integer + format: uint64 + minimum: 0 + PowerDelta: + type: string + SigningKey: + type: string + required: + - ParticipantID + - PowerDelta + - SigningKey + PubSubConfig: + type: object + properties: + ChainCompressionEnabled: + type: boolean + CompressionEnabled: + type: boolean + GMessageSubscriptionBufferSize: + type: integer + format: int32 + ValidatedMessageBufferSize: + type: integer + format: int32 + required: + - CompressionEnabled + - ChainCompressionEnabled + - GMessageSubscriptionBufferSize + - ValidatedMessageBufferSize + PublicVersion: + description: Represents the current version of the API. + type: object + properties: + APIVersion: + $ref: "#/components/schemas/ShiftingVersion" + BlockDelay: + type: integer + format: uint32 + minimum: 0 + Version: + type: string + required: + - Version + - APIVersion + - BlockDelay + Receipt: + type: object + properties: + EventsRoot: + $ref: "#/components/schemas/Nullable_Cid" + default: ~ + ExitCode: + type: integer + format: uint32 + minimum: 0 + GasUsed: + type: integer + format: uint64 + minimum: 0 + Return: + $ref: "#/components/schemas/Base64String" + required: + - ExitCode + - Return + - GasUsed + ReturnTrace: + type: object + properties: + ExitCode: + $ref: "#/components/schemas/ExitCode" + Return: + $ref: "#/components/schemas/Base64String" + ReturnCodec: + type: integer + format: uint64 + minimum: 0 + required: + - ExitCode + - Return + - ReturnCodec + SectorExpiration: + type: object + properties: + Early: + type: integer + format: int64 + OnTime: + type: integer + format: int64 + required: + - OnTime + - Early + SectorLocation: + type: object + properties: + Deadline: + type: integer + format: uint64 + minimum: 0 + Partition: + type: integer + format: uint64 + minimum: 0 + required: + - Deadline + - Partition + SectorOnChainInfo: + type: object + properties: + Activation: + description: Epoch during which the sector proof was accepted + type: integer + format: int64 + DailyFee: + description: "The total fee payable per day for this sector. The value of this field is set at the time of\nsector activation, extension and whenever a sector's `QAP` is changed. This fee is payable for\nthe lifetime of the sector and is aggregated in the deadline's `daily_fee` field.\n\nThis field is not included in the serialized form of the struct prior to the activation of\nFIP-0100, and is added as the 16th element of the array after that point only for new sectors\nor sectors that are updated after that point. For old sectors, the value of this field will\nalways be zero." + $ref: "#/components/schemas/TokenAmount" + DealWeight: + description: Integral of active deals over sector lifetime + $ref: "#/components/schemas/BigInt" + ExpectedDayReward: + description: "Expected one day projection of reward for sector computed at activation\ntime" + $ref: "#/components/schemas/Nullable_TokenAmount" + ExpectedStoragePledge: + description: "Expected twenty day projection of reward for sector computed at\nactivation time" + $ref: "#/components/schemas/Nullable_TokenAmount" + Expiration: + description: Epoch during which the sector expires + type: integer + format: int64 + Flags: + description: "Additional flags, see [`fil_actor_miner_state::v12::SectorOnChainInfoFlags`]" + type: integer + format: uint32 + minimum: 0 + InitialPledge: + description: Pledge collected to commit this sector + $ref: "#/components/schemas/TokenAmount" + PowerBaseEpoch: + description: "Epoch at which this sector's power was most recently updated" + type: integer + format: int64 + ReplacedDayReward: + $ref: "#/components/schemas/Nullable_TokenAmount" + SealProof: + description: The seal proof type implies the PoSt proofs + type: integer + format: int64 + SealedCID: + description: "`CommR`" + $ref: "#/components/schemas/Cid" + SectorKeyCID: + $ref: "#/components/schemas/Nullable_Cid" + SectorNumber: + type: integer + format: uint64 + minimum: 0 + VerifiedDealWeight: + description: Integral of active verified deals over sector lifetime + $ref: "#/components/schemas/BigInt" + required: + - SectorNumber + - SealProof + - SealedCID + - Activation + - Expiration + - Flags + - DealWeight + - VerifiedDealWeight + - InitialPledge + - ExpectedDayReward + - PowerBaseEpoch + - ExpectedStoragePledge + - ReplacedDayReward + - SectorKeyCID + - DailyFee + SectorPreCommitInfo: + type: object + properties: + DealIDs: + $ref: "#/components/schemas/Nullable_Array_of_uint64" + Expiration: + type: integer + format: int64 + SealProof: + $ref: "#/components/schemas/int64" + SealRandEpoch: + type: integer + format: int64 + SealedCID: + $ref: "#/components/schemas/Cid" + SectorNumber: + type: integer + format: uint64 + minimum: 0 + UnsealedCid: + $ref: "#/components/schemas/Nullable_Cid" + required: + - SealProof + - SectorNumber + - SealedCID + - SealRandEpoch + - DealIDs + - Expiration + - UnsealedCid + SectorPreCommitOnChainInfo: + type: object + properties: + Info: + $ref: "#/components/schemas/SectorPreCommitInfo" + PreCommitDeposit: + $ref: "#/components/schemas/TokenAmount" + PreCommitEpoch: + type: integer + format: int64 + required: + - Info + - PreCommitDeposit + - PreCommitEpoch + SectorSize: + type: integer + format: uint64 + minimum: 0 + ShiftingVersion: + description: "Integer based value on version information. Highest order bits for Major,\nMid order for Minor and lowest for Patch." + type: integer + format: uint32 + minimum: 0 + Signature: + type: object + properties: + Data: + $ref: "#/components/schemas/Base64String" + Type: + $ref: "#/components/schemas/SignatureTypeLotusJson" + required: + - Type + - Data + SignatureType: + description: Signature variants for Filecoin signatures. + type: string + enum: + - Secp256k1 + - Bls + - Delegated + SignatureTypeLotusJson: + anyOf: + - type: integer + format: uint8 + maximum: 255 + minimum: 0 + - $ref: "#/components/schemas/SignatureType" + SignedMessage: + type: object + properties: + CID: + $ref: "#/components/schemas/Nullable_Cid" + Message: + $ref: "#/components/schemas/Message" + Signature: + $ref: "#/components/schemas/Signature" + required: + - Message + - Signature + SnapshotProgressState: + oneOf: + - type: string + enum: + - Initializing + - Completed + - NotRequired + - type: object + properties: + InProgress: + type: object + properties: + message: + type: string + required: + - message + additionalProperties: false + required: + - InProgress + StateActorCodeCidsOutput: + type: object + properties: + ActorCids: + $ref: "#/components/schemas/Map_of_Cid" + ActorVersion: + type: string + Bundle: + $ref: "#/components/schemas/Cid" + Manifest: + $ref: "#/components/schemas/Cid" + NetworkVersion: + $ref: "#/components/schemas/NetworkVersion" + NetworkVersionRevision: + type: integer + format: int64 + required: + - NetworkVersion + - NetworkVersionRevision + - ActorVersion + - Manifest + - Bundle + - ActorCids + SupplementalData: + type: object + properties: + Commitments: + type: string + PowerTable: + type: string + required: + - Commitments + - PowerTable + SyncStatusReport: + description: "Contains information about the current status of the node's synchronization process." + type: object + properties: + active_forks: + description: List of active fork synchronization tasks the node is currently handling. + type: array + items: + $ref: "#/components/schemas/ForkSyncInfo" + current_head_epoch: + description: "The epoch of the heaviest validated tipset on the node's main chain." + type: integer + format: int64 + current_head_key: + description: The tipset key of the current heaviest validated tipset. + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + epochs_behind: + description: "Estimated number of epochs the node is behind the network head.\nCan be negative if the node is slightly ahead, due to estimation variance." + type: integer + format: int64 + last_updated: + description: Last time this status report was generated. + type: string + format: date-time + network_head_epoch: + type: integer + format: int64 + node_start_time: + description: When the node process started. + type: string + format: date-time + status: + description: "Overall status of the node's synchronization." + $ref: "#/components/schemas/NodeSyncStatus2" + required: + - status + - current_head_epoch + - current_head_key + - network_head_epoch + - epochs_behind + - active_forks + - node_start_time + - last_updated + Ticket: + type: object + properties: + VRFProof: + $ref: "#/components/schemas/Base64String" + required: + - VRFProof + Tipset: + $ref: "#/components/schemas/TipsetInner" + TipsetInner: + type: object + properties: + Blocks: + $ref: "#/components/schemas/NonEmpty_Array_of_BlockHeader" + Cids: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + Height: + type: integer + format: int64 + required: + - Cids + - Blocks + - Height + TokenAmount: + $ref: "#/components/schemas/BigInt" + TraceAction: + anyOf: + - $ref: "#/components/schemas/EthCallTraceAction" + - $ref: "#/components/schemas/EthCreateTraceAction" + TraceResult: + anyOf: + - $ref: "#/components/schemas/EthCallTraceResult" + - $ref: "#/components/schemas/EthCreateTraceResult" + Transaction: + type: object + properties: + Approved: + $ref: "#/components/schemas/Nullable_Array_of_Address" + ID: + type: integer + format: int64 + Method: + type: integer + format: uint64 + minimum: 0 + Params: + $ref: "#/components/schemas/Base64String" + To: + $ref: "#/components/schemas/Address" + Value: + $ref: "#/components/schemas/TokenAmount" + required: + - ID + - To + - Value + - Method + - Params + - Approved + Transactions: + anyOf: + - type: array + items: + type: string + - type: array + items: + $ref: "#/components/schemas/ApiEthTx" + int64: + type: integer + format: int64 diff --git a/src/rpc/snapshots/forest__rpc__tests__rpc__v2.snap b/src/rpc/snapshots/forest__rpc__tests__rpc__v2.snap new file mode 100644 index 000000000000..8c05524bd277 --- /dev/null +++ b/src/rpc/snapshots/forest__rpc__tests__rpc__v2.snap @@ -0,0 +1,2113 @@ +--- +source: src/rpc/mod.rs +expression: spec +--- +openrpc: 1.3.2 +info: + title: forest + version: 0.31.1 +methods: + - name: Filecoin.ChainGetTipSet + description: Returns the tipset with the specified CID. + params: + - name: tipsetSelector + required: true + schema: + $ref: "#/components/schemas/TipsetSelector" + result: + name: Filecoin.ChainGetTipSet.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/Tipset" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthAccounts + params: [] + result: + name: Filecoin.EthAccounts.Result + required: false + schema: + type: + - array + - "null" + items: + type: string + paramStructure: by-position + - name: eth_accounts + params: [] + result: + name: eth_accounts.Result + required: false + schema: + type: + - array + - "null" + items: + type: string + paramStructure: by-position + - name: Filecoin.EthAddressToFilecoinAddress + description: Converts an EthAddress into an f410 Filecoin Address + params: + - name: ethAddress + required: true + schema: + $ref: "#/components/schemas/EthAddress" + result: + name: Filecoin.EthAddressToFilecoinAddress.Result + required: true + schema: + $ref: "#/components/schemas/Address" + paramStructure: by-position + - name: Filecoin.FilecoinAddressToEthAddress + description: Converts any Filecoin address to an EthAddress + params: + - name: filecoinAddress + required: true + schema: + $ref: "#/components/schemas/Address" + - name: blockParam + required: true + schema: + anyOf: + - $ref: "#/components/schemas/BlockNumberOrPredefined" + - type: "null" + result: + name: Filecoin.FilecoinAddressToEthAddress.Result + required: true + schema: + $ref: "#/components/schemas/EthAddress" + paramStructure: by-position + - name: Filecoin.EthBlockNumber + params: [] + result: + name: Filecoin.EthBlockNumber.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: eth_blockNumber + params: [] + result: + name: eth_blockNumber.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: Filecoin.EthCall + params: + - name: tx + required: true + schema: + $ref: "#/components/schemas/EthCallMessage" + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + result: + name: Filecoin.EthCall.Result + required: true + schema: + $ref: "#/components/schemas/EthBytes" + paramStructure: by-position + - name: eth_call + params: + - name: tx + required: true + schema: + $ref: "#/components/schemas/EthCallMessage" + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + result: + name: eth_call.Result + required: true + schema: + $ref: "#/components/schemas/EthBytes" + paramStructure: by-position + - name: Filecoin.EthChainId + params: [] + result: + name: Filecoin.EthChainId.Result + required: true + schema: + type: string + paramStructure: by-position + - name: eth_chainId + params: [] + result: + name: eth_chainId.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.EthEstimateGas + params: + - name: tx + required: true + schema: + $ref: "#/components/schemas/EthCallMessage" + - name: blockParam + required: true + schema: + anyOf: + - $ref: "#/components/schemas/ExtBlockNumberOrHash" + - type: "null" + result: + name: Filecoin.EthEstimateGas.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: eth_estimateGas + params: + - name: tx + required: true + schema: + $ref: "#/components/schemas/EthCallMessage" + - name: blockParam + required: true + schema: + anyOf: + - $ref: "#/components/schemas/ExtBlockNumberOrHash" + - type: "null" + result: + name: eth_estimateGas.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: Filecoin.EthFeeHistory + params: + - name: blockCount + required: true + schema: + $ref: "#/components/schemas/EthUint64" + - name: newestBlockNumber + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + - name: rewardPercentiles + required: true + schema: + type: + - array + - "null" + items: + type: number + format: double + result: + name: Filecoin.EthFeeHistory.Result + required: true + schema: + $ref: "#/components/schemas/EthFeeHistoryResult" + paramStructure: by-position + - name: eth_feeHistory + params: + - name: blockCount + required: true + schema: + $ref: "#/components/schemas/EthUint64" + - name: newestBlockNumber + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + - name: rewardPercentiles + required: true + schema: + type: + - array + - "null" + items: + type: number + format: double + result: + name: eth_feeHistory.Result + required: true + schema: + $ref: "#/components/schemas/EthFeeHistoryResult" + paramStructure: by-position + - name: Filecoin.EthGasPrice + description: Returns the current gas price in attoFIL + params: [] + result: + name: Filecoin.EthGasPrice.Result + required: true + schema: + $ref: "#/components/schemas/EthBigInt" + paramStructure: by-position + - name: eth_gasPrice + description: Returns the current gas price in attoFIL + params: [] + result: + name: eth_gasPrice.Result + required: true + schema: + $ref: "#/components/schemas/EthBigInt" + paramStructure: by-position + - name: Filecoin.EthGetBalance + description: Returns the balance of an Ethereum address at the specified block state + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + result: + name: Filecoin.EthGetBalance.Result + required: true + schema: + $ref: "#/components/schemas/EthBigInt" + paramStructure: by-position + - name: eth_getBalance + description: Returns the balance of an Ethereum address at the specified block state + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + result: + name: eth_getBalance.Result + required: true + schema: + $ref: "#/components/schemas/EthBigInt" + paramStructure: by-position + - name: Filecoin.EthGetBlockByHash + params: + - name: blockHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: fullTxInfo + required: true + schema: + type: boolean + result: + name: Filecoin.EthGetBlockByHash.Result + required: true + schema: + $ref: "#/components/schemas/Block" + paramStructure: by-position + - name: eth_getBlockByHash + params: + - name: blockHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: fullTxInfo + required: true + schema: + type: boolean + result: + name: eth_getBlockByHash.Result + required: true + schema: + $ref: "#/components/schemas/Block" + paramStructure: by-position + - name: Filecoin.EthGetBlockByNumber + description: Retrieves a block by its number or a special tag. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrPredefined" + - name: fullTxInfo + required: true + schema: + type: boolean + result: + name: Filecoin.EthGetBlockByNumber.Result + required: true + schema: + $ref: "#/components/schemas/Block" + paramStructure: by-position + - name: eth_getBlockByNumber + description: Retrieves a block by its number or a special tag. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrPredefined" + - name: fullTxInfo + required: true + schema: + type: boolean + result: + name: eth_getBlockByNumber.Result + required: true + schema: + $ref: "#/components/schemas/Block" + paramStructure: by-position + - name: Filecoin.EthGetBlockReceipts + description: "Retrieves all transaction receipts for a block by its number, hash or a special tag." + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + result: + name: Filecoin.EthGetBlockReceipts.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthTxReceipt" + paramStructure: by-position + - name: eth_getBlockReceipts + description: "Retrieves all transaction receipts for a block by its number, hash or a special tag." + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + result: + name: eth_getBlockReceipts.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthTxReceipt" + paramStructure: by-position + - name: Filecoin.EthGetBlockReceiptsLimited + description: "Retrieves all transaction receipts for a block identified by its number, hash or a special tag along with an optional limit on the chain epoch for state resolution." + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + - name: limit + required: true + schema: + type: integer + format: int64 + result: + name: Filecoin.EthGetBlockReceiptsLimited.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthTxReceipt" + paramStructure: by-position + - name: eth_getBlockReceiptsLimited + description: "Retrieves all transaction receipts for a block identified by its number, hash or a special tag along with an optional limit on the chain epoch for state resolution." + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + - name: limit + required: true + schema: + type: integer + format: int64 + result: + name: eth_getBlockReceiptsLimited.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthTxReceipt" + paramStructure: by-position + - name: Filecoin.EthGetBlockTransactionCountByHash + params: + - name: blockHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: Filecoin.EthGetBlockTransactionCountByHash.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: eth_getBlockTransactionCountByHash + params: + - name: blockHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: eth_getBlockTransactionCountByHash.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: Filecoin.EthGetBlockTransactionCountByNumber + description: Returns the number of transactions in a block identified by its block number or a special tag. + params: + - name: blockNumber + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrPredefined" + result: + name: Filecoin.EthGetBlockTransactionCountByNumber.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: eth_getBlockTransactionCountByNumber + description: Returns the number of transactions in a block identified by its block number or a special tag. + params: + - name: blockNumber + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrPredefined" + result: + name: eth_getBlockTransactionCountByNumber.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: Filecoin.EthGetCode + description: "Retrieves the contract code at a specific address and block state, identified by its number, hash, or a special tag." + params: + - name: ethAddress + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: blockNumberOrHash + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + result: + name: Filecoin.EthGetCode.Result + required: true + schema: + $ref: "#/components/schemas/EthBytes" + paramStructure: by-position + - name: eth_getCode + description: "Retrieves the contract code at a specific address and block state, identified by its number, hash, or a special tag." + params: + - name: ethAddress + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: blockNumberOrHash + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + result: + name: eth_getCode.Result + required: true + schema: + $ref: "#/components/schemas/EthBytes" + paramStructure: by-position + - name: Filecoin.EthGetLogs + params: + - name: ethFilter + required: true + schema: + $ref: "#/components/schemas/EthFilterSpec" + result: + name: Filecoin.EthGetLogs.Result + required: true + schema: + $ref: "#/components/schemas/EthFilterResult" + paramStructure: by-position + - name: eth_getLogs + params: + - name: ethFilter + required: true + schema: + $ref: "#/components/schemas/EthFilterSpec" + result: + name: eth_getLogs.Result + required: true + schema: + $ref: "#/components/schemas/EthFilterResult" + paramStructure: by-position + - name: Filecoin.EthGetFilterLogs + params: + - name: filterId + required: true + schema: + $ref: "#/components/schemas/FilterID" + result: + name: Filecoin.EthGetFilterLogs.Result + required: true + schema: + $ref: "#/components/schemas/EthFilterResult" + paramStructure: by-position + - name: eth_getFilterLogs + params: + - name: filterId + required: true + schema: + $ref: "#/components/schemas/FilterID" + result: + name: eth_getFilterLogs.Result + required: true + schema: + $ref: "#/components/schemas/EthFilterResult" + paramStructure: by-position + - name: Filecoin.EthGetFilterChanges + description: Returns event logs which occurred since the last poll + params: + - name: filterId + required: true + schema: + $ref: "#/components/schemas/FilterID" + result: + name: Filecoin.EthGetFilterChanges.Result + required: true + schema: + $ref: "#/components/schemas/EthFilterResult" + paramStructure: by-position + - name: eth_getFilterChanges + description: Returns event logs which occurred since the last poll + params: + - name: filterId + required: true + schema: + $ref: "#/components/schemas/FilterID" + result: + name: eth_getFilterChanges.Result + required: true + schema: + $ref: "#/components/schemas/EthFilterResult" + paramStructure: by-position + - name: Filecoin.EthGetMessageCidByTransactionHash + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: Filecoin.EthGetMessageCidByTransactionHash.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/Cid" + - type: "null" + paramStructure: by-position + - name: eth_getMessageCidByTransactionHash + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: eth_getMessageCidByTransactionHash.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/Cid" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthGetStorageAt + description: "Retrieves the storage value at a specific position for a contract\n at a given block state, identified by its number, hash, or a special tag." + params: + - name: ethAddress + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: position + required: true + schema: + $ref: "#/components/schemas/EthBytes" + - name: blockNumberOrHash + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + result: + name: Filecoin.EthGetStorageAt.Result + required: true + schema: + $ref: "#/components/schemas/EthBytes" + paramStructure: by-position + - name: eth_getStorageAt + description: "Retrieves the storage value at a specific position for a contract\n at a given block state, identified by its number, hash, or a special tag." + params: + - name: ethAddress + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: position + required: true + schema: + $ref: "#/components/schemas/EthBytes" + - name: blockNumberOrHash + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + result: + name: eth_getStorageAt.Result + required: true + schema: + $ref: "#/components/schemas/EthBytes" + paramStructure: by-position + - name: Filecoin.EthGetTransactionByHash + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: Filecoin.EthGetTransactionByHash.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionByHash + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: eth_getTransactionByHash.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthGetTransactionByHashLimited + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: limit + required: true + schema: + type: integer + format: int64 + result: + name: Filecoin.EthGetTransactionByHashLimited.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionByHashLimited + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: limit + required: true + schema: + type: integer + format: int64 + result: + name: eth_getTransactionByHashLimited.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthGetTransactionCount + params: + - name: sender + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + result: + name: Filecoin.EthGetTransactionCount.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: eth_getTransactionCount + params: + - name: sender + required: true + schema: + $ref: "#/components/schemas/EthAddress" + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + result: + name: eth_getTransactionCount.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: Filecoin.EthGetTransactionHashByCid + params: + - name: cid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: Filecoin.EthGetTransactionHashByCid.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/EthHash" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionHashByCid + params: + - name: cid + required: true + schema: + $ref: "#/components/schemas/Cid" + result: + name: eth_getTransactionHashByCid.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/EthHash" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthGetTransactionByBlockNumberAndIndex + description: Retrieves a transaction by its block number and index. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrPredefined" + - name: txIndex + required: true + schema: + $ref: "#/components/schemas/EthUint64" + result: + name: Filecoin.EthGetTransactionByBlockNumberAndIndex.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionByBlockNumberAndIndex + description: Retrieves a transaction by its block number and index. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/BlockNumberOrPredefined" + - name: txIndex + required: true + schema: + $ref: "#/components/schemas/EthUint64" + result: + name: eth_getTransactionByBlockNumberAndIndex.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthGetTransactionByBlockHashAndIndex + params: + - name: blockHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: txIndex + required: true + schema: + $ref: "#/components/schemas/EthUint64" + result: + name: Filecoin.EthGetTransactionByBlockHashAndIndex.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionByBlockHashAndIndex + params: + - name: blockHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: txIndex + required: true + schema: + $ref: "#/components/schemas/EthUint64" + result: + name: eth_getTransactionByBlockHashAndIndex.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ApiEthTx" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthMaxPriorityFeePerGas + params: [] + result: + name: Filecoin.EthMaxPriorityFeePerGas.Result + required: true + schema: + $ref: "#/components/schemas/EthBigInt" + paramStructure: by-position + - name: eth_maxPriorityFeePerGas + params: [] + result: + name: eth_maxPriorityFeePerGas.Result + required: true + schema: + $ref: "#/components/schemas/EthBigInt" + paramStructure: by-position + - name: Filecoin.EthProtocolVersion + params: [] + result: + name: Filecoin.EthProtocolVersion.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: eth_protocolVersion + params: [] + result: + name: eth_protocolVersion.Result + required: true + schema: + $ref: "#/components/schemas/EthUint64" + paramStructure: by-position + - name: Filecoin.EthGetTransactionReceipt + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: Filecoin.EthGetTransactionReceipt.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/EthTxReceipt" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionReceipt + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + result: + name: eth_getTransactionReceipt.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/EthTxReceipt" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthGetTransactionReceiptLimited + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: limit + required: true + schema: + type: integer + format: int64 + result: + name: Filecoin.EthGetTransactionReceiptLimited.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/EthTxReceipt" + - type: "null" + paramStructure: by-position + - name: eth_getTransactionReceiptLimited + params: + - name: txHash + required: true + schema: + $ref: "#/components/schemas/EthHash" + - name: limit + required: true + schema: + type: integer + format: int64 + result: + name: eth_getTransactionReceiptLimited.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/EthTxReceipt" + - type: "null" + paramStructure: by-position + - name: Filecoin.EthNewPendingTransactionFilter + params: [] + result: + name: Filecoin.EthNewPendingTransactionFilter.Result + required: true + schema: + $ref: "#/components/schemas/FilterID" + paramStructure: by-position + - name: eth_newPendingTransactionFilter + params: [] + result: + name: eth_newPendingTransactionFilter.Result + required: true + schema: + $ref: "#/components/schemas/FilterID" + paramStructure: by-position + - name: Filecoin.EthNewBlockFilter + params: [] + result: + name: Filecoin.EthNewBlockFilter.Result + required: true + schema: + $ref: "#/components/schemas/FilterID" + paramStructure: by-position + - name: eth_newBlockFilter + params: [] + result: + name: eth_newBlockFilter.Result + required: true + schema: + $ref: "#/components/schemas/FilterID" + paramStructure: by-position + - name: Filecoin.EthUninstallFilter + params: + - name: filterId + required: true + schema: + $ref: "#/components/schemas/FilterID" + result: + name: Filecoin.EthUninstallFilter.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: eth_uninstallFilter + params: + - name: filterId + required: true + schema: + $ref: "#/components/schemas/FilterID" + result: + name: eth_uninstallFilter.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: Filecoin.EthUnsubscribe + params: [] + result: + name: Filecoin.EthUnsubscribe.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: eth_unsubscribe + params: [] + result: + name: eth_unsubscribe.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.EthSubscribe + params: [] + result: + name: Filecoin.EthSubscribe.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: eth_subscribe + params: [] + result: + name: eth_subscribe.Result + required: true + schema: + type: "null" + paramStructure: by-position + - name: Filecoin.EthSyncing + params: [] + result: + name: Filecoin.EthSyncing.Result + required: true + schema: + $ref: "#/components/schemas/EthSyncingResultLotusJson" + paramStructure: by-position + - name: eth_syncing + params: [] + result: + name: eth_syncing.Result + required: true + schema: + $ref: "#/components/schemas/EthSyncingResultLotusJson" + paramStructure: by-position + - name: Filecoin.EthTraceBlock + description: Returns traces created at given block. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + result: + name: Filecoin.EthTraceBlock.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthBlockTrace" + paramStructure: by-position + - name: trace_block + description: Returns traces created at given block. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + result: + name: trace_block.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthBlockTrace" + paramStructure: by-position + - name: Filecoin.EthTraceTransaction + description: Returns the traces for a specific transaction. + params: + - name: txHash + required: true + schema: + type: string + result: + name: Filecoin.EthTraceTransaction.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthBlockTrace" + paramStructure: by-position + - name: trace_transaction + description: Returns the traces for a specific transaction. + params: + - name: txHash + required: true + schema: + type: string + result: + name: trace_transaction.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthBlockTrace" + paramStructure: by-position + - name: Filecoin.EthTraceReplayBlockTransactions + description: Replays all transactions in a block returning the requested traces for each transaction. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + - name: traceTypes + required: true + schema: + type: + - array + - "null" + items: + type: string + result: + name: Filecoin.EthTraceReplayBlockTransactions.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthReplayBlockTransactionTrace" + paramStructure: by-position + - name: trace_replayBlockTransactions + description: Replays all transactions in a block returning the requested traces for each transaction. + params: + - name: blockParam + required: true + schema: + $ref: "#/components/schemas/ExtBlockNumberOrHash" + - name: traceTypes + required: true + schema: + type: + - array + - "null" + items: + type: string + result: + name: trace_replayBlockTransactions.Result + required: false + schema: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthReplayBlockTransactionTrace" + paramStructure: by-position + - name: Filecoin.Web3ClientVersion + params: [] + result: + name: Filecoin.Web3ClientVersion.Result + required: true + schema: + type: string + paramStructure: by-position + - name: web3_clientVersion + params: [] + result: + name: web3_clientVersion.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.EthSendRawTransaction + params: + - name: rawTx + required: true + schema: + $ref: "#/components/schemas/EthBytes" + result: + name: Filecoin.EthSendRawTransaction.Result + required: true + schema: + $ref: "#/components/schemas/EthHash" + paramStructure: by-position + - name: eth_sendRawTransaction + params: + - name: rawTx + required: true + schema: + $ref: "#/components/schemas/EthBytes" + result: + name: eth_sendRawTransaction.Result + required: true + schema: + $ref: "#/components/schemas/EthHash" + paramStructure: by-position + - name: Filecoin.NetListening + params: [] + result: + name: Filecoin.NetListening.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: net_listening + params: [] + result: + name: net_listening.Result + required: true + schema: + type: boolean + paramStructure: by-position + - name: Filecoin.NetVersion + params: [] + result: + name: Filecoin.NetVersion.Result + required: true + schema: + type: string + paramStructure: by-position + - name: net_version + params: [] + result: + name: net_version.Result + required: true + schema: + type: string + paramStructure: by-position + - name: Filecoin.StateGetActor + description: Returns the nonce and balance for the specified actor. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetSelector + required: true + schema: + $ref: "#/components/schemas/TipsetSelector" + result: + name: Filecoin.StateGetActor.Result + required: false + schema: + anyOf: + - $ref: "#/components/schemas/ActorState" + - type: "null" + paramStructure: by-position + - name: Filecoin.StateGetID + description: Retrieves the ID address for the specified address at the selected tipset. + params: + - name: address + required: true + schema: + $ref: "#/components/schemas/Address" + - name: tipsetSelector + required: true + schema: + $ref: "#/components/schemas/TipsetSelector" + result: + name: Filecoin.StateGetID.Result + required: true + schema: + $ref: "#/components/schemas/Address" + paramStructure: by-position +components: + schemas: + ActorState: + type: object + properties: + Balance: + $ref: "#/components/schemas/TokenAmount" + Code: + $ref: "#/components/schemas/Cid" + DelegatedAddress: + $ref: "#/components/schemas/Nullable_Address" + Head: + $ref: "#/components/schemas/Cid" + Nonce: + type: integer + format: uint64 + minimum: 0 + required: + - Code + - Head + - Nonce + - Balance + Address: + type: string + ApiEthTx: + type: object + properties: + accessList: + type: + - array + - "null" + items: + $ref: "#/components/schemas/EthHash" + blockHash: + $ref: "#/components/schemas/EthHash" + blockNumber: + $ref: "#/components/schemas/EthUint64" + chainId: + $ref: "#/components/schemas/EthUint64" + from: + $ref: "#/components/schemas/EthAddress" + gas: + $ref: "#/components/schemas/EthUint64" + gasPrice: + anyOf: + - $ref: "#/components/schemas/EthBigInt" + - type: "null" + hash: + $ref: "#/components/schemas/EthHash" + input: + $ref: "#/components/schemas/EthBytes" + maxFeePerGas: + anyOf: + - $ref: "#/components/schemas/EthBigInt" + - type: "null" + maxPriorityFeePerGas: + anyOf: + - $ref: "#/components/schemas/EthBigInt" + - type: "null" + nonce: + $ref: "#/components/schemas/EthUint64" + r: + $ref: "#/components/schemas/EthBigInt" + s: + $ref: "#/components/schemas/EthBigInt" + to: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + transactionIndex: + $ref: "#/components/schemas/EthUint64" + type: + $ref: "#/components/schemas/EthUint64" + v: + $ref: "#/components/schemas/EthBigInt" + value: + $ref: "#/components/schemas/EthBigInt" + required: + - chainId + - nonce + - hash + - blockHash + - blockNumber + - transactionIndex + - from + - value + - type + - input + - gas + - v + - r + - s + Base64String: + type: + - string + - "null" + BeaconEntry: + type: object + properties: + Data: + $ref: "#/components/schemas/Base64String" + Round: + type: integer + format: uint64 + minimum: 0 + required: + - Round + - Data + BigInt: + type: string + Block: + type: object + properties: + baseFeePerGas: + $ref: "#/components/schemas/EthBigInt" + difficulty: + $ref: "#/components/schemas/EthUint64" + extraData: + $ref: "#/components/schemas/EthBytes" + gasLimit: + $ref: "#/components/schemas/EthUint64" + gasUsed: + $ref: "#/components/schemas/EthUint64" + hash: + $ref: "#/components/schemas/EthHash" + logsBloom: + $ref: "#/components/schemas/Bloom" + miner: + $ref: "#/components/schemas/EthAddress" + mixHash: + $ref: "#/components/schemas/EthHash" + nonce: + $ref: "#/components/schemas/Nonce" + number: + $ref: "#/components/schemas/EthUint64" + parentHash: + $ref: "#/components/schemas/EthHash" + receiptsRoot: + $ref: "#/components/schemas/EthHash" + sha3Uncles: + $ref: "#/components/schemas/EthHash" + size: + $ref: "#/components/schemas/EthUint64" + stateRoot: + $ref: "#/components/schemas/EthHash" + timestamp: + $ref: "#/components/schemas/EthUint64" + totalDifficulty: + $ref: "#/components/schemas/EthUint64" + transactions: + $ref: "#/components/schemas/Transactions" + transactionsRoot: + $ref: "#/components/schemas/EthHash" + uncles: + type: array + items: + $ref: "#/components/schemas/EthHash" + required: + - hash + - parentHash + - sha3Uncles + - miner + - stateRoot + - transactionsRoot + - receiptsRoot + - logsBloom + - difficulty + - totalDifficulty + - number + - gasLimit + - gasUsed + - timestamp + - extraData + - mixHash + - nonce + - baseFeePerGas + - size + - transactions + - uncles + BlockHash: + type: object + properties: + blockHash: + $ref: "#/components/schemas/EthHash" + requireCanonical: + type: boolean + required: + - blockHash + - requireCanonical + BlockHeader: + type: object + properties: + BLSAggregate: + $ref: "#/components/schemas/Nullable_Signature" + BeaconEntries: + $ref: "#/components/schemas/Nullable_Array_of_BeaconEntry" + BlockSig: + $ref: "#/components/schemas/Nullable_Signature" + ElectionProof: + $ref: "#/components/schemas/Nullable_ElectionProof" + ForkSignaling: + type: integer + format: uint64 + minimum: 0 + Height: + type: integer + format: int64 + Messages: + $ref: "#/components/schemas/Cid" + Miner: + $ref: "#/components/schemas/Address" + ParentBaseFee: + $ref: "#/components/schemas/TokenAmount" + ParentMessageReceipts: + $ref: "#/components/schemas/Cid" + ParentStateRoot: + $ref: "#/components/schemas/Cid" + ParentWeight: + $ref: "#/components/schemas/BigInt" + Parents: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + Ticket: + $ref: "#/components/schemas/Nullable_Ticket" + Timestamp: + type: integer + format: uint64 + minimum: 0 + WinPoStProof: + $ref: "#/components/schemas/Nullable_Array_of_PoStProof" + required: + - Miner + - BeaconEntries + - WinPoStProof + - Parents + - ParentWeight + - Height + - ParentStateRoot + - ParentMessageReceipts + - Messages + - Timestamp + - ForkSignaling + - ParentBaseFee + BlockNumber: + type: object + properties: + blockNumber: + $ref: "#/components/schemas/EthInt64" + required: + - blockNumber + BlockNumberOrPredefined: + anyOf: + - type: string + - $ref: "#/components/schemas/EthInt64" + Bloom: + type: string + Cid: + type: object + properties: + /: + type: string + required: + - / + ElectionProof: + type: object + properties: + VRFProof: + $ref: "#/components/schemas/Base64String" + WinCount: + type: integer + format: int64 + required: + - VRFProof + - WinCount + EthAddress: + type: string + EthAddressList: + description: "Represents an [`EthAddress`] or a collection of thereof. This allows the caller to either use,\ne.g., `0x1234...` or `[\"0x1234...\", \"0x5678...\"]` as the address parameter." + anyOf: + - type: array + items: + $ref: "#/components/schemas/EthAddress" + - $ref: "#/components/schemas/EthAddress" + EthBigInt: + type: string + EthBlockTrace: + type: object + properties: + action: + $ref: "#/components/schemas/TraceAction" + blockHash: + $ref: "#/components/schemas/EthHash" + blockNumber: + type: integer + format: int64 + error: + type: + - string + - "null" + result: + $ref: "#/components/schemas/TraceResult" + subtraces: + type: integer + format: int64 + traceAddress: + type: array + items: + type: integer + format: int64 + transactionHash: + $ref: "#/components/schemas/EthHash" + transactionPosition: + type: integer + format: int64 + type: + type: string + required: + - type + - subtraces + - traceAddress + - action + - result + - blockHash + - blockNumber + - transactionHash + - transactionPosition + EthBytes: + type: string + EthCallMessage: + type: object + properties: + data: + anyOf: + - $ref: "#/components/schemas/EthBytes" + - type: "null" + from: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + gas: + anyOf: + - $ref: "#/components/schemas/EthUint64" + - type: "null" + gasPrice: + anyOf: + - $ref: "#/components/schemas/EthBigInt" + - type: "null" + to: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + value: + anyOf: + - $ref: "#/components/schemas/EthBigInt" + - type: "null" + EthCallTraceAction: + type: object + properties: + callType: + type: string + from: + $ref: "#/components/schemas/EthAddress" + gas: + $ref: "#/components/schemas/EthUint64" + input: + $ref: "#/components/schemas/EthBytes" + to: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + value: + $ref: "#/components/schemas/EthBigInt" + required: + - callType + - from + - gas + - value + - input + EthCallTraceResult: + type: object + properties: + gasUsed: + $ref: "#/components/schemas/EthUint64" + output: + $ref: "#/components/schemas/EthBytes" + required: + - gasUsed + - output + EthCreateTraceAction: + type: object + properties: + from: + $ref: "#/components/schemas/EthAddress" + gas: + $ref: "#/components/schemas/EthUint64" + init: + $ref: "#/components/schemas/EthBytes" + value: + $ref: "#/components/schemas/EthBigInt" + required: + - from + - gas + - value + - init + EthCreateTraceResult: + type: object + properties: + address: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + code: + $ref: "#/components/schemas/EthBytes" + gasUsed: + $ref: "#/components/schemas/EthUint64" + required: + - gasUsed + - code + EthFeeHistoryResult: + type: object + properties: + baseFeePerGas: + type: array + items: + $ref: "#/components/schemas/EthBigInt" + gasUsedRatio: + type: array + items: + type: number + format: double + oldestBlock: + $ref: "#/components/schemas/EthUint64" + reward: + type: + - array + - "null" + items: + type: array + items: + $ref: "#/components/schemas/EthBigInt" + required: + - oldestBlock + - baseFeePerGas + - gasUsedRatio + EthFilterResult: + description: "`EthFilterResult` represents the response from executing a filter:\n- A list of block hashes\n- A list of transaction hashes\n- Or a list of logs" + anyOf: + - type: array + items: + $ref: "#/components/schemas/EthHash" + - type: array + items: + $ref: "#/components/schemas/EthLog" + EthFilterSpec: + description: "Represents a filter specification for querying Ethereum event logs.\nThis struct can be used to specify criteria for filtering Ethereum event logs based on block range,\naddress, topics, and block hash. It is useful for making requests to Ethereum nodes to fetch logs\nthat match certain conditions.\n\n# Fields\n\n* `from_block` - Optional field interpreted as an epoch (in hex):\n - `\"latest\"`: latest mined block.\n - `\"earliest\"`: first block.\n - `\"pending\"`: blocks that have not yet been mined.\n If omitted, the default value is `\"latest\"`.\n This field is skipped during serialization if `None`.\n\n* `to_block` - Optional field interpreted as an epoch (in hex):\n - `\"latest\"`: latest mined block.\n - `\"earliest\"`: first block.\n - `\"pending\"`: blocks that have not yet been mined.\n If omitted, the default value is `\"latest\"`.\n This field is skipped during serialization if `None`.\n\n* `address` - Optional field interpreted as Actor address or a list of addresses (`Vec`) from which event logs should originate.\n If the filter needs to match a single address, it can be specified as a single element vector.\n This field is required and cannot be omitted.\n\n* `topics` - List of topics (`EthTopicSpec`) to be matched in the event logs. \n\n* `block_hash` - Optional field specifying a block hash (`Hash`)\n Restricts event logs returned to those emitted from messages contained in this tipset. When `block_hash` is provided,\n neither `from_block` nor `to_block` can be specified.\n This field is skipped during serialization if `None`.\n [the spec](https://github.com/filecoin-project/lotus/blob/475139ff95407ed9d55d3a2ef87e28da66512937/chain/types/ethtypes/eth_types.go#L602-L627)." + type: object + properties: + address: + anyOf: + - $ref: "#/components/schemas/EthAddressList" + - type: "null" + blockHash: + anyOf: + - $ref: "#/components/schemas/EthHash" + - type: "null" + fromBlock: + type: + - string + - "null" + toBlock: + type: + - string + - "null" + topics: + anyOf: + - $ref: "#/components/schemas/EthTopicSpec" + - type: "null" + EthHash: + type: string + EthHashList: + description: "`EthHashList` represents a topic filter that can take one of two forms:\n- `List`: Matches if the hash is present in the vector.\n- `Single`: An optional hash, where:\n - `Some(hash)`: Matches exactly this hash.\n - `None`: Acts as a wildcard." + anyOf: + - type: array + items: + $ref: "#/components/schemas/EthHash" + - anyOf: + - $ref: "#/components/schemas/EthHash" + - type: "null" + EthInt64: + type: string + EthLog: + description: Represents the results of an event filter execution. + type: object + properties: + address: + description: The address of the actor that produced the event log. + $ref: "#/components/schemas/EthAddress" + blockHash: + description: The hash of the tipset containing the message that produced the log. + $ref: "#/components/schemas/EthHash" + blockNumber: + description: The epoch of the tipset containing the message. + $ref: "#/components/schemas/EthUint64" + data: + description: "The value of the event log, excluding topics." + $ref: "#/components/schemas/EthBytes" + logIndex: + description: "The index of the event log in the sequence of events produced by the message execution.\n(this is the index in the events AMT on the message receipt)" + $ref: "#/components/schemas/EthUint64" + removed: + description: Indicates whether the log was removed due to a chain reorganization. + type: boolean + topics: + description: List of topics associated with the event log. + type: array + items: + $ref: "#/components/schemas/EthHash" + transactionHash: + description: The hash of the RLP message that produced the event log. + $ref: "#/components/schemas/EthHash" + transactionIndex: + description: "The index in the tipset of the transaction that produced the event log.\nThe index corresponds to the sequence of messages produced by `ChainGetParentMessages`" + $ref: "#/components/schemas/EthUint64" + required: + - address + - data + - topics + - removed + - logIndex + - transactionIndex + - transactionHash + - blockHash + - blockNumber + EthReplayBlockTransactionTrace: + type: object + properties: + output: + $ref: "#/components/schemas/EthBytes" + stateDiff: + type: + - string + - "null" + trace: + type: array + items: + $ref: "#/components/schemas/EthTrace" + transactionHash: + $ref: "#/components/schemas/EthHash" + vmTrace: + type: + - string + - "null" + required: + - output + - trace + - transactionHash + EthSyncingResultLotusJson: + anyOf: + - type: boolean + - type: object + properties: + currentblock: + type: integer + format: int64 + highestblock: + type: integer + format: int64 + startingblock: + type: integer + format: int64 + required: + - startingblock + - currentblock + - highestblock + EthTopicSpec: + type: array + items: + $ref: "#/components/schemas/EthHashList" + EthTrace: + type: object + properties: + action: + $ref: "#/components/schemas/TraceAction" + error: + type: + - string + - "null" + result: + $ref: "#/components/schemas/TraceResult" + subtraces: + type: integer + format: int64 + traceAddress: + type: array + items: + type: integer + format: int64 + type: + type: string + required: + - type + - subtraces + - traceAddress + - action + - result + EthTxReceipt: + type: object + properties: + blockHash: + $ref: "#/components/schemas/EthHash" + blockNumber: + $ref: "#/components/schemas/EthUint64" + contractAddress: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + cumulativeGasUsed: + $ref: "#/components/schemas/EthUint64" + effectiveGasPrice: + $ref: "#/components/schemas/EthBigInt" + from: + $ref: "#/components/schemas/EthAddress" + gasUsed: + $ref: "#/components/schemas/EthUint64" + logs: + type: array + items: + $ref: "#/components/schemas/EthLog" + logsBloom: + $ref: "#/components/schemas/EthBytes" + root: + $ref: "#/components/schemas/EthHash" + status: + $ref: "#/components/schemas/EthUint64" + to: + anyOf: + - $ref: "#/components/schemas/EthAddress" + - type: "null" + transactionHash: + $ref: "#/components/schemas/EthHash" + transactionIndex: + $ref: "#/components/schemas/EthUint64" + type: + $ref: "#/components/schemas/EthUint64" + required: + - transactionHash + - transactionIndex + - blockHash + - blockNumber + - from + - root + - status + - cumulativeGasUsed + - gasUsed + - effectiveGasPrice + - logsBloom + - logs + - type + EthUint64: + type: string + ExtBlockNumberOrHash: + anyOf: + - type: string + - $ref: "#/components/schemas/EthInt64" + - $ref: "#/components/schemas/EthHash" + - $ref: "#/components/schemas/BlockNumber" + - $ref: "#/components/schemas/BlockHash" + FilterID: + $ref: "#/components/schemas/EthHash" + NonEmpty_Array_of_BlockHeader: + type: array + items: + $ref: "#/components/schemas/BlockHeader" + minItems: 1 + NonEmpty_Array_of_Cid: + type: array + items: + $ref: "#/components/schemas/Cid" + minItems: 1 + Nonce: + type: string + Nullable_Address: + anyOf: + - $ref: "#/components/schemas/Address" + - type: "null" + Nullable_Array_of_BeaconEntry: + type: + - array + - "null" + items: + $ref: "#/components/schemas/BeaconEntry" + Nullable_Array_of_PoStProof: + type: + - array + - "null" + items: + $ref: "#/components/schemas/PoStProof" + Nullable_ElectionProof: + anyOf: + - $ref: "#/components/schemas/ElectionProof" + - type: "null" + Nullable_Signature: + anyOf: + - $ref: "#/components/schemas/Signature" + - type: "null" + Nullable_Ticket: + anyOf: + - $ref: "#/components/schemas/Ticket" + - type: "null" + PoStProof: + type: object + properties: + PoStProof: + $ref: "#/components/schemas/int64" + ProofBytes: + $ref: "#/components/schemas/Base64String" + required: + - PoStProof + - ProofBytes + Signature: + type: object + properties: + Data: + $ref: "#/components/schemas/Base64String" + Type: + $ref: "#/components/schemas/SignatureTypeLotusJson" + required: + - Type + - Data + SignatureType: + description: Signature variants for Filecoin signatures. + type: string + enum: + - Secp256k1 + - Bls + - Delegated + SignatureTypeLotusJson: + anyOf: + - type: integer + format: uint8 + maximum: 255 + minimum: 0 + - $ref: "#/components/schemas/SignatureType" + Ticket: + type: object + properties: + VRFProof: + $ref: "#/components/schemas/Base64String" + required: + - VRFProof + Tipset: + $ref: "#/components/schemas/TipsetInner" + TipsetAnchor: + type: object + properties: + key: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + tag: + anyOf: + - $ref: "#/components/schemas/TipsetTag" + - type: "null" + required: + - key + TipsetHeight: + type: object + properties: + anchor: + anyOf: + - $ref: "#/components/schemas/TipsetAnchor" + - type: "null" + at: + type: integer + format: int64 + previous: + type: boolean + required: + - at + - previous + TipsetInner: + type: object + properties: + Blocks: + $ref: "#/components/schemas/NonEmpty_Array_of_BlockHeader" + Cids: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + Height: + type: integer + format: int64 + required: + - Cids + - Blocks + - Height + TipsetSelector: + type: object + properties: + height: + anyOf: + - $ref: "#/components/schemas/TipsetHeight" + - type: "null" + key: + $ref: "#/components/schemas/NonEmpty_Array_of_Cid" + tag: + anyOf: + - $ref: "#/components/schemas/TipsetTag" + - type: "null" + TipsetTag: + type: string + enum: + - latest + - finalized + - safe + TokenAmount: + $ref: "#/components/schemas/BigInt" + TraceAction: + anyOf: + - $ref: "#/components/schemas/EthCallTraceAction" + - $ref: "#/components/schemas/EthCreateTraceAction" + TraceResult: + anyOf: + - $ref: "#/components/schemas/EthCallTraceResult" + - $ref: "#/components/schemas/EthCreateTraceResult" + Transactions: + anyOf: + - type: array + items: + type: string + - type: array + items: + $ref: "#/components/schemas/ApiEthTx" + int64: + type: integer + format: int64