Skip to content

Instantly share code, notes, and snippets.

@olizilla

olizilla/full.json

Created Mar 30, 2021
Embed
What would you like to do?
{
"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": {