2020-08-24 10:25:49 +00:00
|
|
|
# Groups
|
|
|
|
|
* [](#)
|
|
|
|
|
* [Closing](#Closing)
|
OpenRPC Support (#5843)
* main: init implement rpc.Discover RPC method
This implement the basic functionality for the method
over HTTP RPC.
Signed-off-by: meows <b5c6@protonmail.com>
* main,go.mod,go.sum: init example with go-openrpc-reflect lib
Signed-off-by: meows <b5c6@protonmail.com>
Conflicts:
go.mod
go.sum
* main: make variable name human-friendly
Signed-off-by: meows <b5c6@protonmail.com>
* main,go.mod,go.sum: init impl of go-openrp-reflect printing document
Signed-off-by: meows <b5c6@protonmail.com>
Conflicts:
go.mod
go.sum
* go.mod,go.sum: use go-openrpc-reflect and open-rpc/meta-schema hackforks
This is for development only.
Versions need to be bumped when they're ready for use
as canonical remotes.
Signed-off-by: meows <b5c6@protonmail.com>
* main,openrpc,main: refactor openrpc supporting code to own package
This eliminates code duplication.
Signed-off-by: meows <b5c6@protonmail.com>
* main: add rpc.Discover to openrpc document
Signed-off-by: meows <b5c6@protonmail.com>
* openrpc: fix rpc.discover method name casing
Also fixes casing stuff for the rest of Filecoin.
methods.
Signed-off-by: meows <b5c6@protonmail.com>
* Revert "main: add rpc.Discover to openrpc document"
This reverts commit 116898efb10f33e405ac74acb1aa6daefcd46a62.
* main: fix document creation method name
This fixes an issue caused with the latest reverting
commit.
Signed-off-by: meows <b5c6@protonmail.com>
* main,docgen,openrpc: refactor to share api parsing, etc as docgen exported stuff
Signed-off-by: meows <b5c6@protonmail.com>
Makefile: fix docgen refactoring for makefile use of command
Signed-off-by: meows <b5c6@protonmail.com>
* openrpc: add schema.examples to app reflector
There are quite of few of these already registered
for the docgen command, so it makes sense to use
those!
Signed-off-by: meows <b5c6@protonmail.com>
* openrpc: init method pairing examples
Signed-off-by: meows <b5c6@protonmail.com>
* go.mod,go.sum: bump go.mod to use latest meta-schema and openrpc-reflect versions
Signed-off-by: meows <b5c6@protonmail.com>
* openrpc: init SchemaType mapper function
This function will handle the manual configurations
for app-specific data types w/r/t their json schema
representation.
This is useful for cases where the reflect library
is unable to provide a sufficient representation
automatically.
Provided in this commit is an initial implementation
for the integerD type (assuming number are represented
in the API as hexs), and a commonly used cid.Cid type.
Signed-off-by: meows <b5c6@protonmail.com>
* go.mod,go.sum: tame dependencies by bumping etclabscore/go-openrpc-reflect
This removes a problematic dependency
on github.com/ethereum/go-ethereum, which was
imported as a dependency for a couple github.com/etclabscore/go-openrpc-reflect
tests.
etclabscore/go-openrpc-reflect v0.0.36 has removed this
dependency, so this commit is the result of bumping
that version and then running 'go mod tidy'
This is in response to a review at
https://github.com/filecoin-project/lotus/pull/4711#pullrequestreview-535686205
Date: 2020-11-21 06:52:48-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* main: add 'miner' arg to openrpc gen cmd
This allows the command to EITHER
generate the doc for Full or Miner APIs.
See comment for usage.
Date: 2020-11-21 07:48:05-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* docgen: add missing examples for Miner API
Generating the Miner API OpenRPC doc
(via 'go run ./api/openrpc/cmd miner') caused
the example logic to panic because some types
were missing.
This commit adds those missing types, although
I'm not an expert in the API so I can't
suggest that the example values provided are
ideal or well representative.
Date: 2020-11-21 07:50:21-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* build/openrpc/full.json,build/openrpc/miner.json: add build/openrpc/[full/miner].json docs
These will be used as static documents
provided by the rpc.discover method.
Date: 2020-11-21 07:51:39-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* build: init go-rice openrpc static assets
Date: 2020-11-21 08:23:06-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* main: remove rpc.discover implementation from runtime plugin
Instead of generating the doc on the fly,
we're going to serve a static asset.
Rel https://github.com/filecoin-project/lotus/pull/4711#pullrequestreview-535686205
This removes the runtime implementation from the
RPC server construction.
Date: 2020-11-21 08:41:20-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* api,apistruct,common: add Discover(ctx) method to CommonAPI interface and structs
Date: 2020-11-21 08:41:56-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* main: use rpc server method aliasing for rpc.discover
This depends on a currently-forked change at
filecoin-project/go-jsonrpc 8350f9463ee451b187d35c492e32f1b999e80210
which establishes this new method RPCServer.AliasMethod.
This solves the problem that the OpenRPC
spec says that the document should be served
at the system extension-prefixed endpoing
rpc.discover (not Filecoin.Discover).
In fact, the document will be available at BOTH
endpoints, but that duplicity is harmless.
Date: 2020-11-21 09:18:26-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* api,apistruct,build,common: rpc.discover: return json object instead of string
Instead of casting the JSON asset from bytes to string,
unmarshal it to a map[string]interface{} so the
server will provide it as a JSON object.
Date: 2020-11-21 09:27:11-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* Makefile: merge resolve: docsgen command path
Date: 2020-11-22 07:19:36-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* apistruct,main,docgen,openrpc: merge resolve: fix func exporteds, signatures
Date: 2020-11-22 07:31:03-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* go.mod,go.sum: 'get get' auto-bumps version
Date: 2020-11-22 07:31:44-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* Makefile,docgen,main,build/openrpc: refactor openrpc documentation generation
This creates Makefile command docsgen-openrpc-json,
and refactors the docsgen command to generate both
the markdown and openrpc json documents, redirecting
the output of the openrpc json documentation to
the build/openrpc/ directory, where those json
files will be compiled as static assets via go-rice
boxes.
The api/openrpc/cmd now uses usage argumentation
congruent to that of the docgen command (switching
on API context).
Date: 2020-11-22 08:01:18-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* main,docgen_openrpc: rename api/openrpc -> api/docgen-openrpc
Renames the package as well.
This is intended to parallel the
existing docgen package and command
namespacing.
Date: 2020-11-22 10:34:46-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* api,apistruct,docgen,build,build/openrpc: use typed Discover response
Instead of using a map[string]interface{}, use
a typed response for the Discover method implementation.
This avoids having to set a docgen Example for
the generic map[string]interface{} (as an openrpc document)
which both pollutes the generic type and lacks
useful information for the Discover method example.
Date: 2020-11-22 08:31:16-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* apistruct,build,main,impl: implement Discover method for Worker and StorageMiner APIs
Methods return static compiled assets respective
to the APIs.
Date: 2020-11-22 08:57:18-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* docgen_openrpc,build/openrpc: remove timestamping from openrpc doc info
This should allow openrpc docs generated at different
times to be equal. This is important because the CI
(Circle) runs the docgen command and tests that
the output and the source are unchanged (via git diff).
Date: 2020-11-22 10:47:07-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* main,docgen_openrpc,main,build: fix lint issues
Fixes goimports, staticcheck, golint issues.
Date: 2020-11-22 11:06:46-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* docgenopenrpc: fix: don't use an underscore in package name (golint)
Date: 2020-11-22 11:07:53-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* go.sum: fix: mod-tidy-check (run 'go mod tidy')
Date: 2020-11-22 11:09:48-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* go.mod,go.sum: bump filecoin-project/go-jsonrpc dep to latest
This version includes the necessary RPCServer.AliasMethod
method.
Date: 2020-11-23 12:16:15-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* Makefile,main,build,build/openrpc: init gzipped openrpc static docs
Date: 2020-11-24 06:15:06-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* build: refactor gzip reading
Date: 2020-11-24 06:18:34-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* build: add basic test for openrpc doc from static assets
Date: 2020-11-24 06:30:23-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* build: handle reader Close error
This keeps the errcheck linter happy.
Date: 2020-11-24 06:33:14-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* go.sum: run 'go mod tidy'
Date: 2020-11-24 06:36:07-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* go.mod,go.sum: go mod tidy
Tidying up after resolving the merge conflicts
with master at go.mod
Date: 2020-11-24 06:40:45-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* go.mod,go.sum: bump filecoin-project/go-jsonrpc to latest
This is a repeat of 76e6fd2, since the latest merge
to master seems to have reverted this.
Date: 2020-11-24 06:42:30-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* docgenopenrpc,build/openrpc: remove method example pairings, improve schema examples
Removing method example pairings since they were
redundant to schema examples and were not
implemented well.
Improved schema examples by using the ExampleValue
method instead of the map lookup.
Made a note in the comment here that this is
not ideal, since we have to make a shortcut assumption
/workaround by using 'unknown' as the method name
and the typea as its own parent.
Luckily these values aren't heavily used by the
method logic.
Date: 2020-11-27 12:57:36-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* docgenopenrpc: use generic number jsonschema for number types
Previously used an integer schema assuming
hex encoding. It appears, based on review some
of the examples, that this may not be the case.
Obvioussly this schema could be more descriptive,
but just shooting for mostly likely to be
not wrong at this point.
Date: 2020-12-15 14:44:37-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* cmd/lotus,go.mod,go.sum: maybe fix straggling merge resolution conflicts
Date: 2021-01-19 12:30:42-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* build/openrpc/full.json.gz,build/openrpc/miner.json.gz,build/openrpc/worker.json.gz: run 'make docsgen'
Date: 2021-01-19 12:33:55-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* api/apistruct,node/impl: (lint) gofmt
Date: 2021-01-19 12:39:48-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* api/docgen: maybe fix parse error: open ./api: no such file or directory
Date: 2021-01-19 12:52:04-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* api/docgen,build/openrpc: maybe fix no such file error and run 'make docsgen'
Date: 2021-01-19 12:55:52-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* api/docgen: return if AST comment/groupdoc parsing encounters any error
This will returns empty comments/docs maps.
This should fix issues like:
https://app.circleci.com/pipelines/github/filecoin-project/lotus/12445/workflows/4ebadce9-a298-4ad1-939b-f19ef4c0a5bf/jobs/107218
where the environment makes file lookups hard or
impossible.
Date: 2021-01-19 13:04:58-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* api: Don't depend on build/
* make: support parallel docsgen
* openrpc gen: Use simple build version
* methodgen
* goimports
Co-authored-by: meows <b5c6@protonmail.com>
2021-03-19 18:22:46 +00:00
|
|
|
* [Discover](#Discover)
|
2020-10-18 18:10:39 +00:00
|
|
|
* [Session](#Session)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [Shutdown](#Shutdown)
|
|
|
|
|
* [Version](#Version)
|
|
|
|
|
* [Auth](#Auth)
|
|
|
|
|
* [AuthNew](#AuthNew)
|
|
|
|
|
* [AuthVerify](#AuthVerify)
|
|
|
|
|
* [Beacon](#Beacon)
|
|
|
|
|
* [BeaconGetEntry](#BeaconGetEntry)
|
|
|
|
|
* [Chain](#Chain)
|
2020-09-10 17:47:19 +00:00
|
|
|
* [ChainDeleteObj](#ChainDeleteObj)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [ChainExport](#ChainExport)
|
|
|
|
|
* [ChainGetBlock](#ChainGetBlock)
|
|
|
|
|
* [ChainGetBlockMessages](#ChainGetBlockMessages)
|
|
|
|
|
* [ChainGetGenesis](#ChainGetGenesis)
|
|
|
|
|
* [ChainGetMessage](#ChainGetMessage)
|
2021-07-01 03:20:22 +00:00
|
|
|
* [ChainGetMessagesInTipset](#ChainGetMessagesInTipset)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [ChainGetNode](#ChainGetNode)
|
|
|
|
|
* [ChainGetParentMessages](#ChainGetParentMessages)
|
|
|
|
|
* [ChainGetParentReceipts](#ChainGetParentReceipts)
|
|
|
|
|
* [ChainGetPath](#ChainGetPath)
|
|
|
|
|
* [ChainGetRandomnessFromBeacon](#ChainGetRandomnessFromBeacon)
|
|
|
|
|
* [ChainGetRandomnessFromTickets](#ChainGetRandomnessFromTickets)
|
|
|
|
|
* [ChainGetTipSet](#ChainGetTipSet)
|
|
|
|
|
* [ChainGetTipSetByHeight](#ChainGetTipSetByHeight)
|
|
|
|
|
* [ChainHasObj](#ChainHasObj)
|
|
|
|
|
* [ChainHead](#ChainHead)
|
|
|
|
|
* [ChainNotify](#ChainNotify)
|
2022-06-07 03:14:16 +00:00
|
|
|
* [ChainPutObj](#ChainPutObj)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [ChainReadObj](#ChainReadObj)
|
|
|
|
|
* [ChainSetHead](#ChainSetHead)
|
|
|
|
|
* [ChainStatObj](#ChainStatObj)
|
|
|
|
|
* [ChainTipSetWeight](#ChainTipSetWeight)
|
|
|
|
|
* [Client](#Client)
|
|
|
|
|
* [ClientCalcCommP](#ClientCalcCommP)
|
2020-10-24 01:35:01 +00:00
|
|
|
* [ClientCancelDataTransfer](#ClientCancelDataTransfer)
|
2021-03-24 12:36:21 +00:00
|
|
|
* [ClientCancelRetrievalDeal](#ClientCancelRetrievalDeal)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [ClientDataTransferUpdates](#ClientDataTransferUpdates)
|
2020-10-22 11:59:08 +00:00
|
|
|
* [ClientDealPieceCID](#ClientDealPieceCID)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [ClientDealSize](#ClientDealSize)
|
|
|
|
|
* [ClientFindData](#ClientFindData)
|
|
|
|
|
* [ClientGenCar](#ClientGenCar)
|
|
|
|
|
* [ClientGetDealInfo](#ClientGetDealInfo)
|
2020-10-09 04:25:38 +00:00
|
|
|
* [ClientGetDealStatus](#ClientGetDealStatus)
|
2020-08-28 20:17:35 +00:00
|
|
|
* [ClientGetDealUpdates](#ClientGetDealUpdates)
|
2021-05-27 22:00:31 +00:00
|
|
|
* [ClientGetRetrievalUpdates](#ClientGetRetrievalUpdates)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [ClientHasLocal](#ClientHasLocal)
|
|
|
|
|
* [ClientImport](#ClientImport)
|
|
|
|
|
* [ClientListDataTransfers](#ClientListDataTransfers)
|
|
|
|
|
* [ClientListDeals](#ClientListDeals)
|
|
|
|
|
* [ClientListImports](#ClientListImports)
|
2021-05-27 22:00:31 +00:00
|
|
|
* [ClientListRetrievals](#ClientListRetrievals)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [ClientMinerQueryOffer](#ClientMinerQueryOffer)
|
|
|
|
|
* [ClientQueryAsk](#ClientQueryAsk)
|
|
|
|
|
* [ClientRemoveImport](#ClientRemoveImport)
|
2020-10-13 10:37:00 +00:00
|
|
|
* [ClientRestartDataTransfer](#ClientRestartDataTransfer)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [ClientRetrieve](#ClientRetrieve)
|
2020-09-07 12:35:29 +00:00
|
|
|
* [ClientRetrieveTryRestartInsufficientFunds](#ClientRetrieveTryRestartInsufficientFunds)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [ClientRetrieveWithEvents](#ClientRetrieveWithEvents)
|
|
|
|
|
* [ClientStartDeal](#ClientStartDeal)
|
2021-04-05 17:15:32 +00:00
|
|
|
* [ClientStatelessDeal](#ClientStatelessDeal)
|
2020-10-01 16:00:24 +00:00
|
|
|
* [Create](#Create)
|
|
|
|
|
* [CreateBackup](#CreateBackup)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [Gas](#Gas)
|
|
|
|
|
* [GasEstimateFeeCap](#GasEstimateFeeCap)
|
|
|
|
|
* [GasEstimateGasLimit](#GasEstimateGasLimit)
|
|
|
|
|
* [GasEstimateGasPremium](#GasEstimateGasPremium)
|
|
|
|
|
* [GasEstimateMessageGas](#GasEstimateMessageGas)
|
|
|
|
|
* [I](#I)
|
|
|
|
|
* [ID](#ID)
|
|
|
|
|
* [Log](#Log)
|
2021-08-17 13:15:36 +00:00
|
|
|
* [LogAlerts](#LogAlerts)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [LogList](#LogList)
|
|
|
|
|
* [LogSetLevel](#LogSetLevel)
|
|
|
|
|
* [Market](#Market)
|
2021-01-06 13:27:28 +00:00
|
|
|
* [MarketAddBalance](#MarketAddBalance)
|
2021-01-07 08:35:30 +00:00
|
|
|
* [MarketGetReserved](#MarketGetReserved)
|
2020-11-11 05:08:23 +00:00
|
|
|
* [MarketReleaseFunds](#MarketReleaseFunds)
|
|
|
|
|
* [MarketReserveFunds](#MarketReserveFunds)
|
2020-12-03 21:20:50 +00:00
|
|
|
* [MarketWithdraw](#MarketWithdraw)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [Miner](#Miner)
|
|
|
|
|
* [MinerCreateBlock](#MinerCreateBlock)
|
|
|
|
|
* [MinerGetBaseInfo](#MinerGetBaseInfo)
|
|
|
|
|
* [Mpool](#Mpool)
|
2020-10-22 12:46:10 +00:00
|
|
|
* [MpoolBatchPush](#MpoolBatchPush)
|
|
|
|
|
* [MpoolBatchPushMessage](#MpoolBatchPushMessage)
|
|
|
|
|
* [MpoolBatchPushUntrusted](#MpoolBatchPushUntrusted)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [MpoolClear](#MpoolClear)
|
|
|
|
|
* [MpoolGetConfig](#MpoolGetConfig)
|
|
|
|
|
* [MpoolGetNonce](#MpoolGetNonce)
|
|
|
|
|
* [MpoolPending](#MpoolPending)
|
|
|
|
|
* [MpoolPush](#MpoolPush)
|
|
|
|
|
* [MpoolPushMessage](#MpoolPushMessage)
|
2020-10-02 21:14:47 +00:00
|
|
|
* [MpoolPushUntrusted](#MpoolPushUntrusted)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [MpoolSelect](#MpoolSelect)
|
|
|
|
|
* [MpoolSetConfig](#MpoolSetConfig)
|
|
|
|
|
* [MpoolSub](#MpoolSub)
|
|
|
|
|
* [Msig](#Msig)
|
2020-09-06 07:51:06 +00:00
|
|
|
* [MsigAddApprove](#MsigAddApprove)
|
|
|
|
|
* [MsigAddCancel](#MsigAddCancel)
|
|
|
|
|
* [MsigAddPropose](#MsigAddPropose)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [MsigApprove](#MsigApprove)
|
2020-10-10 10:28:59 +00:00
|
|
|
* [MsigApproveTxnHash](#MsigApproveTxnHash)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [MsigCancel](#MsigCancel)
|
|
|
|
|
* [MsigCreate](#MsigCreate)
|
|
|
|
|
* [MsigGetAvailableBalance](#MsigGetAvailableBalance)
|
2021-02-05 11:34:28 +00:00
|
|
|
* [MsigGetPending](#MsigGetPending)
|
2020-09-06 07:51:06 +00:00
|
|
|
* [MsigGetVested](#MsigGetVested)
|
2020-10-08 19:19:39 +00:00
|
|
|
* [MsigGetVestingSchedule](#MsigGetVestingSchedule)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [MsigPropose](#MsigPropose)
|
2020-10-10 10:28:59 +00:00
|
|
|
* [MsigRemoveSigner](#MsigRemoveSigner)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [MsigSwapApprove](#MsigSwapApprove)
|
|
|
|
|
* [MsigSwapCancel](#MsigSwapCancel)
|
|
|
|
|
* [MsigSwapPropose](#MsigSwapPropose)
|
|
|
|
|
* [Net](#Net)
|
|
|
|
|
* [NetAddrsListen](#NetAddrsListen)
|
2020-09-03 23:35:53 +00:00
|
|
|
* [NetAgentVersion](#NetAgentVersion)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [NetAutoNatStatus](#NetAutoNatStatus)
|
2020-09-02 23:31:41 +00:00
|
|
|
* [NetBandwidthStats](#NetBandwidthStats)
|
|
|
|
|
* [NetBandwidthStatsByPeer](#NetBandwidthStatsByPeer)
|
|
|
|
|
* [NetBandwidthStatsByProtocol](#NetBandwidthStatsByProtocol)
|
2020-11-16 16:52:55 +00:00
|
|
|
* [NetBlockAdd](#NetBlockAdd)
|
|
|
|
|
* [NetBlockList](#NetBlockList)
|
|
|
|
|
* [NetBlockRemove](#NetBlockRemove)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [NetConnect](#NetConnect)
|
|
|
|
|
* [NetConnectedness](#NetConnectedness)
|
|
|
|
|
* [NetDisconnect](#NetDisconnect)
|
|
|
|
|
* [NetFindPeer](#NetFindPeer)
|
2022-01-20 09:44:01 +00:00
|
|
|
* [NetLimit](#NetLimit)
|
2021-03-08 12:23:58 +00:00
|
|
|
* [NetPeerInfo](#NetPeerInfo)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [NetPeers](#NetPeers)
|
2022-02-17 09:10:28 +00:00
|
|
|
* [NetPing](#NetPing)
|
2022-02-03 16:24:49 +00:00
|
|
|
* [NetProtectAdd](#NetProtectAdd)
|
|
|
|
|
* [NetProtectList](#NetProtectList)
|
|
|
|
|
* [NetProtectRemove](#NetProtectRemove)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [NetPubsubScores](#NetPubsubScores)
|
2022-01-20 09:44:01 +00:00
|
|
|
* [NetSetLimit](#NetSetLimit)
|
|
|
|
|
* [NetStat](#NetStat)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [Paych](#Paych)
|
|
|
|
|
* [PaychAllocateLane](#PaychAllocateLane)
|
2020-09-03 23:35:53 +00:00
|
|
|
* [PaychAvailableFunds](#PaychAvailableFunds)
|
2020-09-05 19:51:30 +00:00
|
|
|
* [PaychAvailableFundsByFromTo](#PaychAvailableFundsByFromTo)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [PaychCollect](#PaychCollect)
|
|
|
|
|
* [PaychGet](#PaychGet)
|
|
|
|
|
* [PaychGetWaitReady](#PaychGetWaitReady)
|
|
|
|
|
* [PaychList](#PaychList)
|
|
|
|
|
* [PaychNewPayment](#PaychNewPayment)
|
|
|
|
|
* [PaychSettle](#PaychSettle)
|
|
|
|
|
* [PaychStatus](#PaychStatus)
|
|
|
|
|
* [PaychVoucherAdd](#PaychVoucherAdd)
|
|
|
|
|
* [PaychVoucherCheckSpendable](#PaychVoucherCheckSpendable)
|
|
|
|
|
* [PaychVoucherCheckValid](#PaychVoucherCheckValid)
|
|
|
|
|
* [PaychVoucherCreate](#PaychVoucherCreate)
|
|
|
|
|
* [PaychVoucherList](#PaychVoucherList)
|
|
|
|
|
* [PaychVoucherSubmit](#PaychVoucherSubmit)
|
2022-10-05 19:44:55 +00:00
|
|
|
* [Start](#Start)
|
|
|
|
|
* [StartTime](#StartTime)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [State](#State)
|
|
|
|
|
* [StateAccountKey](#StateAccountKey)
|
2022-06-23 18:05:20 +00:00
|
|
|
* [StateActorCodeCIDs](#StateActorCodeCIDs)
|
2022-08-22 21:10:03 +00:00
|
|
|
* [StateActorManifestCID](#StateActorManifestCID)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [StateAllMinerFaults](#StateAllMinerFaults)
|
|
|
|
|
* [StateCall](#StateCall)
|
|
|
|
|
* [StateChangedActors](#StateChangedActors)
|
|
|
|
|
* [StateCirculatingSupply](#StateCirculatingSupply)
|
|
|
|
|
* [StateCompute](#StateCompute)
|
|
|
|
|
* [StateDealProviderCollateralBounds](#StateDealProviderCollateralBounds)
|
2020-09-29 07:01:52 +00:00
|
|
|
* [StateDecodeParams](#StateDecodeParams)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [StateGetActor](#StateGetActor)
|
2022-10-03 05:51:30 +00:00
|
|
|
* [StateGetAllocation](#StateGetAllocation)
|
2022-10-05 18:43:16 +00:00
|
|
|
* [StateGetAllocationForPendingDeal](#StateGetAllocationForPendingDeal)
|
2022-10-05 22:45:43 +00:00
|
|
|
* [StateGetAllocations](#StateGetAllocations)
|
|
|
|
|
* [StateGetClaim](#StateGetClaim)
|
|
|
|
|
* [StateGetClaims](#StateGetClaims)
|
2022-04-24 05:48:07 +00:00
|
|
|
* [StateGetNetworkParams](#StateGetNetworkParams)
|
2021-09-12 02:24:53 +00:00
|
|
|
* [StateGetRandomnessFromBeacon](#StateGetRandomnessFromBeacon)
|
|
|
|
|
* [StateGetRandomnessFromTickets](#StateGetRandomnessFromTickets)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [StateGetReceipt](#StateGetReceipt)
|
|
|
|
|
* [StateListActors](#StateListActors)
|
|
|
|
|
* [StateListMessages](#StateListMessages)
|
|
|
|
|
* [StateListMiners](#StateListMiners)
|
|
|
|
|
* [StateLookupID](#StateLookupID)
|
|
|
|
|
* [StateMarketBalance](#StateMarketBalance)
|
|
|
|
|
* [StateMarketDeals](#StateMarketDeals)
|
|
|
|
|
* [StateMarketParticipants](#StateMarketParticipants)
|
|
|
|
|
* [StateMarketStorageDeal](#StateMarketStorageDeal)
|
|
|
|
|
* [StateMinerActiveSectors](#StateMinerActiveSectors)
|
|
|
|
|
* [StateMinerAvailableBalance](#StateMinerAvailableBalance)
|
|
|
|
|
* [StateMinerDeadlines](#StateMinerDeadlines)
|
|
|
|
|
* [StateMinerFaults](#StateMinerFaults)
|
|
|
|
|
* [StateMinerInfo](#StateMinerInfo)
|
|
|
|
|
* [StateMinerInitialPledgeCollateral](#StateMinerInitialPledgeCollateral)
|
|
|
|
|
* [StateMinerPartitions](#StateMinerPartitions)
|
|
|
|
|
* [StateMinerPower](#StateMinerPower)
|
|
|
|
|
* [StateMinerPreCommitDepositForPower](#StateMinerPreCommitDepositForPower)
|
|
|
|
|
* [StateMinerProvingDeadline](#StateMinerProvingDeadline)
|
|
|
|
|
* [StateMinerRecoveries](#StateMinerRecoveries)
|
2020-10-18 18:10:39 +00:00
|
|
|
* [StateMinerSectorAllocated](#StateMinerSectorAllocated)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [StateMinerSectorCount](#StateMinerSectorCount)
|
|
|
|
|
* [StateMinerSectors](#StateMinerSectors)
|
|
|
|
|
* [StateNetworkName](#StateNetworkName)
|
2020-09-17 15:31:09 +00:00
|
|
|
* [StateNetworkVersion](#StateNetworkVersion)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [StateReadState](#StateReadState)
|
|
|
|
|
* [StateReplay](#StateReplay)
|
|
|
|
|
* [StateSearchMsg](#StateSearchMsg)
|
2021-01-19 10:19:31 +00:00
|
|
|
* [StateSearchMsgLimited](#StateSearchMsgLimited)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [StateSectorExpiration](#StateSectorExpiration)
|
|
|
|
|
* [StateSectorGetInfo](#StateSectorGetInfo)
|
|
|
|
|
* [StateSectorPartition](#StateSectorPartition)
|
|
|
|
|
* [StateSectorPreCommitInfo](#StateSectorPreCommitInfo)
|
2020-10-12 20:41:27 +00:00
|
|
|
* [StateVMCirculatingSupplyInternal](#StateVMCirculatingSupplyInternal)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [StateVerifiedClientStatus](#StateVerifiedClientStatus)
|
2020-10-01 07:14:59 +00:00
|
|
|
* [StateVerifiedRegistryRootKey](#StateVerifiedRegistryRootKey)
|
|
|
|
|
* [StateVerifierStatus](#StateVerifierStatus)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [StateWaitMsg](#StateWaitMsg)
|
2020-10-09 16:43:22 +00:00
|
|
|
* [StateWaitMsgLimited](#StateWaitMsgLimited)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [Sync](#Sync)
|
|
|
|
|
* [SyncCheckBad](#SyncCheckBad)
|
2020-09-09 07:45:47 +00:00
|
|
|
* [SyncCheckpoint](#SyncCheckpoint)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [SyncIncomingBlocks](#SyncIncomingBlocks)
|
|
|
|
|
* [SyncMarkBad](#SyncMarkBad)
|
|
|
|
|
* [SyncState](#SyncState)
|
|
|
|
|
* [SyncSubmitBlock](#SyncSubmitBlock)
|
2020-10-10 18:46:06 +00:00
|
|
|
* [SyncUnmarkAllBad](#SyncUnmarkAllBad)
|
2020-09-09 07:45:47 +00:00
|
|
|
* [SyncUnmarkBad](#SyncUnmarkBad)
|
2020-09-27 22:08:58 +00:00
|
|
|
* [SyncValidateTipset](#SyncValidateTipset)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [Wallet](#Wallet)
|
|
|
|
|
* [WalletBalance](#WalletBalance)
|
|
|
|
|
* [WalletDefaultAddress](#WalletDefaultAddress)
|
|
|
|
|
* [WalletDelete](#WalletDelete)
|
|
|
|
|
* [WalletExport](#WalletExport)
|
|
|
|
|
* [WalletHas](#WalletHas)
|
|
|
|
|
* [WalletImport](#WalletImport)
|
|
|
|
|
* [WalletList](#WalletList)
|
|
|
|
|
* [WalletNew](#WalletNew)
|
|
|
|
|
* [WalletSetDefault](#WalletSetDefault)
|
|
|
|
|
* [WalletSign](#WalletSign)
|
|
|
|
|
* [WalletSignMessage](#WalletSignMessage)
|
2020-09-30 05:45:03 +00:00
|
|
|
* [WalletValidateAddress](#WalletValidateAddress)
|
2020-08-24 10:25:49 +00:00
|
|
|
* [WalletVerify](#WalletVerify)
|
|
|
|
|
##
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Closing
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
OpenRPC Support (#5843)
* main: init implement rpc.Discover RPC method
This implement the basic functionality for the method
over HTTP RPC.
Signed-off-by: meows <b5c6@protonmail.com>
* main,go.mod,go.sum: init example with go-openrpc-reflect lib
Signed-off-by: meows <b5c6@protonmail.com>
Conflicts:
go.mod
go.sum
* main: make variable name human-friendly
Signed-off-by: meows <b5c6@protonmail.com>
* main,go.mod,go.sum: init impl of go-openrp-reflect printing document
Signed-off-by: meows <b5c6@protonmail.com>
Conflicts:
go.mod
go.sum
* go.mod,go.sum: use go-openrpc-reflect and open-rpc/meta-schema hackforks
This is for development only.
Versions need to be bumped when they're ready for use
as canonical remotes.
Signed-off-by: meows <b5c6@protonmail.com>
* main,openrpc,main: refactor openrpc supporting code to own package
This eliminates code duplication.
Signed-off-by: meows <b5c6@protonmail.com>
* main: add rpc.Discover to openrpc document
Signed-off-by: meows <b5c6@protonmail.com>
* openrpc: fix rpc.discover method name casing
Also fixes casing stuff for the rest of Filecoin.
methods.
Signed-off-by: meows <b5c6@protonmail.com>
* Revert "main: add rpc.Discover to openrpc document"
This reverts commit 116898efb10f33e405ac74acb1aa6daefcd46a62.
* main: fix document creation method name
This fixes an issue caused with the latest reverting
commit.
Signed-off-by: meows <b5c6@protonmail.com>
* main,docgen,openrpc: refactor to share api parsing, etc as docgen exported stuff
Signed-off-by: meows <b5c6@protonmail.com>
Makefile: fix docgen refactoring for makefile use of command
Signed-off-by: meows <b5c6@protonmail.com>
* openrpc: add schema.examples to app reflector
There are quite of few of these already registered
for the docgen command, so it makes sense to use
those!
Signed-off-by: meows <b5c6@protonmail.com>
* openrpc: init method pairing examples
Signed-off-by: meows <b5c6@protonmail.com>
* go.mod,go.sum: bump go.mod to use latest meta-schema and openrpc-reflect versions
Signed-off-by: meows <b5c6@protonmail.com>
* openrpc: init SchemaType mapper function
This function will handle the manual configurations
for app-specific data types w/r/t their json schema
representation.
This is useful for cases where the reflect library
is unable to provide a sufficient representation
automatically.
Provided in this commit is an initial implementation
for the integerD type (assuming number are represented
in the API as hexs), and a commonly used cid.Cid type.
Signed-off-by: meows <b5c6@protonmail.com>
* go.mod,go.sum: tame dependencies by bumping etclabscore/go-openrpc-reflect
This removes a problematic dependency
on github.com/ethereum/go-ethereum, which was
imported as a dependency for a couple github.com/etclabscore/go-openrpc-reflect
tests.
etclabscore/go-openrpc-reflect v0.0.36 has removed this
dependency, so this commit is the result of bumping
that version and then running 'go mod tidy'
This is in response to a review at
https://github.com/filecoin-project/lotus/pull/4711#pullrequestreview-535686205
Date: 2020-11-21 06:52:48-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* main: add 'miner' arg to openrpc gen cmd
This allows the command to EITHER
generate the doc for Full or Miner APIs.
See comment for usage.
Date: 2020-11-21 07:48:05-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* docgen: add missing examples for Miner API
Generating the Miner API OpenRPC doc
(via 'go run ./api/openrpc/cmd miner') caused
the example logic to panic because some types
were missing.
This commit adds those missing types, although
I'm not an expert in the API so I can't
suggest that the example values provided are
ideal or well representative.
Date: 2020-11-21 07:50:21-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* build/openrpc/full.json,build/openrpc/miner.json: add build/openrpc/[full/miner].json docs
These will be used as static documents
provided by the rpc.discover method.
Date: 2020-11-21 07:51:39-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* build: init go-rice openrpc static assets
Date: 2020-11-21 08:23:06-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* main: remove rpc.discover implementation from runtime plugin
Instead of generating the doc on the fly,
we're going to serve a static asset.
Rel https://github.com/filecoin-project/lotus/pull/4711#pullrequestreview-535686205
This removes the runtime implementation from the
RPC server construction.
Date: 2020-11-21 08:41:20-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* api,apistruct,common: add Discover(ctx) method to CommonAPI interface and structs
Date: 2020-11-21 08:41:56-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* main: use rpc server method aliasing for rpc.discover
This depends on a currently-forked change at
filecoin-project/go-jsonrpc 8350f9463ee451b187d35c492e32f1b999e80210
which establishes this new method RPCServer.AliasMethod.
This solves the problem that the OpenRPC
spec says that the document should be served
at the system extension-prefixed endpoing
rpc.discover (not Filecoin.Discover).
In fact, the document will be available at BOTH
endpoints, but that duplicity is harmless.
Date: 2020-11-21 09:18:26-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* api,apistruct,build,common: rpc.discover: return json object instead of string
Instead of casting the JSON asset from bytes to string,
unmarshal it to a map[string]interface{} so the
server will provide it as a JSON object.
Date: 2020-11-21 09:27:11-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* Makefile: merge resolve: docsgen command path
Date: 2020-11-22 07:19:36-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* apistruct,main,docgen,openrpc: merge resolve: fix func exporteds, signatures
Date: 2020-11-22 07:31:03-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* go.mod,go.sum: 'get get' auto-bumps version
Date: 2020-11-22 07:31:44-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* Makefile,docgen,main,build/openrpc: refactor openrpc documentation generation
This creates Makefile command docsgen-openrpc-json,
and refactors the docsgen command to generate both
the markdown and openrpc json documents, redirecting
the output of the openrpc json documentation to
the build/openrpc/ directory, where those json
files will be compiled as static assets via go-rice
boxes.
The api/openrpc/cmd now uses usage argumentation
congruent to that of the docgen command (switching
on API context).
Date: 2020-11-22 08:01:18-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* main,docgen_openrpc: rename api/openrpc -> api/docgen-openrpc
Renames the package as well.
This is intended to parallel the
existing docgen package and command
namespacing.
Date: 2020-11-22 10:34:46-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* api,apistruct,docgen,build,build/openrpc: use typed Discover response
Instead of using a map[string]interface{}, use
a typed response for the Discover method implementation.
This avoids having to set a docgen Example for
the generic map[string]interface{} (as an openrpc document)
which both pollutes the generic type and lacks
useful information for the Discover method example.
Date: 2020-11-22 08:31:16-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* apistruct,build,main,impl: implement Discover method for Worker and StorageMiner APIs
Methods return static compiled assets respective
to the APIs.
Date: 2020-11-22 08:57:18-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* docgen_openrpc,build/openrpc: remove timestamping from openrpc doc info
This should allow openrpc docs generated at different
times to be equal. This is important because the CI
(Circle) runs the docgen command and tests that
the output and the source are unchanged (via git diff).
Date: 2020-11-22 10:47:07-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* main,docgen_openrpc,main,build: fix lint issues
Fixes goimports, staticcheck, golint issues.
Date: 2020-11-22 11:06:46-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* docgenopenrpc: fix: don't use an underscore in package name (golint)
Date: 2020-11-22 11:07:53-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* go.sum: fix: mod-tidy-check (run 'go mod tidy')
Date: 2020-11-22 11:09:48-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* go.mod,go.sum: bump filecoin-project/go-jsonrpc dep to latest
This version includes the necessary RPCServer.AliasMethod
method.
Date: 2020-11-23 12:16:15-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* Makefile,main,build,build/openrpc: init gzipped openrpc static docs
Date: 2020-11-24 06:15:06-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* build: refactor gzip reading
Date: 2020-11-24 06:18:34-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* build: add basic test for openrpc doc from static assets
Date: 2020-11-24 06:30:23-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* build: handle reader Close error
This keeps the errcheck linter happy.
Date: 2020-11-24 06:33:14-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* go.sum: run 'go mod tidy'
Date: 2020-11-24 06:36:07-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* go.mod,go.sum: go mod tidy
Tidying up after resolving the merge conflicts
with master at go.mod
Date: 2020-11-24 06:40:45-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* go.mod,go.sum: bump filecoin-project/go-jsonrpc to latest
This is a repeat of 76e6fd2, since the latest merge
to master seems to have reverted this.
Date: 2020-11-24 06:42:30-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* docgenopenrpc,build/openrpc: remove method example pairings, improve schema examples
Removing method example pairings since they were
redundant to schema examples and were not
implemented well.
Improved schema examples by using the ExampleValue
method instead of the map lookup.
Made a note in the comment here that this is
not ideal, since we have to make a shortcut assumption
/workaround by using 'unknown' as the method name
and the typea as its own parent.
Luckily these values aren't heavily used by the
method logic.
Date: 2020-11-27 12:57:36-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* docgenopenrpc: use generic number jsonschema for number types
Previously used an integer schema assuming
hex encoding. It appears, based on review some
of the examples, that this may not be the case.
Obvioussly this schema could be more descriptive,
but just shooting for mostly likely to be
not wrong at this point.
Date: 2020-12-15 14:44:37-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* cmd/lotus,go.mod,go.sum: maybe fix straggling merge resolution conflicts
Date: 2021-01-19 12:30:42-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* build/openrpc/full.json.gz,build/openrpc/miner.json.gz,build/openrpc/worker.json.gz: run 'make docsgen'
Date: 2021-01-19 12:33:55-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* api/apistruct,node/impl: (lint) gofmt
Date: 2021-01-19 12:39:48-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* api/docgen: maybe fix parse error: open ./api: no such file or directory
Date: 2021-01-19 12:52:04-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* api/docgen,build/openrpc: maybe fix no such file error and run 'make docsgen'
Date: 2021-01-19 12:55:52-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* api/docgen: return if AST comment/groupdoc parsing encounters any error
This will returns empty comments/docs maps.
This should fix issues like:
https://app.circleci.com/pipelines/github/filecoin-project/lotus/12445/workflows/4ebadce9-a298-4ad1-939b-f19ef4c0a5bf/jobs/107218
where the environment makes file lookups hard or
impossible.
Date: 2021-01-19 13:04:58-06:00
Signed-off-by: meows <b5c6@protonmail.com>
* api: Don't depend on build/
* make: support parallel docsgen
* openrpc gen: Use simple build version
* methodgen
* goimports
Co-authored-by: meows <b5c6@protonmail.com>
2021-03-19 18:22:46 +00:00
|
|
|
### Discover
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"info": {
|
|
|
|
|
"title": "Lotus RPC API",
|
|
|
|
|
"version": "1.2.1/generated=2020-11-22T08:22:42-06:00"
|
|
|
|
|
},
|
|
|
|
|
"methods": [],
|
|
|
|
|
"openrpc": "1.2.6"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-10-18 18:10:39 +00:00
|
|
|
### Session
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response: `"07070707-0707-0707-0707-070707070707"`
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### Shutdown
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
|
|
|
|
### Version
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Version": "string value",
|
2022-11-25 21:06:19 +00:00
|
|
|
"APIVersion": 0,
|
|
|
|
|
"BlockDelay": 0
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Auth
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### AuthNew
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2021-12-28 02:38:12 +00:00
|
|
|
[
|
|
|
|
|
"write"
|
|
|
|
|
]
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"Ynl0ZSBhcnJheQ=="`
|
|
|
|
|
|
|
|
|
|
### AuthVerify
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"string value"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"write"
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
## Beacon
|
|
|
|
|
The Beacon method group contains methods for interacting with the random beacon (DRAND)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### BeaconGetEntry
|
|
|
|
|
BeaconGetEntry returns the beacon entry for the given filecoin epoch. If
|
|
|
|
|
the entry has not yet been produced, the call will block until the entry
|
|
|
|
|
becomes available
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
10101
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Round": 42,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Chain
|
|
|
|
|
The Chain method group contains methods for interacting with the
|
|
|
|
|
blockchain, but that do not require any form of state computation.
|
|
|
|
|
|
|
|
|
|
|
2020-09-10 17:47:19 +00:00
|
|
|
### ChainDeleteObj
|
|
|
|
|
ChainDeleteObj deletes node referenced by the given CID
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### ChainExport
|
|
|
|
|
ChainExport returns a stream of bytes with CAR dump of chain data.
|
2020-09-02 12:57:44 +00:00
|
|
|
The exported chain data includes the header chain from the given tipset
|
|
|
|
|
back to genesis, the entire genesis state, and the most recent 'nroots'
|
|
|
|
|
state trees.
|
2020-09-11 08:55:10 +00:00
|
|
|
If oldmsgskip is set, messages from before the requested roots are also not included.
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-09-02 12:57:44 +00:00
|
|
|
10101,
|
2020-09-11 08:55:10 +00:00
|
|
|
true,
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"Ynl0ZSBhcnJheQ=="`
|
|
|
|
|
|
|
|
|
|
### ChainGetBlock
|
|
|
|
|
ChainGetBlock returns the block specified by the given CID.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2020-10-06 07:30:40 +00:00
|
|
|
"Miner": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Ticket": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"VRFProof": null
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"ElectionProof": null,
|
|
|
|
|
"BeaconEntries": null,
|
|
|
|
|
"WinPoStProof": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Parents": [
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
],
|
2020-08-24 10:25:49 +00:00
|
|
|
"ParentWeight": "0",
|
|
|
|
|
"Height": 10101,
|
2022-11-25 21:06:19 +00:00
|
|
|
"ParentStateRoot": null,
|
|
|
|
|
"ParentMessageReceipts": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Messages": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"BLSAggregate": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Timestamp": 42,
|
2022-11-25 21:06:19 +00:00
|
|
|
"BlockSig": null,
|
|
|
|
|
"ForkSignaling": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"ParentBaseFee": "0"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### ChainGetBlockMessages
|
|
|
|
|
ChainGetBlockMessages returns messages stored in the specified block.
|
|
|
|
|
|
2021-03-18 21:12:22 +00:00
|
|
|
Note: If there are multiple blocks in a tipset, it's likely that some
|
|
|
|
|
messages will be duplicated. It's also possible for blocks in a tipset to have
|
|
|
|
|
different messages from the same sender at the same nonce. When that happens,
|
|
|
|
|
only the first message (in a block with lowest ticket) will be considered
|
|
|
|
|
for execution
|
|
|
|
|
|
|
|
|
|
NOTE: THIS METHOD SHOULD ONLY BE USED FOR GETTING MESSAGES IN A SPECIFIC BLOCK
|
|
|
|
|
|
|
|
|
|
DO NOT USE THIS METHOD TO GET MESSAGES INCLUDED IN A TIPSET
|
|
|
|
|
Use ChainGetParentMessages, which will perform correct message deduplication
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"BlsMessages": null,
|
|
|
|
|
"SecpkMessages": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Cids": [
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### ChainGetGenesis
|
|
|
|
|
ChainGetGenesis returns the genesis tipset.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Cids": null,
|
|
|
|
|
"Blocks": null,
|
|
|
|
|
"Height": 0
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### ChainGetMessage
|
|
|
|
|
ChainGetMessage reads a message referenced by the specified CID from the
|
|
|
|
|
chain blockstore.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Version": 42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
2020-10-12 18:47:09 +00:00
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2020-10-12 18:47:09 +00:00
|
|
|
}
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2021-07-01 03:20:22 +00:00
|
|
|
### ChainGetMessagesInTipset
|
|
|
|
|
ChainGetMessagesInTipset returns message stores in current tipset
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Cid": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
"Message": {
|
|
|
|
|
"Version": 42,
|
|
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
|
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
|
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2021-07-01 03:20:22 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### ChainGetNode
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"string value"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Cid": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
"Obj": {}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### ChainGetParentMessages
|
|
|
|
|
ChainGetParentMessages returns messages stored in parent tipset of the
|
|
|
|
|
specified block.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Cid": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
"Message": {
|
|
|
|
|
"Version": 42,
|
|
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
|
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
|
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### ChainGetParentReceipts
|
|
|
|
|
ChainGetParentReceipts returns receipts for messages in parent tipset of
|
2021-03-18 18:35:32 +00:00
|
|
|
the specified block. The receipts in the list returned is one-to-one with the
|
|
|
|
|
messages returned by a call to ChainGetParentMessages with the same blockCid.
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"ExitCode": 0,
|
|
|
|
|
"Return": "Ynl0ZSBhcnJheQ==",
|
2022-12-08 06:16:56 +00:00
|
|
|
"GasUsed": 0,
|
|
|
|
|
"EventsRoot": null
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### ChainGetPath
|
|
|
|
|
ChainGetPath returns a set of revert/apply operations needed to get from
|
|
|
|
|
one tipset to another, for example:
|
|
|
|
|
```
|
|
|
|
|
to
|
|
|
|
|
^
|
|
|
|
|
from tAA
|
|
|
|
|
^ ^
|
|
|
|
|
tBA tAB
|
|
|
|
|
^---*--^
|
|
|
|
|
^
|
|
|
|
|
tRR
|
|
|
|
|
```
|
|
|
|
|
Would return `[revert(tBA), apply(tAB), apply(tAA)]`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
],
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Type": "string value",
|
|
|
|
|
"Val": {
|
|
|
|
|
"Cids": null,
|
|
|
|
|
"Blocks": null,
|
|
|
|
|
"Height": 0
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### ChainGetRandomnessFromBeacon
|
|
|
|
|
ChainGetRandomnessFromBeacon is used to sample the beacon for randomness.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
],
|
|
|
|
|
2,
|
|
|
|
|
10101,
|
|
|
|
|
"Ynl0ZSBhcnJheQ=="
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response: `"Bw=="`
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### ChainGetRandomnessFromTickets
|
|
|
|
|
ChainGetRandomnessFromTickets is used to sample the chain for randomness.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
],
|
|
|
|
|
2,
|
|
|
|
|
10101,
|
|
|
|
|
"Ynl0ZSBhcnJheQ=="
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response: `"Bw=="`
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### ChainGetTipSet
|
|
|
|
|
ChainGetTipSet returns the tipset specified by the given TipSetKey.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Cids": null,
|
|
|
|
|
"Blocks": null,
|
|
|
|
|
"Height": 0
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### ChainGetTipSetByHeight
|
|
|
|
|
ChainGetTipSetByHeight looks back for a tipset at the specified epoch.
|
|
|
|
|
If there are no blocks at the specified epoch, a tipset at an earlier epoch
|
|
|
|
|
will be returned.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
10101,
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Cids": null,
|
|
|
|
|
"Blocks": null,
|
|
|
|
|
"Height": 0
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### ChainHasObj
|
|
|
|
|
ChainHasObj checks if a given CID exists in the chain blockstore.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `true`
|
|
|
|
|
|
|
|
|
|
### ChainHead
|
|
|
|
|
ChainHead returns the current head of the chain.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Cids": null,
|
|
|
|
|
"Blocks": null,
|
|
|
|
|
"Height": 0
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### ChainNotify
|
|
|
|
|
ChainNotify returns channel with chain head updates.
|
|
|
|
|
First message is guaranteed to be of len == 1, and type == 'current'.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Type": "string value",
|
|
|
|
|
"Val": {
|
|
|
|
|
"Cids": null,
|
|
|
|
|
"Blocks": null,
|
|
|
|
|
"Height": 0
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
2022-06-07 03:14:16 +00:00
|
|
|
### ChainPutObj
|
|
|
|
|
ChainPutObj puts and object into the blockstore
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms:
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### ChainReadObj
|
|
|
|
|
ChainReadObj reads ipld nodes referenced by the specified CID from chain
|
|
|
|
|
blockstore and returns raw bytes.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"Ynl0ZSBhcnJheQ=="`
|
|
|
|
|
|
|
|
|
|
### ChainSetHead
|
|
|
|
|
ChainSetHead forcefully sets current chain head. Use with caution.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
|
|
|
|
### ChainStatObj
|
|
|
|
|
ChainStatObj returns statistics about the graph referenced by 'obj'.
|
|
|
|
|
If 'base' is also specified, then the returned stat will be a diff
|
|
|
|
|
between the two objects.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Size": 42,
|
|
|
|
|
"Links": 42
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### ChainTipSetWeight
|
|
|
|
|
ChainTipSetWeight computes weight for the specified tipset.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"0"`
|
|
|
|
|
|
|
|
|
|
## Client
|
|
|
|
|
The Client methods all have to do with interacting with the storage and
|
|
|
|
|
retrieval markets as a client
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### ClientCalcCommP
|
|
|
|
|
ClientCalcCommP calculates the CommP for a specified file
|
|
|
|
|
|
|
|
|
|
|
2021-03-23 12:42:56 +00:00
|
|
|
Perms: write
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"string value"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Root": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
"Size": 1024
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-10-24 01:35:01 +00:00
|
|
|
### ClientCancelDataTransfer
|
|
|
|
|
ClientCancelDataTransfer cancels a data transfer with the given transfer ID and other peer
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
3,
|
|
|
|
|
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
|
|
|
|
|
true
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
2021-03-24 12:36:21 +00:00
|
|
|
### ClientCancelRetrievalDeal
|
|
|
|
|
ClientCancelRetrievalDeal cancels an ongoing retrieval deal based on DealID
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
5
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### ClientDataTransferUpdates
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"TransferID": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Status": 1,
|
2022-11-25 21:06:19 +00:00
|
|
|
"BaseCID": null,
|
|
|
|
|
"IsInitiator": false,
|
|
|
|
|
"IsSender": false,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Voucher": "string value",
|
|
|
|
|
"Message": "string value",
|
2022-11-25 21:06:19 +00:00
|
|
|
"OtherPeer": "",
|
2021-03-29 15:32:09 +00:00
|
|
|
"Transferred": 42,
|
|
|
|
|
"Stages": {
|
2021-12-28 02:38:12 +00:00
|
|
|
"Stages": [
|
|
|
|
|
{
|
|
|
|
|
"Name": "string value",
|
|
|
|
|
"Description": "string value",
|
|
|
|
|
"CreatedTime": "0001-01-01T00:00:00Z",
|
|
|
|
|
"UpdatedTime": "0001-01-01T00:00:00Z",
|
|
|
|
|
"Logs": [
|
|
|
|
|
{
|
|
|
|
|
"Log": "string value",
|
|
|
|
|
"UpdatedTime": "0001-01-01T00:00:00Z"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
]
|
2021-03-29 15:32:09 +00:00
|
|
|
}
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-10-22 11:59:08 +00:00
|
|
|
### ClientDealPieceCID
|
|
|
|
|
ClientCalcCommP calculates the CommP and data size of the specified CID
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"PayloadSize": 0,
|
|
|
|
|
"PieceSize": 0,
|
|
|
|
|
"PieceCID": null
|
2020-10-22 11:59:08 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### ClientDealSize
|
|
|
|
|
ClientDealSize calculates real deal data size
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"PayloadSize": 0,
|
|
|
|
|
"PieceSize": 0
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### ClientFindData
|
|
|
|
|
ClientFindData identifies peers that have a certain file, and returns QueryOffers (one per peer).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
2022-11-11 20:20:28 +00:00
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Err": "string value",
|
|
|
|
|
"Root": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
2022-11-11 20:20:28 +00:00
|
|
|
"Piece": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
2021-12-28 02:38:12 +00:00
|
|
|
"Size": 42,
|
|
|
|
|
"MinPrice": "0",
|
|
|
|
|
"UnsealPrice": "0",
|
|
|
|
|
"PricePerByte": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"PaymentInterval": 0,
|
|
|
|
|
"PaymentIntervalIncrease": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Miner": "f01234",
|
|
|
|
|
"MinerPeer": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"Address": "\u003cempty\u003e",
|
|
|
|
|
"ID": "",
|
2021-12-28 02:38:12 +00:00
|
|
|
"PieceCID": null
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### ClientGenCar
|
|
|
|
|
ClientGenCar generates a CAR file for the specified file.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Path": "string value",
|
2022-11-25 21:06:19 +00:00
|
|
|
"IsCAR": false
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
"string value"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
|
|
|
|
### ClientGetDealInfo
|
|
|
|
|
ClientGetDealInfo returns the latest information about a given deal.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"ProposalCid": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"State": 42,
|
|
|
|
|
"Message": "string value",
|
2022-11-25 21:06:19 +00:00
|
|
|
"DealStages": null,
|
2020-10-06 07:30:40 +00:00
|
|
|
"Provider": "f01234",
|
2022-11-25 21:06:19 +00:00
|
|
|
"DataRef": null,
|
|
|
|
|
"PieceCID": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Size": 42,
|
|
|
|
|
"PricePerEpoch": "0",
|
|
|
|
|
"Duration": 42,
|
2022-11-25 21:06:19 +00:00
|
|
|
"DealID": 0,
|
2020-10-03 07:41:01 +00:00
|
|
|
"CreationTime": "0001-01-01T00:00:00Z",
|
2020-12-08 14:18:47 +00:00
|
|
|
"Verified": true,
|
2022-11-25 21:06:19 +00:00
|
|
|
"TransferChannelID": null,
|
|
|
|
|
"DataTransfer": null
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-10-09 04:25:38 +00:00
|
|
|
### ClientGetDealStatus
|
|
|
|
|
ClientGetDealStatus returns status given a code
|
|
|
|
|
|
|
|
|
|
|
2020-10-22 12:15:11 +00:00
|
|
|
Perms: read
|
2020-10-09 04:25:38 +00:00
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
42
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"string value"`
|
|
|
|
|
|
2020-08-28 20:17:35 +00:00
|
|
|
### ClientGetDealUpdates
|
|
|
|
|
ClientGetDealUpdates returns the status of updated deals
|
|
|
|
|
|
|
|
|
|
|
2021-03-23 12:42:56 +00:00
|
|
|
Perms: write
|
2020-08-28 20:17:35 +00:00
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"ProposalCid": null,
|
2020-08-28 20:17:35 +00:00
|
|
|
"State": 42,
|
|
|
|
|
"Message": "string value",
|
2022-11-25 21:06:19 +00:00
|
|
|
"DealStages": null,
|
2020-10-06 07:30:40 +00:00
|
|
|
"Provider": "f01234",
|
2022-11-25 21:06:19 +00:00
|
|
|
"DataRef": null,
|
|
|
|
|
"PieceCID": null,
|
2020-08-28 20:17:35 +00:00
|
|
|
"Size": 42,
|
2022-11-25 21:06:19 +00:00
|
|
|
"PricePerEpoch": "\u003cnil\u003e",
|
2020-08-28 20:17:35 +00:00
|
|
|
"Duration": 42,
|
2022-11-25 21:06:19 +00:00
|
|
|
"DealID": 0,
|
2020-10-03 07:41:01 +00:00
|
|
|
"CreationTime": "0001-01-01T00:00:00Z",
|
2020-12-08 14:18:47 +00:00
|
|
|
"Verified": true,
|
2022-11-25 21:06:19 +00:00
|
|
|
"TransferChannelID": null,
|
|
|
|
|
"DataTransfer": null
|
2020-08-28 20:17:35 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2021-05-27 22:00:31 +00:00
|
|
|
### ClientGetRetrievalUpdates
|
|
|
|
|
ClientGetRetrievalUpdates returns status of updated retrieval deals
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"PayloadCID": null,
|
|
|
|
|
"ID": 0,
|
2021-05-27 22:00:31 +00:00
|
|
|
"PieceCID": null,
|
2022-11-25 21:06:19 +00:00
|
|
|
"PricePerByte": "\u003cnil\u003e",
|
|
|
|
|
"UnsealPrice": "\u003cnil\u003e",
|
2021-05-27 22:00:31 +00:00
|
|
|
"Status": 0,
|
|
|
|
|
"Message": "string value",
|
|
|
|
|
"Provider": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
|
2022-11-25 21:06:19 +00:00
|
|
|
"BytesReceived": 0,
|
|
|
|
|
"BytesPaidFor": 0,
|
|
|
|
|
"TotalPaid": "\u003cnil\u003e",
|
|
|
|
|
"TransferChannelID": null,
|
|
|
|
|
"DataTransfer": null,
|
2021-11-10 16:51:16 +00:00
|
|
|
"Event": 5
|
2021-05-27 22:00:31 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### ClientHasLocal
|
|
|
|
|
ClientHasLocal indicates whether a certain CID is locally stored.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `true`
|
|
|
|
|
|
|
|
|
|
### ClientImport
|
|
|
|
|
ClientImport imports file under the specified path into filestore.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Path": "string value",
|
2022-11-25 21:06:19 +00:00
|
|
|
"IsCAR": false
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Root": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"ImportID": 0
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### ClientListDataTransfers
|
|
|
|
|
ClientListTransfers returns the status of all ongoing transfers of data
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"TransferID": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Status": 1,
|
2022-11-25 21:06:19 +00:00
|
|
|
"BaseCID": null,
|
|
|
|
|
"IsInitiator": false,
|
|
|
|
|
"IsSender": false,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Voucher": "string value",
|
|
|
|
|
"Message": "string value",
|
2022-11-25 21:06:19 +00:00
|
|
|
"OtherPeer": "",
|
2021-12-28 02:38:12 +00:00
|
|
|
"Transferred": 42,
|
|
|
|
|
"Stages": {
|
|
|
|
|
"Stages": [
|
|
|
|
|
{
|
|
|
|
|
"Name": "string value",
|
|
|
|
|
"Description": "string value",
|
|
|
|
|
"CreatedTime": "0001-01-01T00:00:00Z",
|
|
|
|
|
"UpdatedTime": "0001-01-01T00:00:00Z",
|
|
|
|
|
"Logs": [
|
|
|
|
|
{
|
|
|
|
|
"Log": "string value",
|
|
|
|
|
"UpdatedTime": "0001-01-01T00:00:00Z"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### ClientListDeals
|
|
|
|
|
ClientListDeals returns information about the deals made by the local client.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"ProposalCid": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"State": 42,
|
|
|
|
|
"Message": "string value",
|
2022-11-25 21:06:19 +00:00
|
|
|
"DealStages": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Provider": "f01234",
|
2022-11-25 21:06:19 +00:00
|
|
|
"DataRef": null,
|
|
|
|
|
"PieceCID": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Size": 42,
|
|
|
|
|
"PricePerEpoch": "0",
|
|
|
|
|
"Duration": 42,
|
2022-11-25 21:06:19 +00:00
|
|
|
"DealID": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"CreationTime": "0001-01-01T00:00:00Z",
|
|
|
|
|
"Verified": true,
|
2022-11-25 21:06:19 +00:00
|
|
|
"TransferChannelID": null,
|
|
|
|
|
"DataTransfer": null
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### ClientListImports
|
|
|
|
|
ClientListImports lists imported files and their root CIDs
|
|
|
|
|
|
|
|
|
|
|
2021-05-27 22:00:31 +00:00
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Key": 50,
|
|
|
|
|
"Err": "string value",
|
2022-11-11 20:20:28 +00:00
|
|
|
"Root": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
2021-12-28 02:38:12 +00:00
|
|
|
"Source": "string value",
|
2022-11-25 21:06:19 +00:00
|
|
|
"FilePath": "",
|
|
|
|
|
"CARPath": ""
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2021-05-27 22:00:31 +00:00
|
|
|
|
|
|
|
|
### ClientListRetrievals
|
|
|
|
|
ClientQueryAsk returns a signed StorageAsk from the specified miner.
|
|
|
|
|
ClientListRetrievals returns information about retrievals made by the local client
|
|
|
|
|
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"PayloadCID": null,
|
|
|
|
|
"ID": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"PieceCID": null,
|
|
|
|
|
"PricePerByte": "0",
|
|
|
|
|
"UnsealPrice": "0",
|
|
|
|
|
"Status": 0,
|
|
|
|
|
"Message": "string value",
|
|
|
|
|
"Provider": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
|
2022-11-25 21:06:19 +00:00
|
|
|
"BytesReceived": 0,
|
|
|
|
|
"BytesPaidFor": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"TotalPaid": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"TransferChannelID": null,
|
|
|
|
|
"DataTransfer": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Event": 5
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### ClientMinerQueryOffer
|
|
|
|
|
ClientMinerQueryOffer returns a QueryOffer for the specific miner and file.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
2022-11-11 20:20:28 +00:00
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Err": "string value",
|
|
|
|
|
"Root": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
2022-11-11 20:20:28 +00:00
|
|
|
"Piece": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
2020-08-24 10:25:49 +00:00
|
|
|
"Size": 42,
|
2022-11-25 21:06:19 +00:00
|
|
|
"MinPrice": "\u003cnil\u003e",
|
|
|
|
|
"UnsealPrice": "\u003cnil\u003e",
|
|
|
|
|
"PricePerByte": "\u003cnil\u003e",
|
|
|
|
|
"PaymentInterval": 0,
|
|
|
|
|
"PaymentIntervalIncrease": 0,
|
2020-10-06 07:30:40 +00:00
|
|
|
"Miner": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"MinerPeer": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"Address": "\u003cempty\u003e",
|
|
|
|
|
"ID": "",
|
2020-08-24 10:25:49 +00:00
|
|
|
"PieceCID": null
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### ClientQueryAsk
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234"
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2020-09-29 11:53:30 +00:00
|
|
|
"Price": "0",
|
|
|
|
|
"VerifiedPrice": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"MinPieceSize": 0,
|
|
|
|
|
"MaxPieceSize": 0,
|
2020-10-06 07:30:40 +00:00
|
|
|
"Miner": "f01234",
|
2020-09-29 11:53:30 +00:00
|
|
|
"Timestamp": 10101,
|
|
|
|
|
"Expiry": 10101,
|
2022-11-25 21:06:19 +00:00
|
|
|
"SeqNo": 0
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### ClientRemoveImport
|
|
|
|
|
ClientRemoveImport removes file import
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
50
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
2020-10-13 10:37:00 +00:00
|
|
|
### ClientRestartDataTransfer
|
|
|
|
|
ClientRestartDataTransfer attempts to restart a data transfer with the given transfer ID and other peer
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
3,
|
|
|
|
|
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
|
|
|
|
|
true
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### ClientRetrieve
|
|
|
|
|
ClientRetrieve initiates the retrieval of a file, as specified in the order.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Root": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
2022-11-11 20:20:28 +00:00
|
|
|
"Piece": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"DatamodelPathSelector": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Size": 42,
|
2022-11-25 21:06:19 +00:00
|
|
|
"FromLocalCAR": "",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Total": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"UnsealPrice": "\u003cnil\u003e",
|
|
|
|
|
"PaymentInterval": 0,
|
|
|
|
|
"PaymentIntervalIncrease": 0,
|
2020-10-06 07:30:40 +00:00
|
|
|
"Client": "f01234",
|
|
|
|
|
"Miner": "f01234",
|
2022-11-25 21:06:19 +00:00
|
|
|
"MinerPeer": null
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"Path": "string value",
|
2022-11-25 21:06:19 +00:00
|
|
|
"IsCAR": false
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
2020-09-07 12:35:29 +00:00
|
|
|
### ClientRetrieveTryRestartInsufficientFunds
|
|
|
|
|
ClientRetrieveTryRestartInsufficientFunds attempts to restart stalled retrievals on a given payment channel
|
|
|
|
|
which are stuck due to insufficient funds
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234"
|
2020-09-07 12:35:29 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### ClientRetrieveWithEvents
|
|
|
|
|
ClientRetrieveWithEvents initiates the retrieval of a file, as specified in the order, and provides a channel
|
|
|
|
|
of status updates.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Root": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
2022-11-11 20:20:28 +00:00
|
|
|
"Piece": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"DatamodelPathSelector": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Size": 42,
|
2022-11-25 21:06:19 +00:00
|
|
|
"FromLocalCAR": "",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Total": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"UnsealPrice": "\u003cnil\u003e",
|
|
|
|
|
"PaymentInterval": 0,
|
|
|
|
|
"PaymentIntervalIncrease": 0,
|
2020-10-06 07:30:40 +00:00
|
|
|
"Client": "f01234",
|
|
|
|
|
"Miner": "f01234",
|
2022-11-25 21:06:19 +00:00
|
|
|
"MinerPeer": null
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"Path": "string value",
|
2022-11-25 21:06:19 +00:00
|
|
|
"IsCAR": false
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Event": 5,
|
|
|
|
|
"Status": 0,
|
2022-11-25 21:06:19 +00:00
|
|
|
"BytesReceived": 0,
|
|
|
|
|
"FundsSpent": "\u003cnil\u003e",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Err": "string value"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### ClientStartDeal
|
|
|
|
|
ClientStartDeal proposes a deal with a miner.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
2021-04-05 17:15:32 +00:00
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Data": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"TransferType": "",
|
2021-04-05 17:15:32 +00:00
|
|
|
"Root": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
"PieceCid": null,
|
2022-11-25 21:06:19 +00:00
|
|
|
"PieceSize": 0,
|
|
|
|
|
"RawBlockSize": 0
|
2021-04-05 17:15:32 +00:00
|
|
|
},
|
|
|
|
|
"Wallet": "f01234",
|
|
|
|
|
"Miner": "f01234",
|
|
|
|
|
"EpochPrice": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"MinBlocksDuration": 0,
|
2021-04-05 17:15:32 +00:00
|
|
|
"ProviderCollateral": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"DealStartEpoch": 0,
|
|
|
|
|
"FastRetrieval": false,
|
|
|
|
|
"VerifiedDeal": false
|
2021-04-05 17:15:32 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2022-11-11 20:20:28 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
2021-04-05 17:15:32 +00:00
|
|
|
|
|
|
|
|
### ClientStatelessDeal
|
|
|
|
|
ClientStatelessDeal fire-and-forget-proposes an offline deal to a miner without subsequent tracking.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Data": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"TransferType": "",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Root": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
"PieceCid": null,
|
2022-11-25 21:06:19 +00:00
|
|
|
"PieceSize": 0,
|
|
|
|
|
"RawBlockSize": 0
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
2020-10-06 07:30:40 +00:00
|
|
|
"Wallet": "f01234",
|
|
|
|
|
"Miner": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"EpochPrice": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"MinBlocksDuration": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"ProviderCollateral": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"DealStartEpoch": 0,
|
|
|
|
|
"FastRetrieval": false,
|
|
|
|
|
"VerifiedDeal": false
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2022-11-11 20:20:28 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
2020-10-01 16:00:24 +00:00
|
|
|
## Create
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### CreateBackup
|
|
|
|
|
CreateBackup creates node backup onder the specified file name. The
|
|
|
|
|
method requires that the lotus daemon is running with the
|
|
|
|
|
LOTUS_BACKUP_BASE_PATH environment variable set to some path, and that
|
|
|
|
|
the path specified when calling CreateBackup is within the base path
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"string value"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
## Gas
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### GasEstimateFeeCap
|
|
|
|
|
GasEstimateFeeCap estimates gas fee cap
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Version": 42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
2020-10-12 18:47:09 +00:00
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2020-10-12 18:47:09 +00:00
|
|
|
}
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
9,
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"0"`
|
|
|
|
|
|
|
|
|
|
### GasEstimateGasLimit
|
|
|
|
|
GasEstimateGasLimit estimates gas used by the message and returns it.
|
|
|
|
|
It fails if message fails to execute.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Version": 42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
2020-10-12 18:47:09 +00:00
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2020-10-12 18:47:09 +00:00
|
|
|
}
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `9`
|
|
|
|
|
|
|
|
|
|
### GasEstimateGasPremium
|
|
|
|
|
GasEstimateGasPremium estimates what gas price should be used for a
|
|
|
|
|
message to have high likelihood of inclusion in `nblocksincl` epochs.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
9,
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"0"`
|
|
|
|
|
|
|
|
|
|
### GasEstimateMessageGas
|
|
|
|
|
GasEstimateMessageGas estimates gas values for unset message gas fields
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Version": 42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
2020-10-12 18:47:09 +00:00
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2020-10-12 18:47:09 +00:00
|
|
|
}
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
{
|
2022-08-16 19:56:32 +00:00
|
|
|
"MaxFee": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"MsgUuid": "00000000-0000-0000-0000-000000000000"
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Version": 42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
2020-10-12 18:47:09 +00:00
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2020-10-12 18:47:09 +00:00
|
|
|
}
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## I
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### ID
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response: `"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"`
|
|
|
|
|
|
|
|
|
|
## Log
|
|
|
|
|
|
|
|
|
|
|
2021-08-17 13:15:36 +00:00
|
|
|
### LogAlerts
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Type": {
|
|
|
|
|
"System": "string value",
|
|
|
|
|
"Subsystem": "string value"
|
|
|
|
|
},
|
|
|
|
|
"Active": true,
|
2022-11-25 21:06:19 +00:00
|
|
|
"LastActive": null,
|
|
|
|
|
"LastResolved": null
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2021-08-17 13:15:36 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### LogList
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"string value"
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### LogSetLevel
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"string value",
|
|
|
|
|
"string value"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
|
|
|
|
## Market
|
|
|
|
|
|
|
|
|
|
|
2021-01-06 13:27:28 +00:00
|
|
|
### MarketAddBalance
|
|
|
|
|
MarketAddBalance adds funds to the market actor
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
|
|
|
|
"0"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2021-01-07 08:35:30 +00:00
|
|
|
### MarketGetReserved
|
|
|
|
|
MarketGetReserved gets the amount of funds that are currently reserved for the address
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"f01234"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"0"`
|
|
|
|
|
|
2020-11-11 05:08:23 +00:00
|
|
|
### MarketReleaseFunds
|
|
|
|
|
MarketReleaseFunds releases funds reserved by MarketReserveFunds
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"f01234",
|
|
|
|
|
"0"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
|
|
|
|
### MarketReserveFunds
|
|
|
|
|
MarketReserveFunds reserves funds for a deal
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
|
2020-12-03 21:20:50 +00:00
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
|
|
|
|
"0"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### MarketWithdraw
|
|
|
|
|
MarketWithdraw withdraws unlocked funds from the market actor
|
|
|
|
|
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"0"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Miner
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### MinerCreateBlock
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
2020-10-06 07:30:40 +00:00
|
|
|
"Miner": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Parents": [
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
],
|
|
|
|
|
"Ticket": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"VRFProof": null
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
"Eproof": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"WinCount": 0,
|
|
|
|
|
"VRFProof": null
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"BeaconValues": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Messages": [
|
|
|
|
|
{
|
|
|
|
|
"Message": {
|
|
|
|
|
"Version": 42,
|
|
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
|
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
|
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"Signature": {
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
},
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
],
|
2020-08-24 10:25:49 +00:00
|
|
|
"Epoch": 10101,
|
|
|
|
|
"Timestamp": 42,
|
2022-11-25 21:06:19 +00:00
|
|
|
"WinningPoStProof": null
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Header": {
|
2020-10-06 07:30:40 +00:00
|
|
|
"Miner": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Ticket": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"VRFProof": null
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"ElectionProof": null,
|
|
|
|
|
"BeaconEntries": null,
|
|
|
|
|
"WinPoStProof": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Parents": [
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
],
|
2020-08-24 10:25:49 +00:00
|
|
|
"ParentWeight": "0",
|
|
|
|
|
"Height": 10101,
|
2022-11-25 21:06:19 +00:00
|
|
|
"ParentStateRoot": null,
|
|
|
|
|
"ParentMessageReceipts": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Messages": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"BLSAggregate": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Timestamp": 42,
|
2022-11-25 21:06:19 +00:00
|
|
|
"BlockSig": null,
|
|
|
|
|
"ForkSignaling": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"ParentBaseFee": "0"
|
|
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"BlsMessages": null,
|
|
|
|
|
"SecpkMessages": null
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### MinerGetBaseInfo
|
|
|
|
|
There are not yet any comments for this method.
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
10101,
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"MinerPower": "0",
|
|
|
|
|
"NetworkPower": "0",
|
2021-12-28 02:38:12 +00:00
|
|
|
"Sectors": [
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"SealProof": 0,
|
|
|
|
|
"SectorNumber": 0,
|
2021-12-08 17:11:19 +00:00
|
|
|
"SectorKey": null,
|
2022-11-25 21:06:19 +00:00
|
|
|
"SealedCID": null
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
],
|
2022-11-25 21:06:19 +00:00
|
|
|
"WorkerKey": "\u003cempty\u003e",
|
|
|
|
|
"SectorSize": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"PrevBeaconEntry": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"Round": 0,
|
|
|
|
|
"Data": null
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"BeaconEntries": null,
|
|
|
|
|
"EligibleForMining": false
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Mpool
|
|
|
|
|
The Mpool methods are for interacting with the message pool. The message pool
|
|
|
|
|
manages all incoming and outgoing 'messages' going over the network.
|
|
|
|
|
|
|
|
|
|
|
2020-10-22 12:46:10 +00:00
|
|
|
### MpoolBatchPush
|
|
|
|
|
MpoolBatchPush batch pushes a signed message to mempool.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2021-12-28 02:38:12 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Message": {
|
|
|
|
|
"Version": 42,
|
|
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
|
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
|
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"Signature": {
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
},
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
2020-10-22 12:46:10 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-10-22 12:46:10 +00:00
|
|
|
|
|
|
|
|
### MpoolBatchPushMessage
|
|
|
|
|
MpoolBatchPushMessage batch pushes a unsigned message to mempool.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2021-12-28 02:38:12 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Version": 42,
|
|
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
|
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
|
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
],
|
2020-10-22 12:46:10 +00:00
|
|
|
{
|
2022-08-16 19:56:32 +00:00
|
|
|
"MaxFee": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"MsgUuid": "00000000-0000-0000-0000-000000000000"
|
2020-10-22 12:46:10 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Message": {
|
|
|
|
|
"Version": 42,
|
|
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
|
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
|
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"Signature": {
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
},
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-10-22 12:46:10 +00:00
|
|
|
|
|
|
|
|
### MpoolBatchPushUntrusted
|
|
|
|
|
MpoolBatchPushUntrusted batch pushes a signed message to mempool from untrusted sources.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2021-12-28 02:38:12 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Message": {
|
|
|
|
|
"Version": 42,
|
|
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
|
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
|
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"Signature": {
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
},
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
2020-10-22 12:46:10 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-10-22 12:46:10 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### MpoolClear
|
|
|
|
|
MpoolClear clears pending messages from the mpool
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
true
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
|
|
|
|
### MpoolGetConfig
|
|
|
|
|
MpoolGetConfig returns (a copy of) the current mpool config
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"PriorityAddrs": null,
|
|
|
|
|
"SizeLimitHigh": 0,
|
|
|
|
|
"SizeLimitLow": 0,
|
|
|
|
|
"ReplaceByFeeRatio": 0,
|
|
|
|
|
"PruneCooldown": 0,
|
|
|
|
|
"GasLimitOverestimation": 0
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### MpoolGetNonce
|
|
|
|
|
MpoolGetNonce gets next nonce for the specified sender.
|
|
|
|
|
Note that this method may not be atomic. Use MpoolPushMessage instead.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234"
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `42`
|
|
|
|
|
|
|
|
|
|
### MpoolPending
|
|
|
|
|
MpoolPending returns pending mempool messages.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Message": {
|
|
|
|
|
"Version": 42,
|
|
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
|
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
|
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"Signature": {
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
},
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### MpoolPush
|
|
|
|
|
MpoolPush pushes a signed message to mempool.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Message": {
|
|
|
|
|
"Version": 42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
2020-10-12 18:47:09 +00:00
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2020-10-12 18:47:09 +00:00
|
|
|
}
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
"Signature": {
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
2020-10-12 18:47:09 +00:00
|
|
|
},
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### MpoolPushMessage
|
|
|
|
|
MpoolPushMessage atomically assigns a nonce, signs, and pushes a message
|
|
|
|
|
to mempool.
|
|
|
|
|
maxFee is only used when GasFeeCap/GasPremium fields aren't specified
|
|
|
|
|
|
|
|
|
|
When maxFee is set to 0, MpoolPushMessage will guess appropriate fee
|
|
|
|
|
based on current chain conditions
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Version": 42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
2020-10-12 18:47:09 +00:00
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2020-10-12 18:47:09 +00:00
|
|
|
}
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
{
|
2022-08-16 19:56:32 +00:00
|
|
|
"MaxFee": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"MsgUuid": "00000000-0000-0000-0000-000000000000"
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Message": {
|
|
|
|
|
"Version": 42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
2020-10-12 18:47:09 +00:00
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2020-10-12 18:47:09 +00:00
|
|
|
}
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
"Signature": {
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
2020-10-12 18:47:09 +00:00
|
|
|
},
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-10-02 21:14:47 +00:00
|
|
|
### MpoolPushUntrusted
|
|
|
|
|
MpoolPushUntrusted pushes a signed message to mempool from untrusted sources.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Message": {
|
|
|
|
|
"Version": 42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
2020-10-02 21:14:47 +00:00
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2020-10-02 21:14:47 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
2020-10-12 18:47:09 +00:00
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2020-10-12 18:47:09 +00:00
|
|
|
}
|
2020-10-02 21:14:47 +00:00
|
|
|
},
|
|
|
|
|
"Signature": {
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
2020-10-12 18:47:09 +00:00
|
|
|
},
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2020-10-02 21:14:47 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### MpoolSelect
|
|
|
|
|
MpoolSelect returns a list of pending messages for inclusion in the next block
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
],
|
|
|
|
|
12.3
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Message": {
|
|
|
|
|
"Version": 42,
|
|
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
|
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
|
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"Signature": {
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
},
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### MpoolSetConfig
|
|
|
|
|
MpoolSetConfig sets the mpool config to (a copy of) the supplied config
|
|
|
|
|
|
|
|
|
|
|
2021-03-23 12:42:56 +00:00
|
|
|
Perms: admin
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"PriorityAddrs": null,
|
|
|
|
|
"SizeLimitHigh": 0,
|
|
|
|
|
"SizeLimitLow": 0,
|
|
|
|
|
"ReplaceByFeeRatio": 0,
|
|
|
|
|
"PruneCooldown": 0,
|
|
|
|
|
"GasLimitOverestimation": 0
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
|
|
|
|
### MpoolSub
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Type": 0,
|
|
|
|
|
"Message": {
|
|
|
|
|
"Message": {
|
|
|
|
|
"Version": 42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
2020-10-12 18:47:09 +00:00
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2020-10-12 18:47:09 +00:00
|
|
|
}
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
"Signature": {
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
2020-10-12 18:47:09 +00:00
|
|
|
},
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Msig
|
|
|
|
|
The Msig methods are used to interact with multisig wallets on the
|
|
|
|
|
filecoin network
|
|
|
|
|
|
|
|
|
|
|
2020-09-06 07:51:06 +00:00
|
|
|
### MsigAddApprove
|
|
|
|
|
MsigAddApprove approves a previously proposed AddSigner message
|
|
|
|
|
It takes the following params: <multisig address>, <sender address of the approve msg>, <proposed message ID>,
|
|
|
|
|
<proposer address>, <new signer>, <whether the number of required signers should be increased>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
2020-09-06 07:51:06 +00:00
|
|
|
42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
2020-09-06 07:51:06 +00:00
|
|
|
true
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### MsigAddCancel
|
|
|
|
|
MsigAddCancel cancels a previously proposed AddSigner message
|
|
|
|
|
It takes the following params: <multisig address>, <sender address of the cancel msg>, <proposed message ID>,
|
|
|
|
|
<new signer>, <whether the number of required signers should be increased>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
2020-09-06 07:51:06 +00:00
|
|
|
42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-09-06 07:51:06 +00:00
|
|
|
true
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### MsigAddPropose
|
|
|
|
|
MsigAddPropose proposes adding a signer in the multisig
|
|
|
|
|
It takes the following params: <multisig address>, <sender address of the propose msg>,
|
|
|
|
|
<new signer>, <whether the number of required signers should be increased>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
2020-09-06 07:51:06 +00:00
|
|
|
true
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### MsigApprove
|
2020-10-10 10:28:59 +00:00
|
|
|
MsigApprove approves a previously-proposed multisig message by transaction ID
|
|
|
|
|
It takes the following params: <multisig address>, <proposed transaction ID> <signer address>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"f01234",
|
|
|
|
|
42,
|
|
|
|
|
"f01234"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### MsigApproveTxnHash
|
|
|
|
|
MsigApproveTxnHash approves a previously-proposed multisig message, specified
|
|
|
|
|
using both transaction ID and a hash of the parameters used in the
|
|
|
|
|
proposal. This method of approval can be used to ensure you only approve
|
|
|
|
|
exactly the transaction you think you are.
|
2020-08-24 10:25:49 +00:00
|
|
|
It takes the following params: <multisig address>, <proposed message ID>, <proposer address>, <recipient address>, <value to transfer>,
|
2021-06-15 02:59:17 +00:00
|
|
|
<sender address of the approve msg>, <method to call in the approved message>, <params to include in the proposed message>
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"0",
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
42,
|
|
|
|
|
"Ynl0ZSBhcnJheQ=="
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### MsigCancel
|
|
|
|
|
MsigCancel cancels a previously-proposed multisig message
|
2020-10-10 10:28:59 +00:00
|
|
|
It takes the following params: <multisig address>, <proposed transaction ID>, <recipient address>, <value to transfer>,
|
2020-08-24 10:25:49 +00:00
|
|
|
<sender address of the cancel msg>, <method to call in the proposed message>, <params to include in the proposed message>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"0",
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
42,
|
|
|
|
|
"Ynl0ZSBhcnJheQ=="
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### MsigCreate
|
|
|
|
|
MsigCreate creates a multisig wallet
|
|
|
|
|
It takes the following params: <required number of senders>, <approving addresses>, <unlock duration>
|
|
|
|
|
<initial balance>, <sender address of the create msg>, <gas price>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
42,
|
2021-12-28 02:38:12 +00:00
|
|
|
[
|
|
|
|
|
"f01234"
|
|
|
|
|
],
|
2020-08-24 10:25:49 +00:00
|
|
|
10101,
|
|
|
|
|
"0",
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"0"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### MsigGetAvailableBalance
|
|
|
|
|
MsigGetAvailableBalance returns the portion of a multisig's balance that can be withdrawn or spent
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"0"`
|
|
|
|
|
|
2021-02-05 11:34:28 +00:00
|
|
|
### MsigGetPending
|
|
|
|
|
MsigGetPending returns pending transactions for the given multisig
|
|
|
|
|
wallet. Once pending transactions are fully approved, they will no longer
|
|
|
|
|
appear here.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"f01234",
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"ID": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"To": "f01234",
|
|
|
|
|
"Value": "0",
|
|
|
|
|
"Method": 1,
|
|
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"Approved": [
|
|
|
|
|
"f01234"
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2020-09-06 07:51:06 +00:00
|
|
|
### MsigGetVested
|
|
|
|
|
MsigGetVested returns the amount of FIL that vested in a multisig in a certain period.
|
|
|
|
|
It takes the following params: <multisig address>, <start epoch>, <end epoch>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-09-06 07:51:06 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
],
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"0"`
|
|
|
|
|
|
2020-10-08 19:19:39 +00:00
|
|
|
### MsigGetVestingSchedule
|
2020-10-09 21:14:21 +00:00
|
|
|
MsigGetVestingSchedule returns the vesting details of a given multisig.
|
2020-10-08 19:19:39 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"f01234",
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"InitialBalance": "\u003cnil\u003e",
|
|
|
|
|
"StartEpoch": 0,
|
|
|
|
|
"UnlockDuration": 0
|
2020-10-08 19:19:39 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### MsigPropose
|
|
|
|
|
MsigPropose proposes a multisig message
|
|
|
|
|
It takes the following params: <multisig address>, <recipient address>, <value to transfer>,
|
|
|
|
|
<sender address of the propose msg>, <method to call in the proposed message>, <params to include in the proposed message>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"0",
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
42,
|
|
|
|
|
"Ynl0ZSBhcnJheQ=="
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-10-10 10:28:59 +00:00
|
|
|
### MsigRemoveSigner
|
|
|
|
|
MsigRemoveSigner proposes the removal of a signer from the multisig.
|
|
|
|
|
It accepts the multisig to make the change on, the proposer address to
|
|
|
|
|
send the message from, the address to be removed, and a boolean
|
|
|
|
|
indicating whether or not the signing threshold should be lowered by one
|
|
|
|
|
along with the address removal.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
|
|
|
|
true
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### MsigSwapApprove
|
|
|
|
|
MsigSwapApprove approves a previously proposed SwapSigner
|
|
|
|
|
It takes the following params: <multisig address>, <sender address of the approve msg>, <proposed message ID>,
|
2020-09-06 07:51:06 +00:00
|
|
|
<proposer address>, <old signer>, <new signer>
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
|
|
|
|
"f01234"
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### MsigSwapCancel
|
|
|
|
|
MsigSwapCancel cancels a previously proposed SwapSigner message
|
|
|
|
|
It takes the following params: <multisig address>, <sender address of the cancel msg>, <proposed message ID>,
|
2020-09-06 07:51:06 +00:00
|
|
|
<old signer>, <new signer>
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
|
|
|
|
"f01234"
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### MsigSwapPropose
|
|
|
|
|
MsigSwapPropose proposes swapping 2 signers in the multisig
|
|
|
|
|
It takes the following params: <multisig address>, <sender address of the propose msg>,
|
2020-09-06 07:51:06 +00:00
|
|
|
<old signer>, <new signer>
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
|
|
|
|
"f01234"
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Net
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### NetAddrsListen
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"ID": "",
|
2021-12-28 02:38:12 +00:00
|
|
|
"Addrs": [
|
|
|
|
|
"/ip4/52.36.61.156/tcp/1347/p2p/12D3KooWFETiESTf1v4PGUvtnxMAcEFMzLZbJGg4tjWfGEimYior"
|
|
|
|
|
]
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-09-03 23:35:53 +00:00
|
|
|
### NetAgentVersion
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"string value"`
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### NetAutoNatStatus
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Reachability": 1,
|
2022-11-25 21:06:19 +00:00
|
|
|
"PublicAddr": ""
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-09-02 23:31:41 +00:00
|
|
|
### NetBandwidthStats
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"TotalIn": 0,
|
|
|
|
|
"TotalOut": 0,
|
|
|
|
|
"RateIn": 0,
|
|
|
|
|
"RateOut": 0
|
2020-09-02 23:31:41 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### NetBandwidthStatsByPeer
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"12D3KooWSXmXLJmBR1M7i9RW9GQPNUhZSzXKzxDHWtAgNuJAbyEJ": {
|
|
|
|
|
"TotalIn": 174000,
|
|
|
|
|
"TotalOut": 12500,
|
|
|
|
|
"RateIn": 100,
|
|
|
|
|
"RateOut": 50
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### NetBandwidthStatsByProtocol
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/fil/hello/1.0.0": {
|
|
|
|
|
"TotalIn": 174000,
|
|
|
|
|
"TotalOut": 12500,
|
|
|
|
|
"RateIn": 100,
|
|
|
|
|
"RateOut": 50
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-11-16 16:52:55 +00:00
|
|
|
### NetBlockAdd
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
2021-12-28 02:38:12 +00:00
|
|
|
"Peers": [
|
|
|
|
|
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
|
|
|
|
|
],
|
2022-11-25 21:06:19 +00:00
|
|
|
"IPAddrs": null,
|
|
|
|
|
"IPSubnets": null
|
2020-11-16 16:52:55 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
|
|
|
|
### NetBlockList
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2021-12-28 02:38:12 +00:00
|
|
|
"Peers": [
|
|
|
|
|
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
|
|
|
|
|
],
|
2022-11-25 21:06:19 +00:00
|
|
|
"IPAddrs": null,
|
|
|
|
|
"IPSubnets": null
|
2020-11-16 16:52:55 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### NetBlockRemove
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
2021-12-28 02:38:12 +00:00
|
|
|
"Peers": [
|
|
|
|
|
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
|
|
|
|
|
],
|
2022-11-25 21:06:19 +00:00
|
|
|
"IPAddrs": null,
|
|
|
|
|
"IPSubnets": null
|
2020-11-16 16:52:55 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### NetConnect
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"ID": "",
|
2021-12-28 02:38:12 +00:00
|
|
|
"Addrs": [
|
|
|
|
|
"/ip4/52.36.61.156/tcp/1347/p2p/12D3KooWFETiESTf1v4PGUvtnxMAcEFMzLZbJGg4tjWfGEimYior"
|
|
|
|
|
]
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
|
|
|
|
### NetConnectedness
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `1`
|
|
|
|
|
|
|
|
|
|
### NetDisconnect
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
|
|
|
|
### NetFindPeer
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"ID": "",
|
2021-12-28 02:38:12 +00:00
|
|
|
"Addrs": [
|
|
|
|
|
"/ip4/52.36.61.156/tcp/1347/p2p/12D3KooWFETiESTf1v4PGUvtnxMAcEFMzLZbJGg4tjWfGEimYior"
|
|
|
|
|
]
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2022-01-20 09:44:01 +00:00
|
|
|
### NetLimit
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"string value"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Memory": 123,
|
|
|
|
|
"Streams": 3,
|
|
|
|
|
"StreamsInbound": 1,
|
|
|
|
|
"StreamsOutbound": 2,
|
|
|
|
|
"Conns": 4,
|
|
|
|
|
"ConnsInbound": 3,
|
|
|
|
|
"ConnsOutbound": 4,
|
|
|
|
|
"FD": 5
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2021-03-08 12:23:58 +00:00
|
|
|
### NetPeerInfo
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"ID": "",
|
2021-03-08 12:23:58 +00:00
|
|
|
"Agent": "string value",
|
2021-12-28 02:38:12 +00:00
|
|
|
"Addrs": [
|
|
|
|
|
"string value"
|
|
|
|
|
],
|
|
|
|
|
"Protocols": [
|
|
|
|
|
"string value"
|
|
|
|
|
],
|
2022-11-25 21:06:19 +00:00
|
|
|
"ConnMgrMeta": null
|
2021-03-08 12:23:58 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### NetPeers
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"ID": "",
|
2021-12-28 02:38:12 +00:00
|
|
|
"Addrs": [
|
|
|
|
|
"/ip4/52.36.61.156/tcp/1347/p2p/12D3KooWFETiESTf1v4PGUvtnxMAcEFMzLZbJGg4tjWfGEimYior"
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
2022-02-17 09:10:28 +00:00
|
|
|
### NetPing
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `60000000000`
|
|
|
|
|
|
2022-02-03 16:24:49 +00:00
|
|
|
### NetProtectAdd
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
|
|
|
|
### NetProtectList
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### NetProtectRemove
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### NetPubsubScores
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"ID": "",
|
2021-12-28 02:38:12 +00:00
|
|
|
"Score": {
|
|
|
|
|
"Score": 12.3,
|
|
|
|
|
"Topics": {
|
|
|
|
|
"/blocks": {
|
|
|
|
|
"TimeInMesh": 60000000000,
|
|
|
|
|
"FirstMessageDeliveries": 122,
|
|
|
|
|
"MeshMessageDeliveries": 1234,
|
|
|
|
|
"InvalidMessageDeliveries": 3
|
|
|
|
|
}
|
|
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"AppSpecificScore": 0,
|
|
|
|
|
"IPColocationFactor": 0,
|
|
|
|
|
"BehaviourPenalty": 0
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
2022-01-20 09:44:01 +00:00
|
|
|
### NetSetLimit
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"string value",
|
|
|
|
|
{
|
|
|
|
|
"Memory": 123,
|
|
|
|
|
"Streams": 3,
|
|
|
|
|
"StreamsInbound": 1,
|
|
|
|
|
"StreamsOutbound": 2,
|
|
|
|
|
"Conns": 4,
|
|
|
|
|
"ConnsInbound": 3,
|
|
|
|
|
"ConnsOutbound": 4,
|
|
|
|
|
"FD": 5
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
|
|
|
|
### NetStat
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"string value"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"System": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"NumStreamsInbound": 0,
|
|
|
|
|
"NumStreamsOutbound": 0,
|
|
|
|
|
"NumConnsInbound": 0,
|
|
|
|
|
"NumConnsOutbound": 0,
|
|
|
|
|
"NumFD": 0,
|
2022-01-20 09:44:01 +00:00
|
|
|
"Memory": 9
|
|
|
|
|
},
|
|
|
|
|
"Transient": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"NumStreamsInbound": 0,
|
|
|
|
|
"NumStreamsOutbound": 0,
|
|
|
|
|
"NumConnsInbound": 0,
|
|
|
|
|
"NumConnsOutbound": 0,
|
|
|
|
|
"NumFD": 0,
|
2022-01-20 09:44:01 +00:00
|
|
|
"Memory": 9
|
|
|
|
|
},
|
|
|
|
|
"Services": {
|
|
|
|
|
"abc": {
|
|
|
|
|
"NumStreamsInbound": 1,
|
|
|
|
|
"NumStreamsOutbound": 2,
|
|
|
|
|
"NumConnsInbound": 3,
|
|
|
|
|
"NumConnsOutbound": 4,
|
|
|
|
|
"NumFD": 5,
|
|
|
|
|
"Memory": 123
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"Protocols": {
|
|
|
|
|
"abc": {
|
|
|
|
|
"NumStreamsInbound": 1,
|
|
|
|
|
"NumStreamsOutbound": 2,
|
|
|
|
|
"NumConnsInbound": 3,
|
|
|
|
|
"NumConnsOutbound": 4,
|
|
|
|
|
"NumFD": 5,
|
|
|
|
|
"Memory": 123
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"Peers": {
|
|
|
|
|
"abc": {
|
|
|
|
|
"NumStreamsInbound": 1,
|
|
|
|
|
"NumStreamsOutbound": 2,
|
|
|
|
|
"NumConnsInbound": 3,
|
|
|
|
|
"NumConnsOutbound": 4,
|
|
|
|
|
"NumFD": 5,
|
|
|
|
|
"Memory": 123
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
## Paych
|
|
|
|
|
The Paych methods are for interacting with and managing payment channels
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### PaychAllocateLane
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234"
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `42`
|
|
|
|
|
|
2020-09-03 23:35:53 +00:00
|
|
|
### PaychAvailableFunds
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-09-03 23:35:53 +00:00
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
2020-09-15 01:44:45 +00:00
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234"
|
2020-09-15 01:44:45 +00:00
|
|
|
]
|
|
|
|
|
```
|
2020-09-05 19:51:30 +00:00
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Channel": "\u003cempty\u003e",
|
2020-10-06 07:30:40 +00:00
|
|
|
"From": "f01234",
|
|
|
|
|
"To": "f01234",
|
2020-09-05 19:51:30 +00:00
|
|
|
"ConfirmedAmt": "0",
|
|
|
|
|
"PendingAmt": "0",
|
2022-02-16 19:39:43 +00:00
|
|
|
"NonReservedAmt": "0",
|
2022-01-04 23:17:03 +00:00
|
|
|
"PendingAvailableAmt": "0",
|
2020-09-05 19:51:30 +00:00
|
|
|
"PendingWaitSentinel": null,
|
|
|
|
|
"QueuedAmt": "0",
|
|
|
|
|
"VoucherReedeemedAmt": "0"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### PaychAvailableFundsByFromTo
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-09-05 19:51:30 +00:00
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
2020-09-03 23:35:53 +00:00
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
|
|
|
|
"f01234"
|
2020-09-03 23:35:53 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Channel": "\u003cempty\u003e",
|
2020-10-06 07:30:40 +00:00
|
|
|
"From": "f01234",
|
|
|
|
|
"To": "f01234",
|
2020-09-03 23:35:53 +00:00
|
|
|
"ConfirmedAmt": "0",
|
|
|
|
|
"PendingAmt": "0",
|
2022-02-16 19:39:43 +00:00
|
|
|
"NonReservedAmt": "0",
|
2022-01-04 23:17:03 +00:00
|
|
|
"PendingAvailableAmt": "0",
|
2020-09-03 23:35:53 +00:00
|
|
|
"PendingWaitSentinel": null,
|
|
|
|
|
"QueuedAmt": "0",
|
|
|
|
|
"VoucherReedeemedAmt": "0"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### PaychCollect
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234"
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### PaychGet
|
|
|
|
|
There are not yet any comments for this method.
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"0"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2020-10-06 07:30:40 +00:00
|
|
|
"Channel": "f01234",
|
2022-11-25 21:06:19 +00:00
|
|
|
"WaitSentinel": null
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### PaychGetWaitReady
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2020-10-06 07:30:40 +00:00
|
|
|
Response: `"f01234"`
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### PaychList
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"f01234"
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### PaychNewPayment
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
|
|
|
|
"f01234",
|
2021-12-28 02:38:12 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Amount": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"TimeLockMin": 0,
|
|
|
|
|
"TimeLockMax": 0,
|
|
|
|
|
"MinSettle": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Extra": {
|
|
|
|
|
"Actor": "f01234",
|
|
|
|
|
"Method": 1,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2020-10-06 07:30:40 +00:00
|
|
|
"Channel": "f01234",
|
2022-11-25 21:06:19 +00:00
|
|
|
"WaitSentinel": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Vouchers": [
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"ChannelAddr": "\u003cempty\u003e",
|
|
|
|
|
"TimeLockMin": 0,
|
|
|
|
|
"TimeLockMax": 0,
|
|
|
|
|
"SecretHash": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Extra": {
|
|
|
|
|
"Actor": "f01234",
|
|
|
|
|
"Method": 1,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
},
|
|
|
|
|
"Lane": 42,
|
|
|
|
|
"Nonce": 42,
|
|
|
|
|
"Amount": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"MinSettleHeight": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Merges": [
|
|
|
|
|
{
|
|
|
|
|
"Lane": 42,
|
|
|
|
|
"Nonce": 42
|
|
|
|
|
}
|
|
|
|
|
],
|
|
|
|
|
"Signature": {
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### PaychSettle
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234"
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### PaychStatus
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234"
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"ControlAddr": "\u003cempty\u003e",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Direction": 1
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### PaychVoucherAdd
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"ChannelAddr": "\u003cempty\u003e",
|
|
|
|
|
"TimeLockMin": 0,
|
|
|
|
|
"TimeLockMax": 0,
|
|
|
|
|
"SecretHash": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Extra": {
|
2020-10-06 07:30:40 +00:00
|
|
|
"Actor": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Method": 1,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
},
|
|
|
|
|
"Lane": 42,
|
|
|
|
|
"Nonce": 42,
|
|
|
|
|
"Amount": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"MinSettleHeight": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Merges": [
|
|
|
|
|
{
|
|
|
|
|
"Lane": 42,
|
|
|
|
|
"Nonce": 42
|
|
|
|
|
}
|
|
|
|
|
],
|
2020-08-24 10:25:49 +00:00
|
|
|
"Signature": {
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"0"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"0"`
|
|
|
|
|
|
|
|
|
|
### PaychVoucherCheckSpendable
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"ChannelAddr": "\u003cempty\u003e",
|
|
|
|
|
"TimeLockMin": 0,
|
|
|
|
|
"TimeLockMax": 0,
|
|
|
|
|
"SecretHash": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Extra": {
|
2020-10-06 07:30:40 +00:00
|
|
|
"Actor": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Method": 1,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
},
|
|
|
|
|
"Lane": 42,
|
|
|
|
|
"Nonce": 42,
|
|
|
|
|
"Amount": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"MinSettleHeight": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Merges": [
|
|
|
|
|
{
|
|
|
|
|
"Lane": 42,
|
|
|
|
|
"Nonce": 42
|
|
|
|
|
}
|
|
|
|
|
],
|
2020-08-24 10:25:49 +00:00
|
|
|
"Signature": {
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"Ynl0ZSBhcnJheQ=="
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `true`
|
|
|
|
|
|
|
|
|
|
### PaychVoucherCheckValid
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"ChannelAddr": "\u003cempty\u003e",
|
|
|
|
|
"TimeLockMin": 0,
|
|
|
|
|
"TimeLockMax": 0,
|
|
|
|
|
"SecretHash": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Extra": {
|
2020-10-06 07:30:40 +00:00
|
|
|
"Actor": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Method": 1,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
},
|
|
|
|
|
"Lane": 42,
|
|
|
|
|
"Nonce": 42,
|
|
|
|
|
"Amount": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"MinSettleHeight": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Merges": [
|
|
|
|
|
{
|
|
|
|
|
"Lane": 42,
|
|
|
|
|
"Nonce": 42
|
|
|
|
|
}
|
|
|
|
|
],
|
2020-08-24 10:25:49 +00:00
|
|
|
"Signature": {
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
|
|
|
|
### PaychVoucherCreate
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"0",
|
|
|
|
|
42
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2020-09-03 23:35:53 +00:00
|
|
|
"Voucher": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"ChannelAddr": "\u003cempty\u003e",
|
|
|
|
|
"TimeLockMin": 0,
|
|
|
|
|
"TimeLockMax": 0,
|
|
|
|
|
"SecretHash": null,
|
2020-09-03 23:35:53 +00:00
|
|
|
"Extra": {
|
2020-10-06 07:30:40 +00:00
|
|
|
"Actor": "f01234",
|
2020-09-03 23:35:53 +00:00
|
|
|
"Method": 1,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
},
|
|
|
|
|
"Lane": 42,
|
|
|
|
|
"Nonce": 42,
|
|
|
|
|
"Amount": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"MinSettleHeight": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Merges": [
|
|
|
|
|
{
|
|
|
|
|
"Lane": 42,
|
|
|
|
|
"Nonce": 42
|
|
|
|
|
}
|
|
|
|
|
],
|
2020-09-03 23:35:53 +00:00
|
|
|
"Signature": {
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
}
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
2020-09-03 23:35:53 +00:00
|
|
|
"Shortfall": "0"
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### PaychVoucherList
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234"
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"ChannelAddr": "\u003cempty\u003e",
|
|
|
|
|
"TimeLockMin": 0,
|
|
|
|
|
"TimeLockMax": 0,
|
|
|
|
|
"SecretHash": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Extra": {
|
|
|
|
|
"Actor": "f01234",
|
|
|
|
|
"Method": 1,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
},
|
|
|
|
|
"Lane": 42,
|
|
|
|
|
"Nonce": 42,
|
|
|
|
|
"Amount": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"MinSettleHeight": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Merges": [
|
|
|
|
|
{
|
|
|
|
|
"Lane": 42,
|
|
|
|
|
"Nonce": 42
|
|
|
|
|
}
|
|
|
|
|
],
|
|
|
|
|
"Signature": {
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### PaychVoucherSubmit
|
2021-03-23 12:42:56 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"ChannelAddr": "\u003cempty\u003e",
|
|
|
|
|
"TimeLockMin": 0,
|
|
|
|
|
"TimeLockMax": 0,
|
|
|
|
|
"SecretHash": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Extra": {
|
2020-10-06 07:30:40 +00:00
|
|
|
"Actor": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Method": 1,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
},
|
|
|
|
|
"Lane": 42,
|
|
|
|
|
"Nonce": 42,
|
|
|
|
|
"Amount": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"MinSettleHeight": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Merges": [
|
|
|
|
|
{
|
|
|
|
|
"Lane": 42,
|
|
|
|
|
"Nonce": 42
|
|
|
|
|
}
|
|
|
|
|
],
|
2020-08-24 10:25:49 +00:00
|
|
|
"Signature": {
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
}
|
2020-08-28 20:03:09 +00:00
|
|
|
},
|
|
|
|
|
"Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"Ynl0ZSBhcnJheQ=="
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2022-10-05 19:44:55 +00:00
|
|
|
## Start
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### StartTime
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response: `"0001-01-01T00:00:00Z"`
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
## State
|
|
|
|
|
The State methods are used to query, inspect, and interact with chain state.
|
2020-10-26 17:46:41 +00:00
|
|
|
Most methods take a TipSetKey as a parameter. The state looked up is the parent state of the tipset.
|
2020-08-24 10:25:49 +00:00
|
|
|
A nil TipSetKey can be provided as a param, this will cause the heaviest tipset in the chain to be used.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### StateAccountKey
|
|
|
|
|
StateAccountKey returns the public key address of the given ID address
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2020-10-06 07:30:40 +00:00
|
|
|
Response: `"f01234"`
|
2020-08-24 10:25:49 +00:00
|
|
|
|
2022-06-23 18:05:20 +00:00
|
|
|
### StateActorCodeCIDs
|
2022-06-23 18:17:41 +00:00
|
|
|
StateActorCodeCIDs returns the CIDs of all the builtin actors for the given network version
|
2022-06-23 18:05:20 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2022-11-08 05:53:13 +00:00
|
|
|
18
|
2022-06-23 18:05:20 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
2022-08-22 21:10:03 +00:00
|
|
|
### StateActorManifestCID
|
|
|
|
|
StateActorManifestCID returns the CID of the builtin actors manifest for the given network version
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2022-11-08 05:53:13 +00:00
|
|
|
18
|
2022-08-22 21:10:03 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### StateAllMinerFaults
|
|
|
|
|
StateAllMinerFaults returns all non-expired Faults that occur within lookback epochs of the given tipset
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
10101,
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Miner": "f01234",
|
|
|
|
|
"Epoch": 10101
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### StateCall
|
|
|
|
|
StateCall runs the given message and returns its result without any persisted changes.
|
|
|
|
|
|
2020-10-26 17:46:41 +00:00
|
|
|
StateCall applies the message to the tipset's parent state. The
|
|
|
|
|
message is not applied on-top-of the messages in the passed-in
|
|
|
|
|
tipset.
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Version": 42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
2020-10-12 18:47:09 +00:00
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2020-10-12 18:47:09 +00:00
|
|
|
}
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"MsgCid": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Msg": {
|
|
|
|
|
"Version": 42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
2020-10-12 18:47:09 +00:00
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2022-11-10 12:02:22 +00:00
|
|
|
}
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"MsgRct": null,
|
2020-10-16 01:00:47 +00:00
|
|
|
"GasCost": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"Message": null,
|
2020-10-16 01:00:47 +00:00
|
|
|
"GasUsed": "0",
|
|
|
|
|
"BaseFeeBurn": "0",
|
|
|
|
|
"OverEstimationBurn": "0",
|
|
|
|
|
"MinerPenalty": "0",
|
|
|
|
|
"MinerTip": "0",
|
|
|
|
|
"Refund": "0",
|
|
|
|
|
"TotalCost": "0"
|
|
|
|
|
},
|
2020-08-24 10:25:49 +00:00
|
|
|
"ExecutionTrace": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"Msg": null,
|
|
|
|
|
"MsgRct": null,
|
|
|
|
|
"Error": "",
|
|
|
|
|
"Duration": 0,
|
|
|
|
|
"GasCharges": null,
|
|
|
|
|
"Subcalls": null
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
"Error": "string value",
|
|
|
|
|
"Duration": 60000000000
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateChangedActors
|
|
|
|
|
StateChangedActors returns all the actors whose states change between the two given state CIDs
|
|
|
|
|
TODO: Should this take tipset keys instead?
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"t01236": {
|
|
|
|
|
"Code": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
"Head": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
"Nonce": 42,
|
2022-11-09 08:45:11 +00:00
|
|
|
"Balance": "0",
|
|
|
|
|
"Address": "\u003cempty\u003e"
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateCirculatingSupply
|
2020-10-11 22:17:28 +00:00
|
|
|
StateCirculatingSupply returns the exact circulating supply of Filecoin at the given tipset.
|
|
|
|
|
This is not used anywhere in the protocol itself, and is only for external consumption.
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2020-10-11 22:17:28 +00:00
|
|
|
Response: `"0"`
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### StateCompute
|
|
|
|
|
StateCompute is a flexible command that applies the given messages on the given tipset.
|
|
|
|
|
The messages are run as though the VM were at the provided height.
|
|
|
|
|
|
2021-03-19 11:57:59 +00:00
|
|
|
When called, StateCompute will:
|
|
|
|
|
- Load the provided tipset, or use the current chain head if not provided
|
|
|
|
|
- Compute the tipset state of the provided tipset on top of the parent state
|
|
|
|
|
- (note that this step runs before vmheight is applied to the execution)
|
|
|
|
|
- Execute state upgrade if any were scheduled at the epoch, or in null
|
|
|
|
|
blocks preceding the tipset
|
|
|
|
|
- Call the cron actor on null blocks preceding the tipset
|
|
|
|
|
- For each block in the tipset
|
|
|
|
|
- Apply messages in blocks in the specified
|
|
|
|
|
- Award block reward by calling the reward actor
|
|
|
|
|
- Call the cron actor for the current epoch
|
|
|
|
|
- If the specified vmheight is higher than the current epoch, apply any
|
|
|
|
|
needed state upgrades to the state
|
|
|
|
|
- Apply the specified messages to the state
|
|
|
|
|
|
|
|
|
|
The vmheight parameter sets VM execution epoch, and can be used to simulate
|
|
|
|
|
message execution in different network versions. If the specified vmheight
|
|
|
|
|
epoch is higher than the epoch of the specified tipset, any state upgrades
|
|
|
|
|
until the vmheight will be executed on the state before applying messages
|
|
|
|
|
specified by the user.
|
|
|
|
|
|
|
|
|
|
Note that the initial tipset state computation is not affected by the
|
|
|
|
|
vmheight parameter - only the messages in the `apply` set are
|
|
|
|
|
|
|
|
|
|
If the caller wants to simply compute the state, vmheight should be set to
|
|
|
|
|
the epoch of the specified tipset.
|
|
|
|
|
|
|
|
|
|
Messages in the `apply` parameter must have the correct nonces, and gas
|
|
|
|
|
values set.
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
10101,
|
2021-12-28 02:38:12 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Version": 42,
|
|
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
|
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
|
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
],
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Root": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
2021-12-28 02:38:12 +00:00
|
|
|
"Trace": [
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"MsgCid": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Msg": {
|
|
|
|
|
"Version": 42,
|
|
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
|
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2021-12-28 02:38:12 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
|
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2022-11-10 12:02:22 +00:00
|
|
|
}
|
2021-12-28 02:38:12 +00:00
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"MsgRct": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"GasCost": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"Message": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"GasUsed": "0",
|
|
|
|
|
"BaseFeeBurn": "0",
|
|
|
|
|
"OverEstimationBurn": "0",
|
|
|
|
|
"MinerPenalty": "0",
|
|
|
|
|
"MinerTip": "0",
|
|
|
|
|
"Refund": "0",
|
|
|
|
|
"TotalCost": "0"
|
|
|
|
|
},
|
|
|
|
|
"ExecutionTrace": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"Msg": null,
|
|
|
|
|
"MsgRct": null,
|
|
|
|
|
"Error": "",
|
|
|
|
|
"Duration": 0,
|
|
|
|
|
"GasCharges": null,
|
|
|
|
|
"Subcalls": null
|
2021-12-28 02:38:12 +00:00
|
|
|
},
|
|
|
|
|
"Error": "string value",
|
|
|
|
|
"Duration": 60000000000
|
|
|
|
|
}
|
|
|
|
|
]
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateDealProviderCollateralBounds
|
|
|
|
|
StateDealProviderCollateralBounds returns the min and max collateral a storage provider
|
|
|
|
|
can issue. It takes the deal size and verified status as parameters.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
1032,
|
|
|
|
|
true,
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Min": "0",
|
|
|
|
|
"Max": "0"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-09-29 07:01:52 +00:00
|
|
|
### StateDecodeParams
|
|
|
|
|
StateDecodeParams attempts to decode the provided params, based on the recipient actor address and method number.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"f01234",
|
|
|
|
|
1,
|
|
|
|
|
"Ynl0ZSBhcnJheQ==",
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### StateGetActor
|
|
|
|
|
StateGetActor returns the indicated actor's nonce and balance.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Code": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
"Head": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
"Nonce": 42,
|
2022-11-09 08:45:11 +00:00
|
|
|
"Balance": "0",
|
|
|
|
|
"Address": "\u003cempty\u003e"
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2022-10-03 05:51:30 +00:00
|
|
|
### StateGetAllocation
|
2022-10-05 18:43:16 +00:00
|
|
|
StateGetAllocation returns the allocation for a given address and allocation ID.
|
2022-10-03 05:51:30 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"f01234",
|
|
|
|
|
0,
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Client": 1000,
|
|
|
|
|
"Provider": 1000,
|
|
|
|
|
"Data": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
"Size": 1032,
|
2022-11-25 21:06:19 +00:00
|
|
|
"TermMin": 0,
|
|
|
|
|
"TermMax": 0,
|
2022-10-03 05:51:30 +00:00
|
|
|
"Expiration": 10101
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2022-10-05 18:43:16 +00:00
|
|
|
### StateGetAllocationForPendingDeal
|
|
|
|
|
StateGetAllocationForPendingDeal returns the allocation for a given deal ID of a pending deal.
|
2022-10-03 05:51:30 +00:00
|
|
|
|
|
|
|
|
|
2022-10-10 08:54:07 +00:00
|
|
|
Perms: read
|
2022-10-03 05:51:30 +00:00
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
5432,
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Client": 1000,
|
|
|
|
|
"Provider": 1000,
|
|
|
|
|
"Data": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
"Size": 1032,
|
2022-11-25 21:06:19 +00:00
|
|
|
"TermMin": 0,
|
|
|
|
|
"TermMax": 0,
|
2022-10-03 05:51:30 +00:00
|
|
|
"Expiration": 10101
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2022-10-05 22:45:43 +00:00
|
|
|
### StateGetAllocations
|
|
|
|
|
StateGetAllocations returns the all the allocations for a given client.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"f01234",
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
|
|
|
|
### StateGetClaim
|
|
|
|
|
StateGetClaim returns the claim for a given address and claim ID.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"f01234",
|
|
|
|
|
0,
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Provider": 1000,
|
|
|
|
|
"Client": 1000,
|
|
|
|
|
"Data": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
"Size": 1032,
|
2022-11-25 21:06:19 +00:00
|
|
|
"TermMin": 0,
|
|
|
|
|
"TermMax": 0,
|
|
|
|
|
"TermStart": 0,
|
2022-10-05 22:45:43 +00:00
|
|
|
"Sector": 9
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateGetClaims
|
|
|
|
|
StateGetClaims returns the all the claims for a given provider.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"f01234",
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
2022-04-24 05:48:07 +00:00
|
|
|
### StateGetNetworkParams
|
|
|
|
|
StateGetNetworkParams return current network params
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"NetworkName": "",
|
|
|
|
|
"BlockDelaySecs": 0,
|
2022-04-24 05:48:07 +00:00
|
|
|
"ConsensusMinerMinPower": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"SupportedProofTypes": null,
|
|
|
|
|
"PreCommitChallengeDelay": 0,
|
2022-04-24 05:48:07 +00:00
|
|
|
"ForkUpgradeParams": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"UpgradeSmokeHeight": 0,
|
|
|
|
|
"UpgradeBreezeHeight": 0,
|
|
|
|
|
"UpgradeIgnitionHeight": 0,
|
|
|
|
|
"UpgradeLiftoffHeight": 0,
|
|
|
|
|
"UpgradeAssemblyHeight": 0,
|
|
|
|
|
"UpgradeRefuelHeight": 0,
|
|
|
|
|
"UpgradeTapeHeight": 0,
|
|
|
|
|
"UpgradeKumquatHeight": 0,
|
|
|
|
|
"UpgradePriceListOopsHeight": 0,
|
|
|
|
|
"BreezeGasTampingDuration": 0,
|
|
|
|
|
"UpgradeCalicoHeight": 0,
|
|
|
|
|
"UpgradePersianHeight": 0,
|
|
|
|
|
"UpgradeOrangeHeight": 0,
|
|
|
|
|
"UpgradeClausHeight": 0,
|
|
|
|
|
"UpgradeTrustHeight": 0,
|
|
|
|
|
"UpgradeNorwegianHeight": 0,
|
|
|
|
|
"UpgradeTurboHeight": 0,
|
|
|
|
|
"UpgradeHyperdriveHeight": 0,
|
|
|
|
|
"UpgradeChocolateHeight": 0,
|
|
|
|
|
"UpgradeOhSnapHeight": 0,
|
|
|
|
|
"UpgradeSkyrHeight": 0,
|
|
|
|
|
"UpgradeSharkHeight": 0
|
2022-04-24 05:48:07 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2021-09-12 02:24:53 +00:00
|
|
|
### StateGetRandomnessFromBeacon
|
|
|
|
|
StateGetRandomnessFromBeacon is used to sample the beacon for randomness.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
2,
|
|
|
|
|
10101,
|
|
|
|
|
"Ynl0ZSBhcnJheQ==",
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response: `"Bw=="`
|
2021-09-12 02:24:53 +00:00
|
|
|
|
|
|
|
|
### StateGetRandomnessFromTickets
|
|
|
|
|
StateGetRandomnessFromTickets is used to sample the chain for randomness.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
2,
|
|
|
|
|
10101,
|
|
|
|
|
"Ynl0ZSBhcnJheQ==",
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response: `"Bw=="`
|
2021-09-12 02:24:53 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### StateGetReceipt
|
2021-03-18 17:17:46 +00:00
|
|
|
StateGetReceipt returns the message receipt for the given message or for a
|
|
|
|
|
matching gas-repriced replacing message
|
|
|
|
|
|
|
|
|
|
NOTE: If the requested message was replaced, this method will return the receipt
|
|
|
|
|
for the replacing message - if the caller needs the receipt for exactly the
|
|
|
|
|
requested message, use StateSearchMsg().Receipt, and check that MsgLookup.Message
|
2021-03-19 11:57:59 +00:00
|
|
|
is matching the requested CID
|
2020-08-24 10:25:49 +00:00
|
|
|
|
2021-03-18 18:46:26 +00:00
|
|
|
DEPRECATED: Use StateSearchMsg, this method won't be supported in v1 API
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"ExitCode": 0,
|
|
|
|
|
"Return": "Ynl0ZSBhcnJheQ==",
|
2022-12-08 06:16:56 +00:00
|
|
|
"GasUsed": 0,
|
|
|
|
|
"EventsRoot": null
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateListActors
|
|
|
|
|
StateListActors returns the addresses of every actor in the state
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"f01234"
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### StateListMessages
|
|
|
|
|
StateListMessages looks back and returns all messages with a matching to or from address, stopping at the given height.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
2020-10-06 07:30:40 +00:00
|
|
|
"To": "f01234",
|
2020-10-15 19:07:41 +00:00
|
|
|
"From": "f01234"
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
],
|
|
|
|
|
10101
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### StateListMiners
|
|
|
|
|
StateListMiners returns the addresses of every miner that has claimed power in the Power Actor
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"f01234"
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### StateLookupID
|
|
|
|
|
StateLookupID retrieves the ID address of the given address
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2020-10-06 07:30:40 +00:00
|
|
|
Response: `"f01234"`
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### StateMarketBalance
|
|
|
|
|
StateMarketBalance looks up the Escrow and Locked balances of the given address in the Storage Market
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Escrow": "0",
|
|
|
|
|
"Locked": "0"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateMarketDeals
|
|
|
|
|
StateMarketDeals returns information about every deal in the Storage Market
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"t026363": {
|
|
|
|
|
"Proposal": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"PieceCID": null,
|
|
|
|
|
"PieceSize": 0,
|
|
|
|
|
"VerifiedDeal": false,
|
2020-10-06 07:30:40 +00:00
|
|
|
"Client": "f01234",
|
|
|
|
|
"Provider": "f01234",
|
2022-04-26 15:36:22 +00:00
|
|
|
"Label": "",
|
2022-11-25 21:06:19 +00:00
|
|
|
"StartEpoch": 0,
|
|
|
|
|
"EndEpoch": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"StoragePricePerEpoch": "0",
|
|
|
|
|
"ProviderCollateral": "0",
|
|
|
|
|
"ClientCollateral": "0"
|
|
|
|
|
},
|
|
|
|
|
"State": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"SectorStartEpoch": 0,
|
|
|
|
|
"LastUpdatedEpoch": 0,
|
|
|
|
|
"SlashEpoch": 0,
|
2022-09-26 16:47:48 +00:00
|
|
|
"VerifiedClaim": 0
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateMarketParticipants
|
|
|
|
|
StateMarketParticipants returns the Escrow and Locked balances of every participant in the Storage Market
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"t026363": {
|
|
|
|
|
"Escrow": "0",
|
|
|
|
|
"Locked": "0"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateMarketStorageDeal
|
|
|
|
|
StateMarketStorageDeal returns information about the indicated deal
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
5432,
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Proposal": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"PieceCID": null,
|
|
|
|
|
"PieceSize": 0,
|
|
|
|
|
"VerifiedDeal": false,
|
2020-10-06 07:30:40 +00:00
|
|
|
"Client": "f01234",
|
|
|
|
|
"Provider": "f01234",
|
2022-04-26 15:36:22 +00:00
|
|
|
"Label": "",
|
2022-11-25 21:06:19 +00:00
|
|
|
"StartEpoch": 0,
|
|
|
|
|
"EndEpoch": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"StoragePricePerEpoch": "0",
|
|
|
|
|
"ProviderCollateral": "0",
|
|
|
|
|
"ClientCollateral": "0"
|
|
|
|
|
},
|
|
|
|
|
"State": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"SectorStartEpoch": 0,
|
|
|
|
|
"LastUpdatedEpoch": 0,
|
|
|
|
|
"SlashEpoch": 0,
|
2022-09-26 16:47:48 +00:00
|
|
|
"VerifiedClaim": 0
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateMinerActiveSectors
|
|
|
|
|
StateMinerActiveSectors returns info about sectors that a given miner is actively proving.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"SectorNumber": 0,
|
|
|
|
|
"SealProof": 0,
|
|
|
|
|
"SealedCID": null,
|
|
|
|
|
"DealIDs": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Activation": 10101,
|
|
|
|
|
"Expiration": 10101,
|
|
|
|
|
"DealWeight": "0",
|
|
|
|
|
"VerifiedDealWeight": "0",
|
|
|
|
|
"InitialPledge": "0",
|
|
|
|
|
"ExpectedDayReward": "0",
|
|
|
|
|
"ExpectedStoragePledge": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"ReplacedSectorAge": 0,
|
2022-04-20 21:34:28 +00:00
|
|
|
"ReplacedDayReward": "0",
|
2022-09-22 17:36:43 +00:00
|
|
|
"SectorKeyCID": null,
|
2022-11-25 21:06:19 +00:00
|
|
|
"SimpleQAPower": false
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### StateMinerAvailableBalance
|
|
|
|
|
StateMinerAvailableBalance returns the portion of a miner's balance that can be withdrawn or spent
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"0"`
|
|
|
|
|
|
|
|
|
|
### StateMinerDeadlines
|
|
|
|
|
StateMinerDeadlines returns all the proving deadlines for the given miner
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"PostSubmissions": [
|
2022-11-25 21:06:19 +00:00
|
|
|
0
|
2021-12-28 02:38:12 +00:00
|
|
|
],
|
2022-11-25 21:06:19 +00:00
|
|
|
"DisputableProofCount": 0
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### StateMinerFaults
|
|
|
|
|
StateMinerFaults returns a bitfield indicating the faulty sectors of the given miner
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
5,
|
|
|
|
|
1
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateMinerInfo
|
|
|
|
|
StateMinerInfo returns info about the indicated miner
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2020-10-06 07:30:40 +00:00
|
|
|
"Owner": "f01234",
|
|
|
|
|
"Worker": "f01234",
|
2022-11-25 21:06:19 +00:00
|
|
|
"NewWorker": "\u003cempty\u003e",
|
|
|
|
|
"ControlAddresses": null,
|
|
|
|
|
"WorkerChangeEpoch": 0,
|
|
|
|
|
"PeerId": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Multiaddrs": [
|
|
|
|
|
"Ynl0ZSBhcnJheQ=="
|
|
|
|
|
],
|
2022-11-25 21:06:19 +00:00
|
|
|
"WindowPoStProofType": 0,
|
|
|
|
|
"SectorSize": 0,
|
|
|
|
|
"WindowPoStPartitionSectors": 0,
|
|
|
|
|
"ConsensusFaultElapsed": 0,
|
2022-09-14 04:19:47 +00:00
|
|
|
"Beneficiary": "f01234",
|
2022-11-25 21:06:19 +00:00
|
|
|
"BeneficiaryTerm": null,
|
|
|
|
|
"PendingBeneficiaryTerm": null
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateMinerInitialPledgeCollateral
|
|
|
|
|
StateMinerInitialPledgeCollateral returns the initial pledge collateral for the specified miner's sector
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"SealProof": 0,
|
|
|
|
|
"SectorNumber": 0,
|
|
|
|
|
"SealedCID": null,
|
|
|
|
|
"SealRandEpoch": 0,
|
|
|
|
|
"DealIDs": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Expiration": 10101,
|
2022-09-08 01:25:28 +00:00
|
|
|
"UnsealedCid": null
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"0"`
|
|
|
|
|
|
|
|
|
|
### StateMinerPartitions
|
2020-09-17 15:31:09 +00:00
|
|
|
StateMinerPartitions returns all partitions in the specified deadline
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
42,
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"AllSectors": [
|
2022-11-25 21:06:19 +00:00
|
|
|
0
|
2021-12-28 02:38:12 +00:00
|
|
|
],
|
|
|
|
|
"FaultySectors": [
|
2022-11-25 21:06:19 +00:00
|
|
|
0
|
2021-12-28 02:38:12 +00:00
|
|
|
],
|
|
|
|
|
"RecoveringSectors": [
|
2022-11-25 21:06:19 +00:00
|
|
|
0
|
2021-12-28 02:38:12 +00:00
|
|
|
],
|
|
|
|
|
"LiveSectors": [
|
2022-11-25 21:06:19 +00:00
|
|
|
0
|
2021-12-28 02:38:12 +00:00
|
|
|
],
|
|
|
|
|
"ActiveSectors": [
|
2022-11-25 21:06:19 +00:00
|
|
|
0
|
2021-12-28 02:38:12 +00:00
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### StateMinerPower
|
|
|
|
|
StateMinerPower returns the power of the indicated miner
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"MinerPower": {
|
|
|
|
|
"RawBytePower": "0",
|
|
|
|
|
"QualityAdjPower": "0"
|
|
|
|
|
},
|
|
|
|
|
"TotalPower": {
|
|
|
|
|
"RawBytePower": "0",
|
|
|
|
|
"QualityAdjPower": "0"
|
2020-09-17 15:31:09 +00:00
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"HasMinPower": false
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateMinerPreCommitDepositForPower
|
|
|
|
|
StateMinerInitialPledgeCollateral returns the precommit deposit for the specified miner's sector
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"SealProof": 0,
|
|
|
|
|
"SectorNumber": 0,
|
|
|
|
|
"SealedCID": null,
|
|
|
|
|
"SealRandEpoch": 0,
|
|
|
|
|
"DealIDs": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Expiration": 10101,
|
2022-09-08 01:25:28 +00:00
|
|
|
"UnsealedCid": null
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"0"`
|
|
|
|
|
|
|
|
|
|
### StateMinerProvingDeadline
|
|
|
|
|
StateMinerProvingDeadline calculates the deadline at some epoch for a proving period
|
|
|
|
|
and returns the deadline-related calculations.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"CurrentEpoch": 0,
|
|
|
|
|
"PeriodStart": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Index": 42,
|
|
|
|
|
"Open": 10101,
|
|
|
|
|
"Close": 10101,
|
|
|
|
|
"Challenge": 10101,
|
2022-11-25 21:06:19 +00:00
|
|
|
"FaultCutoff": 0,
|
|
|
|
|
"WPoStPeriodDeadlines": 0,
|
|
|
|
|
"WPoStProvingPeriod": 0,
|
|
|
|
|
"WPoStChallengeWindow": 0,
|
|
|
|
|
"WPoStChallengeLookback": 0,
|
|
|
|
|
"FaultDeclarationCutoff": 0
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateMinerRecoveries
|
|
|
|
|
StateMinerRecoveries returns a bitfield indicating the recovering sectors of the given miner
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
5,
|
|
|
|
|
1
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2020-10-18 18:10:39 +00:00
|
|
|
### StateMinerSectorAllocated
|
|
|
|
|
StateMinerSectorAllocated checks if a sector is allocated
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"f01234",
|
|
|
|
|
9,
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `true`
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### StateMinerSectorCount
|
|
|
|
|
StateMinerSectorCount returns the number of sectors in a miner's sector set and proving set
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2020-09-17 15:31:09 +00:00
|
|
|
"Live": 42,
|
|
|
|
|
"Active": 42,
|
|
|
|
|
"Faulty": 42
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateMinerSectors
|
|
|
|
|
StateMinerSectors returns info about the given miner's sectors. If the filter bitfield is nil, all sectors are included.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
0
|
|
|
|
|
],
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"SectorNumber": 0,
|
|
|
|
|
"SealProof": 0,
|
|
|
|
|
"SealedCID": null,
|
|
|
|
|
"DealIDs": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Activation": 10101,
|
|
|
|
|
"Expiration": 10101,
|
|
|
|
|
"DealWeight": "0",
|
|
|
|
|
"VerifiedDealWeight": "0",
|
|
|
|
|
"InitialPledge": "0",
|
|
|
|
|
"ExpectedDayReward": "0",
|
|
|
|
|
"ExpectedStoragePledge": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"ReplacedSectorAge": 0,
|
2022-04-20 21:34:28 +00:00
|
|
|
"ReplacedDayReward": "0",
|
2022-09-22 17:36:43 +00:00
|
|
|
"SectorKeyCID": null,
|
2022-11-25 21:06:19 +00:00
|
|
|
"SimpleQAPower": false
|
2021-12-28 02:38:12 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### StateNetworkName
|
|
|
|
|
StateNetworkName returns the name of the network the node is synced to
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response: `"lotus"`
|
|
|
|
|
|
2020-09-17 15:31:09 +00:00
|
|
|
### StateNetworkVersion
|
|
|
|
|
StateNetworkVersion returns the network version at the given tipset
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2022-11-08 05:53:13 +00:00
|
|
|
Response: `18`
|
2020-09-17 15:31:09 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### StateReadState
|
|
|
|
|
StateReadState returns the indicated actor's state.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Balance": "0",
|
2021-02-09 23:46:33 +00:00
|
|
|
"Code": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
2020-08-24 10:25:49 +00:00
|
|
|
"State": {}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateReplay
|
2020-10-16 02:45:11 +00:00
|
|
|
StateReplay replays a given message, assuming it was included in a block in the specified tipset.
|
2021-03-18 20:54:35 +00:00
|
|
|
|
2022-07-26 02:26:53 +00:00
|
|
|
If a tipset key is provided, and a replacing message is not found on chain,
|
2021-03-18 20:54:35 +00:00
|
|
|
the method will return an error saying that the message wasn't found
|
|
|
|
|
|
|
|
|
|
If no tipset key is provided, the appropriate tipset is looked up, and if
|
|
|
|
|
the message was gas-repriced, the on-chain message will be replayed - in
|
|
|
|
|
that case the returned InvocResult.MsgCid will not match the Cid param
|
|
|
|
|
|
|
|
|
|
If the caller wants to ensure that exactly the requested message was executed,
|
|
|
|
|
they MUST check that InvocResult.MsgCid is equal to the provided Cid.
|
|
|
|
|
Without this check both the requested and original message may appear as
|
|
|
|
|
successfully executed on-chain, which may look like a double-spend.
|
|
|
|
|
|
|
|
|
|
A replacing message is a message with a different CID, any of Gas values, and
|
|
|
|
|
different signature, but with all other parameters matching (source/destination,
|
|
|
|
|
nonce, params, etc.)
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-16 02:45:11 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
],
|
2020-08-24 10:25:49 +00:00
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"MsgCid": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Msg": {
|
|
|
|
|
"Version": 42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
2020-10-12 18:47:09 +00:00
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2022-11-10 12:02:22 +00:00
|
|
|
}
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"MsgRct": null,
|
2020-10-16 01:00:47 +00:00
|
|
|
"GasCost": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"Message": null,
|
2020-10-16 01:00:47 +00:00
|
|
|
"GasUsed": "0",
|
|
|
|
|
"BaseFeeBurn": "0",
|
|
|
|
|
"OverEstimationBurn": "0",
|
|
|
|
|
"MinerPenalty": "0",
|
|
|
|
|
"MinerTip": "0",
|
|
|
|
|
"Refund": "0",
|
|
|
|
|
"TotalCost": "0"
|
|
|
|
|
},
|
2020-08-24 10:25:49 +00:00
|
|
|
"ExecutionTrace": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"Msg": null,
|
|
|
|
|
"MsgRct": null,
|
|
|
|
|
"Error": "",
|
|
|
|
|
"Duration": 0,
|
|
|
|
|
"GasCharges": null,
|
|
|
|
|
"Subcalls": null
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
"Error": "string value",
|
|
|
|
|
"Duration": 60000000000
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateSearchMsg
|
|
|
|
|
StateSearchMsg searches for a message in the chain, and returns its receipt and the tipset where it was executed
|
|
|
|
|
|
2021-03-18 18:46:26 +00:00
|
|
|
NOTE: If a replacing message is found on chain, this method will return
|
|
|
|
|
a MsgLookup for the replacing message - the MsgLookup.Message will be a different
|
|
|
|
|
CID than the one provided in the 'cid' param, MsgLookup.Receipt will contain the
|
|
|
|
|
result of the execution of the replacing message.
|
|
|
|
|
|
|
|
|
|
If the caller wants to ensure that exactly the requested message was executed,
|
|
|
|
|
they MUST check that MsgLookup.Message is equal to the provided 'cid'.
|
|
|
|
|
Without this check both the requested and original message may appear as
|
|
|
|
|
successfully executed on-chain, which may look like a double-spend.
|
|
|
|
|
|
|
|
|
|
A replacing message is a message with a different CID, any of Gas values, and
|
|
|
|
|
different signature, but with all other parameters matching (source/destination,
|
|
|
|
|
nonce, params, etc.)
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2021-01-19 10:19:31 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Message": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
"Receipt": {
|
|
|
|
|
"ExitCode": 0,
|
|
|
|
|
"Return": "Ynl0ZSBhcnJheQ==",
|
2022-12-08 06:16:56 +00:00
|
|
|
"GasUsed": 0,
|
|
|
|
|
"EventsRoot": null
|
2021-01-19 10:19:31 +00:00
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"ReturnDec": null,
|
|
|
|
|
"TipSet": [],
|
2021-01-19 10:19:31 +00:00
|
|
|
"Height": 10101
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateSearchMsgLimited
|
|
|
|
|
StateSearchMsgLimited looks back up to limit epochs in the chain for a message, and returns its receipt and the tipset where it was executed
|
|
|
|
|
|
2021-03-18 17:17:46 +00:00
|
|
|
NOTE: If a replacing message is found on chain, this method will return
|
|
|
|
|
a MsgLookup for the replacing message - the MsgLookup.Message will be a different
|
|
|
|
|
CID than the one provided in the 'cid' param, MsgLookup.Receipt will contain the
|
|
|
|
|
result of the execution of the replacing message.
|
|
|
|
|
|
|
|
|
|
If the caller wants to ensure that exactly the requested message was executed,
|
|
|
|
|
they MUST check that MsgLookup.Message is equal to the provided 'cid'.
|
|
|
|
|
Without this check both the requested and original message may appear as
|
|
|
|
|
successfully executed on-chain, which may look like a double-spend.
|
|
|
|
|
|
|
|
|
|
A replacing message is a message with a different CID, any of Gas values, and
|
|
|
|
|
different signature, but with all other parameters matching (source/destination,
|
|
|
|
|
nonce, params, etc.)
|
|
|
|
|
|
2021-01-19 10:19:31 +00:00
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
10101
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Message": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
"Receipt": {
|
|
|
|
|
"ExitCode": 0,
|
|
|
|
|
"Return": "Ynl0ZSBhcnJheQ==",
|
2022-12-08 06:16:56 +00:00
|
|
|
"GasUsed": 0,
|
|
|
|
|
"EventsRoot": null
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"ReturnDec": null,
|
|
|
|
|
"TipSet": [],
|
2020-08-24 10:25:49 +00:00
|
|
|
"Height": 10101
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateSectorExpiration
|
|
|
|
|
StateSectorExpiration returns epoch at which given sector will expire
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
9,
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"OnTime": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Early": 10101
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateSectorGetInfo
|
2020-08-27 11:53:04 +00:00
|
|
|
StateSectorGetInfo returns the on-chain info for the specified miner's sector. Returns null in case the sector info isn't found
|
2020-08-24 10:25:49 +00:00
|
|
|
NOTE: returned info.Expiration may not be accurate in some cases, use StateSectorExpiration to get accurate
|
|
|
|
|
expiration epoch
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
9,
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"SectorNumber": 0,
|
|
|
|
|
"SealProof": 0,
|
|
|
|
|
"SealedCID": null,
|
|
|
|
|
"DealIDs": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Activation": 10101,
|
|
|
|
|
"Expiration": 10101,
|
|
|
|
|
"DealWeight": "0",
|
|
|
|
|
"VerifiedDealWeight": "0",
|
|
|
|
|
"InitialPledge": "0",
|
|
|
|
|
"ExpectedDayReward": "0",
|
2021-11-18 23:35:06 +00:00
|
|
|
"ExpectedStoragePledge": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"ReplacedSectorAge": 0,
|
2022-04-20 21:34:28 +00:00
|
|
|
"ReplacedDayReward": "0",
|
2022-09-22 17:36:43 +00:00
|
|
|
"SectorKeyCID": null,
|
2022-11-25 21:06:19 +00:00
|
|
|
"SimpleQAPower": false
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateSectorPartition
|
|
|
|
|
StateSectorPartition finds deadline/partition with the specified sector
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
9,
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Deadline": 42,
|
|
|
|
|
"Partition": 42
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateSectorPreCommitInfo
|
|
|
|
|
StateSectorPreCommitInfo returns the PreCommit info for the specified miner's sector
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
9,
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Info": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"SealProof": 0,
|
|
|
|
|
"SectorNumber": 0,
|
|
|
|
|
"SealedCID": null,
|
|
|
|
|
"SealRandEpoch": 0,
|
|
|
|
|
"DealIDs": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Expiration": 10101,
|
2022-09-08 01:25:28 +00:00
|
|
|
"UnsealedCid": null
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"PreCommitDeposit": "\u003cnil\u003e",
|
|
|
|
|
"PreCommitEpoch": 0
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-10-12 20:41:27 +00:00
|
|
|
### StateVMCirculatingSupplyInternal
|
|
|
|
|
StateVMCirculatingSupplyInternal returns an approximation of the circulating supply of Filecoin at the given tipset.
|
2020-10-11 22:17:28 +00:00
|
|
|
This is the value reported by the runtime interface to actors code.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"FilVested": "\u003cnil\u003e",
|
|
|
|
|
"FilMined": "\u003cnil\u003e",
|
|
|
|
|
"FilBurnt": "\u003cnil\u003e",
|
|
|
|
|
"FilLocked": "\u003cnil\u003e",
|
|
|
|
|
"FilCirculating": "\u003cnil\u003e",
|
|
|
|
|
"FilReserveDisbursed": "\u003cnil\u003e"
|
2020-10-11 22:17:28 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### StateVerifiedClientStatus
|
|
|
|
|
StateVerifiedClientStatus returns the data cap for the given address.
|
|
|
|
|
Returns nil if there is no entry in the data cap table for the
|
|
|
|
|
address.
|
|
|
|
|
|
|
|
|
|
|
2020-10-01 07:14:59 +00:00
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-10-01 07:14:59 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"0"`
|
|
|
|
|
|
|
|
|
|
### StateVerifiedRegistryRootKey
|
2022-08-12 07:12:22 +00:00
|
|
|
StateVerifiedRegistryRootKey returns the address of the Verified Registry's root key
|
2020-10-01 07:14:59 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2020-10-06 07:30:40 +00:00
|
|
|
Response: `"f01234"`
|
2020-10-01 07:14:59 +00:00
|
|
|
|
|
|
|
|
### StateVerifierStatus
|
|
|
|
|
StateVerifierStatus returns the data cap for the given address.
|
|
|
|
|
Returns nil if there is no entry in the data cap table for the
|
|
|
|
|
address.
|
|
|
|
|
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"0"`
|
|
|
|
|
|
|
|
|
|
### StateWaitMsg
|
|
|
|
|
StateWaitMsg looks back in the chain for a message. If not found, it blocks until the
|
|
|
|
|
message arrives on chain, and gets to the indicated confidence depth.
|
|
|
|
|
|
2021-03-18 17:17:46 +00:00
|
|
|
NOTE: If a replacing message is found on chain, this method will return
|
|
|
|
|
a MsgLookup for the replacing message - the MsgLookup.Message will be a different
|
|
|
|
|
CID than the one provided in the 'cid' param, MsgLookup.Receipt will contain the
|
|
|
|
|
result of the execution of the replacing message.
|
|
|
|
|
|
|
|
|
|
If the caller wants to ensure that exactly the requested message was executed,
|
|
|
|
|
they MUST check that MsgLookup.Message is equal to the provided 'cid'.
|
|
|
|
|
Without this check both the requested and original message may appear as
|
|
|
|
|
successfully executed on-chain, which may look like a double-spend.
|
|
|
|
|
|
|
|
|
|
A replacing message is a message with a different CID, any of Gas values, and
|
|
|
|
|
different signature, but with all other parameters matching (source/destination,
|
|
|
|
|
nonce, params, etc.)
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
42
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2020-10-09 16:43:22 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Message": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
"Receipt": {
|
|
|
|
|
"ExitCode": 0,
|
|
|
|
|
"Return": "Ynl0ZSBhcnJheQ==",
|
2022-12-08 06:16:56 +00:00
|
|
|
"GasUsed": 0,
|
|
|
|
|
"EventsRoot": null
|
2020-10-09 16:43:22 +00:00
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"ReturnDec": null,
|
|
|
|
|
"TipSet": [],
|
2020-10-09 16:43:22 +00:00
|
|
|
"Height": 10101
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### StateWaitMsgLimited
|
|
|
|
|
StateWaitMsgLimited looks back up to limit epochs in the chain for a message.
|
|
|
|
|
If not found, it blocks until the message arrives on chain, and gets to the
|
|
|
|
|
indicated confidence depth.
|
|
|
|
|
|
2021-03-18 17:17:46 +00:00
|
|
|
NOTE: If a replacing message is found on chain, this method will return
|
|
|
|
|
a MsgLookup for the replacing message - the MsgLookup.Message will be a different
|
|
|
|
|
CID than the one provided in the 'cid' param, MsgLookup.Receipt will contain the
|
|
|
|
|
result of the execution of the replacing message.
|
|
|
|
|
|
|
|
|
|
If the caller wants to ensure that exactly the requested message was executed,
|
|
|
|
|
they MUST check that MsgLookup.Message is equal to the provided 'cid'.
|
|
|
|
|
Without this check both the requested and original message may appear as
|
|
|
|
|
successfully executed on-chain, which may look like a double-spend.
|
|
|
|
|
|
|
|
|
|
A replacing message is a message with a different CID, any of Gas values, and
|
|
|
|
|
different signature, but with all other parameters matching (source/destination,
|
|
|
|
|
nonce, params, etc.)
|
|
|
|
|
|
2020-10-09 16:43:22 +00:00
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
42,
|
|
|
|
|
10101
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Message": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
"Receipt": {
|
|
|
|
|
"ExitCode": 0,
|
|
|
|
|
"Return": "Ynl0ZSBhcnJheQ==",
|
2022-12-08 06:16:56 +00:00
|
|
|
"GasUsed": 0,
|
|
|
|
|
"EventsRoot": null
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"ReturnDec": null,
|
|
|
|
|
"TipSet": [],
|
2020-08-24 10:25:49 +00:00
|
|
|
"Height": 10101
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Sync
|
|
|
|
|
The Sync method group contains methods for interacting with and
|
|
|
|
|
observing the lotus sync service.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### SyncCheckBad
|
|
|
|
|
SyncCheckBad checks if a block was marked as bad, and if it was, returns
|
|
|
|
|
the reason.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"string value"`
|
|
|
|
|
|
2020-09-09 07:45:47 +00:00
|
|
|
### SyncCheckpoint
|
|
|
|
|
SyncCheckpoint marks a blocks as checkpointed, meaning that it won't ever fork away from it.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### SyncIncomingBlocks
|
|
|
|
|
SyncIncomingBlocks returns a channel streaming incoming, potentially not
|
|
|
|
|
yet synced block headers.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2020-10-06 07:30:40 +00:00
|
|
|
"Miner": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Ticket": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"VRFProof": null
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"ElectionProof": null,
|
|
|
|
|
"BeaconEntries": null,
|
|
|
|
|
"WinPoStProof": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Parents": [
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
],
|
2020-08-24 10:25:49 +00:00
|
|
|
"ParentWeight": "0",
|
|
|
|
|
"Height": 10101,
|
2022-11-25 21:06:19 +00:00
|
|
|
"ParentStateRoot": null,
|
|
|
|
|
"ParentMessageReceipts": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Messages": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"BLSAggregate": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Timestamp": 42,
|
2022-11-25 21:06:19 +00:00
|
|
|
"BlockSig": null,
|
|
|
|
|
"ForkSignaling": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"ParentBaseFee": "0"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### SyncMarkBad
|
|
|
|
|
SyncMarkBad marks a blocks as bad, meaning that it won't ever by synced.
|
|
|
|
|
Use with extreme caution.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
|
|
|
|
### SyncState
|
|
|
|
|
SyncState returns the current status of the lotus sync system.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2022-11-25 21:06:19 +00:00
|
|
|
"ActiveSyncs": null,
|
|
|
|
|
"VMApplied": 0
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### SyncSubmitBlock
|
|
|
|
|
SyncSubmitBlock can be used to submit a newly created block to the.
|
|
|
|
|
network through this node
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"Header": {
|
2020-10-06 07:30:40 +00:00
|
|
|
"Miner": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Ticket": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"VRFProof": null
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"ElectionProof": null,
|
|
|
|
|
"BeaconEntries": null,
|
|
|
|
|
"WinPoStProof": null,
|
2021-12-28 02:38:12 +00:00
|
|
|
"Parents": [
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
],
|
2020-08-24 10:25:49 +00:00
|
|
|
"ParentWeight": "0",
|
|
|
|
|
"Height": 10101,
|
2022-11-25 21:06:19 +00:00
|
|
|
"ParentStateRoot": null,
|
|
|
|
|
"ParentMessageReceipts": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Messages": {
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"BLSAggregate": null,
|
2020-08-24 10:25:49 +00:00
|
|
|
"Timestamp": 42,
|
2022-11-25 21:06:19 +00:00
|
|
|
"BlockSig": null,
|
|
|
|
|
"ForkSignaling": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"ParentBaseFee": "0"
|
|
|
|
|
},
|
2022-11-25 21:06:19 +00:00
|
|
|
"BlsMessages": null,
|
|
|
|
|
"SecpkMessages": null
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
2020-10-10 18:46:06 +00:00
|
|
|
### SyncUnmarkAllBad
|
|
|
|
|
SyncUnmarkAllBad purges bad block cache, making it possible to sync to chains previously marked as bad
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
2020-09-09 07:45:47 +00:00
|
|
|
### SyncUnmarkBad
|
|
|
|
|
SyncUnmarkBad unmarks a blocks as bad, making it possible to be validated and synced again.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
2020-09-27 22:08:58 +00:00
|
|
|
### SyncValidateTipset
|
|
|
|
|
SyncValidateTipset indicates whether the provided tipset is valid or not
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `true`
|
|
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
## Wallet
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### WalletBalance
|
|
|
|
|
WalletBalance returns the balance of the given address at the current head of the chain.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234"
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `"0"`
|
|
|
|
|
|
|
|
|
|
### WalletDefaultAddress
|
|
|
|
|
WalletDefaultAddress returns the address marked as default in the wallet.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
2020-10-06 07:30:40 +00:00
|
|
|
Response: `"f01234"`
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### WalletDelete
|
|
|
|
|
WalletDelete deletes an address from the wallet.
|
|
|
|
|
|
|
|
|
|
|
2021-03-23 12:42:56 +00:00
|
|
|
Perms: admin
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234"
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
|
|
|
|
### WalletExport
|
|
|
|
|
WalletExport returns the private key of an address in the wallet.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234"
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
2020-10-11 18:12:01 +00:00
|
|
|
"Type": "bls",
|
2022-11-25 21:06:19 +00:00
|
|
|
"PrivateKey": null
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### WalletHas
|
|
|
|
|
WalletHas indicates whether the given address is in the wallet.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234"
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `true`
|
|
|
|
|
|
|
|
|
|
### WalletImport
|
|
|
|
|
WalletImport receives a KeyInfo, which includes a private key, and imports it into the wallet.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: admin
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
{
|
2020-10-11 18:12:01 +00:00
|
|
|
"Type": "bls",
|
2022-11-25 21:06:19 +00:00
|
|
|
"PrivateKey": null
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2020-10-06 07:30:40 +00:00
|
|
|
Response: `"f01234"`
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### WalletList
|
|
|
|
|
WalletList lists all the addresses in the wallet.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs: `null`
|
|
|
|
|
|
2021-12-28 02:38:12 +00:00
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"f01234"
|
|
|
|
|
]
|
|
|
|
|
```
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### WalletNew
|
|
|
|
|
WalletNew creates a new address in the wallet with the given sigType.
|
2020-10-11 18:12:01 +00:00
|
|
|
Available key types: bls, secp256k1, secp256k1-ledger
|
|
|
|
|
Support for numerical types: 1 - secp256k1, 2 - BLS is deprecated
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: write
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-11 18:12:01 +00:00
|
|
|
"bls"
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2020-10-06 07:30:40 +00:00
|
|
|
Response: `"f01234"`
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
### WalletSetDefault
|
|
|
|
|
WalletSetDefault marks the given address as as the default one.
|
|
|
|
|
|
|
|
|
|
|
2021-03-23 12:42:56 +00:00
|
|
|
Perms: write
|
2020-08-24 10:25:49 +00:00
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234"
|
2020-08-24 10:25:49 +00:00
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `{}`
|
|
|
|
|
|
|
|
|
|
### WalletSign
|
|
|
|
|
WalletSign signs the given bytes using the given address.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Ynl0ZSBhcnJheQ=="
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### WalletSignMessage
|
|
|
|
|
WalletSignMessage signs the given message using the given address.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: sign
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
{
|
|
|
|
|
"Version": 42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
2020-10-12 18:47:09 +00:00
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2020-10-12 18:47:09 +00:00
|
|
|
}
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response:
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"Message": {
|
|
|
|
|
"Version": 42,
|
2020-10-06 07:30:40 +00:00
|
|
|
"To": "f01234",
|
|
|
|
|
"From": "f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Nonce": 42,
|
|
|
|
|
"Value": "0",
|
2022-11-25 21:06:19 +00:00
|
|
|
"GasLimit": 0,
|
2020-08-24 10:25:49 +00:00
|
|
|
"GasFeeCap": "0",
|
|
|
|
|
"GasPremium": "0",
|
|
|
|
|
"Method": 1,
|
2020-10-12 18:47:09 +00:00
|
|
|
"Params": "Ynl0ZSBhcnJheQ==",
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2020-10-12 18:47:09 +00:00
|
|
|
}
|
2020-08-24 10:25:49 +00:00
|
|
|
},
|
|
|
|
|
"Signature": {
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
2020-10-12 18:47:09 +00:00
|
|
|
},
|
|
|
|
|
"CID": {
|
2022-11-25 21:06:19 +00:00
|
|
|
"/": "bafy2bzacebnkgxcy5pyk763pyw5l2sbltrai3qga5k2rcvvpgpdx2stlegnz4"
|
2020-08-24 10:25:49 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-09-30 05:45:03 +00:00
|
|
|
### WalletValidateAddress
|
|
|
|
|
WalletValidateAddress validates whether a given string can be decoded as a well-formed address
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
|
|
|
|
"string value"
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
2020-10-06 07:30:40 +00:00
|
|
|
Response: `"f01234"`
|
2020-09-30 05:45:03 +00:00
|
|
|
|
2020-08-24 10:25:49 +00:00
|
|
|
### WalletVerify
|
|
|
|
|
WalletVerify takes an address, a signature, and some bytes, and indicates whether the signature is valid.
|
|
|
|
|
The address does not have to be in the wallet.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Perms: read
|
|
|
|
|
|
|
|
|
|
Inputs:
|
|
|
|
|
```json
|
|
|
|
|
[
|
2020-10-06 07:30:40 +00:00
|
|
|
"f01234",
|
2020-08-24 10:25:49 +00:00
|
|
|
"Ynl0ZSBhcnJheQ==",
|
|
|
|
|
{
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Data": "Ynl0ZSBhcnJheQ=="
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Response: `true`
|
|
|
|
|
|
