Created
March 30, 2021 15:05
-
-
Save olizilla/fc6abf836023b6ee662955695f1cfd21 to your computer and use it in GitHub Desktop.
Lotus OpenRPC definitions from 1.7.0-dev https://github.com/filecoin-project/lotus/tree/f4a2c8fa49dfc456090f5a5ea1b4ae62d33b4f85/build/openrpc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"openrpc": "1.2.6", | |
"info": { | |
"title": "Lotus RPC API", | |
"version": "1.7.0-dev" | |
}, | |
"methods": [ | |
{ | |
"name": "Filecoin.BeaconGetEntry", | |
"description": "```go\nfunc (s *FullNodeStruct) BeaconGetEntry(p0 context.Context, p1 abi.ChainEpoch) (*types.BeaconEntry, error) {\n\treturn s.Internal.BeaconGetEntry(p0, p1)\n}\n```", | |
"summary": "BeaconGetEntry returns the beacon entry for the given filecoin epoch. If\nthe entry has not yet been produced, the call will block until the entry\nbecomes available\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "abi.ChainEpoch", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
10101 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*types.BeaconEntry", | |
"description": "*types.BeaconEntry", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Round": 42, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Round": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L888" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainDeleteObj", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainDeleteObj(p0 context.Context, p1 cid.Cid) error {\n\treturn s.Internal.ChainDeleteObj(p0, p1)\n}\n```", | |
"summary": "ChainDeleteObj deletes node referenced by the given CID\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L892" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainGetBlock", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainGetBlock(p0 context.Context, p1 cid.Cid) (*types.BlockHeader, error) {\n\treturn s.Internal.ChainGetBlock(p0, p1)\n}\n```", | |
"summary": "ChainGetBlock returns the block specified by the given CID.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*types.BlockHeader", | |
"description": "*types.BlockHeader", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Miner": "f01234", | |
"Ticket": { | |
"VRFProof": "Ynl0ZSBhcnJheQ==" | |
}, | |
"ElectionProof": { | |
"WinCount": 9, | |
"VRFProof": "Ynl0ZSBhcnJheQ==" | |
}, | |
"BeaconEntries": null, | |
"WinPoStProof": null, | |
"Parents": null, | |
"ParentWeight": "0", | |
"Height": 10101, | |
"ParentStateRoot": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"ParentMessageReceipts": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Messages": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"BLSAggregate": { | |
"Type": 2, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
}, | |
"Timestamp": 42, | |
"BlockSig": { | |
"Type": 2, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
}, | |
"ForkSignaling": 42, | |
"ParentBaseFee": "0" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"BLSAggregate": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"BeaconEntries": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Round": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"BlockSig": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"ElectionProof": { | |
"additionalProperties": false, | |
"properties": { | |
"VRFProof": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"WinCount": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"ForkSignaling": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Height": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Messages": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Miner": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ParentBaseFee": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ParentMessageReceipts": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"ParentStateRoot": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"ParentWeight": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Parents": { | |
"items": { | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"type": "array" | |
}, | |
"Ticket": { | |
"additionalProperties": false, | |
"properties": { | |
"VRFProof": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"Timestamp": { | |
"title": "number", | |
"type": "number" | |
}, | |
"WinPoStProof": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"PoStProof": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ProofBytes": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L900" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainGetBlockMessages", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainGetBlockMessages(p0 context.Context, p1 cid.Cid) (*api.BlockMessages, error) {\n\treturn s.Internal.ChainGetBlockMessages(p0, p1)\n}\n```", | |
"summary": "ChainGetBlockMessages returns messages stored in the specified block.\n\nNote: If there are multiple blocks in a tipset, it's likely that some\nmessages will be duplicated. It's also possible for blocks in a tipset to have\ndifferent messages from the same sender at the same nonce. When that happens,\nonly the first message (in a block with lowest ticket) will be considered\nfor execution\n\nNOTE: THIS METHOD SHOULD ONLY BE USED FOR GETTING MESSAGES IN A SPECIFIC BLOCK\n\nDO NOT USE THIS METHOD TO GET MESSAGES INCLUDED IN A TIPSET\nUse ChainGetParentMessages, which will perform correct message deduplication\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.BlockMessages", | |
"description": "*api.BlockMessages", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"BlsMessages": null, | |
"SecpkMessages": null, | |
"Cids": null | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"BlsMessages": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"Cids": { | |
"items": { | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"type": "array" | |
}, | |
"SecpkMessages": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Message": { | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L904" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainGetGenesis", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainGetGenesis(p0 context.Context) (*types.TipSet, error) {\n\treturn s.Internal.ChainGetGenesis(p0)\n}\n```", | |
"summary": "ChainGetGenesis returns the genesis tipset.\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "*types.TipSet", | |
"description": "*types.TipSet", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Cids": null, | |
"Blocks": null, | |
"Height": 0 | |
} | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L908" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainGetMessage", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainGetMessage(p0 context.Context, p1 cid.Cid) (*types.Message, error) {\n\treturn s.Internal.ChainGetMessage(p0, p1)\n}\n```", | |
"summary": "ChainGetMessage reads a message referenced by the specified CID from the\nchain blockstore.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*types.Message", | |
"description": "*types.Message", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Version": 42, | |
"To": "f01234", | |
"From": "f01234", | |
"Nonce": 42, | |
"Value": "0", | |
"GasLimit": 9, | |
"GasFeeCap": "0", | |
"GasPremium": "0", | |
"Method": 1, | |
"Params": "Ynl0ZSBhcnJheQ==", | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L912" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainGetNode", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainGetNode(p0 context.Context, p1 string) (*api.IpldObject, error) {\n\treturn s.Internal.ChainGetNode(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "string", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"string value" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.IpldObject", | |
"description": "*api.IpldObject", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Cid": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Obj": {} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Cid": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Obj": { | |
"additionalProperties": true, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L916" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainGetParentMessages", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainGetParentMessages(p0 context.Context, p1 cid.Cid) ([]api.Message, error) {\n\treturn s.Internal.ChainGetParentMessages(p0, p1)\n}\n```", | |
"summary": "ChainGetParentMessages returns messages stored in parent tipset of the\nspecified block.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]api.Message", | |
"description": "[]api.Message", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Cid": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Message": { | |
"additionalProperties": false, | |
"properties": { | |
"Cid": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Message": {} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L920" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainGetParentReceipts", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainGetParentReceipts(p0 context.Context, p1 cid.Cid) ([]*types.MessageReceipt, error) {\n\treturn s.Internal.ChainGetParentReceipts(p0, p1)\n}\n```", | |
"summary": "ChainGetParentReceipts returns receipts for messages in parent tipset of\nthe specified block. The receipts in the list returned is one-to-one with the\nmessages returned by a call to ChainGetParentMessages with the same blockCid.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]*types.MessageReceipt", | |
"description": "[]*types.MessageReceipt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"ExitCode": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasUsed": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Return": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L924" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainGetPath", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainGetPath(p0 context.Context, p1 types.TipSetKey, p2 types.TipSetKey) ([]*api.HeadChange, error) {\n\treturn s.Internal.ChainGetPath(p0, p1, p2)\n}\n```", | |
"summary": "ChainGetPath returns a set of revert/apply operations needed to get from\none tipset to another, for example:\n```\n to\n ^\nfrom tAA\n ^ ^\ntBA tAB\n ^---*--^\n ^\n tRR\n```\nWould return `[revert(tBA), apply(tAB), apply(tAA)]`\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]*api.HeadChange", | |
"description": "[]*api.HeadChange", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Type": { | |
"type": "string" | |
}, | |
"Val": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L928" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainGetRandomnessFromBeacon", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainGetRandomnessFromBeacon(p0 context.Context, p1 types.TipSetKey, p2 crypto.DomainSeparationTag, p3 abi.ChainEpoch, p4 []byte) (abi.Randomness, error) {\n\treturn s.Internal.ChainGetRandomnessFromBeacon(p0, p1, p2, p3, p4)\n}\n```", | |
"summary": "ChainGetRandomnessFromBeacon is used to sample the beacon for randomness.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "crypto.DomainSeparationTag", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
2 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "abi.ChainEpoch", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
10101 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "[]byte", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"Ynl0ZSBhcnJheQ==" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "abi.Randomness", | |
"description": "abi.Randomness", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "number", | |
"description": "Number is a number", | |
"type": [ | |
"number" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L932" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainGetRandomnessFromTickets", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainGetRandomnessFromTickets(p0 context.Context, p1 types.TipSetKey, p2 crypto.DomainSeparationTag, p3 abi.ChainEpoch, p4 []byte) (abi.Randomness, error) {\n\treturn s.Internal.ChainGetRandomnessFromTickets(p0, p1, p2, p3, p4)\n}\n```", | |
"summary": "ChainGetRandomnessFromTickets is used to sample the chain for randomness.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "crypto.DomainSeparationTag", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
2 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "abi.ChainEpoch", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
10101 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "[]byte", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"Ynl0ZSBhcnJheQ==" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "abi.Randomness", | |
"description": "abi.Randomness", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "number", | |
"description": "Number is a number", | |
"type": [ | |
"number" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L936" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainGetTipSet", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainGetTipSet(p0 context.Context, p1 types.TipSetKey) (*types.TipSet, error) {\n\treturn s.Internal.ChainGetTipSet(p0, p1)\n}\n```", | |
"summary": "ChainGetTipSet returns the tipset specified by the given TipSetKey.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*types.TipSet", | |
"description": "*types.TipSet", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Cids": null, | |
"Blocks": null, | |
"Height": 0 | |
} | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L940" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainGetTipSetByHeight", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainGetTipSetByHeight(p0 context.Context, p1 abi.ChainEpoch, p2 types.TipSetKey) (*types.TipSet, error) {\n\treturn s.Internal.ChainGetTipSetByHeight(p0, p1, p2)\n}\n```", | |
"summary": "ChainGetTipSetByHeight looks back for a tipset at the specified epoch.\nIf there are no blocks at the specified epoch, a tipset at an earlier epoch\nwill be returned.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "abi.ChainEpoch", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
10101 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*types.TipSet", | |
"description": "*types.TipSet", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Cids": null, | |
"Blocks": null, | |
"Height": 0 | |
} | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L944" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainHasObj", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainHasObj(p0 context.Context, p1 cid.Cid) (bool, error) {\n\treturn s.Internal.ChainHasObj(p0, p1)\n}\n```", | |
"summary": "ChainHasObj checks if a given CID exists in the chain blockstore.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "bool", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L948" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainHead", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainHead(p0 context.Context) (*types.TipSet, error) {\n\treturn s.Internal.ChainHead(p0)\n}\n```", | |
"summary": "ChainHead returns the current head of the chain.\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "*types.TipSet", | |
"description": "*types.TipSet", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Cids": null, | |
"Blocks": null, | |
"Height": 0 | |
} | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L952" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainReadObj", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainReadObj(p0 context.Context, p1 cid.Cid) ([]byte, error) {\n\treturn s.Internal.ChainReadObj(p0, p1)\n}\n```", | |
"summary": "ChainReadObj reads ipld nodes referenced by the specified CID from chain\nblockstore and returns raw bytes.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]byte", | |
"description": "[]byte", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"Ynl0ZSBhcnJheQ==" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L960" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainSetHead", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainSetHead(p0 context.Context, p1 types.TipSetKey) error {\n\treturn s.Internal.ChainSetHead(p0, p1)\n}\n```", | |
"summary": "ChainSetHead forcefully sets current chain head. Use with caution.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L964" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainStatObj", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainStatObj(p0 context.Context, p1 cid.Cid, p2 cid.Cid) (api.ObjStat, error) {\n\treturn s.Internal.ChainStatObj(p0, p1, p2)\n}\n```", | |
"summary": "ChainStatObj returns statistics about the graph referenced by 'obj'.\nIf 'base' is also specified, then the returned stat will be a diff\nbetween the two objects.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "api.ObjStat", | |
"description": "api.ObjStat", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Size": 42, | |
"Links": 42 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Links": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Size": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L968" | |
} | |
}, | |
{ | |
"name": "Filecoin.ChainTipSetWeight", | |
"description": "```go\nfunc (s *FullNodeStruct) ChainTipSetWeight(p0 context.Context, p1 types.TipSetKey) (types.BigInt, error) {\n\treturn s.Internal.ChainTipSetWeight(p0, p1)\n}\n```", | |
"summary": "ChainTipSetWeight computes weight for the specified tipset.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "types.BigInt", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L972" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientCalcCommP", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientCalcCommP(p0 context.Context, p1 string) (*api.CommPRet, error) {\n\treturn s.Internal.ClientCalcCommP(p0, p1)\n}\n```", | |
"summary": "ClientCalcCommP calculates the CommP for a specified file\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "string", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"string value" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.CommPRet", | |
"description": "*api.CommPRet", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Root": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Size": 1024 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Root": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Size": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L976" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientCancelDataTransfer", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientCancelDataTransfer(p0 context.Context, p1 datatransfer.TransferID, p2 peer.ID, p3 bool) error {\n\treturn s.Internal.ClientCancelDataTransfer(p0, p1, p2, p3)\n}\n```", | |
"summary": "ClientCancelDataTransfer cancels a data transfer with the given transfer ID and other peer\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "datatransfer.TransferID", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
3 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "peer.ID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L980" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientDealPieceCID", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientDealPieceCID(p0 context.Context, p1 cid.Cid) (api.DataCIDSize, error) {\n\treturn s.Internal.ClientDealPieceCID(p0, p1)\n}\n```", | |
"summary": "ClientCalcCommP calculates the CommP and data size of the specified CID\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "api.DataCIDSize", | |
"description": "api.DataCIDSize", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"PayloadSize": 9, | |
"PieceSize": 1032, | |
"PieceCID": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"PayloadSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"PieceSize": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L988" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientDealSize", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientDealSize(p0 context.Context, p1 cid.Cid) (api.DataSize, error) {\n\treturn s.Internal.ClientDealSize(p0, p1)\n}\n```", | |
"summary": "ClientDealSize calculates real deal data size\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "api.DataSize", | |
"description": "api.DataSize", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"PayloadSize": 9, | |
"PieceSize": 1032 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"PayloadSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"PieceSize": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L992" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientFindData", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientFindData(p0 context.Context, p1 cid.Cid, p2 *cid.Cid) ([]api.QueryOffer, error) {\n\treturn s.Internal.ClientFindData(p0, p1, p2)\n}\n```", | |
"summary": "ClientFindData identifies peers that have a certain file, and returns QueryOffers (one per peer).\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "*cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
null | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]api.QueryOffer", | |
"description": "[]api.QueryOffer", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Err": { | |
"type": "string" | |
}, | |
"MinPrice": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Miner": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"MinerPeer": { | |
"additionalProperties": false, | |
"properties": { | |
"Address": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ID": { | |
"type": "string" | |
}, | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"PaymentInterval": { | |
"title": "number", | |
"type": "number" | |
}, | |
"PaymentIntervalIncrease": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Piece": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Root": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Size": { | |
"title": "number", | |
"type": "number" | |
}, | |
"UnsealPrice": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L996" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientGenCar", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientGenCar(p0 context.Context, p1 api.FileRef, p2 string) error {\n\treturn s.Internal.ClientGenCar(p0, p1, p2)\n}\n```", | |
"summary": "ClientGenCar generates a CAR file for the specified file.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "api.FileRef", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Path": "string value", | |
"IsCAR": true | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"IsCAR": { | |
"type": "boolean" | |
}, | |
"Path": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "string", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"string value" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1000" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientGetDealInfo", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientGetDealInfo(p0 context.Context, p1 cid.Cid) (*api.DealInfo, error) {\n\treturn s.Internal.ClientGetDealInfo(p0, p1)\n}\n```", | |
"summary": "ClientGetDealInfo returns the latest information about a given deal.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.DealInfo", | |
"description": "*api.DealInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ProposalCid": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"State": 42, | |
"Message": "string value", | |
"Provider": "f01234", | |
"DataRef": { | |
"TransferType": "string value", | |
"Root": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"PieceCid": null, | |
"PieceSize": 1024, | |
"RawBlockSize": 42 | |
}, | |
"PieceCID": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Size": 42, | |
"PricePerEpoch": "0", | |
"Duration": 42, | |
"DealID": 5432, | |
"CreationTime": "0001-01-01T00:00:00Z", | |
"Verified": true, | |
"TransferChannelID": { | |
"Initiator": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf", | |
"Responder": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf", | |
"ID": 3 | |
}, | |
"DataTransfer": { | |
"TransferID": 3, | |
"Status": 1, | |
"BaseCID": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"IsInitiator": true, | |
"IsSender": true, | |
"Voucher": "string value", | |
"Message": "string value", | |
"OtherPeer": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf", | |
"Transferred": 42 | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"CreationTime": { | |
"format": "date-time", | |
"type": "string" | |
}, | |
"DataRef": { | |
"additionalProperties": false, | |
"properties": { | |
"PieceCid": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"PieceSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"RawBlockSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Root": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"TransferType": { | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"DataTransfer": { | |
"additionalProperties": false, | |
"properties": { | |
"BaseCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"IsInitiator": { | |
"type": "boolean" | |
}, | |
"IsSender": { | |
"type": "boolean" | |
}, | |
"Message": { | |
"type": "string" | |
}, | |
"OtherPeer": { | |
"type": "string" | |
}, | |
"Status": { | |
"title": "number", | |
"type": "number" | |
}, | |
"TransferID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Transferred": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Voucher": { | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"DealID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Duration": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Message": { | |
"type": "string" | |
}, | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"PricePerEpoch": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ProposalCid": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Provider": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Size": { | |
"title": "number", | |
"type": "number" | |
}, | |
"State": { | |
"title": "number", | |
"type": "number" | |
}, | |
"TransferChannelID": { | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Initiator": { | |
"type": "string" | |
}, | |
"Responder": { | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"Verified": { | |
"type": "boolean" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1004" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientGetDealStatus", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientGetDealStatus(p0 context.Context, p1 uint64) (string, error) {\n\treturn s.Internal.ClientGetDealStatus(p0, p1)\n}\n```", | |
"summary": "ClientGetDealStatus returns status given a code\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "string", | |
"description": "string", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"string value" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1008" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientHasLocal", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientHasLocal(p0 context.Context, p1 cid.Cid) (bool, error) {\n\treturn s.Internal.ClientHasLocal(p0, p1)\n}\n```", | |
"summary": "ClientHasLocal indicates whether a certain CID is locally stored.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "bool", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1016" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientImport", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientImport(p0 context.Context, p1 api.FileRef) (*api.ImportRes, error) {\n\treturn s.Internal.ClientImport(p0, p1)\n}\n```", | |
"summary": "ClientImport imports file under the specified path into filestore.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "api.FileRef", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Path": "string value", | |
"IsCAR": true | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"IsCAR": { | |
"type": "boolean" | |
}, | |
"Path": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.ImportRes", | |
"description": "*api.ImportRes", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Root": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"ImportID": 50 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ImportID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Root": { | |
"title": "Content Identifier", | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1020" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientListDataTransfers", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientListDataTransfers(p0 context.Context) ([]api.DataTransferChannel, error) {\n\treturn s.Internal.ClientListDataTransfers(p0)\n}\n```", | |
"summary": "ClientListTransfers returns the status of all ongoing transfers of data\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "[]api.DataTransferChannel", | |
"description": "[]api.DataTransferChannel", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"BaseCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"IsInitiator": { | |
"type": "boolean" | |
}, | |
"IsSender": { | |
"type": "boolean" | |
}, | |
"Message": { | |
"type": "string" | |
}, | |
"OtherPeer": { | |
"type": "string" | |
}, | |
"Status": { | |
"title": "number", | |
"type": "number" | |
}, | |
"TransferID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Transferred": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Voucher": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1024" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientListDeals", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientListDeals(p0 context.Context) ([]api.DealInfo, error) {\n\treturn s.Internal.ClientListDeals(p0)\n}\n```", | |
"summary": "ClientListDeals returns information about the deals made by the local client.\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "[]api.DealInfo", | |
"description": "[]api.DealInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"CreationTime": { | |
"format": "date-time", | |
"type": "string" | |
}, | |
"DataRef": { | |
"additionalProperties": false, | |
"properties": { | |
"PieceCid": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"PieceSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"RawBlockSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Root": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"TransferType": { | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"DataTransfer": { | |
"additionalProperties": false, | |
"properties": { | |
"BaseCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"IsInitiator": { | |
"type": "boolean" | |
}, | |
"IsSender": { | |
"type": "boolean" | |
}, | |
"Message": { | |
"type": "string" | |
}, | |
"OtherPeer": { | |
"type": "string" | |
}, | |
"Status": { | |
"title": "number", | |
"type": "number" | |
}, | |
"TransferID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Transferred": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Voucher": { | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"DealID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Duration": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Message": { | |
"type": "string" | |
}, | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"PricePerEpoch": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ProposalCid": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Provider": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Size": { | |
"title": "number", | |
"type": "number" | |
}, | |
"State": { | |
"title": "number", | |
"type": "number" | |
}, | |
"TransferChannelID": { | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Initiator": { | |
"type": "string" | |
}, | |
"Responder": { | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"Verified": { | |
"type": "boolean" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1028" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientListImports", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientListImports(p0 context.Context) ([]api.Import, error) {\n\treturn s.Internal.ClientListImports(p0)\n}\n```", | |
"summary": "ClientListImports lists imported files and their root CIDs\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "[]api.Import", | |
"description": "[]api.Import", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Err": { | |
"type": "string" | |
}, | |
"FilePath": { | |
"type": "string" | |
}, | |
"Key": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Root": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Source": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1032" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientMinerQueryOffer", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientMinerQueryOffer(p0 context.Context, p1 address.Address, p2 cid.Cid, p3 *cid.Cid) (api.QueryOffer, error) {\n\treturn s.Internal.ClientMinerQueryOffer(p0, p1, p2, p3)\n}\n```", | |
"summary": "ClientMinerQueryOffer returns a QueryOffer for the specific miner and file.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "*cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
null | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "api.QueryOffer", | |
"description": "api.QueryOffer", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Err": "string value", | |
"Root": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Piece": null, | |
"Size": 42, | |
"MinPrice": "0", | |
"UnsealPrice": "0", | |
"PaymentInterval": 42, | |
"PaymentIntervalIncrease": 42, | |
"Miner": "f01234", | |
"MinerPeer": { | |
"Address": "f01234", | |
"ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf", | |
"PieceCID": null | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Err": { | |
"type": "string" | |
}, | |
"MinPrice": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Miner": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"MinerPeer": { | |
"additionalProperties": false, | |
"properties": { | |
"Address": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ID": { | |
"type": "string" | |
}, | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"PaymentInterval": { | |
"title": "number", | |
"type": "number" | |
}, | |
"PaymentIntervalIncrease": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Piece": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Root": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Size": { | |
"title": "number", | |
"type": "number" | |
}, | |
"UnsealPrice": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1036" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientQueryAsk", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientQueryAsk(p0 context.Context, p1 peer.ID, p2 address.Address) (*storagemarket.StorageAsk, error) {\n\treturn s.Internal.ClientQueryAsk(p0, p1, p2)\n}\n```", | |
"summary": "ClientQueryAsk returns a signed StorageAsk from the specified miner.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "peer.ID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*storagemarket.StorageAsk", | |
"description": "*storagemarket.StorageAsk", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Price": "0", | |
"VerifiedPrice": "0", | |
"MinPieceSize": 1032, | |
"MaxPieceSize": 1032, | |
"Miner": "f01234", | |
"Timestamp": 10101, | |
"Expiry": 10101, | |
"SeqNo": 42 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Expiry": { | |
"title": "number", | |
"type": "number" | |
}, | |
"MaxPieceSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"MinPieceSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Miner": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Price": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"SeqNo": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Timestamp": { | |
"title": "number", | |
"type": "number" | |
}, | |
"VerifiedPrice": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1040" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientRemoveImport", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientRemoveImport(p0 context.Context, p1 multistore.StoreID) error {\n\treturn s.Internal.ClientRemoveImport(p0, p1)\n}\n```", | |
"summary": "ClientRemoveImport removes file import\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "multistore.StoreID", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
50 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1044" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientRestartDataTransfer", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientRestartDataTransfer(p0 context.Context, p1 datatransfer.TransferID, p2 peer.ID, p3 bool) error {\n\treturn s.Internal.ClientRestartDataTransfer(p0, p1, p2, p3)\n}\n```", | |
"summary": "ClientRestartDataTransfer attempts to restart a data transfer with the given transfer ID and other peer\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "datatransfer.TransferID", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
3 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "peer.ID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1048" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientRetrieve", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientRetrieve(p0 context.Context, p1 api.RetrievalOrder, p2 *api.FileRef) error {\n\treturn s.Internal.ClientRetrieve(p0, p1, p2)\n}\n```", | |
"summary": "ClientRetrieve initiates the retrieval of a file, as specified in the order.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "api.RetrievalOrder", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Root": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Piece": null, | |
"Size": 42, | |
"Total": "0", | |
"UnsealPrice": "0", | |
"PaymentInterval": 42, | |
"PaymentIntervalIncrease": 42, | |
"Client": "f01234", | |
"Miner": "f01234", | |
"MinerPeer": { | |
"Address": "f01234", | |
"ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf", | |
"PieceCID": null | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Client": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Miner": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"MinerPeer": { | |
"additionalProperties": false, | |
"properties": { | |
"Address": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ID": { | |
"type": "string" | |
}, | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"PaymentInterval": { | |
"title": "number", | |
"type": "number" | |
}, | |
"PaymentIntervalIncrease": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Piece": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Root": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Size": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Total": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"UnsealPrice": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "*api.FileRef", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Path": "string value", | |
"IsCAR": true | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"IsCAR": { | |
"type": "boolean" | |
}, | |
"Path": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1052" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientRetrieveTryRestartInsufficientFunds", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientRetrieveTryRestartInsufficientFunds(p0 context.Context, p1 address.Address) error {\n\treturn s.Internal.ClientRetrieveTryRestartInsufficientFunds(p0, p1)\n}\n```", | |
"summary": "ClientRetrieveTryRestartInsufficientFunds attempts to restart stalled retrievals on a given payment channel\nwhich are stuck due to insufficient funds\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1056" | |
} | |
}, | |
{ | |
"name": "Filecoin.ClientStartDeal", | |
"description": "```go\nfunc (s *FullNodeStruct) ClientStartDeal(p0 context.Context, p1 *api.StartDealParams) (*cid.Cid, error) {\n\treturn s.Internal.ClientStartDeal(p0, p1)\n}\n```", | |
"summary": "ClientStartDeal proposes a deal with a miner.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "*api.StartDealParams", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Data": { | |
"TransferType": "string value", | |
"Root": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"PieceCid": null, | |
"PieceSize": 1024, | |
"RawBlockSize": 42 | |
}, | |
"Wallet": "f01234", | |
"Miner": "f01234", | |
"EpochPrice": "0", | |
"MinBlocksDuration": 42, | |
"ProviderCollateral": "0", | |
"DealStartEpoch": 10101, | |
"FastRetrieval": true, | |
"VerifiedDeal": true | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"additionalProperties": false, | |
"properties": { | |
"PieceCid": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"PieceSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"RawBlockSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Root": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"TransferType": { | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"DealStartEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"EpochPrice": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"FastRetrieval": { | |
"type": "boolean" | |
}, | |
"MinBlocksDuration": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Miner": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ProviderCollateral": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"VerifiedDeal": { | |
"type": "boolean" | |
}, | |
"Wallet": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*cid.Cid", | |
"description": "*cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
null | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1064" | |
} | |
}, | |
{ | |
"name": "Filecoin.CreateBackup", | |
"description": "```go\nfunc (s *FullNodeStruct) CreateBackup(p0 context.Context, p1 string) error {\n\treturn s.Internal.CreateBackup(p0, p1)\n}\n```", | |
"summary": "CreateBackup creates node backup onder the specified file name. The\nmethod requires that the lotus daemon is running with the\nLOTUS_BACKUP_BASE_PATH environment variable set to some path, and that\nthe path specified when calling CreateBackup is within the base path\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "string", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"string value" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1068" | |
} | |
}, | |
{ | |
"name": "Filecoin.GasEstimateFeeCap", | |
"description": "```go\nfunc (s *FullNodeStruct) GasEstimateFeeCap(p0 context.Context, p1 *types.Message, p2 int64, p3 types.TipSetKey) (types.BigInt, error) {\n\treturn s.Internal.GasEstimateFeeCap(p0, p1, p2, p3)\n}\n```", | |
"summary": "GasEstimateFeeCap estimates gas fee cap\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "*types.Message", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Version": 42, | |
"To": "f01234", | |
"From": "f01234", | |
"Nonce": 42, | |
"Value": "0", | |
"GasLimit": 9, | |
"GasFeeCap": "0", | |
"GasPremium": "0", | |
"Method": 1, | |
"Params": "Ynl0ZSBhcnJheQ==", | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "int64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
9 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "types.BigInt", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1072" | |
} | |
}, | |
{ | |
"name": "Filecoin.GasEstimateGasLimit", | |
"description": "```go\nfunc (s *FullNodeStruct) GasEstimateGasLimit(p0 context.Context, p1 *types.Message, p2 types.TipSetKey) (int64, error) {\n\treturn s.Internal.GasEstimateGasLimit(p0, p1, p2)\n}\n```", | |
"summary": "GasEstimateGasLimit estimates gas used by the message and returns it.\nIt fails if message fails to execute.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "*types.Message", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Version": 42, | |
"To": "f01234", | |
"From": "f01234", | |
"Nonce": 42, | |
"Value": "0", | |
"GasLimit": 9, | |
"GasFeeCap": "0", | |
"GasPremium": "0", | |
"Method": 1, | |
"Params": "Ynl0ZSBhcnJheQ==", | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "int64", | |
"description": "int64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
9 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1076" | |
} | |
}, | |
{ | |
"name": "Filecoin.GasEstimateGasPremium", | |
"description": "```go\nfunc (s *FullNodeStruct) GasEstimateGasPremium(p0 context.Context, p1 uint64, p2 address.Address, p3 int64, p4 types.TipSetKey) (types.BigInt, error) {\n\treturn s.Internal.GasEstimateGasPremium(p0, p1, p2, p3, p4)\n}\n```", | |
"summary": "GasEstimateGasPremium estimates what gas price should be used for a\nmessage to have high likelihood of inclusion in `nblocksincl` epochs.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "int64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
9 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "types.BigInt", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1080" | |
} | |
}, | |
{ | |
"name": "Filecoin.GasEstimateMessageGas", | |
"description": "```go\nfunc (s *FullNodeStruct) GasEstimateMessageGas(p0 context.Context, p1 *types.Message, p2 *api.MessageSendSpec, p3 types.TipSetKey) (*types.Message, error) {\n\treturn s.Internal.GasEstimateMessageGas(p0, p1, p2, p3)\n}\n```", | |
"summary": "GasEstimateMessageGas estimates gas values for unset message gas fields\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "*types.Message", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Version": 42, | |
"To": "f01234", | |
"From": "f01234", | |
"Nonce": 42, | |
"Value": "0", | |
"GasLimit": 9, | |
"GasFeeCap": "0", | |
"GasPremium": "0", | |
"Method": 1, | |
"Params": "Ynl0ZSBhcnJheQ==", | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "*api.MessageSendSpec", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"MaxFee": "0" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"MaxFee": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*types.Message", | |
"description": "*types.Message", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Version": 42, | |
"To": "f01234", | |
"From": "f01234", | |
"Nonce": 42, | |
"Value": "0", | |
"GasLimit": 9, | |
"GasFeeCap": "0", | |
"GasPremium": "0", | |
"Method": 1, | |
"Params": "Ynl0ZSBhcnJheQ==", | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1084" | |
} | |
}, | |
{ | |
"name": "Filecoin.MarketAddBalance", | |
"description": "```go\nfunc (s *FullNodeStruct) MarketAddBalance(p0 context.Context, p1 address.Address, p2 address.Address, p3 types.BigInt) (cid.Cid, error) {\n\treturn s.Internal.MarketAddBalance(p0, p1, p2, p3)\n}\n```", | |
"summary": "MarketAddBalance adds funds to the market actor\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1088" | |
} | |
}, | |
{ | |
"name": "Filecoin.MarketGetReserved", | |
"description": "```go\nfunc (s *FullNodeStruct) MarketGetReserved(p0 context.Context, p1 address.Address) (types.BigInt, error) {\n\treturn s.Internal.MarketGetReserved(p0, p1)\n}\n```", | |
"summary": "MarketGetReserved gets the amount of funds that are currently reserved for the address\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "types.BigInt", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1092" | |
} | |
}, | |
{ | |
"name": "Filecoin.MarketReleaseFunds", | |
"description": "```go\nfunc (s *FullNodeStruct) MarketReleaseFunds(p0 context.Context, p1 address.Address, p2 types.BigInt) error {\n\treturn s.Internal.MarketReleaseFunds(p0, p1, p2)\n}\n```", | |
"summary": "MarketReleaseFunds releases funds reserved by MarketReserveFunds\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1096" | |
} | |
}, | |
{ | |
"name": "Filecoin.MarketReserveFunds", | |
"description": "```go\nfunc (s *FullNodeStruct) MarketReserveFunds(p0 context.Context, p1 address.Address, p2 address.Address, p3 types.BigInt) (cid.Cid, error) {\n\treturn s.Internal.MarketReserveFunds(p0, p1, p2, p3)\n}\n```", | |
"summary": "MarketReserveFunds reserves funds for a deal\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1100" | |
} | |
}, | |
{ | |
"name": "Filecoin.MarketWithdraw", | |
"description": "```go\nfunc (s *FullNodeStruct) MarketWithdraw(p0 context.Context, p1 address.Address, p2 address.Address, p3 types.BigInt) (cid.Cid, error) {\n\treturn s.Internal.MarketWithdraw(p0, p1, p2, p3)\n}\n```", | |
"summary": "MarketWithdraw withdraws unlocked funds from the market actor\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1104" | |
} | |
}, | |
{ | |
"name": "Filecoin.MinerCreateBlock", | |
"description": "```go\nfunc (s *FullNodeStruct) MinerCreateBlock(p0 context.Context, p1 *api.BlockTemplate) (*types.BlockMsg, error) {\n\treturn s.Internal.MinerCreateBlock(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "*api.BlockTemplate", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Miner": "f01234", | |
"Parents": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
], | |
"Ticket": { | |
"VRFProof": "Ynl0ZSBhcnJheQ==" | |
}, | |
"Eproof": { | |
"WinCount": 9, | |
"VRFProof": "Ynl0ZSBhcnJheQ==" | |
}, | |
"BeaconValues": null, | |
"Messages": null, | |
"Epoch": 10101, | |
"Timestamp": 42, | |
"WinningPoStProof": null | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"BeaconValues": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Round": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"Epoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Eproof": { | |
"additionalProperties": false, | |
"properties": { | |
"VRFProof": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"WinCount": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Messages": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Message": { | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"Miner": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Parents": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Ticket": { | |
"additionalProperties": false, | |
"properties": { | |
"VRFProof": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"Timestamp": { | |
"title": "number", | |
"type": "number" | |
}, | |
"WinningPoStProof": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"PoStProof": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ProofBytes": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*types.BlockMsg", | |
"description": "*types.BlockMsg", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Header": { | |
"Miner": "f01234", | |
"Ticket": { | |
"VRFProof": "Ynl0ZSBhcnJheQ==" | |
}, | |
"ElectionProof": { | |
"WinCount": 9, | |
"VRFProof": "Ynl0ZSBhcnJheQ==" | |
}, | |
"BeaconEntries": null, | |
"WinPoStProof": null, | |
"Parents": null, | |
"ParentWeight": "0", | |
"Height": 10101, | |
"ParentStateRoot": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"ParentMessageReceipts": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Messages": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"BLSAggregate": { | |
"Type": 2, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
}, | |
"Timestamp": 42, | |
"BlockSig": { | |
"Type": 2, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
}, | |
"ForkSignaling": 42, | |
"ParentBaseFee": "0" | |
}, | |
"BlsMessages": null, | |
"SecpkMessages": null | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"BlsMessages": { | |
"items": { | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"type": "array" | |
}, | |
"Header": { | |
"additionalProperties": false, | |
"properties": { | |
"BLSAggregate": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"BeaconEntries": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Round": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"BlockSig": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"ElectionProof": { | |
"additionalProperties": false, | |
"properties": { | |
"VRFProof": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"WinCount": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"ForkSignaling": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Height": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Messages": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Miner": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ParentBaseFee": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ParentMessageReceipts": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"ParentStateRoot": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"ParentWeight": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Parents": { | |
"items": { | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"type": "array" | |
}, | |
"Ticket": { | |
"additionalProperties": false, | |
"properties": { | |
"VRFProof": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"Timestamp": { | |
"title": "number", | |
"type": "number" | |
}, | |
"WinPoStProof": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"PoStProof": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ProofBytes": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
} | |
}, | |
"type": "object" | |
}, | |
"SecpkMessages": { | |
"items": { | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"type": "array" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1108" | |
} | |
}, | |
{ | |
"name": "Filecoin.MinerGetBaseInfo", | |
"description": "```go\nfunc (s *FullNodeStruct) MinerGetBaseInfo(p0 context.Context, p1 address.Address, p2 abi.ChainEpoch, p3 types.TipSetKey) (*api.MiningBaseInfo, error) {\n\treturn s.Internal.MinerGetBaseInfo(p0, p1, p2, p3)\n}\n```", | |
"summary": "There are not yet any comments for this method.", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "abi.ChainEpoch", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
10101 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.MiningBaseInfo", | |
"description": "*api.MiningBaseInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"MinerPower": "0", | |
"NetworkPower": "0", | |
"Sectors": null, | |
"WorkerKey": "f01234", | |
"SectorSize": 34359738368, | |
"PrevBeaconEntry": { | |
"Round": 42, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
}, | |
"BeaconEntries": null, | |
"EligibleForMining": true | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"BeaconEntries": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Round": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"EligibleForMining": { | |
"type": "boolean" | |
}, | |
"MinerPower": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"NetworkPower": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"PrevBeaconEntry": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Round": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"SectorSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Sectors": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"SealProof": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SealedCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"SectorNumber": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"WorkerKey": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1112" | |
} | |
}, | |
{ | |
"name": "Filecoin.MpoolBatchPush", | |
"description": "```go\nfunc (s *FullNodeStruct) MpoolBatchPush(p0 context.Context, p1 []*types.SignedMessage) ([]cid.Cid, error) {\n\treturn s.Internal.MpoolBatchPush(p0, p1)\n}\n```", | |
"summary": "MpoolBatchPush batch pushes a signed message to mempool.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "[]*types.SignedMessage", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Message": { | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]cid.Cid", | |
"description": "[]cid.Cid", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"type": [ | |
"string" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1116" | |
} | |
}, | |
{ | |
"name": "Filecoin.MpoolBatchPushMessage", | |
"description": "```go\nfunc (s *FullNodeStruct) MpoolBatchPushMessage(p0 context.Context, p1 []*types.Message, p2 *api.MessageSendSpec) ([]*types.SignedMessage, error) {\n\treturn s.Internal.MpoolBatchPushMessage(p0, p1, p2)\n}\n```", | |
"summary": "MpoolBatchPushMessage batch pushes a unsigned message to mempool.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "[]*types.Message", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "*api.MessageSendSpec", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"MaxFee": "0" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"MaxFee": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]*types.SignedMessage", | |
"description": "[]*types.SignedMessage", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Message": { | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1120" | |
} | |
}, | |
{ | |
"name": "Filecoin.MpoolBatchPushUntrusted", | |
"description": "```go\nfunc (s *FullNodeStruct) MpoolBatchPushUntrusted(p0 context.Context, p1 []*types.SignedMessage) ([]cid.Cid, error) {\n\treturn s.Internal.MpoolBatchPushUntrusted(p0, p1)\n}\n```", | |
"summary": "MpoolBatchPushUntrusted batch pushes a signed message to mempool from untrusted sources.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "[]*types.SignedMessage", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Message": { | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]cid.Cid", | |
"description": "[]cid.Cid", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"type": [ | |
"string" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1124" | |
} | |
}, | |
{ | |
"name": "Filecoin.MpoolClear", | |
"description": "```go\nfunc (s *FullNodeStruct) MpoolClear(p0 context.Context, p1 bool) error {\n\treturn s.Internal.MpoolClear(p0, p1)\n}\n```", | |
"summary": "MpoolClear clears pending messages from the mpool\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1128" | |
} | |
}, | |
{ | |
"name": "Filecoin.MpoolGetConfig", | |
"description": "```go\nfunc (s *FullNodeStruct) MpoolGetConfig(p0 context.Context) (*types.MpoolConfig, error) {\n\treturn s.Internal.MpoolGetConfig(p0)\n}\n```", | |
"summary": "MpoolGetConfig returns (a copy of) the current mpool config\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "*types.MpoolConfig", | |
"description": "*types.MpoolConfig", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"PriorityAddrs": null, | |
"SizeLimitHigh": 123, | |
"SizeLimitLow": 123, | |
"ReplaceByFeeRatio": 12.3, | |
"PruneCooldown": 60000000000, | |
"GasLimitOverestimation": 12.3 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"GasLimitOverestimation": { | |
"type": "number" | |
}, | |
"PriorityAddrs": { | |
"items": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"PruneCooldown": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ReplaceByFeeRatio": { | |
"type": "number" | |
}, | |
"SizeLimitHigh": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SizeLimitLow": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1132" | |
} | |
}, | |
{ | |
"name": "Filecoin.MpoolGetNonce", | |
"description": "```go\nfunc (s *FullNodeStruct) MpoolGetNonce(p0 context.Context, p1 address.Address) (uint64, error) {\n\treturn s.Internal.MpoolGetNonce(p0, p1)\n}\n```", | |
"summary": "MpoolGetNonce gets next nonce for the specified sender.\nNote that this method may not be atomic. Use MpoolPushMessage instead.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "uint64", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1136" | |
} | |
}, | |
{ | |
"name": "Filecoin.MpoolPending", | |
"description": "```go\nfunc (s *FullNodeStruct) MpoolPending(p0 context.Context, p1 types.TipSetKey) ([]*types.SignedMessage, error) {\n\treturn s.Internal.MpoolPending(p0, p1)\n}\n```", | |
"summary": "MpoolPending returns pending mempool messages.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]*types.SignedMessage", | |
"description": "[]*types.SignedMessage", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Message": { | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1140" | |
} | |
}, | |
{ | |
"name": "Filecoin.MpoolPush", | |
"description": "```go\nfunc (s *FullNodeStruct) MpoolPush(p0 context.Context, p1 *types.SignedMessage) (cid.Cid, error) {\n\treturn s.Internal.MpoolPush(p0, p1)\n}\n```", | |
"summary": "MpoolPush pushes a signed message to mempool.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "*types.SignedMessage", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Message": { | |
"Version": 42, | |
"To": "f01234", | |
"From": "f01234", | |
"Nonce": 42, | |
"Value": "0", | |
"GasLimit": 9, | |
"GasFeeCap": "0", | |
"GasPremium": "0", | |
"Method": 1, | |
"Params": "Ynl0ZSBhcnJheQ==", | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
}, | |
"Signature": { | |
"Type": 2, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
}, | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Message": { | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1144" | |
} | |
}, | |
{ | |
"name": "Filecoin.MpoolPushMessage", | |
"description": "```go\nfunc (s *FullNodeStruct) MpoolPushMessage(p0 context.Context, p1 *types.Message, p2 *api.MessageSendSpec) (*types.SignedMessage, error) {\n\treturn s.Internal.MpoolPushMessage(p0, p1, p2)\n}\n```", | |
"summary": "MpoolPushMessage atomically assigns a nonce, signs, and pushes a message\nto mempool.\nmaxFee is only used when GasFeeCap/GasPremium fields aren't specified\n\nWhen maxFee is set to 0, MpoolPushMessage will guess appropriate fee\nbased on current chain conditions\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "*types.Message", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Version": 42, | |
"To": "f01234", | |
"From": "f01234", | |
"Nonce": 42, | |
"Value": "0", | |
"GasLimit": 9, | |
"GasFeeCap": "0", | |
"GasPremium": "0", | |
"Method": 1, | |
"Params": "Ynl0ZSBhcnJheQ==", | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "*api.MessageSendSpec", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"MaxFee": "0" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"MaxFee": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*types.SignedMessage", | |
"description": "*types.SignedMessage", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Message": { | |
"Version": 42, | |
"To": "f01234", | |
"From": "f01234", | |
"Nonce": 42, | |
"Value": "0", | |
"GasLimit": 9, | |
"GasFeeCap": "0", | |
"GasPremium": "0", | |
"Method": 1, | |
"Params": "Ynl0ZSBhcnJheQ==", | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
}, | |
"Signature": { | |
"Type": 2, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
}, | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Message": { | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1148" | |
} | |
}, | |
{ | |
"name": "Filecoin.MpoolPushUntrusted", | |
"description": "```go\nfunc (s *FullNodeStruct) MpoolPushUntrusted(p0 context.Context, p1 *types.SignedMessage) (cid.Cid, error) {\n\treturn s.Internal.MpoolPushUntrusted(p0, p1)\n}\n```", | |
"summary": "MpoolPushUntrusted pushes a signed message to mempool from untrusted sources.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "*types.SignedMessage", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Message": { | |
"Version": 42, | |
"To": "f01234", | |
"From": "f01234", | |
"Nonce": 42, | |
"Value": "0", | |
"GasLimit": 9, | |
"GasFeeCap": "0", | |
"GasPremium": "0", | |
"Method": 1, | |
"Params": "Ynl0ZSBhcnJheQ==", | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
}, | |
"Signature": { | |
"Type": 2, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
}, | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Message": { | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1152" | |
} | |
}, | |
{ | |
"name": "Filecoin.MpoolSelect", | |
"description": "```go\nfunc (s *FullNodeStruct) MpoolSelect(p0 context.Context, p1 types.TipSetKey, p2 float64) ([]*types.SignedMessage, error) {\n\treturn s.Internal.MpoolSelect(p0, p1, p2)\n}\n```", | |
"summary": "MpoolSelect returns a list of pending messages for inclusion in the next block\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "float64", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
12.3 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]*types.SignedMessage", | |
"description": "[]*types.SignedMessage", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Message": { | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1156" | |
} | |
}, | |
{ | |
"name": "Filecoin.MpoolSetConfig", | |
"description": "```go\nfunc (s *FullNodeStruct) MpoolSetConfig(p0 context.Context, p1 *types.MpoolConfig) error {\n\treturn s.Internal.MpoolSetConfig(p0, p1)\n}\n```", | |
"summary": "MpoolSetConfig sets the mpool config to (a copy of) the supplied config\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "*types.MpoolConfig", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"PriorityAddrs": null, | |
"SizeLimitHigh": 123, | |
"SizeLimitLow": 123, | |
"ReplaceByFeeRatio": 12.3, | |
"PruneCooldown": 60000000000, | |
"GasLimitOverestimation": 12.3 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"GasLimitOverestimation": { | |
"type": "number" | |
}, | |
"PriorityAddrs": { | |
"items": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"PruneCooldown": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ReplaceByFeeRatio": { | |
"type": "number" | |
}, | |
"SizeLimitHigh": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SizeLimitLow": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1160" | |
} | |
}, | |
{ | |
"name": "Filecoin.MsigAddApprove", | |
"description": "```go\nfunc (s *FullNodeStruct) MsigAddApprove(p0 context.Context, p1 address.Address, p2 address.Address, p3 uint64, p4 address.Address, p5 address.Address, p6 bool) (cid.Cid, error) {\n\treturn s.Internal.MsigAddApprove(p0, p1, p2, p3, p4, p5, p6)\n}\n```", | |
"summary": "MsigAddApprove approves a previously proposed AddSigner message\nIt takes the following params: <multisig address>, <sender address of the approve msg>, <proposed message ID>,\n<proposer address>, <new signer>, <whether the number of required signers should be increased>\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p5", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p6", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1168" | |
} | |
}, | |
{ | |
"name": "Filecoin.MsigAddCancel", | |
"description": "```go\nfunc (s *FullNodeStruct) MsigAddCancel(p0 context.Context, p1 address.Address, p2 address.Address, p3 uint64, p4 address.Address, p5 bool) (cid.Cid, error) {\n\treturn s.Internal.MsigAddCancel(p0, p1, p2, p3, p4, p5)\n}\n```", | |
"summary": "MsigAddCancel cancels a previously proposed AddSigner message\nIt takes the following params: <multisig address>, <sender address of the cancel msg>, <proposed message ID>,\n<new signer>, <whether the number of required signers should be increased>\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p5", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1172" | |
} | |
}, | |
{ | |
"name": "Filecoin.MsigAddPropose", | |
"description": "```go\nfunc (s *FullNodeStruct) MsigAddPropose(p0 context.Context, p1 address.Address, p2 address.Address, p3 address.Address, p4 bool) (cid.Cid, error) {\n\treturn s.Internal.MsigAddPropose(p0, p1, p2, p3, p4)\n}\n```", | |
"summary": "MsigAddPropose proposes adding a signer in the multisig\nIt takes the following params: <multisig address>, <sender address of the propose msg>,\n<new signer>, <whether the number of required signers should be increased>\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1176" | |
} | |
}, | |
{ | |
"name": "Filecoin.MsigApprove", | |
"description": "```go\nfunc (s *FullNodeStruct) MsigApprove(p0 context.Context, p1 address.Address, p2 uint64, p3 address.Address) (cid.Cid, error) {\n\treturn s.Internal.MsigApprove(p0, p1, p2, p3)\n}\n```", | |
"summary": "MsigApprove approves a previously-proposed multisig message by transaction ID\nIt takes the following params: <multisig address>, <proposed transaction ID> <signer address>\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1180" | |
} | |
}, | |
{ | |
"name": "Filecoin.MsigApproveTxnHash", | |
"description": "```go\nfunc (s *FullNodeStruct) MsigApproveTxnHash(p0 context.Context, p1 address.Address, p2 uint64, p3 address.Address, p4 address.Address, p5 types.BigInt, p6 address.Address, p7 uint64, p8 []byte) (cid.Cid, error) {\n\treturn s.Internal.MsigApproveTxnHash(p0, p1, p2, p3, p4, p5, p6, p7, p8)\n}\n```", | |
"summary": "MsigApproveTxnHash approves a previously-proposed multisig message, specified\nusing both transaction ID and a hash of the parameters used in the\nproposal. This method of approval can be used to ensure you only approve\nexactly the transaction you think you are.\nIt takes the following params: <multisig address>, <proposed message ID>, <proposer address>, <recipient address>, <value to transfer>,\n<sender address of the approve msg>, <method to call in the proposed message>, <params to include in the proposed message>\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p5", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p6", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p7", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p8", | |
"description": "[]byte", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"Ynl0ZSBhcnJheQ==" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1184" | |
} | |
}, | |
{ | |
"name": "Filecoin.MsigCancel", | |
"description": "```go\nfunc (s *FullNodeStruct) MsigCancel(p0 context.Context, p1 address.Address, p2 uint64, p3 address.Address, p4 types.BigInt, p5 address.Address, p6 uint64, p7 []byte) (cid.Cid, error) {\n\treturn s.Internal.MsigCancel(p0, p1, p2, p3, p4, p5, p6, p7)\n}\n```", | |
"summary": "MsigCancel cancels a previously-proposed multisig message\nIt takes the following params: <multisig address>, <proposed transaction ID>, <recipient address>, <value to transfer>,\n<sender address of the cancel msg>, <method to call in the proposed message>, <params to include in the proposed message>\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p5", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p6", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p7", | |
"description": "[]byte", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"Ynl0ZSBhcnJheQ==" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1188" | |
} | |
}, | |
{ | |
"name": "Filecoin.MsigCreate", | |
"description": "```go\nfunc (s *FullNodeStruct) MsigCreate(p0 context.Context, p1 uint64, p2 []address.Address, p3 abi.ChainEpoch, p4 types.BigInt, p5 address.Address, p6 types.BigInt) (cid.Cid, error) {\n\treturn s.Internal.MsigCreate(p0, p1, p2, p3, p4, p5, p6)\n}\n```", | |
"summary": "MsigCreate creates a multisig wallet\nIt takes the following params: <required number of senders>, <approving addresses>, <unlock duration>\n<initial balance>, <sender address of the create msg>, <gas price>\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "[]address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "abi.ChainEpoch", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
10101 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p5", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p6", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1192" | |
} | |
}, | |
{ | |
"name": "Filecoin.MsigGetAvailableBalance", | |
"description": "```go\nfunc (s *FullNodeStruct) MsigGetAvailableBalance(p0 context.Context, p1 address.Address, p2 types.TipSetKey) (types.BigInt, error) {\n\treturn s.Internal.MsigGetAvailableBalance(p0, p1, p2)\n}\n```", | |
"summary": "MsigGetAvailableBalance returns the portion of a multisig's balance that can be withdrawn or spent\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "types.BigInt", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1196" | |
} | |
}, | |
{ | |
"name": "Filecoin.MsigGetPending", | |
"description": "```go\nfunc (s *FullNodeStruct) MsigGetPending(p0 context.Context, p1 address.Address, p2 types.TipSetKey) ([]*api.MsigTransaction, error) {\n\treturn s.Internal.MsigGetPending(p0, p1, p2)\n}\n```", | |
"summary": "MsigGetPending returns pending transactions for the given multisig\nwallet. Once pending transactions are fully approved, they will no longer\nappear here.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]*api.MsigTransaction", | |
"description": "[]*api.MsigTransaction", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Approved": { | |
"items": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"ID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1200" | |
} | |
}, | |
{ | |
"name": "Filecoin.MsigGetVested", | |
"description": "```go\nfunc (s *FullNodeStruct) MsigGetVested(p0 context.Context, p1 address.Address, p2 types.TipSetKey, p3 types.TipSetKey) (types.BigInt, error) {\n\treturn s.Internal.MsigGetVested(p0, p1, p2, p3)\n}\n```", | |
"summary": "MsigGetVested returns the amount of FIL that vested in a multisig in a certain period.\nIt takes the following params: <multisig address>, <start epoch>, <end epoch>\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "types.BigInt", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1204" | |
} | |
}, | |
{ | |
"name": "Filecoin.MsigGetVestingSchedule", | |
"description": "```go\nfunc (s *FullNodeStruct) MsigGetVestingSchedule(p0 context.Context, p1 address.Address, p2 types.TipSetKey) (api.MsigVesting, error) {\n\treturn s.Internal.MsigGetVestingSchedule(p0, p1, p2)\n}\n```", | |
"summary": "MsigGetVestingSchedule returns the vesting details of a given multisig.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "api.MsigVesting", | |
"description": "api.MsigVesting", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"InitialBalance": "0", | |
"StartEpoch": 10101, | |
"UnlockDuration": 10101 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"InitialBalance": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"StartEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"UnlockDuration": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1208" | |
} | |
}, | |
{ | |
"name": "Filecoin.MsigPropose", | |
"description": "```go\nfunc (s *FullNodeStruct) MsigPropose(p0 context.Context, p1 address.Address, p2 address.Address, p3 types.BigInt, p4 address.Address, p5 uint64, p6 []byte) (cid.Cid, error) {\n\treturn s.Internal.MsigPropose(p0, p1, p2, p3, p4, p5, p6)\n}\n```", | |
"summary": "MsigPropose proposes a multisig message\nIt takes the following params: <multisig address>, <recipient address>, <value to transfer>,\n<sender address of the propose msg>, <method to call in the proposed message>, <params to include in the proposed message>\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p5", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p6", | |
"description": "[]byte", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"Ynl0ZSBhcnJheQ==" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1212" | |
} | |
}, | |
{ | |
"name": "Filecoin.MsigRemoveSigner", | |
"description": "```go\nfunc (s *FullNodeStruct) MsigRemoveSigner(p0 context.Context, p1 address.Address, p2 address.Address, p3 address.Address, p4 bool) (cid.Cid, error) {\n\treturn s.Internal.MsigRemoveSigner(p0, p1, p2, p3, p4)\n}\n```", | |
"summary": "MsigRemoveSigner proposes the removal of a signer from the multisig.\nIt accepts the multisig to make the change on, the proposer address to\nsend the message from, the address to be removed, and a boolean\nindicating whether or not the signing threshold should be lowered by one\nalong with the address removal.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1216" | |
} | |
}, | |
{ | |
"name": "Filecoin.MsigSwapApprove", | |
"description": "```go\nfunc (s *FullNodeStruct) MsigSwapApprove(p0 context.Context, p1 address.Address, p2 address.Address, p3 uint64, p4 address.Address, p5 address.Address, p6 address.Address) (cid.Cid, error) {\n\treturn s.Internal.MsigSwapApprove(p0, p1, p2, p3, p4, p5, p6)\n}\n```", | |
"summary": "MsigSwapApprove approves a previously proposed SwapSigner\nIt takes the following params: <multisig address>, <sender address of the approve msg>, <proposed message ID>,\n<proposer address>, <old signer>, <new signer>\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p5", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p6", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1220" | |
} | |
}, | |
{ | |
"name": "Filecoin.MsigSwapCancel", | |
"description": "```go\nfunc (s *FullNodeStruct) MsigSwapCancel(p0 context.Context, p1 address.Address, p2 address.Address, p3 uint64, p4 address.Address, p5 address.Address) (cid.Cid, error) {\n\treturn s.Internal.MsigSwapCancel(p0, p1, p2, p3, p4, p5)\n}\n```", | |
"summary": "MsigSwapCancel cancels a previously proposed SwapSigner message\nIt takes the following params: <multisig address>, <sender address of the cancel msg>, <proposed message ID>,\n<old signer>, <new signer>\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p5", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1224" | |
} | |
}, | |
{ | |
"name": "Filecoin.MsigSwapPropose", | |
"description": "```go\nfunc (s *FullNodeStruct) MsigSwapPropose(p0 context.Context, p1 address.Address, p2 address.Address, p3 address.Address, p4 address.Address) (cid.Cid, error) {\n\treturn s.Internal.MsigSwapPropose(p0, p1, p2, p3, p4)\n}\n```", | |
"summary": "MsigSwapPropose proposes swapping 2 signers in the multisig\nIt takes the following params: <multisig address>, <sender address of the propose msg>,\n<old signer>, <new signer>\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1228" | |
} | |
}, | |
{ | |
"name": "Filecoin.PaychAllocateLane", | |
"description": "```go\nfunc (s *FullNodeStruct) PaychAllocateLane(p0 context.Context, p1 address.Address) (uint64, error) {\n\treturn s.Internal.PaychAllocateLane(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "uint64", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1232" | |
} | |
}, | |
{ | |
"name": "Filecoin.PaychAvailableFunds", | |
"description": "```go\nfunc (s *FullNodeStruct) PaychAvailableFunds(p0 context.Context, p1 address.Address) (*api.ChannelAvailableFunds, error) {\n\treturn s.Internal.PaychAvailableFunds(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.ChannelAvailableFunds", | |
"description": "*api.ChannelAvailableFunds", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Channel": "<empty>", | |
"From": "f01234", | |
"To": "f01234", | |
"ConfirmedAmt": "0", | |
"PendingAmt": "0", | |
"PendingWaitSentinel": null, | |
"QueuedAmt": "0", | |
"VoucherReedeemedAmt": "0" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Channel": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ConfirmedAmt": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"PendingAmt": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"PendingWaitSentinel": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"QueuedAmt": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"VoucherReedeemedAmt": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1236" | |
} | |
}, | |
{ | |
"name": "Filecoin.PaychAvailableFundsByFromTo", | |
"description": "```go\nfunc (s *FullNodeStruct) PaychAvailableFundsByFromTo(p0 context.Context, p1 address.Address, p2 address.Address) (*api.ChannelAvailableFunds, error) {\n\treturn s.Internal.PaychAvailableFundsByFromTo(p0, p1, p2)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.ChannelAvailableFunds", | |
"description": "*api.ChannelAvailableFunds", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Channel": "<empty>", | |
"From": "f01234", | |
"To": "f01234", | |
"ConfirmedAmt": "0", | |
"PendingAmt": "0", | |
"PendingWaitSentinel": null, | |
"QueuedAmt": "0", | |
"VoucherReedeemedAmt": "0" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Channel": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ConfirmedAmt": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"PendingAmt": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"PendingWaitSentinel": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"QueuedAmt": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"VoucherReedeemedAmt": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1240" | |
} | |
}, | |
{ | |
"name": "Filecoin.PaychCollect", | |
"description": "```go\nfunc (s *FullNodeStruct) PaychCollect(p0 context.Context, p1 address.Address) (cid.Cid, error) {\n\treturn s.Internal.PaychCollect(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1244" | |
} | |
}, | |
{ | |
"name": "Filecoin.PaychGet", | |
"description": "```go\nfunc (s *FullNodeStruct) PaychGet(p0 context.Context, p1 address.Address, p2 address.Address, p3 types.BigInt) (*api.ChannelInfo, error) {\n\treturn s.Internal.PaychGet(p0, p1, p2, p3)\n}\n```", | |
"summary": "There are not yet any comments for this method.", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.ChannelInfo", | |
"description": "*api.ChannelInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Channel": "f01234", | |
"WaitSentinel": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Channel": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"WaitSentinel": { | |
"title": "Content Identifier", | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1248" | |
} | |
}, | |
{ | |
"name": "Filecoin.PaychGetWaitReady", | |
"description": "```go\nfunc (s *FullNodeStruct) PaychGetWaitReady(p0 context.Context, p1 cid.Cid) (address.Address, error) {\n\treturn s.Internal.PaychGetWaitReady(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "address.Address", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1252" | |
} | |
}, | |
{ | |
"name": "Filecoin.PaychList", | |
"description": "```go\nfunc (s *FullNodeStruct) PaychList(p0 context.Context) ([]address.Address, error) {\n\treturn s.Internal.PaychList(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "[]address.Address", | |
"description": "[]address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1256" | |
} | |
}, | |
{ | |
"name": "Filecoin.PaychNewPayment", | |
"description": "```go\nfunc (s *FullNodeStruct) PaychNewPayment(p0 context.Context, p1 address.Address, p2 address.Address, p3 []api.VoucherSpec) (*api.PaymentInfo, error) {\n\treturn s.Internal.PaychNewPayment(p0, p1, p2, p3)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "[]api.VoucherSpec", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Amount": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Extra": { | |
"additionalProperties": false, | |
"properties": { | |
"Actor": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"MinSettle": { | |
"title": "number", | |
"type": "number" | |
}, | |
"TimeLockMax": { | |
"title": "number", | |
"type": "number" | |
}, | |
"TimeLockMin": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.PaymentInfo", | |
"description": "*api.PaymentInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Channel": "f01234", | |
"WaitSentinel": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Vouchers": null | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Channel": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Vouchers": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Amount": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ChannelAddr": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Extra": { | |
"additionalProperties": false, | |
"properties": { | |
"Actor": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Lane": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Merges": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Lane": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"MinSettleHeight": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SecretPreimage": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"TimeLockMax": { | |
"title": "number", | |
"type": "number" | |
}, | |
"TimeLockMin": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"WaitSentinel": { | |
"title": "Content Identifier", | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1260" | |
} | |
}, | |
{ | |
"name": "Filecoin.PaychSettle", | |
"description": "```go\nfunc (s *FullNodeStruct) PaychSettle(p0 context.Context, p1 address.Address) (cid.Cid, error) {\n\treturn s.Internal.PaychSettle(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1264" | |
} | |
}, | |
{ | |
"name": "Filecoin.PaychStatus", | |
"description": "```go\nfunc (s *FullNodeStruct) PaychStatus(p0 context.Context, p1 address.Address) (*api.PaychStatus, error) {\n\treturn s.Internal.PaychStatus(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.PaychStatus", | |
"description": "*api.PaychStatus", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ControlAddr": "f01234", | |
"Direction": 1 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ControlAddr": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Direction": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1268" | |
} | |
}, | |
{ | |
"name": "Filecoin.PaychVoucherAdd", | |
"description": "```go\nfunc (s *FullNodeStruct) PaychVoucherAdd(p0 context.Context, p1 address.Address, p2 *paych.SignedVoucher, p3 []byte, p4 types.BigInt) (types.BigInt, error) {\n\treturn s.Internal.PaychVoucherAdd(p0, p1, p2, p3, p4)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "*paych.SignedVoucher", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ChannelAddr": "f01234", | |
"TimeLockMin": 10101, | |
"TimeLockMax": 10101, | |
"SecretPreimage": "Ynl0ZSBhcnJheQ==", | |
"Extra": { | |
"Actor": "f01234", | |
"Method": 1, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
}, | |
"Lane": 42, | |
"Nonce": 42, | |
"Amount": "0", | |
"MinSettleHeight": 10101, | |
"Merges": null, | |
"Signature": { | |
"Type": 2, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Amount": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ChannelAddr": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Extra": { | |
"additionalProperties": false, | |
"properties": { | |
"Actor": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Lane": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Merges": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Lane": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"MinSettleHeight": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SecretPreimage": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"TimeLockMax": { | |
"title": "number", | |
"type": "number" | |
}, | |
"TimeLockMin": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "[]byte", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"Ynl0ZSBhcnJheQ==" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "types.BigInt", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1272" | |
} | |
}, | |
{ | |
"name": "Filecoin.PaychVoucherCheckSpendable", | |
"description": "```go\nfunc (s *FullNodeStruct) PaychVoucherCheckSpendable(p0 context.Context, p1 address.Address, p2 *paych.SignedVoucher, p3 []byte, p4 []byte) (bool, error) {\n\treturn s.Internal.PaychVoucherCheckSpendable(p0, p1, p2, p3, p4)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "*paych.SignedVoucher", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ChannelAddr": "f01234", | |
"TimeLockMin": 10101, | |
"TimeLockMax": 10101, | |
"SecretPreimage": "Ynl0ZSBhcnJheQ==", | |
"Extra": { | |
"Actor": "f01234", | |
"Method": 1, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
}, | |
"Lane": 42, | |
"Nonce": 42, | |
"Amount": "0", | |
"MinSettleHeight": 10101, | |
"Merges": null, | |
"Signature": { | |
"Type": 2, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Amount": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ChannelAddr": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Extra": { | |
"additionalProperties": false, | |
"properties": { | |
"Actor": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Lane": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Merges": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Lane": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"MinSettleHeight": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SecretPreimage": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"TimeLockMax": { | |
"title": "number", | |
"type": "number" | |
}, | |
"TimeLockMin": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "[]byte", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"Ynl0ZSBhcnJheQ==" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "[]byte", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"Ynl0ZSBhcnJheQ==" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "bool", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1276" | |
} | |
}, | |
{ | |
"name": "Filecoin.PaychVoucherCheckValid", | |
"description": "```go\nfunc (s *FullNodeStruct) PaychVoucherCheckValid(p0 context.Context, p1 address.Address, p2 *paych.SignedVoucher) error {\n\treturn s.Internal.PaychVoucherCheckValid(p0, p1, p2)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "*paych.SignedVoucher", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ChannelAddr": "f01234", | |
"TimeLockMin": 10101, | |
"TimeLockMax": 10101, | |
"SecretPreimage": "Ynl0ZSBhcnJheQ==", | |
"Extra": { | |
"Actor": "f01234", | |
"Method": 1, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
}, | |
"Lane": 42, | |
"Nonce": 42, | |
"Amount": "0", | |
"MinSettleHeight": 10101, | |
"Merges": null, | |
"Signature": { | |
"Type": 2, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Amount": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ChannelAddr": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Extra": { | |
"additionalProperties": false, | |
"properties": { | |
"Actor": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Lane": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Merges": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Lane": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"MinSettleHeight": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SecretPreimage": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"TimeLockMax": { | |
"title": "number", | |
"type": "number" | |
}, | |
"TimeLockMin": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1280" | |
} | |
}, | |
{ | |
"name": "Filecoin.PaychVoucherCreate", | |
"description": "```go\nfunc (s *FullNodeStruct) PaychVoucherCreate(p0 context.Context, p1 address.Address, p2 types.BigInt, p3 uint64) (*api.VoucherCreateResult, error) {\n\treturn s.Internal.PaychVoucherCreate(p0, p1, p2, p3)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.VoucherCreateResult", | |
"description": "*api.VoucherCreateResult", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Voucher": { | |
"ChannelAddr": "f01234", | |
"TimeLockMin": 10101, | |
"TimeLockMax": 10101, | |
"SecretPreimage": "Ynl0ZSBhcnJheQ==", | |
"Extra": { | |
"Actor": "f01234", | |
"Method": 1, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
}, | |
"Lane": 42, | |
"Nonce": 42, | |
"Amount": "0", | |
"MinSettleHeight": 10101, | |
"Merges": null, | |
"Signature": { | |
"Type": 2, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
} | |
}, | |
"Shortfall": "0" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Shortfall": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Voucher": { | |
"additionalProperties": false, | |
"properties": { | |
"Amount": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ChannelAddr": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Extra": { | |
"additionalProperties": false, | |
"properties": { | |
"Actor": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Lane": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Merges": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Lane": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"MinSettleHeight": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SecretPreimage": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"TimeLockMax": { | |
"title": "number", | |
"type": "number" | |
}, | |
"TimeLockMin": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1284" | |
} | |
}, | |
{ | |
"name": "Filecoin.PaychVoucherList", | |
"description": "```go\nfunc (s *FullNodeStruct) PaychVoucherList(p0 context.Context, p1 address.Address) ([]*paych.SignedVoucher, error) {\n\treturn s.Internal.PaychVoucherList(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]*paych.SignedVoucher", | |
"description": "[]*paych.SignedVoucher", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Amount": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ChannelAddr": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Extra": { | |
"additionalProperties": false, | |
"properties": { | |
"Actor": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Lane": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Merges": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Lane": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"MinSettleHeight": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SecretPreimage": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"TimeLockMax": { | |
"title": "number", | |
"type": "number" | |
}, | |
"TimeLockMin": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1288" | |
} | |
}, | |
{ | |
"name": "Filecoin.PaychVoucherSubmit", | |
"description": "```go\nfunc (s *FullNodeStruct) PaychVoucherSubmit(p0 context.Context, p1 address.Address, p2 *paych.SignedVoucher, p3 []byte, p4 []byte) (cid.Cid, error) {\n\treturn s.Internal.PaychVoucherSubmit(p0, p1, p2, p3, p4)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "*paych.SignedVoucher", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ChannelAddr": "f01234", | |
"TimeLockMin": 10101, | |
"TimeLockMax": 10101, | |
"SecretPreimage": "Ynl0ZSBhcnJheQ==", | |
"Extra": { | |
"Actor": "f01234", | |
"Method": 1, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
}, | |
"Lane": 42, | |
"Nonce": 42, | |
"Amount": "0", | |
"MinSettleHeight": 10101, | |
"Merges": null, | |
"Signature": { | |
"Type": 2, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Amount": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ChannelAddr": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Extra": { | |
"additionalProperties": false, | |
"properties": { | |
"Actor": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Lane": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Merges": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Lane": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"MinSettleHeight": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SecretPreimage": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"TimeLockMax": { | |
"title": "number", | |
"type": "number" | |
}, | |
"TimeLockMin": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "[]byte", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"Ynl0ZSBhcnJheQ==" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "[]byte", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"Ynl0ZSBhcnJheQ==" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "cid.Cid", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1292" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateAccountKey", | |
"description": "```go\nfunc (s *FullNodeStruct) StateAccountKey(p0 context.Context, p1 address.Address, p2 types.TipSetKey) (address.Address, error) {\n\treturn s.Internal.StateAccountKey(p0, p1, p2)\n}\n```", | |
"summary": "StateAccountKey returns the public key address of the given ID address\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "address.Address", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1296" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateAllMinerFaults", | |
"description": "```go\nfunc (s *FullNodeStruct) StateAllMinerFaults(p0 context.Context, p1 abi.ChainEpoch, p2 types.TipSetKey) ([]*api.Fault, error) {\n\treturn s.Internal.StateAllMinerFaults(p0, p1, p2)\n}\n```", | |
"summary": "StateAllMinerFaults returns all non-expired Faults that occur within lookback epochs of the given tipset\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "abi.ChainEpoch", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
10101 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]*api.Fault", | |
"description": "[]*api.Fault", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Epoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Miner": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1300" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateCall", | |
"description": "```go\nfunc (s *FullNodeStruct) StateCall(p0 context.Context, p1 *types.Message, p2 types.TipSetKey) (*api.InvocResult, error) {\n\treturn s.Internal.StateCall(p0, p1, p2)\n}\n```", | |
"summary": "StateCall runs the given message and returns its result without any persisted changes.\n\nStateCall applies the message to the tipset's parent state. The\nmessage is not applied on-top-of the messages in the passed-in\ntipset.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "*types.Message", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Version": 42, | |
"To": "f01234", | |
"From": "f01234", | |
"Nonce": 42, | |
"Value": "0", | |
"GasLimit": 9, | |
"GasFeeCap": "0", | |
"GasPremium": "0", | |
"Method": 1, | |
"Params": "Ynl0ZSBhcnJheQ==", | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.InvocResult", | |
"description": "*api.InvocResult", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"MsgCid": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Msg": { | |
"Version": 42, | |
"To": "f01234", | |
"From": "f01234", | |
"Nonce": 42, | |
"Value": "0", | |
"GasLimit": 9, | |
"GasFeeCap": "0", | |
"GasPremium": "0", | |
"Method": 1, | |
"Params": "Ynl0ZSBhcnJheQ==", | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
}, | |
"MsgRct": { | |
"ExitCode": 0, | |
"Return": "Ynl0ZSBhcnJheQ==", | |
"GasUsed": 9 | |
}, | |
"GasCost": { | |
"Message": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"GasUsed": "0", | |
"BaseFeeBurn": "0", | |
"OverEstimationBurn": "0", | |
"MinerPenalty": "0", | |
"MinerTip": "0", | |
"Refund": "0", | |
"TotalCost": "0" | |
}, | |
"ExecutionTrace": { | |
"Msg": { | |
"Version": 42, | |
"To": "f01234", | |
"From": "f01234", | |
"Nonce": 42, | |
"Value": "0", | |
"GasLimit": 9, | |
"GasFeeCap": "0", | |
"GasPremium": "0", | |
"Method": 1, | |
"Params": "Ynl0ZSBhcnJheQ==", | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
}, | |
"MsgRct": { | |
"ExitCode": 0, | |
"Return": "Ynl0ZSBhcnJheQ==", | |
"GasUsed": 9 | |
}, | |
"Error": "string value", | |
"Duration": 60000000000, | |
"GasCharges": null, | |
"Subcalls": null | |
}, | |
"Error": "string value", | |
"Duration": 60000000000 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Duration": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Error": { | |
"type": "string" | |
}, | |
"ExecutionTrace": { | |
"additionalProperties": false, | |
"properties": { | |
"Duration": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Error": { | |
"type": "string" | |
}, | |
"GasCharges": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Name": { | |
"type": "string" | |
}, | |
"cg": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ex": { | |
"additionalProperties": true, | |
"type": "object" | |
}, | |
"loc": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"File": { | |
"type": "string" | |
}, | |
"Function": { | |
"type": "string" | |
}, | |
"Line": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"sg": { | |
"title": "number", | |
"type": "number" | |
}, | |
"tg": { | |
"title": "number", | |
"type": "number" | |
}, | |
"tt": { | |
"title": "number", | |
"type": "number" | |
}, | |
"vcg": { | |
"title": "number", | |
"type": "number" | |
}, | |
"vsg": { | |
"title": "number", | |
"type": "number" | |
}, | |
"vtg": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"Msg": { | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"MsgRct": { | |
"additionalProperties": false, | |
"properties": { | |
"ExitCode": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasUsed": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Return": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"Subcalls": { | |
"items": {}, | |
"type": "array" | |
} | |
}, | |
"type": "object" | |
}, | |
"GasCost": { | |
"additionalProperties": false, | |
"properties": { | |
"BaseFeeBurn": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasUsed": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Message": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"MinerPenalty": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"MinerTip": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"OverEstimationBurn": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Refund": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"TotalCost": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": "object" | |
}, | |
"Msg": { | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"MsgCid": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"MsgRct": { | |
"additionalProperties": false, | |
"properties": { | |
"ExitCode": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasUsed": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Return": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1304" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateChangedActors", | |
"description": "```go\nfunc (s *FullNodeStruct) StateChangedActors(p0 context.Context, p1 cid.Cid, p2 cid.Cid) (map[string]types.Actor, error) {\n\treturn s.Internal.StateChangedActors(p0, p1, p2)\n}\n```", | |
"summary": "StateChangedActors returns all the actors whose states change between the two given state CIDs\nTODO: Should this take tipset keys instead?\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "map[string]types.Actor", | |
"description": "map[string]types.Actor", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"t01236": { | |
"Code": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Head": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Nonce": 42, | |
"Balance": "0" | |
} | |
} | |
], | |
"patternProperties": { | |
".*": { | |
"additionalProperties": false, | |
"properties": { | |
"Balance": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Code": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Head": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1308" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateCirculatingSupply", | |
"description": "```go\nfunc (s *FullNodeStruct) StateCirculatingSupply(p0 context.Context, p1 types.TipSetKey) (abi.TokenAmount, error) {\n\treturn s.Internal.StateCirculatingSupply(p0, p1)\n}\n```", | |
"summary": "StateCirculatingSupply returns the exact circulating supply of Filecoin at the given tipset.\nThis is not used anywhere in the protocol itself, and is only for external consumption.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "abi.TokenAmount", | |
"description": "abi.TokenAmount", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1312" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateCompute", | |
"description": "```go\nfunc (s *FullNodeStruct) StateCompute(p0 context.Context, p1 abi.ChainEpoch, p2 []*types.Message, p3 types.TipSetKey) (*api.ComputeStateOutput, error) {\n\treturn s.Internal.StateCompute(p0, p1, p2, p3)\n}\n```", | |
"summary": "StateCompute is a flexible command that applies the given messages on the given tipset.\nThe messages are run as though the VM were at the provided height.\n\nWhen called, StateCompute will:\n- Load the provided tipset, or use the current chain head if not provided\n- Compute the tipset state of the provided tipset on top of the parent state\n - (note that this step runs before vmheight is applied to the execution)\n - Execute state upgrade if any were scheduled at the epoch, or in null\n blocks preceding the tipset\n - Call the cron actor on null blocks preceding the tipset\n - For each block in the tipset\n - Apply messages in blocks in the specified\n - Award block reward by calling the reward actor\n - Call the cron actor for the current epoch\n- If the specified vmheight is higher than the current epoch, apply any\n needed state upgrades to the state\n- Apply the specified messages to the state\n\nThe vmheight parameter sets VM execution epoch, and can be used to simulate\nmessage execution in different network versions. If the specified vmheight\nepoch is higher than the epoch of the specified tipset, any state upgrades\nuntil the vmheight will be executed on the state before applying messages\nspecified by the user.\n\nNote that the initial tipset state computation is not affected by the\nvmheight parameter - only the messages in the `apply` set are\n\nIf the caller wants to simply compute the state, vmheight should be set to\nthe epoch of the specified tipset.\n\nMessages in the `apply` parameter must have the correct nonces, and gas\nvalues set.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "abi.ChainEpoch", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
10101 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "[]*types.Message", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.ComputeStateOutput", | |
"description": "*api.ComputeStateOutput", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Root": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Trace": null | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Root": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Trace": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Duration": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Error": { | |
"type": "string" | |
}, | |
"ExecutionTrace": { | |
"additionalProperties": false, | |
"properties": { | |
"Duration": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Error": { | |
"type": "string" | |
}, | |
"GasCharges": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Name": { | |
"type": "string" | |
}, | |
"cg": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ex": { | |
"additionalProperties": true, | |
"type": "object" | |
}, | |
"loc": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"File": { | |
"type": "string" | |
}, | |
"Function": { | |
"type": "string" | |
}, | |
"Line": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"sg": { | |
"title": "number", | |
"type": "number" | |
}, | |
"tg": { | |
"title": "number", | |
"type": "number" | |
}, | |
"tt": { | |
"title": "number", | |
"type": "number" | |
}, | |
"vcg": { | |
"title": "number", | |
"type": "number" | |
}, | |
"vsg": { | |
"title": "number", | |
"type": "number" | |
}, | |
"vtg": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"Msg": { | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"MsgRct": { | |
"additionalProperties": false, | |
"properties": { | |
"ExitCode": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasUsed": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Return": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"Subcalls": { | |
"items": {}, | |
"type": "array" | |
} | |
}, | |
"type": "object" | |
}, | |
"GasCost": { | |
"additionalProperties": false, | |
"properties": { | |
"BaseFeeBurn": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasUsed": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Message": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"MinerPenalty": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"MinerTip": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"OverEstimationBurn": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Refund": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"TotalCost": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": "object" | |
}, | |
"Msg": { | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"MsgCid": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"MsgRct": { | |
"additionalProperties": false, | |
"properties": { | |
"ExitCode": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasUsed": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Return": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1316" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateDealProviderCollateralBounds", | |
"description": "```go\nfunc (s *FullNodeStruct) StateDealProviderCollateralBounds(p0 context.Context, p1 abi.PaddedPieceSize, p2 bool, p3 types.TipSetKey) (api.DealCollateralBounds, error) {\n\treturn s.Internal.StateDealProviderCollateralBounds(p0, p1, p2, p3)\n}\n```", | |
"summary": "StateDealProviderCollateralBounds returns the min and max collateral a storage provider\ncan issue. It takes the deal size and verified status as parameters.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "abi.PaddedPieceSize", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1032 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "api.DealCollateralBounds", | |
"description": "api.DealCollateralBounds", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Min": "0", | |
"Max": "0" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Max": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Min": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1320" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateDecodeParams", | |
"description": "```go\nfunc (s *FullNodeStruct) StateDecodeParams(p0 context.Context, p1 address.Address, p2 abi.MethodNum, p3 []byte, p4 types.TipSetKey) (interface{}, error) {\n\treturn s.Internal.StateDecodeParams(p0, p1, p2, p3, p4)\n}\n```", | |
"summary": "StateDecodeParams attempts to decode the provided params, based on the recipient actor address and method number.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "abi.MethodNum", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "[]byte", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"Ynl0ZSBhcnJheQ==" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "interface{}", | |
"description": "interface{}", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{} | |
], | |
"additionalProperties": true, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1324" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateGetActor", | |
"description": "```go\nfunc (s *FullNodeStruct) StateGetActor(p0 context.Context, p1 address.Address, p2 types.TipSetKey) (*types.Actor, error) {\n\treturn s.Internal.StateGetActor(p0, p1, p2)\n}\n```", | |
"summary": "StateGetActor returns the indicated actor's nonce and balance.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*types.Actor", | |
"description": "*types.Actor", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Code": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Head": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Nonce": 42, | |
"Balance": "0" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Balance": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Code": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Head": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1328" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateGetReceipt", | |
"description": "```go\nfunc (s *FullNodeStruct) StateGetReceipt(p0 context.Context, p1 cid.Cid, p2 types.TipSetKey) (*types.MessageReceipt, error) {\n\treturn s.Internal.StateGetReceipt(p0, p1, p2)\n}\n```", | |
"summary": "StateGetReceipt returns the message receipt for the given message or for a\nmatching gas-repriced replacing message\n\nNOTE: If the requested message was replaced, this method will return the receipt\nfor the replacing message - if the caller needs the receipt for exactly the\nrequested message, use StateSearchMsg().Receipt, and check that MsgLookup.Message\nis matching the requested CID\n\nDEPRECATED: Use StateSearchMsg, this method won't be supported in v1 API\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*types.MessageReceipt", | |
"description": "*types.MessageReceipt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ExitCode": 0, | |
"Return": "Ynl0ZSBhcnJheQ==", | |
"GasUsed": 9 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ExitCode": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasUsed": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Return": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1332" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateListActors", | |
"description": "```go\nfunc (s *FullNodeStruct) StateListActors(p0 context.Context, p1 types.TipSetKey) ([]address.Address, error) {\n\treturn s.Internal.StateListActors(p0, p1)\n}\n```", | |
"summary": "StateListActors returns the addresses of every actor in the state\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]address.Address", | |
"description": "[]address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1336" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateListMessages", | |
"description": "```go\nfunc (s *FullNodeStruct) StateListMessages(p0 context.Context, p1 *api.MessageMatch, p2 types.TipSetKey, p3 abi.ChainEpoch) ([]cid.Cid, error) {\n\treturn s.Internal.StateListMessages(p0, p1, p2, p3)\n}\n```", | |
"summary": "StateListMessages looks back and returns all messages with a matching to or from address, stopping at the given height.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "*api.MessageMatch", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"To": "f01234", | |
"From": "f01234" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "abi.ChainEpoch", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
10101 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]cid.Cid", | |
"description": "[]cid.Cid", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"type": [ | |
"string" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1340" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateListMiners", | |
"description": "```go\nfunc (s *FullNodeStruct) StateListMiners(p0 context.Context, p1 types.TipSetKey) ([]address.Address, error) {\n\treturn s.Internal.StateListMiners(p0, p1)\n}\n```", | |
"summary": "StateListMiners returns the addresses of every miner that has claimed power in the Power Actor\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]address.Address", | |
"description": "[]address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1344" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateLookupID", | |
"description": "```go\nfunc (s *FullNodeStruct) StateLookupID(p0 context.Context, p1 address.Address, p2 types.TipSetKey) (address.Address, error) {\n\treturn s.Internal.StateLookupID(p0, p1, p2)\n}\n```", | |
"summary": "StateLookupID retrieves the ID address of the given address\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "address.Address", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1348" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateMarketBalance", | |
"description": "```go\nfunc (s *FullNodeStruct) StateMarketBalance(p0 context.Context, p1 address.Address, p2 types.TipSetKey) (api.MarketBalance, error) {\n\treturn s.Internal.StateMarketBalance(p0, p1, p2)\n}\n```", | |
"summary": "StateMarketBalance looks up the Escrow and Locked balances of the given address in the Storage Market\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "api.MarketBalance", | |
"description": "api.MarketBalance", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Escrow": "0", | |
"Locked": "0" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Escrow": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Locked": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1352" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateMarketDeals", | |
"description": "```go\nfunc (s *FullNodeStruct) StateMarketDeals(p0 context.Context, p1 types.TipSetKey) (map[string]api.MarketDeal, error) {\n\treturn s.Internal.StateMarketDeals(p0, p1)\n}\n```", | |
"summary": "StateMarketDeals returns information about every deal in the Storage Market\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "map[string]api.MarketDeal", | |
"description": "map[string]api.MarketDeal", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"t026363": { | |
"Proposal": { | |
"PieceCID": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"PieceSize": 1032, | |
"VerifiedDeal": true, | |
"Client": "f01234", | |
"Provider": "f01234", | |
"Label": "string value", | |
"StartEpoch": 10101, | |
"EndEpoch": 10101, | |
"StoragePricePerEpoch": "0", | |
"ProviderCollateral": "0", | |
"ClientCollateral": "0" | |
}, | |
"State": { | |
"SectorStartEpoch": 10101, | |
"LastUpdatedEpoch": 10101, | |
"SlashEpoch": 10101 | |
} | |
} | |
} | |
], | |
"patternProperties": { | |
".*": { | |
"additionalProperties": false, | |
"properties": { | |
"Proposal": { | |
"additionalProperties": false, | |
"properties": { | |
"Client": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ClientCollateral": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"EndEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Label": { | |
"type": "string" | |
}, | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"PieceSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Provider": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ProviderCollateral": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"StartEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"StoragePricePerEpoch": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"VerifiedDeal": { | |
"type": "boolean" | |
} | |
}, | |
"type": "object" | |
}, | |
"State": { | |
"additionalProperties": false, | |
"properties": { | |
"LastUpdatedEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SectorStartEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SlashEpoch": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1356" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateMarketParticipants", | |
"description": "```go\nfunc (s *FullNodeStruct) StateMarketParticipants(p0 context.Context, p1 types.TipSetKey) (map[string]api.MarketBalance, error) {\n\treturn s.Internal.StateMarketParticipants(p0, p1)\n}\n```", | |
"summary": "StateMarketParticipants returns the Escrow and Locked balances of every participant in the Storage Market\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "map[string]api.MarketBalance", | |
"description": "map[string]api.MarketBalance", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"t026363": { | |
"Escrow": "0", | |
"Locked": "0" | |
} | |
} | |
], | |
"patternProperties": { | |
".*": { | |
"additionalProperties": false, | |
"properties": { | |
"Escrow": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Locked": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1360" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateMarketStorageDeal", | |
"description": "```go\nfunc (s *FullNodeStruct) StateMarketStorageDeal(p0 context.Context, p1 abi.DealID, p2 types.TipSetKey) (*api.MarketDeal, error) {\n\treturn s.Internal.StateMarketStorageDeal(p0, p1, p2)\n}\n```", | |
"summary": "StateMarketStorageDeal returns information about the indicated deal\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "abi.DealID", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
5432 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.MarketDeal", | |
"description": "*api.MarketDeal", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Proposal": { | |
"PieceCID": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"PieceSize": 1032, | |
"VerifiedDeal": true, | |
"Client": "f01234", | |
"Provider": "f01234", | |
"Label": "string value", | |
"StartEpoch": 10101, | |
"EndEpoch": 10101, | |
"StoragePricePerEpoch": "0", | |
"ProviderCollateral": "0", | |
"ClientCollateral": "0" | |
}, | |
"State": { | |
"SectorStartEpoch": 10101, | |
"LastUpdatedEpoch": 10101, | |
"SlashEpoch": 10101 | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Proposal": { | |
"additionalProperties": false, | |
"properties": { | |
"Client": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ClientCollateral": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"EndEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Label": { | |
"type": "string" | |
}, | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"PieceSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Provider": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ProviderCollateral": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"StartEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"StoragePricePerEpoch": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"VerifiedDeal": { | |
"type": "boolean" | |
} | |
}, | |
"type": "object" | |
}, | |
"State": { | |
"additionalProperties": false, | |
"properties": { | |
"LastUpdatedEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SectorStartEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SlashEpoch": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1364" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateMinerActiveSectors", | |
"description": "```go\nfunc (s *FullNodeStruct) StateMinerActiveSectors(p0 context.Context, p1 address.Address, p2 types.TipSetKey) ([]*miner.SectorOnChainInfo, error) {\n\treturn s.Internal.StateMinerActiveSectors(p0, p1, p2)\n}\n```", | |
"summary": "StateMinerActiveSectors returns info about sectors that a given miner is actively proving.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]*miner.SectorOnChainInfo", | |
"description": "[]*miner.SectorOnChainInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Activation": { | |
"title": "number", | |
"type": "number" | |
}, | |
"DealIDs": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"type": "array" | |
}, | |
"DealWeight": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ExpectedDayReward": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ExpectedStoragePledge": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Expiration": { | |
"title": "number", | |
"type": "number" | |
}, | |
"InitialPledge": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"SealProof": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SealedCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"SectorNumber": { | |
"title": "number", | |
"type": "number" | |
}, | |
"VerifiedDealWeight": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1368" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateMinerAvailableBalance", | |
"description": "```go\nfunc (s *FullNodeStruct) StateMinerAvailableBalance(p0 context.Context, p1 address.Address, p2 types.TipSetKey) (types.BigInt, error) {\n\treturn s.Internal.StateMinerAvailableBalance(p0, p1, p2)\n}\n```", | |
"summary": "StateMinerAvailableBalance returns the portion of a miner's balance that can be withdrawn or spent\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "types.BigInt", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1372" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateMinerDeadlines", | |
"description": "```go\nfunc (s *FullNodeStruct) StateMinerDeadlines(p0 context.Context, p1 address.Address, p2 types.TipSetKey) ([]api.Deadline, error) {\n\treturn s.Internal.StateMinerDeadlines(p0, p1, p2)\n}\n```", | |
"summary": "StateMinerDeadlines returns all the proving deadlines for the given miner\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]api.Deadline", | |
"description": "[]api.Deadline", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"DisputableProofCount": { | |
"title": "number", | |
"type": "number" | |
}, | |
"PostSubmissions": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1376" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateMinerFaults", | |
"description": "```go\nfunc (s *FullNodeStruct) StateMinerFaults(p0 context.Context, p1 address.Address, p2 types.TipSetKey) (bitfield.BitField, error) {\n\treturn s.Internal.StateMinerFaults(p0, p1, p2)\n}\n```", | |
"summary": "StateMinerFaults returns a bitfield indicating the faulty sectors of the given miner\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "bitfield.BitField", | |
"description": "bitfield.BitField", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
5, | |
1 | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1380" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateMinerInfo", | |
"description": "```go\nfunc (s *FullNodeStruct) StateMinerInfo(p0 context.Context, p1 address.Address, p2 types.TipSetKey) (miner.MinerInfo, error) {\n\treturn s.Internal.StateMinerInfo(p0, p1, p2)\n}\n```", | |
"summary": "StateMinerInfo returns info about the indicated miner\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "miner.MinerInfo", | |
"description": "miner.MinerInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Owner": "f01234", | |
"Worker": "f01234", | |
"NewWorker": "f01234", | |
"ControlAddresses": null, | |
"WorkerChangeEpoch": 10101, | |
"PeerId": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf", | |
"Multiaddrs": null, | |
"WindowPoStProofType": 8, | |
"SectorSize": 34359738368, | |
"WindowPoStPartitionSectors": 42, | |
"ConsensusFaultElapsed": 10101 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ConsensusFaultElapsed": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ControlAddresses": { | |
"items": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"Multiaddrs": { | |
"items": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"type": "array" | |
}, | |
"NewWorker": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Owner": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"PeerId": { | |
"type": "string" | |
}, | |
"SectorSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"WindowPoStPartitionSectors": { | |
"title": "number", | |
"type": "number" | |
}, | |
"WindowPoStProofType": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Worker": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"WorkerChangeEpoch": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1384" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateMinerInitialPledgeCollateral", | |
"description": "```go\nfunc (s *FullNodeStruct) StateMinerInitialPledgeCollateral(p0 context.Context, p1 address.Address, p2 miner.SectorPreCommitInfo, p3 types.TipSetKey) (types.BigInt, error) {\n\treturn s.Internal.StateMinerInitialPledgeCollateral(p0, p1, p2, p3)\n}\n```", | |
"summary": "StateMinerInitialPledgeCollateral returns the initial pledge collateral for the specified miner's sector\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "miner.SectorPreCommitInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"SealProof": 8, | |
"SectorNumber": 9, | |
"SealedCID": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"SealRandEpoch": 10101, | |
"DealIDs": null, | |
"Expiration": 10101, | |
"ReplaceCapacity": true, | |
"ReplaceSectorDeadline": 42, | |
"ReplaceSectorPartition": 42, | |
"ReplaceSectorNumber": 9 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"DealIDs": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"type": "array" | |
}, | |
"Expiration": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ReplaceCapacity": { | |
"type": "boolean" | |
}, | |
"ReplaceSectorDeadline": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ReplaceSectorNumber": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ReplaceSectorPartition": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SealProof": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SealRandEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SealedCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"SectorNumber": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "types.BigInt", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1388" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateMinerPartitions", | |
"description": "```go\nfunc (s *FullNodeStruct) StateMinerPartitions(p0 context.Context, p1 address.Address, p2 uint64, p3 types.TipSetKey) ([]api.Partition, error) {\n\treturn s.Internal.StateMinerPartitions(p0, p1, p2, p3)\n}\n```", | |
"summary": "StateMinerPartitions returns all partitions in the specified deadline\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]api.Partition", | |
"description": "[]api.Partition", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"ActiveSectors": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"AllSectors": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"FaultySectors": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"LiveSectors": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"RecoveringSectors": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1392" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateMinerPower", | |
"description": "```go\nfunc (s *FullNodeStruct) StateMinerPower(p0 context.Context, p1 address.Address, p2 types.TipSetKey) (*api.MinerPower, error) {\n\treturn s.Internal.StateMinerPower(p0, p1, p2)\n}\n```", | |
"summary": "StateMinerPower returns the power of the indicated miner\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.MinerPower", | |
"description": "*api.MinerPower", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"MinerPower": { | |
"RawBytePower": "0", | |
"QualityAdjPower": "0" | |
}, | |
"TotalPower": { | |
"RawBytePower": "0", | |
"QualityAdjPower": "0" | |
}, | |
"HasMinPower": true | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"HasMinPower": { | |
"type": "boolean" | |
}, | |
"MinerPower": { | |
"additionalProperties": false, | |
"properties": { | |
"QualityAdjPower": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"RawBytePower": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": "object" | |
}, | |
"TotalPower": { | |
"additionalProperties": false, | |
"properties": { | |
"QualityAdjPower": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"RawBytePower": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1396" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateMinerPreCommitDepositForPower", | |
"description": "```go\nfunc (s *FullNodeStruct) StateMinerPreCommitDepositForPower(p0 context.Context, p1 address.Address, p2 miner.SectorPreCommitInfo, p3 types.TipSetKey) (types.BigInt, error) {\n\treturn s.Internal.StateMinerPreCommitDepositForPower(p0, p1, p2, p3)\n}\n```", | |
"summary": "StateMinerInitialPledgeCollateral returns the precommit deposit for the specified miner's sector\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "miner.SectorPreCommitInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"SealProof": 8, | |
"SectorNumber": 9, | |
"SealedCID": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"SealRandEpoch": 10101, | |
"DealIDs": null, | |
"Expiration": 10101, | |
"ReplaceCapacity": true, | |
"ReplaceSectorDeadline": 42, | |
"ReplaceSectorPartition": 42, | |
"ReplaceSectorNumber": 9 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"DealIDs": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"type": "array" | |
}, | |
"Expiration": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ReplaceCapacity": { | |
"type": "boolean" | |
}, | |
"ReplaceSectorDeadline": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ReplaceSectorNumber": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ReplaceSectorPartition": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SealProof": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SealRandEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SealedCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"SectorNumber": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "types.BigInt", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1400" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateMinerProvingDeadline", | |
"description": "```go\nfunc (s *FullNodeStruct) StateMinerProvingDeadline(p0 context.Context, p1 address.Address, p2 types.TipSetKey) (*dline.Info, error) {\n\treturn s.Internal.StateMinerProvingDeadline(p0, p1, p2)\n}\n```", | |
"summary": "StateMinerProvingDeadline calculates the deadline at some epoch for a proving period\nand returns the deadline-related calculations.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*dline.Info", | |
"description": "*dline.Info", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"CurrentEpoch": 10101, | |
"PeriodStart": 10101, | |
"Index": 42, | |
"Open": 10101, | |
"Close": 10101, | |
"Challenge": 10101, | |
"FaultCutoff": 10101, | |
"WPoStPeriodDeadlines": 42, | |
"WPoStProvingPeriod": 10101, | |
"WPoStChallengeWindow": 10101, | |
"WPoStChallengeLookback": 10101, | |
"FaultDeclarationCutoff": 10101 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Challenge": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Close": { | |
"title": "number", | |
"type": "number" | |
}, | |
"CurrentEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"FaultCutoff": { | |
"title": "number", | |
"type": "number" | |
}, | |
"FaultDeclarationCutoff": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Index": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Open": { | |
"title": "number", | |
"type": "number" | |
}, | |
"PeriodStart": { | |
"title": "number", | |
"type": "number" | |
}, | |
"WPoStChallengeLookback": { | |
"title": "number", | |
"type": "number" | |
}, | |
"WPoStChallengeWindow": { | |
"title": "number", | |
"type": "number" | |
}, | |
"WPoStPeriodDeadlines": { | |
"title": "number", | |
"type": "number" | |
}, | |
"WPoStProvingPeriod": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1404" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateMinerRecoveries", | |
"description": "```go\nfunc (s *FullNodeStruct) StateMinerRecoveries(p0 context.Context, p1 address.Address, p2 types.TipSetKey) (bitfield.BitField, error) {\n\treturn s.Internal.StateMinerRecoveries(p0, p1, p2)\n}\n```", | |
"summary": "StateMinerRecoveries returns a bitfield indicating the recovering sectors of the given miner\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "bitfield.BitField", | |
"description": "bitfield.BitField", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
5, | |
1 | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1408" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateMinerSectorAllocated", | |
"description": "```go\nfunc (s *FullNodeStruct) StateMinerSectorAllocated(p0 context.Context, p1 address.Address, p2 abi.SectorNumber, p3 types.TipSetKey) (bool, error) {\n\treturn s.Internal.StateMinerSectorAllocated(p0, p1, p2, p3)\n}\n```", | |
"summary": "StateMinerSectorAllocated checks if a sector is allocated\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "abi.SectorNumber", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
9 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "bool", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1412" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateMinerSectorCount", | |
"description": "```go\nfunc (s *FullNodeStruct) StateMinerSectorCount(p0 context.Context, p1 address.Address, p2 types.TipSetKey) (api.MinerSectors, error) {\n\treturn s.Internal.StateMinerSectorCount(p0, p1, p2)\n}\n```", | |
"summary": "StateMinerSectorCount returns the number of sectors in a miner's sector set and proving set\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "api.MinerSectors", | |
"description": "api.MinerSectors", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Live": 42, | |
"Active": 42, | |
"Faulty": 42 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Active": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Faulty": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Live": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1416" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateMinerSectors", | |
"description": "```go\nfunc (s *FullNodeStruct) StateMinerSectors(p0 context.Context, p1 address.Address, p2 *bitfield.BitField, p3 types.TipSetKey) ([]*miner.SectorOnChainInfo, error) {\n\treturn s.Internal.StateMinerSectors(p0, p1, p2, p3)\n}\n```", | |
"summary": "StateMinerSectors returns info about the given miner's sectors. If the filter bitfield is nil, all sectors are included.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "*bitfield.BitField", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
0 | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]*miner.SectorOnChainInfo", | |
"description": "[]*miner.SectorOnChainInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Activation": { | |
"title": "number", | |
"type": "number" | |
}, | |
"DealIDs": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"type": "array" | |
}, | |
"DealWeight": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ExpectedDayReward": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ExpectedStoragePledge": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Expiration": { | |
"title": "number", | |
"type": "number" | |
}, | |
"InitialPledge": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"SealProof": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SealedCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"SectorNumber": { | |
"title": "number", | |
"type": "number" | |
}, | |
"VerifiedDealWeight": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1420" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateNetworkName", | |
"description": "```go\nfunc (s *FullNodeStruct) StateNetworkName(p0 context.Context) (dtypes.NetworkName, error) {\n\treturn s.Internal.StateNetworkName(p0)\n}\n```", | |
"summary": "StateNetworkName returns the name of the network the node is synced to\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "dtypes.NetworkName", | |
"description": "dtypes.NetworkName", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"lotus" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1424" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateNetworkVersion", | |
"description": "```go\nfunc (s *FullNodeStruct) StateNetworkVersion(p0 context.Context, p1 types.TipSetKey) (apitypes.NetworkVersion, error) {\n\treturn s.Internal.StateNetworkVersion(p0, p1)\n}\n```", | |
"summary": "StateNetworkVersion returns the network version at the given tipset\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "apitypes.NetworkVersion", | |
"description": "apitypes.NetworkVersion", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
9 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1428" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateReadState", | |
"description": "```go\nfunc (s *FullNodeStruct) StateReadState(p0 context.Context, p1 address.Address, p2 types.TipSetKey) (*api.ActorState, error) {\n\treturn s.Internal.StateReadState(p0, p1, p2)\n}\n```", | |
"summary": "StateReadState returns the indicated actor's state.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.ActorState", | |
"description": "*api.ActorState", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Balance": "0", | |
"Code": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"State": {} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Balance": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Code": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"State": { | |
"additionalProperties": true, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1432" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateReplay", | |
"description": "```go\nfunc (s *FullNodeStruct) StateReplay(p0 context.Context, p1 types.TipSetKey, p2 cid.Cid) (*api.InvocResult, error) {\n\treturn s.Internal.StateReplay(p0, p1, p2)\n}\n```", | |
"summary": "StateReplay replays a given message, assuming it was included in a block in the specified tipset.\n\nIf a tipset key is provided, and a replacing message is found on chain,\nthe method will return an error saying that the message wasn't found\n\nIf no tipset key is provided, the appropriate tipset is looked up, and if\nthe message was gas-repriced, the on-chain message will be replayed - in\nthat case the returned InvocResult.MsgCid will not match the Cid param\n\nIf the caller wants to ensure that exactly the requested message was executed,\nthey MUST check that InvocResult.MsgCid is equal to the provided Cid.\nWithout this check both the requested and original message may appear as\nsuccessfully executed on-chain, which may look like a double-spend.\n\nA replacing message is a message with a different CID, any of Gas values, and\ndifferent signature, but with all other parameters matching (source/destination,\nnonce, params, etc.)\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.InvocResult", | |
"description": "*api.InvocResult", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"MsgCid": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Msg": { | |
"Version": 42, | |
"To": "f01234", | |
"From": "f01234", | |
"Nonce": 42, | |
"Value": "0", | |
"GasLimit": 9, | |
"GasFeeCap": "0", | |
"GasPremium": "0", | |
"Method": 1, | |
"Params": "Ynl0ZSBhcnJheQ==", | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
}, | |
"MsgRct": { | |
"ExitCode": 0, | |
"Return": "Ynl0ZSBhcnJheQ==", | |
"GasUsed": 9 | |
}, | |
"GasCost": { | |
"Message": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"GasUsed": "0", | |
"BaseFeeBurn": "0", | |
"OverEstimationBurn": "0", | |
"MinerPenalty": "0", | |
"MinerTip": "0", | |
"Refund": "0", | |
"TotalCost": "0" | |
}, | |
"ExecutionTrace": { | |
"Msg": { | |
"Version": 42, | |
"To": "f01234", | |
"From": "f01234", | |
"Nonce": 42, | |
"Value": "0", | |
"GasLimit": 9, | |
"GasFeeCap": "0", | |
"GasPremium": "0", | |
"Method": 1, | |
"Params": "Ynl0ZSBhcnJheQ==", | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
}, | |
"MsgRct": { | |
"ExitCode": 0, | |
"Return": "Ynl0ZSBhcnJheQ==", | |
"GasUsed": 9 | |
}, | |
"Error": "string value", | |
"Duration": 60000000000, | |
"GasCharges": null, | |
"Subcalls": null | |
}, | |
"Error": "string value", | |
"Duration": 60000000000 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Duration": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Error": { | |
"type": "string" | |
}, | |
"ExecutionTrace": { | |
"additionalProperties": false, | |
"properties": { | |
"Duration": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Error": { | |
"type": "string" | |
}, | |
"GasCharges": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Name": { | |
"type": "string" | |
}, | |
"cg": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ex": { | |
"additionalProperties": true, | |
"type": "object" | |
}, | |
"loc": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"File": { | |
"type": "string" | |
}, | |
"Function": { | |
"type": "string" | |
}, | |
"Line": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"sg": { | |
"title": "number", | |
"type": "number" | |
}, | |
"tg": { | |
"title": "number", | |
"type": "number" | |
}, | |
"tt": { | |
"title": "number", | |
"type": "number" | |
}, | |
"vcg": { | |
"title": "number", | |
"type": "number" | |
}, | |
"vsg": { | |
"title": "number", | |
"type": "number" | |
}, | |
"vtg": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"Msg": { | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"MsgRct": { | |
"additionalProperties": false, | |
"properties": { | |
"ExitCode": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasUsed": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Return": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"Subcalls": { | |
"items": {}, | |
"type": "array" | |
} | |
}, | |
"type": "object" | |
}, | |
"GasCost": { | |
"additionalProperties": false, | |
"properties": { | |
"BaseFeeBurn": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasUsed": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Message": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"MinerPenalty": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"MinerTip": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"OverEstimationBurn": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Refund": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"TotalCost": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": "object" | |
}, | |
"Msg": { | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"MsgCid": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"MsgRct": { | |
"additionalProperties": false, | |
"properties": { | |
"ExitCode": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasUsed": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Return": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1436" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateSearchMsg", | |
"description": "```go\nfunc (s *FullNodeStruct) StateSearchMsg(p0 context.Context, p1 cid.Cid) (*api.MsgLookup, error) {\n\treturn s.Internal.StateSearchMsg(p0, p1)\n}\n```", | |
"summary": "StateSearchMsg searches for a message in the chain, and returns its receipt and the tipset where it was executed\n\nNOTE: If a replacing message is found on chain, this method will return\na MsgLookup for the replacing message - the MsgLookup.Message will be a different\nCID than the one provided in the 'cid' param, MsgLookup.Receipt will contain the\nresult of the execution of the replacing message.\n\nIf the caller wants to ensure that exactly the requested message was executed,\nthey MUST check that MsgLookup.Message is equal to the provided 'cid'.\nWithout this check both the requested and original message may appear as\nsuccessfully executed on-chain, which may look like a double-spend.\n\nA replacing message is a message with a different CID, any of Gas values, and\ndifferent signature, but with all other parameters matching (source/destination,\nnonce, params, etc.)\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.MsgLookup", | |
"description": "*api.MsgLookup", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Message": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Receipt": { | |
"ExitCode": 0, | |
"Return": "Ynl0ZSBhcnJheQ==", | |
"GasUsed": 9 | |
}, | |
"ReturnDec": {}, | |
"TipSet": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
], | |
"Height": 10101 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Height": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Message": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Receipt": { | |
"additionalProperties": false, | |
"properties": { | |
"ExitCode": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasUsed": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Return": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"ReturnDec": { | |
"additionalProperties": true, | |
"type": "object" | |
}, | |
"TipSet": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1440" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateSearchMsgLimited", | |
"description": "```go\nfunc (s *FullNodeStruct) StateSearchMsgLimited(p0 context.Context, p1 cid.Cid, p2 abi.ChainEpoch) (*api.MsgLookup, error) {\n\treturn s.Internal.StateSearchMsgLimited(p0, p1, p2)\n}\n```", | |
"summary": "StateSearchMsgLimited looks back up to limit epochs in the chain for a message, and returns its receipt and the tipset where it was executed\n\nNOTE: If a replacing message is found on chain, this method will return\na MsgLookup for the replacing message - the MsgLookup.Message will be a different\nCID than the one provided in the 'cid' param, MsgLookup.Receipt will contain the\nresult of the execution of the replacing message.\n\nIf the caller wants to ensure that exactly the requested message was executed,\nthey MUST check that MsgLookup.Message is equal to the provided 'cid'.\nWithout this check both the requested and original message may appear as\nsuccessfully executed on-chain, which may look like a double-spend.\n\nA replacing message is a message with a different CID, any of Gas values, and\ndifferent signature, but with all other parameters matching (source/destination,\nnonce, params, etc.)\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "abi.ChainEpoch", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
10101 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.MsgLookup", | |
"description": "*api.MsgLookup", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Message": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Receipt": { | |
"ExitCode": 0, | |
"Return": "Ynl0ZSBhcnJheQ==", | |
"GasUsed": 9 | |
}, | |
"ReturnDec": {}, | |
"TipSet": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
], | |
"Height": 10101 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Height": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Message": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Receipt": { | |
"additionalProperties": false, | |
"properties": { | |
"ExitCode": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasUsed": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Return": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"ReturnDec": { | |
"additionalProperties": true, | |
"type": "object" | |
}, | |
"TipSet": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1444" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateSectorExpiration", | |
"description": "```go\nfunc (s *FullNodeStruct) StateSectorExpiration(p0 context.Context, p1 address.Address, p2 abi.SectorNumber, p3 types.TipSetKey) (*miner.SectorExpiration, error) {\n\treturn s.Internal.StateSectorExpiration(p0, p1, p2, p3)\n}\n```", | |
"summary": "StateSectorExpiration returns epoch at which given sector will expire\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "abi.SectorNumber", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
9 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*miner.SectorExpiration", | |
"description": "*miner.SectorExpiration", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"OnTime": 10101, | |
"Early": 10101 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Early": { | |
"title": "number", | |
"type": "number" | |
}, | |
"OnTime": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1448" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateSectorGetInfo", | |
"description": "```go\nfunc (s *FullNodeStruct) StateSectorGetInfo(p0 context.Context, p1 address.Address, p2 abi.SectorNumber, p3 types.TipSetKey) (*miner.SectorOnChainInfo, error) {\n\treturn s.Internal.StateSectorGetInfo(p0, p1, p2, p3)\n}\n```", | |
"summary": "StateSectorGetInfo returns the on-chain info for the specified miner's sector. Returns null in case the sector info isn't found\nNOTE: returned info.Expiration may not be accurate in some cases, use StateSectorExpiration to get accurate\nexpiration epoch\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "abi.SectorNumber", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
9 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*miner.SectorOnChainInfo", | |
"description": "*miner.SectorOnChainInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"SectorNumber": 9, | |
"SealProof": 8, | |
"SealedCID": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"DealIDs": null, | |
"Activation": 10101, | |
"Expiration": 10101, | |
"DealWeight": "0", | |
"VerifiedDealWeight": "0", | |
"InitialPledge": "0", | |
"ExpectedDayReward": "0", | |
"ExpectedStoragePledge": "0" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Activation": { | |
"title": "number", | |
"type": "number" | |
}, | |
"DealIDs": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"type": "array" | |
}, | |
"DealWeight": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ExpectedDayReward": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ExpectedStoragePledge": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Expiration": { | |
"title": "number", | |
"type": "number" | |
}, | |
"InitialPledge": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"SealProof": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SealedCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"SectorNumber": { | |
"title": "number", | |
"type": "number" | |
}, | |
"VerifiedDealWeight": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1452" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateSectorPartition", | |
"description": "```go\nfunc (s *FullNodeStruct) StateSectorPartition(p0 context.Context, p1 address.Address, p2 abi.SectorNumber, p3 types.TipSetKey) (*miner.SectorLocation, error) {\n\treturn s.Internal.StateSectorPartition(p0, p1, p2, p3)\n}\n```", | |
"summary": "StateSectorPartition finds deadline/partition with the specified sector\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "abi.SectorNumber", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
9 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*miner.SectorLocation", | |
"description": "*miner.SectorLocation", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Deadline": 42, | |
"Partition": 42 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Deadline": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Partition": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1456" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateSectorPreCommitInfo", | |
"description": "```go\nfunc (s *FullNodeStruct) StateSectorPreCommitInfo(p0 context.Context, p1 address.Address, p2 abi.SectorNumber, p3 types.TipSetKey) (miner.SectorPreCommitOnChainInfo, error) {\n\treturn s.Internal.StateSectorPreCommitInfo(p0, p1, p2, p3)\n}\n```", | |
"summary": "StateSectorPreCommitInfo returns the PreCommit info for the specified miner's sector\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "abi.SectorNumber", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
9 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "miner.SectorPreCommitOnChainInfo", | |
"description": "miner.SectorPreCommitOnChainInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Info": { | |
"SealProof": 8, | |
"SectorNumber": 9, | |
"SealedCID": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"SealRandEpoch": 10101, | |
"DealIDs": null, | |
"Expiration": 10101, | |
"ReplaceCapacity": true, | |
"ReplaceSectorDeadline": 42, | |
"ReplaceSectorPartition": 42, | |
"ReplaceSectorNumber": 9 | |
}, | |
"PreCommitDeposit": "0", | |
"PreCommitEpoch": 10101, | |
"DealWeight": "0", | |
"VerifiedDealWeight": "0" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"DealWeight": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Info": { | |
"additionalProperties": false, | |
"properties": { | |
"DealIDs": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"type": "array" | |
}, | |
"Expiration": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ReplaceCapacity": { | |
"type": "boolean" | |
}, | |
"ReplaceSectorDeadline": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ReplaceSectorNumber": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ReplaceSectorPartition": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SealProof": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SealRandEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SealedCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"SectorNumber": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"PreCommitDeposit": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"PreCommitEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"VerifiedDealWeight": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1460" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateVMCirculatingSupplyInternal", | |
"description": "```go\nfunc (s *FullNodeStruct) StateVMCirculatingSupplyInternal(p0 context.Context, p1 types.TipSetKey) (api.CirculatingSupply, error) {\n\treturn s.Internal.StateVMCirculatingSupplyInternal(p0, p1)\n}\n```", | |
"summary": "StateVMCirculatingSupplyInternal returns an approximation of the circulating supply of Filecoin at the given tipset.\nThis is the value reported by the runtime interface to actors code.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "api.CirculatingSupply", | |
"description": "api.CirculatingSupply", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"FilVested": "0", | |
"FilMined": "0", | |
"FilBurnt": "0", | |
"FilLocked": "0", | |
"FilCirculating": "0" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"FilBurnt": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"FilCirculating": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"FilLocked": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"FilMined": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"FilVested": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1464" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateVerifiedClientStatus", | |
"description": "```go\nfunc (s *FullNodeStruct) StateVerifiedClientStatus(p0 context.Context, p1 address.Address, p2 types.TipSetKey) (*abi.StoragePower, error) {\n\treturn s.Internal.StateVerifiedClientStatus(p0, p1, p2)\n}\n```", | |
"summary": "StateVerifiedClientStatus returns the data cap for the given address.\nReturns nil if there is no entry in the data cap table for the\naddress.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*abi.StoragePower", | |
"description": "*abi.StoragePower", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1468" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateVerifiedRegistryRootKey", | |
"description": "```go\nfunc (s *FullNodeStruct) StateVerifiedRegistryRootKey(p0 context.Context, p1 types.TipSetKey) (address.Address, error) {\n\treturn s.Internal.StateVerifiedRegistryRootKey(p0, p1)\n}\n```", | |
"summary": "StateVerifiedClientStatus returns the address of the Verified Registry's root key\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "address.Address", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1472" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateVerifierStatus", | |
"description": "```go\nfunc (s *FullNodeStruct) StateVerifierStatus(p0 context.Context, p1 address.Address, p2 types.TipSetKey) (*abi.StoragePower, error) {\n\treturn s.Internal.StateVerifierStatus(p0, p1, p2)\n}\n```", | |
"summary": "StateVerifierStatus returns the data cap for the given address.\nReturns nil if there is no entry in the data cap table for the\naddress.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*abi.StoragePower", | |
"description": "*abi.StoragePower", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1476" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateWaitMsg", | |
"description": "```go\nfunc (s *FullNodeStruct) StateWaitMsg(p0 context.Context, p1 cid.Cid, p2 uint64) (*api.MsgLookup, error) {\n\treturn s.Internal.StateWaitMsg(p0, p1, p2)\n}\n```", | |
"summary": "StateWaitMsg looks back in the chain for a message. If not found, it blocks until the\nmessage arrives on chain, and gets to the indicated confidence depth.\n\nNOTE: If a replacing message is found on chain, this method will return\na MsgLookup for the replacing message - the MsgLookup.Message will be a different\nCID than the one provided in the 'cid' param, MsgLookup.Receipt will contain the\nresult of the execution of the replacing message.\n\nIf the caller wants to ensure that exactly the requested message was executed,\nthey MUST check that MsgLookup.Message is equal to the provided 'cid'.\nWithout this check both the requested and original message may appear as\nsuccessfully executed on-chain, which may look like a double-spend.\n\nA replacing message is a message with a different CID, any of Gas values, and\ndifferent signature, but with all other parameters matching (source/destination,\nnonce, params, etc.)\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.MsgLookup", | |
"description": "*api.MsgLookup", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Message": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Receipt": { | |
"ExitCode": 0, | |
"Return": "Ynl0ZSBhcnJheQ==", | |
"GasUsed": 9 | |
}, | |
"ReturnDec": {}, | |
"TipSet": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
], | |
"Height": 10101 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Height": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Message": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Receipt": { | |
"additionalProperties": false, | |
"properties": { | |
"ExitCode": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasUsed": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Return": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"ReturnDec": { | |
"additionalProperties": true, | |
"type": "object" | |
}, | |
"TipSet": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1480" | |
} | |
}, | |
{ | |
"name": "Filecoin.StateWaitMsgLimited", | |
"description": "```go\nfunc (s *FullNodeStruct) StateWaitMsgLimited(p0 context.Context, p1 cid.Cid, p2 uint64, p3 abi.ChainEpoch) (*api.MsgLookup, error) {\n\treturn s.Internal.StateWaitMsgLimited(p0, p1, p2, p3)\n}\n```", | |
"summary": "StateWaitMsgLimited looks back up to limit epochs in the chain for a message.\nIf not found, it blocks until the message arrives on chain, and gets to the\nindicated confidence depth.\n\nNOTE: If a replacing message is found on chain, this method will return\na MsgLookup for the replacing message - the MsgLookup.Message will be a different\nCID than the one provided in the 'cid' param, MsgLookup.Receipt will contain the\nresult of the execution of the replacing message.\n\nIf the caller wants to ensure that exactly the requested message was executed,\nthey MUST check that MsgLookup.Message is equal to the provided 'cid'.\nWithout this check both the requested and original message may appear as\nsuccessfully executed on-chain, which may look like a double-spend.\n\nA replacing message is a message with a different CID, any of Gas values, and\ndifferent signature, but with all other parameters matching (source/destination,\nnonce, params, etc.)\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "uint64", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
42 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "abi.ChainEpoch", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
10101 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*api.MsgLookup", | |
"description": "*api.MsgLookup", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Message": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Receipt": { | |
"ExitCode": 0, | |
"Return": "Ynl0ZSBhcnJheQ==", | |
"GasUsed": 9 | |
}, | |
"ReturnDec": {}, | |
"TipSet": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
], | |
"Height": 10101 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Height": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Message": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Receipt": { | |
"additionalProperties": false, | |
"properties": { | |
"ExitCode": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasUsed": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Return": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"ReturnDec": { | |
"additionalProperties": true, | |
"type": "object" | |
}, | |
"TipSet": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1484" | |
} | |
}, | |
{ | |
"name": "Filecoin.SyncCheckBad", | |
"description": "```go\nfunc (s *FullNodeStruct) SyncCheckBad(p0 context.Context, p1 cid.Cid) (string, error) {\n\treturn s.Internal.SyncCheckBad(p0, p1)\n}\n```", | |
"summary": "SyncCheckBad checks if a block was marked as bad, and if it was, returns\nthe reason.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "string", | |
"description": "string", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"string value" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1488" | |
} | |
}, | |
{ | |
"name": "Filecoin.SyncCheckpoint", | |
"description": "```go\nfunc (s *FullNodeStruct) SyncCheckpoint(p0 context.Context, p1 types.TipSetKey) error {\n\treturn s.Internal.SyncCheckpoint(p0, p1)\n}\n```", | |
"summary": "SyncCheckpoint marks a blocks as checkpointed, meaning that it won't ever fork away from it.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1492" | |
} | |
}, | |
{ | |
"name": "Filecoin.SyncMarkBad", | |
"description": "```go\nfunc (s *FullNodeStruct) SyncMarkBad(p0 context.Context, p1 cid.Cid) error {\n\treturn s.Internal.SyncMarkBad(p0, p1)\n}\n```", | |
"summary": "SyncMarkBad marks a blocks as bad, meaning that it won't ever by synced.\nUse with extreme caution.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1500" | |
} | |
}, | |
{ | |
"name": "Filecoin.SyncState", | |
"description": "```go\nfunc (s *FullNodeStruct) SyncState(p0 context.Context) (*api.SyncState, error) {\n\treturn s.Internal.SyncState(p0)\n}\n```", | |
"summary": "SyncState returns the current status of the lotus sync system.\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "*api.SyncState", | |
"description": "*api.SyncState", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ActiveSyncs": null, | |
"VMApplied": 42 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ActiveSyncs": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Base": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"End": { | |
"format": "date-time", | |
"type": "string" | |
}, | |
"Height": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Message": { | |
"type": "string" | |
}, | |
"Stage": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Start": { | |
"format": "date-time", | |
"type": "string" | |
}, | |
"Target": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"WorkerID": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"VMApplied": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1504" | |
} | |
}, | |
{ | |
"name": "Filecoin.SyncSubmitBlock", | |
"description": "```go\nfunc (s *FullNodeStruct) SyncSubmitBlock(p0 context.Context, p1 *types.BlockMsg) error {\n\treturn s.Internal.SyncSubmitBlock(p0, p1)\n}\n```", | |
"summary": "SyncSubmitBlock can be used to submit a newly created block to the.\nnetwork through this node\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "*types.BlockMsg", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Header": { | |
"Miner": "f01234", | |
"Ticket": { | |
"VRFProof": "Ynl0ZSBhcnJheQ==" | |
}, | |
"ElectionProof": { | |
"WinCount": 9, | |
"VRFProof": "Ynl0ZSBhcnJheQ==" | |
}, | |
"BeaconEntries": null, | |
"WinPoStProof": null, | |
"Parents": null, | |
"ParentWeight": "0", | |
"Height": 10101, | |
"ParentStateRoot": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"ParentMessageReceipts": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Messages": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"BLSAggregate": { | |
"Type": 2, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
}, | |
"Timestamp": 42, | |
"BlockSig": { | |
"Type": 2, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
}, | |
"ForkSignaling": 42, | |
"ParentBaseFee": "0" | |
}, | |
"BlsMessages": null, | |
"SecpkMessages": null | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"BlsMessages": { | |
"items": { | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"type": "array" | |
}, | |
"Header": { | |
"additionalProperties": false, | |
"properties": { | |
"BLSAggregate": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"BeaconEntries": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Round": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"BlockSig": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"ElectionProof": { | |
"additionalProperties": false, | |
"properties": { | |
"VRFProof": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"WinCount": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"ForkSignaling": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Height": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Messages": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Miner": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ParentBaseFee": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ParentMessageReceipts": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"ParentStateRoot": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"ParentWeight": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Parents": { | |
"items": { | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"type": "array" | |
}, | |
"Ticket": { | |
"additionalProperties": false, | |
"properties": { | |
"VRFProof": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"Timestamp": { | |
"title": "number", | |
"type": "number" | |
}, | |
"WinPoStProof": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"PoStProof": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ProofBytes": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
} | |
}, | |
"type": "object" | |
}, | |
"SecpkMessages": { | |
"items": { | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"type": "array" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1508" | |
} | |
}, | |
{ | |
"name": "Filecoin.SyncUnmarkAllBad", | |
"description": "```go\nfunc (s *FullNodeStruct) SyncUnmarkAllBad(p0 context.Context) error {\n\treturn s.Internal.SyncUnmarkAllBad(p0)\n}\n```", | |
"summary": "SyncUnmarkAllBad purges bad block cache, making it possible to sync to chains previously marked as bad\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1512" | |
} | |
}, | |
{ | |
"name": "Filecoin.SyncUnmarkBad", | |
"description": "```go\nfunc (s *FullNodeStruct) SyncUnmarkBad(p0 context.Context, p1 cid.Cid) error {\n\treturn s.Internal.SyncUnmarkBad(p0, p1)\n}\n```", | |
"summary": "SyncUnmarkBad unmarks a blocks as bad, making it possible to be validated and synced again.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1516" | |
} | |
}, | |
{ | |
"name": "Filecoin.SyncValidateTipset", | |
"description": "```go\nfunc (s *FullNodeStruct) SyncValidateTipset(p0 context.Context, p1 types.TipSetKey) (bool, error) {\n\treturn s.Internal.SyncValidateTipset(p0, p1)\n}\n```", | |
"summary": "SyncValidateTipset indicates whether the provided tipset is valid or not\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.TipSetKey", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
{ | |
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve" | |
} | |
] | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "bool", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1520" | |
} | |
}, | |
{ | |
"name": "Filecoin.WalletBalance", | |
"description": "```go\nfunc (s *FullNodeStruct) WalletBalance(p0 context.Context, p1 address.Address) (types.BigInt, error) {\n\treturn s.Internal.WalletBalance(p0, p1)\n}\n```", | |
"summary": "WalletBalance returns the balance of the given address at the current head of the chain.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "types.BigInt", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1524" | |
} | |
}, | |
{ | |
"name": "Filecoin.WalletDefaultAddress", | |
"description": "```go\nfunc (s *FullNodeStruct) WalletDefaultAddress(p0 context.Context) (address.Address, error) {\n\treturn s.Internal.WalletDefaultAddress(p0)\n}\n```", | |
"summary": "WalletDefaultAddress returns the address marked as default in the wallet.\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "address.Address", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1528" | |
} | |
}, | |
{ | |
"name": "Filecoin.WalletDelete", | |
"description": "```go\nfunc (s *FullNodeStruct) WalletDelete(p0 context.Context, p1 address.Address) error {\n\treturn s.Internal.WalletDelete(p0, p1)\n}\n```", | |
"summary": "WalletDelete deletes an address from the wallet.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1532" | |
} | |
}, | |
{ | |
"name": "Filecoin.WalletExport", | |
"description": "```go\nfunc (s *FullNodeStruct) WalletExport(p0 context.Context, p1 address.Address) (*types.KeyInfo, error) {\n\treturn s.Internal.WalletExport(p0, p1)\n}\n```", | |
"summary": "WalletExport returns the private key of an address in the wallet.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*types.KeyInfo", | |
"description": "*types.KeyInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Type": "bls", | |
"PrivateKey": "Ynl0ZSBhcnJheQ==" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"PrivateKey": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1536" | |
} | |
}, | |
{ | |
"name": "Filecoin.WalletHas", | |
"description": "```go\nfunc (s *FullNodeStruct) WalletHas(p0 context.Context, p1 address.Address) (bool, error) {\n\treturn s.Internal.WalletHas(p0, p1)\n}\n```", | |
"summary": "WalletHas indicates whether the given address is in the wallet.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "bool", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1540" | |
} | |
}, | |
{ | |
"name": "Filecoin.WalletImport", | |
"description": "```go\nfunc (s *FullNodeStruct) WalletImport(p0 context.Context, p1 *types.KeyInfo) (address.Address, error) {\n\treturn s.Internal.WalletImport(p0, p1)\n}\n```", | |
"summary": "WalletImport receives a KeyInfo, which includes a private key, and imports it into the wallet.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "*types.KeyInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Type": "bls", | |
"PrivateKey": "Ynl0ZSBhcnJheQ==" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"PrivateKey": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "address.Address", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1544" | |
} | |
}, | |
{ | |
"name": "Filecoin.WalletList", | |
"description": "```go\nfunc (s *FullNodeStruct) WalletList(p0 context.Context) ([]address.Address, error) {\n\treturn s.Internal.WalletList(p0)\n}\n```", | |
"summary": "WalletList lists all the addresses in the wallet.\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "[]address.Address", | |
"description": "[]address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1548" | |
} | |
}, | |
{ | |
"name": "Filecoin.WalletNew", | |
"description": "```go\nfunc (s *FullNodeStruct) WalletNew(p0 context.Context, p1 types.KeyType) (address.Address, error) {\n\treturn s.Internal.WalletNew(p0, p1)\n}\n```", | |
"summary": "WalletNew creates a new address in the wallet with the given sigType.\nAvailable key types: bls, secp256k1, secp256k1-ledger\nSupport for numerical types: 1 - secp256k1, 2 - BLS is deprecated\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.KeyType", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"bls" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "address.Address", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1552" | |
} | |
}, | |
{ | |
"name": "Filecoin.WalletSetDefault", | |
"description": "```go\nfunc (s *FullNodeStruct) WalletSetDefault(p0 context.Context, p1 address.Address) error {\n\treturn s.Internal.WalletSetDefault(p0, p1)\n}\n```", | |
"summary": "WalletSetDefault marks the given address as as the default one.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1556" | |
} | |
}, | |
{ | |
"name": "Filecoin.WalletSign", | |
"description": "```go\nfunc (s *FullNodeStruct) WalletSign(p0 context.Context, p1 address.Address, p2 []byte) (*crypto.Signature, error) {\n\treturn s.Internal.WalletSign(p0, p1, p2)\n}\n```", | |
"summary": "WalletSign signs the given bytes using the given address.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "[]byte", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"Ynl0ZSBhcnJheQ==" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*crypto.Signature", | |
"description": "*crypto.Signature", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Type": 2, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1560" | |
} | |
}, | |
{ | |
"name": "Filecoin.WalletSignMessage", | |
"description": "```go\nfunc (s *FullNodeStruct) WalletSignMessage(p0 context.Context, p1 address.Address, p2 *types.Message) (*types.SignedMessage, error) {\n\treturn s.Internal.WalletSignMessage(p0, p1, p2)\n}\n```", | |
"summary": "WalletSignMessage signs the given message using the given address.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "*types.Message", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Version": 42, | |
"To": "f01234", | |
"From": "f01234", | |
"Nonce": 42, | |
"Value": "0", | |
"GasLimit": 9, | |
"GasFeeCap": "0", | |
"GasPremium": "0", | |
"Method": 1, | |
"Params": "Ynl0ZSBhcnJheQ==", | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*types.SignedMessage", | |
"description": "*types.SignedMessage", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Message": { | |
"Version": 42, | |
"To": "f01234", | |
"From": "f01234", | |
"Nonce": 42, | |
"Value": "0", | |
"GasLimit": 9, | |
"GasFeeCap": "0", | |
"GasPremium": "0", | |
"Method": 1, | |
"Params": "Ynl0ZSBhcnJheQ==", | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
}, | |
"Signature": { | |
"Type": 2, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
}, | |
"CID": { | |
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Message": { | |
"additionalProperties": false, | |
"properties": { | |
"From": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasFeeCap": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"GasLimit": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GasPremium": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Method": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Nonce": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Params": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"To": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Value": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Version": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1564" | |
} | |
}, | |
{ | |
"name": "Filecoin.WalletValidateAddress", | |
"description": "```go\nfunc (s *FullNodeStruct) WalletValidateAddress(p0 context.Context, p1 string) (address.Address, error) {\n\treturn s.Internal.WalletValidateAddress(p0, p1)\n}\n```", | |
"summary": "WalletValidateAddress validates whether a given string can be decoded as a well-formed address\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "string", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"string value" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "address.Address", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1568" | |
} | |
}, | |
{ | |
"name": "Filecoin.WalletVerify", | |
"description": "```go\nfunc (s *FullNodeStruct) WalletVerify(p0 context.Context, p1 address.Address, p2 []byte, p3 *crypto.Signature) (bool, error) {\n\treturn s.Internal.WalletVerify(p0, p1, p2, p3)\n}\n```", | |
"summary": "WalletVerify takes an address, a signature, and some bytes, and indicates whether the signature is valid.\nThe address does not have to be in the wallet.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "[]byte", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"Ynl0ZSBhcnJheQ==" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "*crypto.Signature", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Type": 2, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "bool", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1572" | |
} | |
} | |
] | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"openrpc": "1.2.6", | |
"info": { | |
"title": "Lotus RPC API", | |
"version": "1.7.0-dev" | |
}, | |
"methods": [ | |
{ | |
"name": "Filecoin.ActorAddress", | |
"description": "```go\nfunc (s *StorageMinerStruct) ActorAddress(p0 context.Context) (address.Address, error) {\n\treturn s.Internal.ActorAddress(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "address.Address", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1696" | |
} | |
}, | |
{ | |
"name": "Filecoin.ActorAddressConfig", | |
"description": "```go\nfunc (s *StorageMinerStruct) ActorAddressConfig(p0 context.Context) (api.AddressConfig, error) {\n\treturn s.Internal.ActorAddressConfig(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "api.AddressConfig", | |
"description": "api.AddressConfig", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"PreCommitControl": null, | |
"CommitControl": null, | |
"TerminateControl": null, | |
"DisableOwnerFallback": true, | |
"DisableWorkerFallback": true | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"CommitControl": { | |
"items": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"DisableOwnerFallback": { | |
"type": "boolean" | |
}, | |
"DisableWorkerFallback": { | |
"type": "boolean" | |
}, | |
"PreCommitControl": { | |
"items": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"TerminateControl": { | |
"items": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"type": "array" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1700" | |
} | |
}, | |
{ | |
"name": "Filecoin.ActorSectorSize", | |
"description": "```go\nfunc (s *StorageMinerStruct) ActorSectorSize(p0 context.Context, p1 address.Address) (abi.SectorSize, error) {\n\treturn s.Internal.ActorSectorSize(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "address.Address", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"f01234" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "abi.SectorSize", | |
"description": "abi.SectorSize", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
34359738368 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1704" | |
} | |
}, | |
{ | |
"name": "Filecoin.CheckProvable", | |
"description": "```go\nfunc (s *StorageMinerStruct) CheckProvable(p0 context.Context, p1 abi.RegisteredPoStProof, p2 []storage.SectorRef, p3 bool) (map[abi.SectorNumber]string, error) {\n\treturn s.Internal.CheckProvable(p0, p1, p2, p3)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "abi.RegisteredPoStProof", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
8 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "[]storage.SectorRef", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"ProofType": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "map[abi.SectorNumber]string", | |
"description": "map[abi.SectorNumber]string", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"123": "can't acquire read lock" | |
} | |
], | |
"patternProperties": { | |
".*": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1708" | |
} | |
}, | |
{ | |
"name": "Filecoin.ComputeProof", | |
"description": "```go\nfunc (s *StorageMinerStruct) ComputeProof(p0 context.Context, p1 []builtin.SectorInfo, p2 abi.PoStRandomness) ([]builtin.PoStProof, error) {\n\treturn s.Internal.ComputeProof(p0, p1, p2)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "[]builtin.SectorInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"SealProof": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SealedCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"SectorNumber": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "abi.PoStRandomness", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "number", | |
"description": "Number is a number", | |
"type": [ | |
"number" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]builtin.PoStProof", | |
"description": "[]builtin.PoStProof", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"PoStProof": { | |
"title": "number", | |
"type": "number" | |
}, | |
"ProofBytes": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1712" | |
} | |
}, | |
{ | |
"name": "Filecoin.CreateBackup", | |
"description": "```go\nfunc (s *StorageMinerStruct) CreateBackup(p0 context.Context, p1 string) error {\n\treturn s.Internal.CreateBackup(p0, p1)\n}\n```", | |
"summary": "CreateBackup creates node backup onder the specified file name. The\nmethod requires that the lotus-miner is running with the\nLOTUS_BACKUP_BASE_PATH environment variable set to some path, and that\nthe path specified when calling CreateBackup is within the base path\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "string", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"string value" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1716" | |
} | |
}, | |
{ | |
"name": "Filecoin.DealsConsiderOfflineRetrievalDeals", | |
"description": "```go\nfunc (s *StorageMinerStruct) DealsConsiderOfflineRetrievalDeals(p0 context.Context) (bool, error) {\n\treturn s.Internal.DealsConsiderOfflineRetrievalDeals(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "bool", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1720" | |
} | |
}, | |
{ | |
"name": "Filecoin.DealsConsiderOfflineStorageDeals", | |
"description": "```go\nfunc (s *StorageMinerStruct) DealsConsiderOfflineStorageDeals(p0 context.Context) (bool, error) {\n\treturn s.Internal.DealsConsiderOfflineStorageDeals(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "bool", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1724" | |
} | |
}, | |
{ | |
"name": "Filecoin.DealsConsiderOnlineRetrievalDeals", | |
"description": "```go\nfunc (s *StorageMinerStruct) DealsConsiderOnlineRetrievalDeals(p0 context.Context) (bool, error) {\n\treturn s.Internal.DealsConsiderOnlineRetrievalDeals(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "bool", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1728" | |
} | |
}, | |
{ | |
"name": "Filecoin.DealsConsiderOnlineStorageDeals", | |
"description": "```go\nfunc (s *StorageMinerStruct) DealsConsiderOnlineStorageDeals(p0 context.Context) (bool, error) {\n\treturn s.Internal.DealsConsiderOnlineStorageDeals(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "bool", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1732" | |
} | |
}, | |
{ | |
"name": "Filecoin.DealsConsiderUnverifiedStorageDeals", | |
"description": "```go\nfunc (s *StorageMinerStruct) DealsConsiderUnverifiedStorageDeals(p0 context.Context) (bool, error) {\n\treturn s.Internal.DealsConsiderUnverifiedStorageDeals(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "bool", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1736" | |
} | |
}, | |
{ | |
"name": "Filecoin.DealsConsiderVerifiedStorageDeals", | |
"description": "```go\nfunc (s *StorageMinerStruct) DealsConsiderVerifiedStorageDeals(p0 context.Context) (bool, error) {\n\treturn s.Internal.DealsConsiderVerifiedStorageDeals(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "bool", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1740" | |
} | |
}, | |
{ | |
"name": "Filecoin.DealsImportData", | |
"description": "```go\nfunc (s *StorageMinerStruct) DealsImportData(p0 context.Context, p1 cid.Cid, p2 string) error {\n\treturn s.Internal.DealsImportData(p0, p1, p2)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "string", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"string value" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1744" | |
} | |
}, | |
{ | |
"name": "Filecoin.DealsList", | |
"description": "```go\nfunc (s *StorageMinerStruct) DealsList(p0 context.Context) ([]api.MarketDeal, error) {\n\treturn s.Internal.DealsList(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "[]api.MarketDeal", | |
"description": "[]api.MarketDeal", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Proposal": { | |
"additionalProperties": false, | |
"properties": { | |
"Client": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ClientCollateral": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"EndEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Label": { | |
"type": "string" | |
}, | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"PieceSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Provider": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ProviderCollateral": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"StartEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"StoragePricePerEpoch": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"VerifiedDeal": { | |
"type": "boolean" | |
} | |
}, | |
"type": "object" | |
}, | |
"State": { | |
"additionalProperties": false, | |
"properties": { | |
"LastUpdatedEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SectorStartEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SlashEpoch": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1748" | |
} | |
}, | |
{ | |
"name": "Filecoin.DealsPieceCidBlocklist", | |
"description": "```go\nfunc (s *StorageMinerStruct) DealsPieceCidBlocklist(p0 context.Context) ([]cid.Cid, error) {\n\treturn s.Internal.DealsPieceCidBlocklist(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "[]cid.Cid", | |
"description": "[]cid.Cid", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"type": [ | |
"string" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1752" | |
} | |
}, | |
{ | |
"name": "Filecoin.DealsSetConsiderOfflineRetrievalDeals", | |
"description": "```go\nfunc (s *StorageMinerStruct) DealsSetConsiderOfflineRetrievalDeals(p0 context.Context, p1 bool) error {\n\treturn s.Internal.DealsSetConsiderOfflineRetrievalDeals(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1756" | |
} | |
}, | |
{ | |
"name": "Filecoin.DealsSetConsiderOfflineStorageDeals", | |
"description": "```go\nfunc (s *StorageMinerStruct) DealsSetConsiderOfflineStorageDeals(p0 context.Context, p1 bool) error {\n\treturn s.Internal.DealsSetConsiderOfflineStorageDeals(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1760" | |
} | |
}, | |
{ | |
"name": "Filecoin.DealsSetConsiderOnlineRetrievalDeals", | |
"description": "```go\nfunc (s *StorageMinerStruct) DealsSetConsiderOnlineRetrievalDeals(p0 context.Context, p1 bool) error {\n\treturn s.Internal.DealsSetConsiderOnlineRetrievalDeals(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1764" | |
} | |
}, | |
{ | |
"name": "Filecoin.DealsSetConsiderOnlineStorageDeals", | |
"description": "```go\nfunc (s *StorageMinerStruct) DealsSetConsiderOnlineStorageDeals(p0 context.Context, p1 bool) error {\n\treturn s.Internal.DealsSetConsiderOnlineStorageDeals(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1768" | |
} | |
}, | |
{ | |
"name": "Filecoin.DealsSetConsiderUnverifiedStorageDeals", | |
"description": "```go\nfunc (s *StorageMinerStruct) DealsSetConsiderUnverifiedStorageDeals(p0 context.Context, p1 bool) error {\n\treturn s.Internal.DealsSetConsiderUnverifiedStorageDeals(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1772" | |
} | |
}, | |
{ | |
"name": "Filecoin.DealsSetConsiderVerifiedStorageDeals", | |
"description": "```go\nfunc (s *StorageMinerStruct) DealsSetConsiderVerifiedStorageDeals(p0 context.Context, p1 bool) error {\n\treturn s.Internal.DealsSetConsiderVerifiedStorageDeals(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1776" | |
} | |
}, | |
{ | |
"name": "Filecoin.DealsSetPieceCidBlocklist", | |
"description": "```go\nfunc (s *StorageMinerStruct) DealsSetPieceCidBlocklist(p0 context.Context, p1 []cid.Cid) error {\n\treturn s.Internal.DealsSetPieceCidBlocklist(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "[]cid.Cid", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"type": [ | |
"string" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1780" | |
} | |
}, | |
{ | |
"name": "Filecoin.MarketCancelDataTransfer", | |
"description": "```go\nfunc (s *StorageMinerStruct) MarketCancelDataTransfer(p0 context.Context, p1 datatransfer.TransferID, p2 peer.ID, p3 bool) error {\n\treturn s.Internal.MarketCancelDataTransfer(p0, p1, p2, p3)\n}\n```", | |
"summary": "MarketCancelDataTransfer cancels a data transfer with the given transfer ID and other peer\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "datatransfer.TransferID", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
3 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "peer.ID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1784" | |
} | |
}, | |
{ | |
"name": "Filecoin.MarketGetAsk", | |
"description": "```go\nfunc (s *StorageMinerStruct) MarketGetAsk(p0 context.Context) (*storagemarket.SignedStorageAsk, error) {\n\treturn s.Internal.MarketGetAsk(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "*storagemarket.SignedStorageAsk", | |
"description": "*storagemarket.SignedStorageAsk", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Ask": { | |
"Price": "0", | |
"VerifiedPrice": "0", | |
"MinPieceSize": 1032, | |
"MaxPieceSize": 1032, | |
"Miner": "f01234", | |
"Timestamp": 10101, | |
"Expiry": 10101, | |
"SeqNo": 42 | |
}, | |
"Signature": { | |
"Type": 2, | |
"Data": "Ynl0ZSBhcnJheQ==" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Ask": { | |
"additionalProperties": false, | |
"properties": { | |
"Expiry": { | |
"title": "number", | |
"type": "number" | |
}, | |
"MaxPieceSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"MinPieceSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Miner": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Price": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"SeqNo": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Timestamp": { | |
"title": "number", | |
"type": "number" | |
}, | |
"VerifiedPrice": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": "object" | |
}, | |
"Signature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1792" | |
} | |
}, | |
{ | |
"name": "Filecoin.MarketGetRetrievalAsk", | |
"description": "```go\nfunc (s *StorageMinerStruct) MarketGetRetrievalAsk(p0 context.Context) (*retrievalmarket.Ask, error) {\n\treturn s.Internal.MarketGetRetrievalAsk(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "*retrievalmarket.Ask", | |
"description": "*retrievalmarket.Ask", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"PricePerByte": "0", | |
"UnsealPrice": "0", | |
"PaymentInterval": 42, | |
"PaymentIntervalIncrease": 42 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"PaymentInterval": { | |
"title": "number", | |
"type": "number" | |
}, | |
"PaymentIntervalIncrease": { | |
"title": "number", | |
"type": "number" | |
}, | |
"PricePerByte": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"UnsealPrice": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1800" | |
} | |
}, | |
{ | |
"name": "Filecoin.MarketImportDealData", | |
"description": "```go\nfunc (s *StorageMinerStruct) MarketImportDealData(p0 context.Context, p1 cid.Cid, p2 string) error {\n\treturn s.Internal.MarketImportDealData(p0, p1, p2)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "string", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"string value" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1804" | |
} | |
}, | |
{ | |
"name": "Filecoin.MarketListDataTransfers", | |
"description": "```go\nfunc (s *StorageMinerStruct) MarketListDataTransfers(p0 context.Context) ([]api.DataTransferChannel, error) {\n\treturn s.Internal.MarketListDataTransfers(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "[]api.DataTransferChannel", | |
"description": "[]api.DataTransferChannel", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"BaseCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"IsInitiator": { | |
"type": "boolean" | |
}, | |
"IsSender": { | |
"type": "boolean" | |
}, | |
"Message": { | |
"type": "string" | |
}, | |
"OtherPeer": { | |
"type": "string" | |
}, | |
"Status": { | |
"title": "number", | |
"type": "number" | |
}, | |
"TransferID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Transferred": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Voucher": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1808" | |
} | |
}, | |
{ | |
"name": "Filecoin.MarketListDeals", | |
"description": "```go\nfunc (s *StorageMinerStruct) MarketListDeals(p0 context.Context) ([]api.MarketDeal, error) {\n\treturn s.Internal.MarketListDeals(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "[]api.MarketDeal", | |
"description": "[]api.MarketDeal", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Proposal": { | |
"additionalProperties": false, | |
"properties": { | |
"Client": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ClientCollateral": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"EndEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Label": { | |
"type": "string" | |
}, | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"PieceSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Provider": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ProviderCollateral": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"StartEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"StoragePricePerEpoch": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"VerifiedDeal": { | |
"type": "boolean" | |
} | |
}, | |
"type": "object" | |
}, | |
"State": { | |
"additionalProperties": false, | |
"properties": { | |
"LastUpdatedEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SectorStartEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SlashEpoch": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1812" | |
} | |
}, | |
{ | |
"name": "Filecoin.MarketListIncompleteDeals", | |
"description": "```go\nfunc (s *StorageMinerStruct) MarketListIncompleteDeals(p0 context.Context) ([]storagemarket.MinerDeal, error) {\n\treturn s.Internal.MarketListIncompleteDeals(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "[]storagemarket.MinerDeal", | |
"description": "[]storagemarket.MinerDeal", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"AddFundsCid": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"AvailableForRetrieval": { | |
"type": "boolean" | |
}, | |
"Client": { | |
"type": "string" | |
}, | |
"ClientSignature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"CreationTime": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"DealID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"FastRetrieval": { | |
"type": "boolean" | |
}, | |
"FundsReserved": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Message": { | |
"type": "string" | |
}, | |
"MetadataPath": { | |
"type": "string" | |
}, | |
"Miner": { | |
"type": "string" | |
}, | |
"PiecePath": { | |
"type": "string" | |
}, | |
"Proposal": { | |
"additionalProperties": false, | |
"properties": { | |
"Client": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ClientCollateral": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"EndEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Label": { | |
"type": "string" | |
}, | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"PieceSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Provider": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ProviderCollateral": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"StartEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"StoragePricePerEpoch": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"VerifiedDeal": { | |
"type": "boolean" | |
} | |
}, | |
"type": "object" | |
}, | |
"ProposalCid": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"PublishCid": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Ref": { | |
"additionalProperties": false, | |
"properties": { | |
"PieceCid": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"PieceSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"RawBlockSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Root": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"TransferType": { | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"SectorNumber": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SlashEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"State": { | |
"title": "number", | |
"type": "number" | |
}, | |
"StoreID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"TransferChannelId": { | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Initiator": { | |
"type": "string" | |
}, | |
"Responder": { | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1816" | |
} | |
}, | |
{ | |
"name": "Filecoin.MarketListRetrievalDeals", | |
"description": "```go\nfunc (s *StorageMinerStruct) MarketListRetrievalDeals(p0 context.Context) ([]retrievalmarket.ProviderDealState, error) {\n\treturn s.Internal.MarketListRetrievalDeals(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "[]retrievalmarket.ProviderDealState", | |
"description": "[]retrievalmarket.ProviderDealState", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"ChannelID": { | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Initiator": { | |
"type": "string" | |
}, | |
"Responder": { | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"CurrentInterval": { | |
"title": "number", | |
"type": "number" | |
}, | |
"FundsReceived": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"LegacyProtocol": { | |
"type": "boolean" | |
}, | |
"Message": { | |
"type": "string" | |
}, | |
"PayloadCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"PaymentInterval": { | |
"title": "number", | |
"type": "number" | |
}, | |
"PaymentIntervalIncrease": { | |
"title": "number", | |
"type": "number" | |
}, | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"PieceInfo": { | |
"additionalProperties": false, | |
"properties": { | |
"Deals": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"DealID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Length": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Offset": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SectorID": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"PricePerByte": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Receiver": { | |
"type": "string" | |
}, | |
"Selector": { | |
"additionalProperties": false, | |
"properties": { | |
"Raw": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"Status": { | |
"title": "number", | |
"type": "number" | |
}, | |
"StoreID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"TotalSent": { | |
"title": "number", | |
"type": "number" | |
}, | |
"UnsealPrice": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1820" | |
} | |
}, | |
{ | |
"name": "Filecoin.MarketPendingDeals", | |
"description": "```go\nfunc (s *StorageMinerStruct) MarketPendingDeals(p0 context.Context) (api.PendingDealInfo, error) {\n\treturn s.Internal.MarketPendingDeals(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "api.PendingDealInfo", | |
"description": "api.PendingDealInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Deals": null, | |
"PublishPeriodStart": "0001-01-01T00:00:00Z", | |
"PublishPeriod": 60000000000 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Deals": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"ClientSignature": { | |
"additionalProperties": false, | |
"properties": { | |
"Data": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Type": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Proposal": { | |
"additionalProperties": false, | |
"properties": { | |
"Client": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ClientCollateral": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"EndEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Label": { | |
"type": "string" | |
}, | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"PieceSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Provider": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"ProviderCollateral": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"StartEpoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"StoragePricePerEpoch": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"VerifiedDeal": { | |
"type": "boolean" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"PublishPeriod": { | |
"title": "number", | |
"type": "number" | |
}, | |
"PublishPeriodStart": { | |
"format": "date-time", | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1824" | |
} | |
}, | |
{ | |
"name": "Filecoin.MarketPublishPendingDeals", | |
"description": "```go\nfunc (s *StorageMinerStruct) MarketPublishPendingDeals(p0 context.Context) error {\n\treturn s.Internal.MarketPublishPendingDeals(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1828" | |
} | |
}, | |
{ | |
"name": "Filecoin.MarketRestartDataTransfer", | |
"description": "```go\nfunc (s *StorageMinerStruct) MarketRestartDataTransfer(p0 context.Context, p1 datatransfer.TransferID, p2 peer.ID, p3 bool) error {\n\treturn s.Internal.MarketRestartDataTransfer(p0, p1, p2, p3)\n}\n```", | |
"summary": "MarketRestartDataTransfer attempts to restart a data transfer with the given transfer ID and other peer\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "datatransfer.TransferID", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
3 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "peer.ID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1832" | |
} | |
}, | |
{ | |
"name": "Filecoin.MarketSetAsk", | |
"description": "```go\nfunc (s *StorageMinerStruct) MarketSetAsk(p0 context.Context, p1 types.BigInt, p2 types.BigInt, p3 abi.ChainEpoch, p4 abi.PaddedPieceSize, p5 abi.PaddedPieceSize) error {\n\treturn s.Internal.MarketSetAsk(p0, p1, p2, p3, p4, p5)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "types.BigInt", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"0" | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "abi.ChainEpoch", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
10101 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "abi.PaddedPieceSize", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1032 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p5", | |
"description": "abi.PaddedPieceSize", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1032 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1836" | |
} | |
}, | |
{ | |
"name": "Filecoin.MarketSetRetrievalAsk", | |
"description": "```go\nfunc (s *StorageMinerStruct) MarketSetRetrievalAsk(p0 context.Context, p1 *retrievalmarket.Ask) error {\n\treturn s.Internal.MarketSetRetrievalAsk(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "*retrievalmarket.Ask", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"PricePerByte": "0", | |
"UnsealPrice": "0", | |
"PaymentInterval": 42, | |
"PaymentIntervalIncrease": 42 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"PaymentInterval": { | |
"title": "number", | |
"type": "number" | |
}, | |
"PaymentIntervalIncrease": { | |
"title": "number", | |
"type": "number" | |
}, | |
"PricePerByte": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"UnsealPrice": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1840" | |
} | |
}, | |
{ | |
"name": "Filecoin.MiningBase", | |
"description": "```go\nfunc (s *StorageMinerStruct) MiningBase(p0 context.Context) (*types.TipSet, error) {\n\treturn s.Internal.MiningBase(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "*types.TipSet", | |
"description": "*types.TipSet", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Cids": null, | |
"Blocks": null, | |
"Height": 0 | |
} | |
], | |
"additionalProperties": false, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1844" | |
} | |
}, | |
{ | |
"name": "Filecoin.PiecesGetCIDInfo", | |
"description": "```go\nfunc (s *StorageMinerStruct) PiecesGetCIDInfo(p0 context.Context, p1 cid.Cid) (*piecestore.CIDInfo, error) {\n\treturn s.Internal.PiecesGetCIDInfo(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*piecestore.CIDInfo", | |
"description": "*piecestore.CIDInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"CID": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"PieceBlockLocations": null | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"CID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"PieceBlockLocations": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"BlockSize": { | |
"title": "number", | |
"type": "number" | |
}, | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"RelOffset": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1848" | |
} | |
}, | |
{ | |
"name": "Filecoin.PiecesGetPieceInfo", | |
"description": "```go\nfunc (s *StorageMinerStruct) PiecesGetPieceInfo(p0 context.Context, p1 cid.Cid) (*piecestore.PieceInfo, error) {\n\treturn s.Internal.PiecesGetPieceInfo(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "*piecestore.PieceInfo", | |
"description": "*piecestore.PieceInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"PieceCID": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Deals": null | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Deals": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"DealID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Length": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Offset": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SectorID": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1852" | |
} | |
}, | |
{ | |
"name": "Filecoin.PiecesListCidInfos", | |
"description": "```go\nfunc (s *StorageMinerStruct) PiecesListCidInfos(p0 context.Context) ([]cid.Cid, error) {\n\treturn s.Internal.PiecesListCidInfos(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "[]cid.Cid", | |
"description": "[]cid.Cid", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"type": [ | |
"string" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1856" | |
} | |
}, | |
{ | |
"name": "Filecoin.PiecesListPieces", | |
"description": "```go\nfunc (s *StorageMinerStruct) PiecesListPieces(p0 context.Context) ([]cid.Cid, error) {\n\treturn s.Internal.PiecesListPieces(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "[]cid.Cid", | |
"description": "[]cid.Cid", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"type": [ | |
"string" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1860" | |
} | |
}, | |
{ | |
"name": "Filecoin.PledgeSector", | |
"description": "```go\nfunc (s *StorageMinerStruct) PledgeSector(p0 context.Context) (abi.SectorID, error) {\n\treturn s.Internal.PledgeSector(p0)\n}\n```", | |
"summary": "Temp api for testing\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "abi.SectorID", | |
"description": "abi.SectorID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Miner": 1000, | |
"Number": 9 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1864" | |
} | |
}, | |
{ | |
"name": "Filecoin.ReturnAddPiece", | |
"description": "```go\nfunc (s *StorageMinerStruct) ReturnAddPiece(p0 context.Context, p1 storiface.CallID, p2 abi.PieceInfo, p3 *storiface.CallError) error {\n\treturn s.Internal.ReturnAddPiece(p0, p1, p2, p3)\n}\n```", | |
"summary": "storiface.WorkerReturn\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "abi.PieceInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Size": 1032, | |
"PieceCID": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Size": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "*storiface.CallError", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Code": 0, | |
"Message": "string value" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Code": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Message": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1868" | |
} | |
}, | |
{ | |
"name": "Filecoin.ReturnFetch", | |
"description": "```go\nfunc (s *StorageMinerStruct) ReturnFetch(p0 context.Context, p1 storiface.CallID, p2 *storiface.CallError) error {\n\treturn s.Internal.ReturnFetch(p0, p1, p2)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "*storiface.CallError", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Code": 0, | |
"Message": "string value" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Code": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Message": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1872" | |
} | |
}, | |
{ | |
"name": "Filecoin.ReturnFinalizeSector", | |
"description": "```go\nfunc (s *StorageMinerStruct) ReturnFinalizeSector(p0 context.Context, p1 storiface.CallID, p2 *storiface.CallError) error {\n\treturn s.Internal.ReturnFinalizeSector(p0, p1, p2)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "*storiface.CallError", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Code": 0, | |
"Message": "string value" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Code": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Message": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1876" | |
} | |
}, | |
{ | |
"name": "Filecoin.ReturnMoveStorage", | |
"description": "```go\nfunc (s *StorageMinerStruct) ReturnMoveStorage(p0 context.Context, p1 storiface.CallID, p2 *storiface.CallError) error {\n\treturn s.Internal.ReturnMoveStorage(p0, p1, p2)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "*storiface.CallError", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Code": 0, | |
"Message": "string value" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Code": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Message": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1880" | |
} | |
}, | |
{ | |
"name": "Filecoin.ReturnReadPiece", | |
"description": "```go\nfunc (s *StorageMinerStruct) ReturnReadPiece(p0 context.Context, p1 storiface.CallID, p2 bool, p3 *storiface.CallError) error {\n\treturn s.Internal.ReturnReadPiece(p0, p1, p2, p3)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "*storiface.CallError", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Code": 0, | |
"Message": "string value" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Code": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Message": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1884" | |
} | |
}, | |
{ | |
"name": "Filecoin.ReturnReleaseUnsealed", | |
"description": "```go\nfunc (s *StorageMinerStruct) ReturnReleaseUnsealed(p0 context.Context, p1 storiface.CallID, p2 *storiface.CallError) error {\n\treturn s.Internal.ReturnReleaseUnsealed(p0, p1, p2)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "*storiface.CallError", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Code": 0, | |
"Message": "string value" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Code": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Message": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1888" | |
} | |
}, | |
{ | |
"name": "Filecoin.ReturnSealCommit1", | |
"description": "```go\nfunc (s *StorageMinerStruct) ReturnSealCommit1(p0 context.Context, p1 storiface.CallID, p2 storage.Commit1Out, p3 *storiface.CallError) error {\n\treturn s.Internal.ReturnSealCommit1(p0, p1, p2, p3)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "storage.Commit1Out", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "number", | |
"description": "Number is a number", | |
"type": [ | |
"number" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "*storiface.CallError", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Code": 0, | |
"Message": "string value" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Code": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Message": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1892" | |
} | |
}, | |
{ | |
"name": "Filecoin.ReturnSealCommit2", | |
"description": "```go\nfunc (s *StorageMinerStruct) ReturnSealCommit2(p0 context.Context, p1 storiface.CallID, p2 storage.Proof, p3 *storiface.CallError) error {\n\treturn s.Internal.ReturnSealCommit2(p0, p1, p2, p3)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "storage.Proof", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "number", | |
"description": "Number is a number", | |
"type": [ | |
"number" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "*storiface.CallError", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Code": 0, | |
"Message": "string value" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Code": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Message": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1896" | |
} | |
}, | |
{ | |
"name": "Filecoin.ReturnSealPreCommit1", | |
"description": "```go\nfunc (s *StorageMinerStruct) ReturnSealPreCommit1(p0 context.Context, p1 storiface.CallID, p2 storage.PreCommit1Out, p3 *storiface.CallError) error {\n\treturn s.Internal.ReturnSealPreCommit1(p0, p1, p2, p3)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "storage.PreCommit1Out", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "number", | |
"description": "Number is a number", | |
"type": [ | |
"number" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "*storiface.CallError", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Code": 0, | |
"Message": "string value" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Code": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Message": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1900" | |
} | |
}, | |
{ | |
"name": "Filecoin.ReturnSealPreCommit2", | |
"description": "```go\nfunc (s *StorageMinerStruct) ReturnSealPreCommit2(p0 context.Context, p1 storiface.CallID, p2 storage.SectorCids, p3 *storiface.CallError) error {\n\treturn s.Internal.ReturnSealPreCommit2(p0, p1, p2, p3)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "storage.SectorCids", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Unsealed": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Sealed": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Sealed": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Unsealed": { | |
"title": "Content Identifier", | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "*storiface.CallError", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Code": 0, | |
"Message": "string value" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Code": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Message": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1904" | |
} | |
}, | |
{ | |
"name": "Filecoin.ReturnUnsealPiece", | |
"description": "```go\nfunc (s *StorageMinerStruct) ReturnUnsealPiece(p0 context.Context, p1 storiface.CallID, p2 *storiface.CallError) error {\n\treturn s.Internal.ReturnUnsealPiece(p0, p1, p2)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "*storiface.CallError", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Code": 0, | |
"Message": "string value" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Code": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Message": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1908" | |
} | |
}, | |
{ | |
"name": "Filecoin.SealingAbort", | |
"description": "```go\nfunc (s *StorageMinerStruct) SealingAbort(p0 context.Context, p1 storiface.CallID) error {\n\treturn s.Internal.SealingAbort(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1912" | |
} | |
}, | |
{ | |
"name": "Filecoin.SealingSchedDiag", | |
"description": "```go\nfunc (s *StorageMinerStruct) SealingSchedDiag(p0 context.Context, p1 bool) (interface{}, error) {\n\treturn s.Internal.SealingSchedDiag(p0, p1)\n}\n```", | |
"summary": "SealingSchedDiag dumps internal sealing scheduler state\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "interface{}", | |
"description": "interface{}", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{} | |
], | |
"additionalProperties": true, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1916" | |
} | |
}, | |
{ | |
"name": "Filecoin.SectorGetExpectedSealDuration", | |
"description": "```go\nfunc (s *StorageMinerStruct) SectorGetExpectedSealDuration(p0 context.Context) (time.Duration, error) {\n\treturn s.Internal.SectorGetExpectedSealDuration(p0)\n}\n```", | |
"summary": "SectorGetExpectedSealDuration gets the expected time for a sector to seal\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "time.Duration", | |
"description": "time.Duration", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
60000000000 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1920" | |
} | |
}, | |
{ | |
"name": "Filecoin.SectorGetSealDelay", | |
"description": "```go\nfunc (s *StorageMinerStruct) SectorGetSealDelay(p0 context.Context) (time.Duration, error) {\n\treturn s.Internal.SectorGetSealDelay(p0)\n}\n```", | |
"summary": "SectorGetSealDelay gets the time that a newly-created sector\nwaits for more deals before it starts sealing\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "time.Duration", | |
"description": "time.Duration", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
60000000000 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1924" | |
} | |
}, | |
{ | |
"name": "Filecoin.SectorMarkForUpgrade", | |
"description": "```go\nfunc (s *StorageMinerStruct) SectorMarkForUpgrade(p0 context.Context, p1 abi.SectorNumber) error {\n\treturn s.Internal.SectorMarkForUpgrade(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "abi.SectorNumber", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
9 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1928" | |
} | |
}, | |
{ | |
"name": "Filecoin.SectorRemove", | |
"description": "```go\nfunc (s *StorageMinerStruct) SectorRemove(p0 context.Context, p1 abi.SectorNumber) error {\n\treturn s.Internal.SectorRemove(p0, p1)\n}\n```", | |
"summary": "SectorRemove removes the sector from storage. It doesn't terminate it on-chain, which can\nbe done with SectorTerminate. Removing and not terminating live sectors will cause additional penalties.\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "abi.SectorNumber", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
9 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1932" | |
} | |
}, | |
{ | |
"name": "Filecoin.SectorSetExpectedSealDuration", | |
"description": "```go\nfunc (s *StorageMinerStruct) SectorSetExpectedSealDuration(p0 context.Context, p1 time.Duration) error {\n\treturn s.Internal.SectorSetExpectedSealDuration(p0, p1)\n}\n```", | |
"summary": "SectorSetExpectedSealDuration sets the expected time for a sector to seal\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "time.Duration", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
60000000000 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1936" | |
} | |
}, | |
{ | |
"name": "Filecoin.SectorSetSealDelay", | |
"description": "```go\nfunc (s *StorageMinerStruct) SectorSetSealDelay(p0 context.Context, p1 time.Duration) error {\n\treturn s.Internal.SectorSetSealDelay(p0, p1)\n}\n```", | |
"summary": "SectorSetSealDelay sets the time that a newly-created sector\nwaits for more deals before it starts sealing\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "time.Duration", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
60000000000 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1940" | |
} | |
}, | |
{ | |
"name": "Filecoin.SectorStartSealing", | |
"description": "```go\nfunc (s *StorageMinerStruct) SectorStartSealing(p0 context.Context, p1 abi.SectorNumber) error {\n\treturn s.Internal.SectorStartSealing(p0, p1)\n}\n```", | |
"summary": "SectorStartSealing can be called on sectors in Empty or WaitDeals states\nto trigger sealing early\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "abi.SectorNumber", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
9 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1944" | |
} | |
}, | |
{ | |
"name": "Filecoin.SectorTerminate", | |
"description": "```go\nfunc (s *StorageMinerStruct) SectorTerminate(p0 context.Context, p1 abi.SectorNumber) error {\n\treturn s.Internal.SectorTerminate(p0, p1)\n}\n```", | |
"summary": "SectorTerminate terminates the sector on-chain (adding it to a termination batch first), then\nautomatically removes it from storage\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "abi.SectorNumber", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
9 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1948" | |
} | |
}, | |
{ | |
"name": "Filecoin.SectorTerminateFlush", | |
"description": "```go\nfunc (s *StorageMinerStruct) SectorTerminateFlush(p0 context.Context) (*cid.Cid, error) {\n\treturn s.Internal.SectorTerminateFlush(p0)\n}\n```", | |
"summary": "SectorTerminateFlush immediately sends a terminate message with sectors batched for termination.\nReturns null if message wasn't sent\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "*cid.Cid", | |
"description": "*cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
null | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1952" | |
} | |
}, | |
{ | |
"name": "Filecoin.SectorTerminatePending", | |
"description": "```go\nfunc (s *StorageMinerStruct) SectorTerminatePending(p0 context.Context) ([]abi.SectorID, error) {\n\treturn s.Internal.SectorTerminatePending(p0)\n}\n```", | |
"summary": "SectorTerminatePending returns a list of pending sector terminations to be sent in the next batch message\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "[]abi.SectorID", | |
"description": "[]abi.SectorID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1956" | |
} | |
}, | |
{ | |
"name": "Filecoin.SectorsList", | |
"description": "```go\nfunc (s *StorageMinerStruct) SectorsList(p0 context.Context) ([]abi.SectorNumber, error) {\n\treturn s.Internal.SectorsList(p0)\n}\n```", | |
"summary": "List all staged sectors\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "[]abi.SectorNumber", | |
"description": "[]abi.SectorNumber", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
123, | |
124 | |
] | |
], | |
"items": [ | |
{ | |
"title": "number", | |
"description": "Number is a number", | |
"type": [ | |
"number" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1960" | |
} | |
}, | |
{ | |
"name": "Filecoin.SectorsListInStates", | |
"description": "```go\nfunc (s *StorageMinerStruct) SectorsListInStates(p0 context.Context, p1 []api.SectorState) ([]abi.SectorNumber, error) {\n\treturn s.Internal.SectorsListInStates(p0, p1)\n}\n```", | |
"summary": "List sectors in particular states\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "[]api.SectorState", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"type": [ | |
"string" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]abi.SectorNumber", | |
"description": "[]abi.SectorNumber", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
[ | |
123, | |
124 | |
] | |
], | |
"items": [ | |
{ | |
"title": "number", | |
"description": "Number is a number", | |
"type": [ | |
"number" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1964" | |
} | |
}, | |
{ | |
"name": "Filecoin.SectorsRefs", | |
"description": "```go\nfunc (s *StorageMinerStruct) SectorsRefs(p0 context.Context) (map[string][]api.SealedRef, error) {\n\treturn s.Internal.SectorsRefs(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "map[string][]api.SealedRef", | |
"description": "map[string][]api.SealedRef", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"98000": [ | |
{ | |
"SectorID": 100, | |
"Offset": 10485760, | |
"Size": 1048576 | |
} | |
] | |
} | |
], | |
"patternProperties": { | |
".*": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Offset": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SectorID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Size": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1968" | |
} | |
}, | |
{ | |
"name": "Filecoin.SectorsStatus", | |
"description": "```go\nfunc (s *StorageMinerStruct) SectorsStatus(p0 context.Context, p1 abi.SectorNumber, p2 bool) (api.SectorInfo, error) {\n\treturn s.Internal.SectorsStatus(p0, p1, p2)\n}\n```", | |
"summary": "Get the status of a given sector by ID\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "abi.SectorNumber", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
9 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "api.SectorInfo", | |
"description": "api.SectorInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"SectorID": 9, | |
"State": "Proving", | |
"CommD": null, | |
"CommR": null, | |
"Proof": "Ynl0ZSBhcnJheQ==", | |
"Deals": 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 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Activation": { | |
"title": "number", | |
"type": "number" | |
}, | |
"CommD": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"CommR": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"CommitMsg": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"DealWeight": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"Deals": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"type": "array" | |
}, | |
"Early": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Expiration": { | |
"title": "number", | |
"type": "number" | |
}, | |
"InitialPledge": { | |
"additionalProperties": false, | |
"type": "object" | |
}, | |
"LastErr": { | |
"type": "string" | |
}, | |
"Log": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Kind": { | |
"type": "string" | |
}, | |
"Message": { | |
"type": "string" | |
}, | |
"Timestamp": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Trace": { | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
}, | |
"OnTime": { | |
"title": "number", | |
"type": "number" | |
}, | |
"PreCommitMsg": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Proof": { | |
"media": { | |
"binaryEncoding": "base64" | |
}, | |
"type": "string" | |
}, | |
"Retries": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SealProof": { | |
"title": "number", | |
"type": "number" | |
}, | |
"SectorID": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Seed": { | |
"additionalProperties": false, | |
"properties": { | |
"Epoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Value": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"type": "array" | |
} | |
}, | |
"type": "object" | |
}, | |
"State": { | |
"type": "string" | |
}, | |
"Ticket": { | |
"additionalProperties": false, | |
"properties": { | |
"Epoch": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Value": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"type": "array" | |
} | |
}, | |
"type": "object" | |
}, | |
"ToUpgrade": { | |
"type": "boolean" | |
}, | |
"VerifiedDealWeight": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1972" | |
} | |
}, | |
{ | |
"name": "Filecoin.SectorsSummary", | |
"description": "```go\nfunc (s *StorageMinerStruct) SectorsSummary(p0 context.Context) (map[api.SectorState]int, error) {\n\treturn s.Internal.SectorsSummary(p0)\n}\n```", | |
"summary": "Get summary info of sectors\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "map[api.SectorState]int", | |
"description": "map[api.SectorState]int", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Proving": 120 | |
} | |
], | |
"patternProperties": { | |
".*": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1976" | |
} | |
}, | |
{ | |
"name": "Filecoin.SectorsUpdate", | |
"description": "```go\nfunc (s *StorageMinerStruct) SectorsUpdate(p0 context.Context, p1 abi.SectorNumber, p2 api.SectorState) error {\n\treturn s.Internal.SectorsUpdate(p0, p1, p2)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "abi.SectorNumber", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
9 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "api.SectorState", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"Proving" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1980" | |
} | |
}, | |
{ | |
"name": "Filecoin.StorageAddLocal", | |
"description": "```go\nfunc (s *StorageMinerStruct) StorageAddLocal(p0 context.Context, p1 string) error {\n\treturn s.Internal.StorageAddLocal(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "string", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"string value" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1984" | |
} | |
}, | |
{ | |
"name": "Filecoin.StorageAttach", | |
"description": "```go\nfunc (s *StorageMinerStruct) StorageAttach(p0 context.Context, p1 stores.StorageInfo, p2 fsutil.FsStat) error {\n\treturn s.Internal.StorageAttach(p0, p1, p2)\n}\n```", | |
"summary": "stores.SectorIndex\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "stores.StorageInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ID": "76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8", | |
"URLs": null, | |
"Weight": 42, | |
"MaxStorage": 42, | |
"CanSeal": true, | |
"CanStore": true | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"CanSeal": { | |
"type": "boolean" | |
}, | |
"CanStore": { | |
"type": "boolean" | |
}, | |
"ID": { | |
"type": "string" | |
}, | |
"MaxStorage": { | |
"title": "number", | |
"type": "number" | |
}, | |
"URLs": { | |
"items": { | |
"type": "string" | |
}, | |
"type": "array" | |
}, | |
"Weight": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "fsutil.FsStat", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Capacity": 9, | |
"Available": 9, | |
"FSAvailable": 9, | |
"Reserved": 9, | |
"Max": 9, | |
"Used": 9 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Available": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Capacity": { | |
"title": "number", | |
"type": "number" | |
}, | |
"FSAvailable": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Max": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Reserved": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Used": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1988" | |
} | |
}, | |
{ | |
"name": "Filecoin.StorageBestAlloc", | |
"description": "```go\nfunc (s *StorageMinerStruct) StorageBestAlloc(p0 context.Context, p1 storiface.SectorFileType, p2 abi.SectorSize, p3 storiface.PathType) ([]stores.StorageInfo, error) {\n\treturn s.Internal.StorageBestAlloc(p0, p1, p2, p3)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storiface.SectorFileType", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "abi.SectorSize", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
34359738368 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "storiface.PathType", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"sealing" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]stores.StorageInfo", | |
"description": "[]stores.StorageInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"CanSeal": { | |
"type": "boolean" | |
}, | |
"CanStore": { | |
"type": "boolean" | |
}, | |
"ID": { | |
"type": "string" | |
}, | |
"MaxStorage": { | |
"title": "number", | |
"type": "number" | |
}, | |
"URLs": { | |
"items": { | |
"type": "string" | |
}, | |
"type": "array" | |
}, | |
"Weight": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1992" | |
} | |
}, | |
{ | |
"name": "Filecoin.StorageDeclareSector", | |
"description": "```go\nfunc (s *StorageMinerStruct) StorageDeclareSector(p0 context.Context, p1 stores.ID, p2 abi.SectorID, p3 storiface.SectorFileType, p4 bool) error {\n\treturn s.Internal.StorageDeclareSector(p0, p1, p2, p3, p4)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "stores.ID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "abi.SectorID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Miner": 1000, | |
"Number": 9 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "storiface.SectorFileType", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L1996" | |
} | |
}, | |
{ | |
"name": "Filecoin.StorageDropSector", | |
"description": "```go\nfunc (s *StorageMinerStruct) StorageDropSector(p0 context.Context, p1 stores.ID, p2 abi.SectorID, p3 storiface.SectorFileType) error {\n\treturn s.Internal.StorageDropSector(p0, p1, p2, p3)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "stores.ID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "abi.SectorID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Miner": 1000, | |
"Number": 9 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "storiface.SectorFileType", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2000" | |
} | |
}, | |
{ | |
"name": "Filecoin.StorageFindSector", | |
"description": "```go\nfunc (s *StorageMinerStruct) StorageFindSector(p0 context.Context, p1 abi.SectorID, p2 storiface.SectorFileType, p3 abi.SectorSize, p4 bool) ([]stores.SectorStorageInfo, error) {\n\treturn s.Internal.StorageFindSector(p0, p1, p2, p3, p4)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "abi.SectorID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Miner": 1000, | |
"Number": 9 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "storiface.SectorFileType", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "abi.SectorSize", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
34359738368 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "[]stores.SectorStorageInfo", | |
"description": "[]stores.SectorStorageInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"CanSeal": { | |
"type": "boolean" | |
}, | |
"CanStore": { | |
"type": "boolean" | |
}, | |
"ID": { | |
"type": "string" | |
}, | |
"Primary": { | |
"type": "boolean" | |
}, | |
"URLs": { | |
"items": { | |
"type": "string" | |
}, | |
"type": "array" | |
}, | |
"Weight": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2004" | |
} | |
}, | |
{ | |
"name": "Filecoin.StorageInfo", | |
"description": "```go\nfunc (s *StorageMinerStruct) StorageInfo(p0 context.Context, p1 stores.ID) (stores.StorageInfo, error) {\n\treturn s.Internal.StorageInfo(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "stores.ID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "stores.StorageInfo", | |
"description": "stores.StorageInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ID": "76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8", | |
"URLs": null, | |
"Weight": 42, | |
"MaxStorage": 42, | |
"CanSeal": true, | |
"CanStore": true | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"CanSeal": { | |
"type": "boolean" | |
}, | |
"CanStore": { | |
"type": "boolean" | |
}, | |
"ID": { | |
"type": "string" | |
}, | |
"MaxStorage": { | |
"title": "number", | |
"type": "number" | |
}, | |
"URLs": { | |
"items": { | |
"type": "string" | |
}, | |
"type": "array" | |
}, | |
"Weight": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2008" | |
} | |
}, | |
{ | |
"name": "Filecoin.StorageList", | |
"description": "```go\nfunc (s *StorageMinerStruct) StorageList(p0 context.Context) (map[stores.ID][]stores.Decl, error) {\n\treturn s.Internal.StorageList(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "map[stores.ID][]stores.Decl", | |
"description": "map[stores.ID][]stores.Decl", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8": [ | |
{ | |
"Miner": 1000, | |
"Number": 100, | |
"SectorFileType": 2 | |
} | |
] | |
} | |
], | |
"patternProperties": { | |
".*": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2012" | |
} | |
}, | |
{ | |
"name": "Filecoin.StorageLocal", | |
"description": "```go\nfunc (s *StorageMinerStruct) StorageLocal(p0 context.Context) (map[stores.ID]string, error) {\n\treturn s.Internal.StorageLocal(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "map[stores.ID]string", | |
"description": "map[stores.ID]string", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8": "/data/path" | |
} | |
], | |
"patternProperties": { | |
".*": { | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2016" | |
} | |
}, | |
{ | |
"name": "Filecoin.StorageLock", | |
"description": "```go\nfunc (s *StorageMinerStruct) StorageLock(p0 context.Context, p1 abi.SectorID, p2 storiface.SectorFileType, p3 storiface.SectorFileType) error {\n\treturn s.Internal.StorageLock(p0, p1, p2, p3)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "abi.SectorID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Miner": 1000, | |
"Number": 9 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "storiface.SectorFileType", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "storiface.SectorFileType", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2020" | |
} | |
}, | |
{ | |
"name": "Filecoin.StorageReportHealth", | |
"description": "```go\nfunc (s *StorageMinerStruct) StorageReportHealth(p0 context.Context, p1 stores.ID, p2 stores.HealthReport) error {\n\treturn s.Internal.StorageReportHealth(p0, p1, p2)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "stores.ID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "stores.HealthReport", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Stat": { | |
"Capacity": 9, | |
"Available": 9, | |
"FSAvailable": 9, | |
"Reserved": 9, | |
"Max": 9, | |
"Used": 9 | |
}, | |
"Err": "string value" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Err": { | |
"type": "string" | |
}, | |
"Stat": { | |
"additionalProperties": false, | |
"properties": { | |
"Available": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Capacity": { | |
"title": "number", | |
"type": "number" | |
}, | |
"FSAvailable": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Max": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Reserved": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Used": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2024" | |
} | |
}, | |
{ | |
"name": "Filecoin.StorageStat", | |
"description": "```go\nfunc (s *StorageMinerStruct) StorageStat(p0 context.Context, p1 stores.ID) (fsutil.FsStat, error) {\n\treturn s.Internal.StorageStat(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "stores.ID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "fsutil.FsStat", | |
"description": "fsutil.FsStat", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Capacity": 9, | |
"Available": 9, | |
"FSAvailable": 9, | |
"Reserved": 9, | |
"Max": 9, | |
"Used": 9 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Available": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Capacity": { | |
"title": "number", | |
"type": "number" | |
}, | |
"FSAvailable": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Max": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Reserved": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Used": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2028" | |
} | |
}, | |
{ | |
"name": "Filecoin.StorageTryLock", | |
"description": "```go\nfunc (s *StorageMinerStruct) StorageTryLock(p0 context.Context, p1 abi.SectorID, p2 storiface.SectorFileType, p3 storiface.SectorFileType) (bool, error) {\n\treturn s.Internal.StorageTryLock(p0, p1, p2, p3)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "abi.SectorID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Miner": 1000, | |
"Number": 9 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "storiface.SectorFileType", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "storiface.SectorFileType", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "bool", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2032" | |
} | |
}, | |
{ | |
"name": "Filecoin.WorkerConnect", | |
"description": "```go\nfunc (s *StorageMinerStruct) WorkerConnect(p0 context.Context, p1 string) error {\n\treturn s.Internal.WorkerConnect(p0, p1)\n}\n```", | |
"summary": "WorkerConnect tells the node to connect to workers RPC\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "string", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"string value" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2036" | |
} | |
}, | |
{ | |
"name": "Filecoin.WorkerJobs", | |
"description": "```go\nfunc (s *StorageMinerStruct) WorkerJobs(p0 context.Context) (map[uuid.UUID][]storiface.WorkerJob, error) {\n\treturn s.Internal.WorkerJobs(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "map[uuid.UUID][]storiface.WorkerJob", | |
"description": "map[uuid.UUID][]storiface.WorkerJob", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"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" | |
} | |
] | |
} | |
], | |
"patternProperties": { | |
".*": { | |
"items": { | |
"additionalProperties": false, | |
"properties": { | |
"Hostname": { | |
"type": "string" | |
}, | |
"ID": { | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": "object" | |
}, | |
"RunWait": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"Start": { | |
"format": "date-time", | |
"type": "string" | |
}, | |
"Task": { | |
"type": "string" | |
} | |
}, | |
"type": "object" | |
}, | |
"type": "array" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2040" | |
} | |
}, | |
{ | |
"name": "Filecoin.WorkerStats", | |
"description": "```go\nfunc (s *StorageMinerStruct) WorkerStats(p0 context.Context) (map[uuid.UUID]storiface.WorkerStats, error) {\n\treturn s.Internal.WorkerStats(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "map[uuid.UUID]storiface.WorkerStats", | |
"description": "map[uuid.UUID]storiface.WorkerStats", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ef8d99a2-6865-4189-8ffa-9fef0f806eee": { | |
"Info": { | |
"Hostname": "host", | |
"Resources": { | |
"MemPhysical": 274877906944, | |
"MemSwap": 128849018880, | |
"MemReserved": 2147483648, | |
"CPUs": 64, | |
"GPUs": [ | |
"aGPU 1337" | |
] | |
} | |
}, | |
"Enabled": true, | |
"MemUsedMin": 0, | |
"MemUsedMax": 0, | |
"GpuUsed": false, | |
"CpuUse": 0 | |
} | |
} | |
], | |
"patternProperties": { | |
".*": { | |
"additionalProperties": false, | |
"properties": { | |
"CpuUse": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Enabled": { | |
"type": "boolean" | |
}, | |
"GpuUsed": { | |
"type": "boolean" | |
}, | |
"Info": { | |
"additionalProperties": false, | |
"properties": { | |
"Hostname": { | |
"type": "string" | |
}, | |
"Resources": { | |
"additionalProperties": false, | |
"properties": { | |
"CPUs": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GPUs": { | |
"items": { | |
"type": "string" | |
}, | |
"type": "array" | |
}, | |
"MemPhysical": { | |
"title": "number", | |
"type": "number" | |
}, | |
"MemReserved": { | |
"title": "number", | |
"type": "number" | |
}, | |
"MemSwap": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": "object" | |
}, | |
"MemUsedMax": { | |
"title": "number", | |
"type": "number" | |
}, | |
"MemUsedMin": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2044" | |
} | |
} | |
] | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"openrpc": "1.2.6", | |
"info": { | |
"title": "Lotus RPC API", | |
"version": "1.7.0-dev" | |
}, | |
"methods": [ | |
{ | |
"name": "Filecoin.AddPiece", | |
"description": "```go\nfunc (s *WorkerStruct) AddPiece(p0 context.Context, p1 storage.SectorRef, p2 []abi.UnpaddedPieceSize, p3 abi.UnpaddedPieceSize, p4 storage.Data) (storiface.CallID, error) {\n\treturn s.Internal.AddPiece(p0, p1, p2, p3, p4)\n}\n```", | |
"summary": "storiface.WorkerCalls\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storage.SectorRef", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ID": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ProofType": 8 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"ProofType": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "[]abi.UnpaddedPieceSize", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "number", | |
"description": "Number is a number", | |
"type": [ | |
"number" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "abi.UnpaddedPieceSize", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1024 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "storage.Data", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{} | |
], | |
"additionalProperties": true | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "storiface.CallID", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2076" | |
} | |
}, | |
{ | |
"name": "Filecoin.Enabled", | |
"description": "```go\nfunc (s *WorkerStruct) Enabled(p0 context.Context) (bool, error) {\n\treturn s.Internal.Enabled(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "bool", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2080" | |
} | |
}, | |
{ | |
"name": "Filecoin.Fetch", | |
"description": "```go\nfunc (s *WorkerStruct) Fetch(p0 context.Context, p1 storage.SectorRef, p2 storiface.SectorFileType, p3 storiface.PathType, p4 storiface.AcquireMode) (storiface.CallID, error) {\n\treturn s.Internal.Fetch(p0, p1, p2, p3, p4)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storage.SectorRef", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ID": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ProofType": 8 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"ProofType": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "storiface.SectorFileType", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "storiface.PathType", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"sealing" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "storiface.AcquireMode", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"move" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "storiface.CallID", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2084" | |
} | |
}, | |
{ | |
"name": "Filecoin.FinalizeSector", | |
"description": "```go\nfunc (s *WorkerStruct) FinalizeSector(p0 context.Context, p1 storage.SectorRef, p2 []storage.Range) (storiface.CallID, error) {\n\treturn s.Internal.FinalizeSector(p0, p1, p2)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storage.SectorRef", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ID": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ProofType": 8 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"ProofType": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "[]storage.Range", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Offset": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Size": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "storiface.CallID", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2088" | |
} | |
}, | |
{ | |
"name": "Filecoin.Info", | |
"description": "```go\nfunc (s *WorkerStruct) Info(p0 context.Context) (storiface.WorkerInfo, error) {\n\treturn s.Internal.Info(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "storiface.WorkerInfo", | |
"description": "storiface.WorkerInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Hostname": "string value", | |
"Resources": { | |
"MemPhysical": 42, | |
"MemSwap": 42, | |
"MemReserved": 42, | |
"CPUs": 42, | |
"GPUs": null | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Hostname": { | |
"type": "string" | |
}, | |
"Resources": { | |
"additionalProperties": false, | |
"properties": { | |
"CPUs": { | |
"title": "number", | |
"type": "number" | |
}, | |
"GPUs": { | |
"items": { | |
"type": "string" | |
}, | |
"type": "array" | |
}, | |
"MemPhysical": { | |
"title": "number", | |
"type": "number" | |
}, | |
"MemReserved": { | |
"title": "number", | |
"type": "number" | |
}, | |
"MemSwap": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2092" | |
} | |
}, | |
{ | |
"name": "Filecoin.MoveStorage", | |
"description": "```go\nfunc (s *WorkerStruct) MoveStorage(p0 context.Context, p1 storage.SectorRef, p2 storiface.SectorFileType) (storiface.CallID, error) {\n\treturn s.Internal.MoveStorage(p0, p1, p2)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storage.SectorRef", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ID": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ProofType": 8 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"ProofType": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "storiface.SectorFileType", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "storiface.CallID", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2096" | |
} | |
}, | |
{ | |
"name": "Filecoin.Paths", | |
"description": "```go\nfunc (s *WorkerStruct) Paths(p0 context.Context) ([]stores.StoragePath, error) {\n\treturn s.Internal.Paths(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "[]stores.StoragePath", | |
"description": "[]stores.StoragePath", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"CanSeal": { | |
"type": "boolean" | |
}, | |
"CanStore": { | |
"type": "boolean" | |
}, | |
"ID": { | |
"type": "string" | |
}, | |
"LocalPath": { | |
"type": "string" | |
}, | |
"Weight": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2100" | |
} | |
}, | |
{ | |
"name": "Filecoin.ProcessSession", | |
"description": "```go\nfunc (s *WorkerStruct) ProcessSession(p0 context.Context) (uuid.UUID, error) {\n\treturn s.Internal.ProcessSession(p0)\n}\n```", | |
"summary": "returns a random UUID of worker session, generated randomly when worker\nprocess starts\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "uuid.UUID", | |
"description": "uuid.UUID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"07070707-0707-0707-0707-070707070707" | |
], | |
"items": [ | |
{ | |
"title": "number", | |
"description": "Number is a number", | |
"type": [ | |
"number" | |
] | |
} | |
], | |
"maxItems": 16, | |
"minItems": 16, | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2104" | |
} | |
}, | |
{ | |
"name": "Filecoin.ReadPiece", | |
"description": "```go\nfunc (s *WorkerStruct) ReadPiece(p0 context.Context, p1 io.Writer, p2 storage.SectorRef, p3 storiface.UnpaddedByteIndex, p4 abi.UnpaddedPieceSize) (storiface.CallID, error) {\n\treturn s.Internal.ReadPiece(p0, p1, p2, p3, p4)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "io.Writer", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{} | |
], | |
"additionalProperties": true | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "storage.SectorRef", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ID": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ProofType": 8 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"ProofType": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "storiface.UnpaddedByteIndex", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1040384 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "abi.UnpaddedPieceSize", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1024 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "storiface.CallID", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2108" | |
} | |
}, | |
{ | |
"name": "Filecoin.ReleaseUnsealed", | |
"description": "```go\nfunc (s *WorkerStruct) ReleaseUnsealed(p0 context.Context, p1 storage.SectorRef, p2 []storage.Range) (storiface.CallID, error) {\n\treturn s.Internal.ReleaseUnsealed(p0, p1, p2)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storage.SectorRef", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ID": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ProofType": 8 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"ProofType": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "[]storage.Range", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"Offset": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Size": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "storiface.CallID", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2112" | |
} | |
}, | |
{ | |
"name": "Filecoin.Remove", | |
"description": "```go\nfunc (s *WorkerStruct) Remove(p0 context.Context, p1 abi.SectorID) error {\n\treturn s.Internal.Remove(p0, p1)\n}\n```", | |
"summary": "Storage / Other\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "abi.SectorID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Miner": 1000, | |
"Number": 9 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2116" | |
} | |
}, | |
{ | |
"name": "Filecoin.SealCommit1", | |
"description": "```go\nfunc (s *WorkerStruct) SealCommit1(p0 context.Context, p1 storage.SectorRef, p2 abi.SealRandomness, p3 abi.InteractiveSealRandomness, p4 []abi.PieceInfo, p5 storage.SectorCids) (storiface.CallID, error) {\n\treturn s.Internal.SealCommit1(p0, p1, p2, p3, p4, p5)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storage.SectorRef", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ID": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ProofType": 8 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"ProofType": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "abi.SealRandomness", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "number", | |
"description": "Number is a number", | |
"type": [ | |
"number" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "abi.InteractiveSealRandomness", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "number", | |
"description": "Number is a number", | |
"type": [ | |
"number" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "[]abi.PieceInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Size": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p5", | |
"description": "storage.SectorCids", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Unsealed": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
}, | |
"Sealed": { | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"Sealed": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Unsealed": { | |
"title": "Content Identifier", | |
"type": "string" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "storiface.CallID", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2120" | |
} | |
}, | |
{ | |
"name": "Filecoin.SealCommit2", | |
"description": "```go\nfunc (s *WorkerStruct) SealCommit2(p0 context.Context, p1 storage.SectorRef, p2 storage.Commit1Out) (storiface.CallID, error) {\n\treturn s.Internal.SealCommit2(p0, p1, p2)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storage.SectorRef", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ID": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ProofType": 8 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"ProofType": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "storage.Commit1Out", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "number", | |
"description": "Number is a number", | |
"type": [ | |
"number" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "storiface.CallID", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2124" | |
} | |
}, | |
{ | |
"name": "Filecoin.SealPreCommit1", | |
"description": "```go\nfunc (s *WorkerStruct) SealPreCommit1(p0 context.Context, p1 storage.SectorRef, p2 abi.SealRandomness, p3 []abi.PieceInfo) (storiface.CallID, error) {\n\treturn s.Internal.SealPreCommit1(p0, p1, p2, p3)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storage.SectorRef", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ID": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ProofType": 8 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"ProofType": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "abi.SealRandomness", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "number", | |
"description": "Number is a number", | |
"type": [ | |
"number" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "[]abi.PieceInfo", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"additionalProperties": false, | |
"properties": { | |
"PieceCID": { | |
"title": "Content Identifier", | |
"type": "string" | |
}, | |
"Size": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "storiface.CallID", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2128" | |
} | |
}, | |
{ | |
"name": "Filecoin.SealPreCommit2", | |
"description": "```go\nfunc (s *WorkerStruct) SealPreCommit2(p0 context.Context, p1 storage.SectorRef, p2 storage.PreCommit1Out) (storiface.CallID, error) {\n\treturn s.Internal.SealPreCommit2(p0, p1, p2)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storage.SectorRef", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ID": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ProofType": 8 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"ProofType": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "storage.PreCommit1Out", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "number", | |
"description": "Number is a number", | |
"type": [ | |
"number" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "storiface.CallID", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2132" | |
} | |
}, | |
{ | |
"name": "Filecoin.Session", | |
"description": "```go\nfunc (s *WorkerStruct) Session(p0 context.Context) (uuid.UUID, error) {\n\treturn s.Internal.Session(p0)\n}\n```", | |
"summary": "Like ProcessSession, but returns an error when worker is disabled\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "uuid.UUID", | |
"description": "uuid.UUID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"07070707-0707-0707-0707-070707070707" | |
], | |
"items": [ | |
{ | |
"title": "number", | |
"description": "Number is a number", | |
"type": [ | |
"number" | |
] | |
} | |
], | |
"maxItems": 16, | |
"minItems": 16, | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2136" | |
} | |
}, | |
{ | |
"name": "Filecoin.SetEnabled", | |
"description": "```go\nfunc (s *WorkerStruct) SetEnabled(p0 context.Context, p1 bool) error {\n\treturn s.Internal.SetEnabled(p0, p1)\n}\n```", | |
"summary": "SetEnabled marks the worker as enabled/disabled. Not that this setting\nmay take a few seconds to propagate to task scheduler\n", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "bool", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
true | |
], | |
"type": [ | |
"boolean" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2140" | |
} | |
}, | |
{ | |
"name": "Filecoin.StorageAddLocal", | |
"description": "```go\nfunc (s *WorkerStruct) StorageAddLocal(p0 context.Context, p1 string) error {\n\treturn s.Internal.StorageAddLocal(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "string", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"string value" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2144" | |
} | |
}, | |
{ | |
"name": "Filecoin.TaskDisable", | |
"description": "```go\nfunc (s *WorkerStruct) TaskDisable(p0 context.Context, p1 sealtasks.TaskType) error {\n\treturn s.Internal.TaskDisable(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "sealtasks.TaskType", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"seal/v0/commit/2" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2148" | |
} | |
}, | |
{ | |
"name": "Filecoin.TaskEnable", | |
"description": "```go\nfunc (s *WorkerStruct) TaskEnable(p0 context.Context, p1 sealtasks.TaskType) error {\n\treturn s.Internal.TaskEnable(p0, p1)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "sealtasks.TaskType", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
"seal/v0/commit/2" | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2152" | |
} | |
}, | |
{ | |
"name": "Filecoin.TaskTypes", | |
"description": "```go\nfunc (s *WorkerStruct) TaskTypes(p0 context.Context) (map[sealtasks.TaskType]struct{}, error) {\n\treturn s.Internal.TaskTypes(p0)\n}\n```", | |
"summary": "TaskType -> Weight\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "map[sealtasks.TaskType]struct{}", | |
"description": "map[sealtasks.TaskType]struct{}", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"seal/v0/precommit/2": {} | |
} | |
], | |
"patternProperties": { | |
".*": { | |
"additionalProperties": false, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2156" | |
} | |
}, | |
{ | |
"name": "Filecoin.UnsealPiece", | |
"description": "```go\nfunc (s *WorkerStruct) UnsealPiece(p0 context.Context, p1 storage.SectorRef, p2 storiface.UnpaddedByteIndex, p3 abi.UnpaddedPieceSize, p4 abi.SealRandomness, p5 cid.Cid) (storiface.CallID, error) {\n\treturn s.Internal.UnsealPiece(p0, p1, p2, p3, p4, p5)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [ | |
{ | |
"name": "p1", | |
"description": "storage.SectorRef", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"ID": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ProofType": 8 | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
}, | |
"ProofType": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p2", | |
"description": "storiface.UnpaddedByteIndex", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1040384 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p3", | |
"description": "abi.UnpaddedPieceSize", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
1024 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p4", | |
"description": "abi.SealRandomness", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
null | |
], | |
"items": [ | |
{ | |
"title": "number", | |
"description": "Number is a number", | |
"type": [ | |
"number" | |
] | |
} | |
], | |
"type": [ | |
"array" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
{ | |
"name": "p5", | |
"description": "cid.Cid", | |
"summary": "", | |
"schema": { | |
"title": "Content Identifier", | |
"description": "Cid represents a self-describing content addressed identifier. It is formed by a Version, a Codec (which indicates a multicodec-packed content type) and a Multihash.", | |
"examples": [ | |
{ | |
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4" | |
} | |
], | |
"type": [ | |
"string" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
} | |
], | |
"result": { | |
"name": "storiface.CallID", | |
"description": "storiface.CallID", | |
"summary": "", | |
"schema": { | |
"examples": [ | |
{ | |
"Sector": { | |
"Miner": 1000, | |
"Number": 9 | |
}, | |
"ID": "07070707-0707-0707-0707-070707070707" | |
} | |
], | |
"additionalProperties": false, | |
"properties": { | |
"ID": { | |
"items": { | |
"description": "Number is a number", | |
"title": "number", | |
"type": "number" | |
}, | |
"maxItems": 16, | |
"minItems": 16, | |
"type": "array" | |
}, | |
"Sector": { | |
"additionalProperties": false, | |
"properties": { | |
"Miner": { | |
"title": "number", | |
"type": "number" | |
}, | |
"Number": { | |
"title": "number", | |
"type": "number" | |
} | |
}, | |
"type": "object" | |
} | |
}, | |
"type": [ | |
"object" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2160" | |
} | |
}, | |
{ | |
"name": "Filecoin.Version", | |
"description": "```go\nfunc (s *WorkerStruct) Version(p0 context.Context) (api.Version, error) {\n\treturn s.Internal.Version(p0)\n}\n```", | |
"summary": "", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "api.Version", | |
"description": "api.Version", | |
"summary": "", | |
"schema": { | |
"title": "number", | |
"description": "Number is a number", | |
"examples": [ | |
65792 | |
], | |
"type": [ | |
"number" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2164" | |
} | |
}, | |
{ | |
"name": "Filecoin.WaitQuiet", | |
"description": "```go\nfunc (s *WorkerStruct) WaitQuiet(p0 context.Context) error {\n\treturn s.Internal.WaitQuiet(p0)\n}\n```", | |
"summary": "WaitQuiet blocks until there are no tasks running\n", | |
"paramStructure": "by-position", | |
"params": [], | |
"result": { | |
"name": "Null", | |
"description": "Null", | |
"schema": { | |
"type": [ | |
"null" | |
] | |
}, | |
"required": true, | |
"deprecated": false | |
}, | |
"deprecated": false, | |
"externalDocs": { | |
"description": "Github remote link", | |
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L2168" | |
} | |
} | |
] | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment