50 KiB
Groups
- Actor
- Auth
- Check
- Compute
- Create
- Dagstore
- Deals
- DealsConsiderOfflineRetrievalDeals
- DealsConsiderOfflineStorageDeals
- DealsConsiderOnlineRetrievalDeals
- DealsConsiderOnlineStorageDeals
- DealsConsiderUnverifiedStorageDeals
- DealsConsiderVerifiedStorageDeals
- DealsImportData
- DealsList
- DealsPieceCidBlocklist
- DealsSetConsiderOfflineRetrievalDeals
- DealsSetConsiderOfflineStorageDeals
- DealsSetConsiderOnlineRetrievalDeals
- DealsSetConsiderOnlineStorageDeals
- DealsSetConsiderUnverifiedStorageDeals
- DealsSetConsiderVerifiedStorageDeals
- DealsSetPieceCidBlocklist
- I
- Log
- Market
- MarketCancelDataTransfer
- MarketDataTransferUpdates
- MarketGetAsk
- MarketGetDealUpdates
- MarketGetRetrievalAsk
- MarketImportDealData
- MarketListDataTransfers
- MarketListDeals
- MarketListIncompleteDeals
- MarketListRetrievalDeals
- MarketPendingDeals
- MarketPublishPendingDeals
- MarketRestartDataTransfer
- MarketRetryPublishDeal
- MarketSetAsk
- MarketSetRetrievalAsk
- Mining
- Net
- Pieces
- Pledge
- Return
- Runtime
- Sealing
- Sector
- SectorAddPieceToAny
- SectorCommitFlush
- SectorCommitPending
- SectorGetExpectedSealDuration
- SectorGetSealDelay
- SectorMarkForUpgrade
- SectorPreCommitFlush
- SectorPreCommitPending
- SectorRemove
- SectorSetExpectedSealDuration
- SectorSetSealDelay
- SectorStartSealing
- SectorTerminate
- SectorTerminateFlush
- SectorTerminatePending
- Sectors
- Storage
- Worker
Closing
Perms: read
Inputs: null
Response: {}
Discover
Perms: read
Inputs: null
Response:
{
"info": {
"title": "Lotus RPC API",
"version": "1.2.1/generated=2020-11-22T08:22:42-06:00"
},
"methods": [],
"openrpc": "1.2.6"
}
Session
Perms: read
Inputs: null
Response: "07070707-0707-0707-0707-070707070707"
Shutdown
Perms: admin
Inputs: null
Response: {}
Version
Perms: read
Inputs: null
Response:
{
"Version": "string value",
"APIVersion": 131328,
"BlockDelay": 42
}
Actor
ActorAddress
Perms: read
Inputs: null
Response: "f01234"
ActorAddressConfig
Perms: read
Inputs: null
Response:
{
"PreCommitControl": null,
"CommitControl": null,
"TerminateControl": null,
"DealPublishControl": null,
"DisableOwnerFallback": true,
"DisableWorkerFallback": true
}
ActorSectorSize
Perms: read
Inputs:
[
"f01234"
]
Response: 34359738368
Auth
AuthNew
Perms: admin
Inputs:
[
null
]
Response: "Ynl0ZSBhcnJheQ=="
AuthVerify
Perms: read
Inputs:
[
"string value"
]
Response: null
Check
CheckProvable
Perms: admin
Inputs:
[
8,
null,
true
]
Response:
{
"123": "can't acquire read lock"
}
Compute
ComputeProof
Perms: read
Inputs:
[
null,
null
]
Response: null
Create
CreateBackup
CreateBackup creates node backup onder the specified file name. The method requires that the lotus-miner 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:
[
"string value"
]
Response: {}
Dagstore
DagstoreGC
DagstoreGC runs garbage collection on the DAG store.
Perms: admin
Inputs: null
Response: null
DagstoreInitializeAll
DagstoreInitializeAll initializes all uninitialized shards in bulk, according to the policy passed in the parameters.
It is recommended to set a maximum concurrency to avoid extreme IO pressure if the storage subsystem has a large amount of deals.
It returns a stream of events to report progress.
Perms: write
Inputs:
[
{
"MaxConcurrency": 123,
"IncludeSealed": true
}
]
Response:
{
"Key": "string value",
"Event": "string value",
"Success": true,
"Error": "string value",
"Total": 123,
"Current": 123
}
DagstoreInitializeShard
DagstoreInitializeShard initializes an uninitialized shard.
Initialization consists of fetching the shard's data (deal payload) from the storage subsystem, generating an index, and persisting the index to facilitate later retrievals, and/or to publish to external sources.
This operation is intended to complement the initial migration. The migration registers a shard for every unique piece CID, with lazy initialization. Thus, shards are not initialized immediately to avoid IO activity competing with proving. Instead, shard are initialized when first accessed. This method forces the initialization of a shard by accessing it and immediately releasing it. This is useful to warm up the cache to facilitate subsequent retrievals, and to generate the indexes to publish them externally.
This operation fails if the shard is not in ShardStateNew state. It blocks until initialization finishes.
Perms: write
Inputs:
[
"string value"
]
Response: {}
DagstoreListShards
DagstoreListShards returns information about all shards known to the DAG store. Only available on nodes running the markets subsystem.
Perms: read
Inputs: null
Response: null
DagstoreRecoverShard
DagstoreRecoverShard attempts to recover a failed shard.
This operation fails if the shard is not in ShardStateErrored state. It blocks until recovery finishes. If recovery failed, it returns the error.
Perms: write
Inputs:
[
"string value"
]
Response: {}
Deals
DealsConsiderOfflineRetrievalDeals
Perms: admin
Inputs: null
Response: true
DealsConsiderOfflineStorageDeals
Perms: admin
Inputs: null
Response: true
DealsConsiderOnlineRetrievalDeals
Perms: admin
Inputs: null
Response: true
DealsConsiderOnlineStorageDeals
Perms: admin
Inputs: null
Response: true
DealsConsiderUnverifiedStorageDeals
Perms: admin
Inputs: null
Response: true
DealsConsiderVerifiedStorageDeals
Perms: admin
Inputs: null
Response: true
DealsImportData
Perms: admin
Inputs:
[
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"string value"
]
Response: {}
DealsList
Perms: admin
Inputs: null
Response: null
DealsPieceCidBlocklist
Perms: admin
Inputs: null
Response: null
DealsSetConsiderOfflineRetrievalDeals
Perms: admin
Inputs:
[
true
]
Response: {}
DealsSetConsiderOfflineStorageDeals
Perms: admin
Inputs:
[
true
]
Response: {}
DealsSetConsiderOnlineRetrievalDeals
Perms: admin
Inputs:
[
true
]
Response: {}
DealsSetConsiderOnlineStorageDeals
Perms: admin
Inputs:
[
true
]
Response: {}
DealsSetConsiderUnverifiedStorageDeals
Perms: admin
Inputs:
[
true
]
Response: {}
DealsSetConsiderVerifiedStorageDeals
Perms: admin
Inputs:
[
true
]
Response: {}
DealsSetPieceCidBlocklist
Perms: admin
Inputs:
[
null
]
Response: {}
I
ID
Perms: read
Inputs: null
Response: "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
Log
LogAlerts
Perms: admin
Inputs: null
Response: null
LogList
Perms: write
Inputs: null
Response: null
LogSetLevel
Perms: write
Inputs:
[
"string value",
"string value"
]
Response: {}
Market
MarketCancelDataTransfer
MarketCancelDataTransfer cancels a data transfer with the given transfer ID and other peer
Perms: write
Inputs:
[
3,
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
true
]
Response: {}
MarketDataTransferUpdates
Perms: write
Inputs: null
Response:
{
"TransferID": 3,
"Status": 1,
"BaseCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"IsInitiator": true,
"IsSender": true,
"Voucher": "string value",
"Message": "string value",
"OtherPeer": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"Transferred": 42,
"Stages": {
"Stages": null
}
}
MarketGetAsk
Perms: read
Inputs: null
Response:
{
"Ask": {
"Price": "0",
"VerifiedPrice": "0",
"MinPieceSize": 1032,
"MaxPieceSize": 1032,
"Miner": "f01234",
"Timestamp": 10101,
"Expiry": 10101,
"SeqNo": 42
},
"Signature": {
"Type": 2,
"Data": "Ynl0ZSBhcnJheQ=="
}
}
MarketGetDealUpdates
Perms: read
Inputs: null
Response:
{
"Proposal": {
"PieceCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PieceSize": 1032,
"VerifiedDeal": true,
"Client": "f01234",
"Provider": "f01234",
"Label": "string value",
"StartEpoch": 10101,
"EndEpoch": 10101,
"StoragePricePerEpoch": "0",
"ProviderCollateral": "0",
"ClientCollateral": "0"
},
"ClientSignature": {
"Type": 2,
"Data": "Ynl0ZSBhcnJheQ=="
},
"ProposalCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"AddFundsCid": null,
"PublishCid": null,
"Miner": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"Client": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"State": 42,
"PiecePath": ".lotusminer/fstmp123",
"MetadataPath": ".lotusminer/fstmp123",
"SlashEpoch": 10101,
"FastRetrieval": true,
"Message": "string value",
"FundsReserved": "0",
"Ref": {
"TransferType": "string value",
"Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PieceCid": null,
"PieceSize": 1024,
"RawBlockSize": 42
},
"AvailableForRetrieval": true,
"DealID": 5432,
"CreationTime": "0001-01-01T00:00:00Z",
"TransferChannelId": {
"Initiator": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"Responder": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"ID": 3
},
"SectorNumber": 9,
"InboundCAR": "string value"
}
MarketGetRetrievalAsk
Perms: read
Inputs: null
Response:
{
"PricePerByte": "0",
"UnsealPrice": "0",
"PaymentInterval": 42,
"PaymentIntervalIncrease": 42
}
MarketImportDealData
Perms: write
Inputs:
[
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"string value"
]
Response: {}
MarketListDataTransfers
Perms: write
Inputs: null
Response: null
MarketListDeals
Perms: read
Inputs: null
Response: null
MarketListIncompleteDeals
Perms: read
Inputs: null
Response: null
MarketListRetrievalDeals
Perms: read
Inputs: null
Response: null
MarketPendingDeals
Perms: write
Inputs: null
Response:
{
"Deals": null,
"PublishPeriodStart": "0001-01-01T00:00:00Z",
"PublishPeriod": 60000000000
}
MarketPublishPendingDeals
Perms: admin
Inputs: null
Response: {}
MarketRestartDataTransfer
MarketRestartDataTransfer attempts to restart a data transfer with the given transfer ID and other peer
Perms: write
Inputs:
[
3,
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
true
]
Response: {}
MarketRetryPublishDeal
Perms: admin
Inputs:
[
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
]
Response: {}
MarketSetAsk
Perms: admin
Inputs:
[
"0",
"0",
10101,
1032,
1032
]
Response: {}
MarketSetRetrievalAsk
Perms: admin
Inputs:
[
{
"PricePerByte": "0",
"UnsealPrice": "0",
"PaymentInterval": 42,
"PaymentIntervalIncrease": 42
}
]
Response: {}
Mining
MiningBase
Perms: read
Inputs: null
Response:
{
"Cids": null,
"Blocks": null,
"Height": 0
}
Net
NetAddrsListen
Perms: read
Inputs: null
Response:
{
"ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"Addrs": []
}
NetAgentVersion
Perms: read
Inputs:
[
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
]
Response: "string value"
NetAutoNatStatus
Perms: read
Inputs: null
Response:
{
"Reachability": 1,
"PublicAddr": "string value"
}
NetBandwidthStats
Perms: read
Inputs: null
Response:
{
"TotalIn": 9,
"TotalOut": 9,
"RateIn": 12.3,
"RateOut": 12.3
}
NetBandwidthStatsByPeer
Perms: read
Inputs: null
Response:
{
"12D3KooWSXmXLJmBR1M7i9RW9GQPNUhZSzXKzxDHWtAgNuJAbyEJ": {
"TotalIn": 174000,
"TotalOut": 12500,
"RateIn": 100,
"RateOut": 50
}
}
NetBandwidthStatsByProtocol
Perms: read
Inputs: null
Response:
{
"/fil/hello/1.0.0": {
"TotalIn": 174000,
"TotalOut": 12500,
"RateIn": 100,
"RateOut": 50
}
}
NetBlockAdd
Perms: admin
Inputs:
[
{
"Peers": null,
"IPAddrs": null,
"IPSubnets": null
}
]
Response: {}
NetBlockList
Perms: read
Inputs: null
Response:
{
"Peers": null,
"IPAddrs": null,
"IPSubnets": null
}
NetBlockRemove
Perms: admin
Inputs:
[
{
"Peers": null,
"IPAddrs": null,
"IPSubnets": null
}
]
Response: {}
NetConnect
Perms: write
Inputs:
[
{
"ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"Addrs": []
}
]
Response: {}
NetConnectedness
Perms: read
Inputs:
[
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
]
Response: 1
NetDisconnect
Perms: write
Inputs:
[
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
]
Response: {}
NetFindPeer
Perms: read
Inputs:
[
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
]
Response:
{
"ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"Addrs": []
}
NetPeerInfo
Perms: read
Inputs:
[
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
]
Response:
{
"ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"Agent": "string value",
"Addrs": null,
"Protocols": null,
"ConnMgrMeta": {
"FirstSeen": "0001-01-01T00:00:00Z",
"Value": 123,
"Tags": {
"name": 42
},
"Conns": {
"name": "2021-03-08T22:52:18Z"
}
}
}
NetPeers
Perms: read
Inputs: null
Response: null
NetPubsubScores
Perms: read
Inputs: null
Response: null
Pieces
PiecesGetCIDInfo
Perms: read
Inputs:
[
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
]
Response:
{
"CID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PieceBlockLocations": null
}
PiecesGetPieceInfo
Perms: read
Inputs:
[
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
]
Response:
{
"PieceCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Deals": null
}
PiecesListCidInfos
Perms: read
Inputs: null
Response: null
PiecesListPieces
Perms: read
Inputs: null
Response: null
Pledge
PledgeSector
Temp api for testing
Perms: write
Inputs: null
Response:
{
"Miner": 1000,
"Number": 9
}
Return
ReturnAddPiece
storiface.WorkerReturn
Perms: admin
Inputs:
[
{
"Sector": {
"Miner": 1000,
"Number": 9
},
"ID": "07070707-0707-0707-0707-070707070707"
},
{
"Size": 1032,
"PieceCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
},
{
"Code": 0,
"Message": "string value"
}
]
Response: {}
ReturnFetch
Perms: admin
Inputs:
[
{
"Sector": {
"Miner": 1000,
"Number": 9
},
"ID": "07070707-0707-0707-0707-070707070707"
},
{
"Code": 0,
"Message": "string value"
}
]
Response: {}
ReturnFinalizeSector
Perms: admin
Inputs:
[
{
"Sector": {
"Miner": 1000,
"Number": 9
},
"ID": "07070707-0707-0707-0707-070707070707"
},
{
"Code": 0,
"Message": "string value"
}
]
Response: {}
ReturnMoveStorage
Perms: admin
Inputs:
[
{
"Sector": {
"Miner": 1000,
"Number": 9
},
"ID": "07070707-0707-0707-0707-070707070707"
},
{
"Code": 0,
"Message": "string value"
}
]
Response: {}
ReturnReadPiece
Perms: admin
Inputs:
[
{
"Sector": {
"Miner": 1000,
"Number": 9
},
"ID": "07070707-0707-0707-0707-070707070707"
},
true,
{
"Code": 0,
"Message": "string value"
}
]
Response: {}
ReturnReleaseUnsealed
Perms: admin
Inputs:
[
{
"Sector": {
"Miner": 1000,
"Number": 9
},
"ID": "07070707-0707-0707-0707-070707070707"
},
{
"Code": 0,
"Message": "string value"
}
]
Response: {}
ReturnSealCommit1
Perms: admin
Inputs:
[
{
"Sector": {
"Miner": 1000,
"Number": 9
},
"ID": "07070707-0707-0707-0707-070707070707"
},
null,
{
"Code": 0,
"Message": "string value"
}
]
Response: {}
ReturnSealCommit2
Perms: admin
Inputs:
[
{
"Sector": {
"Miner": 1000,
"Number": 9
},
"ID": "07070707-0707-0707-0707-070707070707"
},
null,
{
"Code": 0,
"Message": "string value"
}
]
Response: {}
ReturnSealPreCommit1
Perms: admin
Inputs:
[
{
"Sector": {
"Miner": 1000,
"Number": 9
},
"ID": "07070707-0707-0707-0707-070707070707"
},
null,
{
"Code": 0,
"Message": "string value"
}
]
Response: {}
ReturnSealPreCommit2
Perms: admin
Inputs:
[
{
"Sector": {
"Miner": 1000,
"Number": 9
},
"ID": "07070707-0707-0707-0707-070707070707"
},
{
"Unsealed": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Sealed": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
},
{
"Code": 0,
"Message": "string value"
}
]
Response: {}
ReturnUnsealPiece
Perms: admin
Inputs:
[
{
"Sector": {
"Miner": 1000,
"Number": 9
},
"ID": "07070707-0707-0707-0707-070707070707"
},
{
"Code": 0,
"Message": "string value"
}
]
Response: {}
Runtime
RuntimeSubsystems
RuntimeSubsystems returns the subsystems that are enabled in this instance.
Perms: read
Inputs: null
Response:
[
"Mining",
"Sealing",
"SectorStorage",
"Markets"
]
Sealing
SealingAbort
Perms: admin
Inputs:
[
{
"Sector": {
"Miner": 1000,
"Number": 9
},
"ID": "07070707-0707-0707-0707-070707070707"
}
]
Response: {}
SealingSchedDiag
SealingSchedDiag dumps internal sealing scheduler state
Perms: admin
Inputs:
[
true
]
Response: {}
Sector
SectorAddPieceToAny
Add piece to an open sector. If no sectors with enough space are open, either a new sector will be created, or this call will block until more sectors can be created.
Perms: admin
Inputs:
[
1024,
{},
{
"PublishCid": null,
"DealID": 5432,
"DealProposal": {
"PieceCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PieceSize": 1032,
"VerifiedDeal": true,
"Client": "f01234",
"Provider": "f01234",
"Label": "string value",
"StartEpoch": 10101,
"EndEpoch": 10101,
"StoragePricePerEpoch": "0",
"ProviderCollateral": "0",
"ClientCollateral": "0"
},
"DealSchedule": {
"StartEpoch": 10101,
"EndEpoch": 10101
},
"KeepUnsealed": true
}
]
Response:
{
"Sector": 9,
"Offset": 1032
}
SectorCommitFlush
SectorCommitFlush immediately sends a Commit message with sectors aggregated for Commit. Returns null if message wasn't sent
Perms: admin
Inputs: null
Response: null
SectorCommitPending
SectorCommitPending returns a list of pending Commit sectors to be sent in the next aggregate message
Perms: admin
Inputs: null
Response: null
SectorGetExpectedSealDuration
SectorGetExpectedSealDuration gets the expected time for a sector to seal
Perms: read
Inputs: null
Response: 60000000000
SectorGetSealDelay
SectorGetSealDelay gets the time that a newly-created sector waits for more deals before it starts sealing
Perms: read
Inputs: null
Response: 60000000000
SectorMarkForUpgrade
Perms: admin
Inputs:
[
9
]
Response: {}
SectorPreCommitFlush
SectorPreCommitFlush immediately sends a PreCommit message with sectors batched for PreCommit. Returns null if message wasn't sent
Perms: admin
Inputs: null
Response: null
SectorPreCommitPending
SectorPreCommitPending returns a list of pending PreCommit sectors to be sent in the next batch message
Perms: admin
Inputs: null
Response: null
SectorRemove
SectorRemove removes the sector from storage. It doesn't terminate it on-chain, which can be done with SectorTerminate. Removing and not terminating live sectors will cause additional penalties.
Perms: admin
Inputs:
[
9
]
Response: {}
SectorSetExpectedSealDuration
SectorSetExpectedSealDuration sets the expected time for a sector to seal
Perms: write
Inputs:
[
60000000000
]
Response: {}
SectorSetSealDelay
SectorSetSealDelay sets the time that a newly-created sector waits for more deals before it starts sealing
Perms: write
Inputs:
[
60000000000
]
Response: {}
SectorStartSealing
SectorStartSealing can be called on sectors in Empty or WaitDeals states to trigger sealing early
Perms: write
Inputs:
[
9
]
Response: {}
SectorTerminate
SectorTerminate terminates the sector on-chain (adding it to a termination batch first), then automatically removes it from storage
Perms: admin
Inputs:
[
9
]
Response: {}
SectorTerminateFlush
SectorTerminateFlush immediately sends a terminate message with sectors batched for termination. Returns null if message wasn't sent
Perms: admin
Inputs: null
Response: null
SectorTerminatePending
SectorTerminatePending returns a list of pending sector terminations to be sent in the next batch message
Perms: admin
Inputs: null
Response: null
Sectors
SectorsList
List all staged sectors
Perms: read
Inputs: null
Response:
[
123,
124
]
SectorsListInStates
List sectors in particular states
Perms: read
Inputs:
[
null
]
Response:
[
123,
124
]
SectorsRefs
Perms: read
Inputs: null
Response:
{
"98000": [
{
"SectorID": 100,
"Offset": 10485760,
"Size": 1048576
}
]
}
SectorsStatus
Get the status of a given sector by ID
Perms: read
Inputs:
[
9,
true
]
Response:
{
"SectorID": 9,
"State": "Proving",
"CommD": null,
"CommR": null,
"Proof": "Ynl0ZSBhcnJheQ==",
"Deals": null,
"Pieces": null,
"Ticket": {
"Value": null,
"Epoch": 10101
},
"Seed": {
"Value": null,
"Epoch": 10101
},
"PreCommitMsg": null,
"CommitMsg": null,
"Retries": 42,
"ToUpgrade": true,
"LastErr": "string value",
"Log": null,
"SealProof": 8,
"Activation": 10101,
"Expiration": 10101,
"DealWeight": "0",
"VerifiedDealWeight": "0",
"InitialPledge": "0",
"OnTime": 10101,
"Early": 10101
}
SectorsSummary
Get summary info of sectors
Perms: read
Inputs: null
Response:
{
"Proving": 120
}
SectorsUnsealPiece
Perms: admin
Inputs:
[
{
"ID": {
"Miner": 1000,
"Number": 9
},
"ProofType": 8
},
1040384,
1024,
null,
null
]
Response: {}
SectorsUpdate
Perms: admin
Inputs:
[
9,
"Proving"
]
Response: {}
Storage
StorageAddLocal
Perms: admin
Inputs:
[
"string value"
]
Response: {}
StorageAttach
stores.SectorIndex
Perms: admin
Inputs:
[
{
"ID": "76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8",
"URLs": null,
"Weight": 42,
"MaxStorage": 42,
"CanSeal": true,
"CanStore": true,
"Groups": null,
"AllowTo": null
},
{
"Capacity": 9,
"Available": 9,
"FSAvailable": 9,
"Reserved": 9,
"Max": 9,
"Used": 9
}
]
Response: {}
StorageBestAlloc
Perms: admin
Inputs:
[
1,
34359738368,
"sealing"
]
Response: null
StorageDeclareSector
Perms: admin
Inputs:
[
"76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8",
{
"Miner": 1000,
"Number": 9
},
1,
true
]
Response: {}
StorageDropSector
Perms: admin
Inputs:
[
"76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8",
{
"Miner": 1000,
"Number": 9
},
1
]
Response: {}
StorageFindSector
Perms: admin
Inputs:
[
{
"Miner": 1000,
"Number": 9
},
1,
34359738368,
true
]
Response: null
StorageGetLocks
Perms: admin
Inputs: null
Response:
{
"Locks": [
{
"Sector": {
"Miner": 1000,
"Number": 123
},
"Write": [
0,
0,
1
],
"Read": [
2,
3,
0
]
}
]
}
StorageInfo
Perms: admin
Inputs:
[
"76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8"
]
Response:
{
"ID": "76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8",
"URLs": null,
"Weight": 42,
"MaxStorage": 42,
"CanSeal": true,
"CanStore": true,
"Groups": null,
"AllowTo": null
}
StorageList
Perms: admin
Inputs: null
Response:
{
"76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8": [
{
"Miner": 1000,
"Number": 100,
"SectorFileType": 2
}
]
}
StorageLocal
Perms: admin
Inputs: null
Response:
{
"76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8": "/data/path"
}
StorageLock
Perms: admin
Inputs:
[
{
"Miner": 1000,
"Number": 9
},
1,
1
]
Response: {}
StorageReportHealth
Perms: admin
Inputs:
[
"76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8",
{
"Stat": {
"Capacity": 9,
"Available": 9,
"FSAvailable": 9,
"Reserved": 9,
"Max": 9,
"Used": 9
},
"Err": "string value"
}
]
Response: {}
StorageStat
Perms: admin
Inputs:
[
"76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8"
]
Response:
{
"Capacity": 9,
"Available": 9,
"FSAvailable": 9,
"Reserved": 9,
"Max": 9,
"Used": 9
}
StorageTryLock
Perms: admin
Inputs:
[
{
"Miner": 1000,
"Number": 9
},
1,
1
]
Response: true
Worker
WorkerConnect
WorkerConnect tells the node to connect to workers RPC
Perms: admin
Inputs:
[
"string value"
]
Response: {}
WorkerJobs
Perms: admin
Inputs: null
Response:
{
"ef8d99a2-6865-4189-8ffa-9fef0f806eee": [
{
"ID": {
"Sector": {
"Miner": 1000,
"Number": 100
},
"ID": "76081ba0-61bd-45a5-bc08-af05f1c26e5d"
},
"Sector": {
"Miner": 1000,
"Number": 100
},
"Task": "seal/v0/precommit/2",
"RunWait": 0,
"Start": "2020-11-12T09:22:07Z",
"Hostname": "host"
}
]
}
WorkerStats
Perms: admin
Inputs: null
Response:
{
"ef8d99a2-6865-4189-8ffa-9fef0f806eee": {
"Info": {
"Hostname": "host",
"IgnoreResources": false,
"Resources": {
"MemPhysical": 274877906944,
"MemUsed": 2147483648,
"MemSwap": 128849018880,
"MemSwapUsed": 2147483648,
"CPUs": 64,
"GPUs": [
"aGPU 1337"
],
"Resources": {
"seal/v0/addpiece": {
"0": {
"MinMemory": 2048,
"MaxMemory": 2048,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 2048
},
"1": {
"MinMemory": 8388608,
"MaxMemory": 8388608,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 8388608
},
"2": {
"MinMemory": 1073741824,
"MaxMemory": 1073741824,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 1073741824
},
"3": {
"MinMemory": 4294967296,
"MaxMemory": 4294967296,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 1073741824
},
"4": {
"MinMemory": 8589934592,
"MaxMemory": 8589934592,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 1073741824
},
"5": {
"MinMemory": 2048,
"MaxMemory": 2048,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 2048
},
"6": {
"MinMemory": 8388608,
"MaxMemory": 8388608,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 8388608
},
"7": {
"MinMemory": 1073741824,
"MaxMemory": 1073741824,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 1073741824
},
"8": {
"MinMemory": 4294967296,
"MaxMemory": 4294967296,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 1073741824
},
"9": {
"MinMemory": 8589934592,
"MaxMemory": 8589934592,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 1073741824
}
},
"seal/v0/commit/1": {
"0": {
"MinMemory": 2048,
"MaxMemory": 2048,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 2048
},
"1": {
"MinMemory": 8388608,
"MaxMemory": 8388608,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 8388608
},
"2": {
"MinMemory": 1073741824,
"MaxMemory": 1073741824,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 1073741824
},
"3": {
"MinMemory": 1073741824,
"MaxMemory": 1073741824,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 1073741824
},
"4": {
"MinMemory": 1073741824,
"MaxMemory": 1073741824,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 1073741824
},
"5": {
"MinMemory": 2048,
"MaxMemory": 2048,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 2048
},
"6": {
"MinMemory": 8388608,
"MaxMemory": 8388608,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 8388608
},
"7": {
"MinMemory": 1073741824,
"MaxMemory": 1073741824,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 1073741824
},
"8": {
"MinMemory": 1073741824,
"MaxMemory": 1073741824,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 1073741824
},
"9": {
"MinMemory": 1073741824,
"MaxMemory": 1073741824,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 1073741824
}
},
"seal/v0/commit/2": {
"0": {
"MinMemory": 2048,
"MaxMemory": 2048,
"GPUUtilization": 1,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 2048
},
"1": {
"MinMemory": 8388608,
"MaxMemory": 8388608,
"GPUUtilization": 1,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 8388608
},
"2": {
"MinMemory": 1073741824,
"MaxMemory": 1610612736,
"GPUUtilization": 1,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 10737418240
},
"3": {
"MinMemory": 32212254720,
"MaxMemory": 161061273600,
"GPUUtilization": 1,
"MaxParallelism": -1,
"MaxParallelismGPU": 6,
"BaseMinMemory": 34359738368
},
"4": {
"MinMemory": 64424509440,
"MaxMemory": 204010946560,
"GPUUtilization": 1,
"MaxParallelism": -1,
"MaxParallelismGPU": 6,
"BaseMinMemory": 68719476736
},
"5": {
"MinMemory": 2048,
"MaxMemory": 2048,
"GPUUtilization": 1,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 2048
},
"6": {
"MinMemory": 8388608,
"MaxMemory": 8388608,
"GPUUtilization": 1,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 8388608
},
"7": {
"MinMemory": 1073741824,
"MaxMemory": 1610612736,
"GPUUtilization": 1,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 10737418240
},
"8": {
"MinMemory": 32212254720,
"MaxMemory": 161061273600,
"GPUUtilization": 1,
"MaxParallelism": -1,
"MaxParallelismGPU": 6,
"BaseMinMemory": 34359738368
},
"9": {
"MinMemory": 64424509440,
"MaxMemory": 204010946560,
"GPUUtilization": 1,
"MaxParallelism": -1,
"MaxParallelismGPU": 6,
"BaseMinMemory": 68719476736
}
},
"seal/v0/fetch": {
"0": {
"MinMemory": 1048576,
"MaxMemory": 1048576,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 0
},
"1": {
"MinMemory": 1048576,
"MaxMemory": 1048576,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 0
},
"2": {
"MinMemory": 1048576,
"MaxMemory": 1048576,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 0
},
"3": {
"MinMemory": 1048576,
"MaxMemory": 1048576,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 0
},
"4": {
"MinMemory": 1048576,
"MaxMemory": 1048576,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 0
},
"5": {
"MinMemory": 1048576,
"MaxMemory": 1048576,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 0
},
"6": {
"MinMemory": 1048576,
"MaxMemory": 1048576,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 0
},
"7": {
"MinMemory": 1048576,
"MaxMemory": 1048576,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 0
},
"8": {
"MinMemory": 1048576,
"MaxMemory": 1048576,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 0
},
"9": {
"MinMemory": 1048576,
"MaxMemory": 1048576,
"GPUUtilization": 0,
"MaxParallelism": 0,
"MaxParallelismGPU": 0,
"BaseMinMemory": 0
}
},
"seal/v0/precommit/1": {
"0": {
"MinMemory": 2048,
"MaxMemory": 2048,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 2048
},
"1": {
"MinMemory": 8388608,
"MaxMemory": 8388608,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 8388608
},
"2": {
"MinMemory": 805306368,
"MaxMemory": 1073741824,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 1048576
},
"3": {
"MinMemory": 60129542144,
"MaxMemory": 68719476736,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 10485760
},
"4": {
"MinMemory": 120259084288,
"MaxMemory": 137438953472,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 10485760
},
"5": {
"MinMemory": 2048,
"MaxMemory": 2048,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 2048
},
"6": {
"MinMemory": 8388608,
"MaxMemory": 8388608,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 8388608
},
"7": {
"MinMemory": 805306368,
"MaxMemory": 1073741824,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 1048576
},
"8": {
"MinMemory": 60129542144,
"MaxMemory": 68719476736,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 10485760
},
"9": {
"MinMemory": 120259084288,
"MaxMemory": 137438953472,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 10485760
}
},
"seal/v0/precommit/2": {
"0": {
"MinMemory": 2048,
"MaxMemory": 2048,
"GPUUtilization": 0,
"MaxParallelism": -1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 2048
},
"1": {
"MinMemory": 8388608,
"MaxMemory": 8388608,
"GPUUtilization": 0,
"MaxParallelism": -1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 8388608
},
"2": {
"MinMemory": 1073741824,
"MaxMemory": 1610612736,
"GPUUtilization": 0,
"MaxParallelism": -1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 1073741824
},
"3": {
"MinMemory": 16106127360,
"MaxMemory": 16106127360,
"GPUUtilization": 1,
"MaxParallelism": -1,
"MaxParallelismGPU": 6,
"BaseMinMemory": 1073741824
},
"4": {
"MinMemory": 32212254720,
"MaxMemory": 32212254720,
"GPUUtilization": 1,
"MaxParallelism": -1,
"MaxParallelismGPU": 6,
"BaseMinMemory": 1073741824
},
"5": {
"MinMemory": 2048,
"MaxMemory": 2048,
"GPUUtilization": 0,
"MaxParallelism": -1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 2048
},
"6": {
"MinMemory": 8388608,
"MaxMemory": 8388608,
"GPUUtilization": 0,
"MaxParallelism": -1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 8388608
},
"7": {
"MinMemory": 1073741824,
"MaxMemory": 1610612736,
"GPUUtilization": 0,
"MaxParallelism": -1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 1073741824
},
"8": {
"MinMemory": 16106127360,
"MaxMemory": 16106127360,
"GPUUtilization": 1,
"MaxParallelism": -1,
"MaxParallelismGPU": 6,
"BaseMinMemory": 1073741824
},
"9": {
"MinMemory": 32212254720,
"MaxMemory": 32212254720,
"GPUUtilization": 1,
"MaxParallelism": -1,
"MaxParallelismGPU": 6,
"BaseMinMemory": 1073741824
}
},
"seal/v0/unseal": {
"0": {
"MinMemory": 2048,
"MaxMemory": 2048,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 2048
},
"1": {
"MinMemory": 8388608,
"MaxMemory": 8388608,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 8388608
},
"2": {
"MinMemory": 805306368,
"MaxMemory": 1073741824,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 1048576
},
"3": {
"MinMemory": 60129542144,
"MaxMemory": 68719476736,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 10485760
},
"4": {
"MinMemory": 120259084288,
"MaxMemory": 137438953472,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 10485760
},
"5": {
"MinMemory": 2048,
"MaxMemory": 2048,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 2048
},
"6": {
"MinMemory": 8388608,
"MaxMemory": 8388608,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 8388608
},
"7": {
"MinMemory": 805306368,
"MaxMemory": 1073741824,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 1048576
},
"8": {
"MinMemory": 60129542144,
"MaxMemory": 68719476736,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 10485760
},
"9": {
"MinMemory": 120259084288,
"MaxMemory": 137438953472,
"GPUUtilization": 0,
"MaxParallelism": 1,
"MaxParallelismGPU": 0,
"BaseMinMemory": 10485760
}
}
}
}
},
"Enabled": true,
"MemUsedMin": 0,
"MemUsedMax": 0,
"GpuUsed": 0,
"CpuUse": 0
}
}