Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
{
"info": {
"title": "Lotus RPC API",
"version": "1.2.1"
},
"methods": [
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) BeaconGetEntry(ctx context.Context, epoch abi.ChainEpoch) (*types.BeaconEntry, error) {\n\treturn c.Internal.BeaconGetEntry(ctx, epoch)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L862"
},
"name": "Filecoin.BeaconGetEntry",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "abi.ChainEpoch",
"name": "epoch",
"required": true,
"schema": {
"description": "Hex representation of the integer",
"examples": [
10101
],
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "*types.BeaconEntry",
"name": "*types.BeaconEntry",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
{
"Data": "Ynl0ZSBhcnJheQ==",
"Round": 42
}
],
"properties": {
"Data": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"Round": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
}
},
"type": [
"object"
]
},
"summary": ""
},
"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"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainDeleteObj(ctx context.Context, obj cid.Cid) error {\n\treturn c.Internal.ChainDeleteObj(ctx, obj)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L822"
},
"name": "Filecoin.ChainDeleteObj",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "cid.Cid",
"name": "obj",
"required": true,
"schema": {
"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"
}
],
"title": "Content Identifier",
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "Null",
"name": "Null",
"required": true,
"schema": {
"type": [
"null"
]
}
},
"summary": "ChainDeleteObj deletes node referenced by the given CID\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainGetBlock(ctx context.Context, b cid.Cid) (*types.BlockHeader, error) {\n\treturn c.Internal.ChainGetBlock(ctx, b)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L794"
},
"name": "Filecoin.ChainGetBlock",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "cid.Cid",
"name": "b",
"required": true,
"schema": {
"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"
}
],
"title": "Content Identifier",
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "*types.BlockHeader",
"name": "*types.BlockHeader",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
{
"BLSAggregate": {
"Data": "Ynl0ZSBhcnJheQ==",
"Type": 2
},
"BeaconEntries": null,
"BlockSig": {
"Data": "Ynl0ZSBhcnJheQ==",
"Type": 2
},
"ElectionProof": {
"VRFProof": "Ynl0ZSBhcnJheQ==",
"WinCount": 9
},
"ForkSignaling": 42,
"Height": 10101,
"Messages": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Miner": "f01234",
"ParentBaseFee": "0",
"ParentMessageReceipts": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"ParentStateRoot": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"ParentWeight": "0",
"Parents": null,
"Ticket": {
"VRFProof": "Ynl0ZSBhcnJheQ=="
},
"Timestamp": 42,
"WinPoStProof": null
}
],
"properties": {
"BLSAggregate": {
"additionalProperties": false,
"properties": {
"Data": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"Type": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
}
},
"type": "object"
},
"BeaconEntries": {
"items": {
"additionalProperties": false,
"properties": {
"Data": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"Round": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"BlockSig": {
"additionalProperties": false,
"properties": {
"Data": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"Type": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
}
},
"type": "object"
},
"ElectionProof": {
"additionalProperties": false,
"properties": {
"VRFProof": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"WinCount": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
}
},
"type": "object"
},
"ForkSignaling": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Height": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"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": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"WinPoStProof": {
"items": {
"additionalProperties": false,
"properties": {
"PoStProof": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"ProofBytes": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": [
"object"
]
},
"summary": ""
},
"summary": "ChainGetBlock returns the block specified by the given CID.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainGetBlockMessages(ctx context.Context, b cid.Cid) (*api.BlockMessages, error) {\n\treturn c.Internal.ChainGetBlockMessages(ctx, b)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L802"
},
"name": "Filecoin.ChainGetBlockMessages",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "cid.Cid",
"name": "b",
"required": true,
"schema": {
"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"
}
],
"title": "Content Identifier",
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "*api.BlockMessages",
"name": "*api.BlockMessages",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
{
"BlsMessages": null,
"Cids": null,
"SecpkMessages": null
}
],
"properties": {
"BlsMessages": {
"items": {
"additionalProperties": false,
"properties": {
"From": {
"additionalProperties": false,
"type": "object"
},
"GasFeeCap": {
"additionalProperties": false,
"type": "object"
},
"GasLimit": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"GasPremium": {
"additionalProperties": false,
"type": "object"
},
"Method": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Nonce": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Params": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"To": {
"additionalProperties": false,
"type": "object"
},
"Value": {
"additionalProperties": false,
"type": "object"
},
"Version": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
}
},
"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": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"GasPremium": {
"additionalProperties": false,
"type": "object"
},
"Method": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Nonce": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Params": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"To": {
"additionalProperties": false,
"type": "object"
},
"Value": {
"additionalProperties": false,
"type": "object"
},
"Version": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
}
},
"type": "object"
},
"Signature": {
"additionalProperties": false,
"properties": {
"Data": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"Type": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": [
"object"
]
},
"summary": ""
},
"summary": "ChainGetBlockMessages returns messages stored in the specified block.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainGetGenesis(ctx context.Context) (*types.TipSet, error) {\n\treturn c.Internal.ChainGetGenesis(ctx)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L838"
},
"name": "Filecoin.ChainGetGenesis",
"paramStructure": "by-position",
"params": [],
"result": {
"deprecated": false,
"description": "*types.TipSet",
"name": "*types.TipSet",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
{
"Blocks": null,
"Cids": null,
"Height": 0
}
],
"type": [
"object"
]
},
"summary": ""
},
"summary": "ChainGetGenesis returns the genesis tipset.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainGetMessage(ctx context.Context, mc cid.Cid) (*types.Message, error) {\n\treturn c.Internal.ChainGetMessage(ctx, mc)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L850"
},
"name": "Filecoin.ChainGetMessage",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "cid.Cid",
"name": "mc",
"required": true,
"schema": {
"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"
}
],
"title": "Content Identifier",
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "*types.Message",
"name": "*types.Message",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
{
"CID": {
"/": "bafy2bzacebbpdegvr3i4cosewthysg5xkxpqfn2wfcz6mv2hmoktwbdxkax4s"
},
"From": "f01234",
"GasFeeCap": "0",
"GasLimit": 9,
"GasPremium": "0",
"Method": 1,
"Nonce": 42,
"Params": "Ynl0ZSBhcnJheQ==",
"To": "f01234",
"Value": "0",
"Version": 42
}
],
"properties": {
"From": {
"additionalProperties": false,
"type": "object"
},
"GasFeeCap": {
"additionalProperties": false,
"type": "object"
},
"GasLimit": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"GasPremium": {
"additionalProperties": false,
"type": "object"
},
"Method": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Nonce": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Params": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
},
"To": {
"additionalProperties": false,
"type": "object"
},
"Value": {
"additionalProperties": false,
"type": "object"
},
"Version": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
}
},
"type": [
"object"
]
},
"summary": ""
},
"summary": "ChainGetMessage reads a message referenced by the specified CID from the\nchain blockstore.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainGetNode(ctx context.Context, p string) (*api.IpldObject, error) {\n\treturn c.Internal.ChainGetNode(ctx, p)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L846"
},
"name": "Filecoin.ChainGetNode",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "string",
"name": "p",
"required": true,
"schema": {
"examples": [
"string value"
],
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "*api.IpldObject",
"name": "*api.IpldObject",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
{
"Cid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Obj": {}
}
],
"properties": {
"Cid": {
"title": "Content Identifier",
"type": "string"
},
"Obj": {
"additionalProperties": true,
"type": "object"
}
},
"type": [
"object"
]
},
"summary": ""
},
"summary": "There are not yet any comments for this method."
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainGetParentMessages(ctx context.Context, b cid.Cid) ([]api.Message, error) {\n\treturn c.Internal.ChainGetParentMessages(ctx, b)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L810"
},
"name": "Filecoin.ChainGetParentMessages",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "cid.Cid",
"name": "b",
"required": true,
"schema": {
"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"
}
],
"title": "Content Identifier",
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "[]api.Message",
"name": "[]api.Message",
"required": true,
"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"
]
},
"summary": ""
},
"summary": "ChainGetParentMessages returns messages stored in parent tipset of the\nspecified block.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainGetParentReceipts(ctx context.Context, b cid.Cid) ([]*types.MessageReceipt, error) {\n\treturn c.Internal.ChainGetParentReceipts(ctx, b)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L806"
},
"name": "Filecoin.ChainGetParentReceipts",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "cid.Cid",
"name": "b",
"required": true,
"schema": {
"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"
}
],
"title": "Content Identifier",
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "[]*types.MessageReceipt",
"name": "[]*types.MessageReceipt",
"required": true,
"schema": {
"examples": [
null
],
"items": [
{
"additionalProperties": false,
"properties": {
"ExitCode": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"GasUsed": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Return": {
"media": {
"binaryEncoding": "base64"
},
"type": "string"
}
},
"type": [
"object"
]
}
],
"type": [
"array"
]
},
"summary": ""
},
"summary": "ChainGetParentReceipts returns receipts for messages in parent tipset of\nthe specified block.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainGetPath(ctx context.Context, from types.TipSetKey, to types.TipSetKey) ([]*api.HeadChange, error) {\n\treturn c.Internal.ChainGetPath(ctx, from, to)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L854"
},
"name": "Filecoin.ChainGetPath",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "types.TipSetKey",
"name": "from",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
[
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
{
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
}
]
],
"type": [
"object"
]
},
"summary": ""
},
{
"deprecated": false,
"description": "types.TipSetKey",
"name": "to",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
[
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
{
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
}
]
],
"type": [
"object"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "[]*api.HeadChange",
"name": "[]*api.HeadChange",
"required": true,
"schema": {
"examples": [
null
],
"items": [
{
"additionalProperties": false,
"properties": {
"Type": {
"type": "string"
},
"Val": {
"additionalProperties": false,
"type": "object"
}
},
"type": [
"object"
]
}
],
"type": [
"array"
]
},
"summary": ""
},
"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"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainGetRandomnessFromBeacon(ctx context.Context, tsk types.TipSetKey, personalization crypto.DomainSeparationTag, randEpoch abi.ChainEpoch, entropy []byte) (abi.Randomness, error) {\n\treturn c.Internal.ChainGetRandomnessFromBeacon(ctx, tsk, personalization, randEpoch, entropy)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L730"
},
"name": "Filecoin.ChainGetRandomnessFromBeacon",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "types.TipSetKey",
"name": "tsk",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
[
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
{
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
}
]
],
"type": [
"object"
]
},
"summary": ""
},
{
"deprecated": false,
"description": "crypto.DomainSeparationTag",
"name": "personalization",
"required": true,
"schema": {
"description": "Hex representation of the integer",
"examples": [
2
],
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": [
"string"
]
},
"summary": ""
},
{
"deprecated": false,
"description": "abi.ChainEpoch",
"name": "randEpoch",
"required": true,
"schema": {
"description": "Hex representation of the integer",
"examples": [
10101
],
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": [
"string"
]
},
"summary": ""
},
{
"deprecated": false,
"description": "[]byte",
"name": "entropy",
"required": true,
"schema": {
"examples": [
"Ynl0ZSBhcnJheQ=="
],
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "abi.Randomness",
"name": "abi.Randomness",
"required": true,
"schema": {
"examples": [
null
],
"items": [
{
"description": "Hex representation of the integer",
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": [
"string"
]
}
],
"type": [
"array"
]
},
"summary": ""
},
"summary": "ChainGetRandomnessFromBeacon is used to sample the beacon for randomness.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainGetRandomnessFromTickets(ctx context.Context, tsk types.TipSetKey, personalization crypto.DomainSeparationTag, randEpoch abi.ChainEpoch, entropy []byte) (abi.Randomness, error) {\n\treturn c.Internal.ChainGetRandomnessFromTickets(ctx, tsk, personalization, randEpoch, entropy)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L726"
},
"name": "Filecoin.ChainGetRandomnessFromTickets",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "types.TipSetKey",
"name": "tsk",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
[
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
{
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
}
]
],
"type": [
"object"
]
},
"summary": ""
},
{
"deprecated": false,
"description": "crypto.DomainSeparationTag",
"name": "personalization",
"required": true,
"schema": {
"description": "Hex representation of the integer",
"examples": [
2
],
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": [
"string"
]
},
"summary": ""
},
{
"deprecated": false,
"description": "abi.ChainEpoch",
"name": "randEpoch",
"required": true,
"schema": {
"description": "Hex representation of the integer",
"examples": [
10101
],
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": [
"string"
]
},
"summary": ""
},
{
"deprecated": false,
"description": "[]byte",
"name": "entropy",
"required": true,
"schema": {
"examples": [
"Ynl0ZSBhcnJheQ=="
],
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "abi.Randomness",
"name": "abi.Randomness",
"required": true,
"schema": {
"examples": [
null
],
"items": [
{
"description": "Hex representation of the integer",
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": [
"string"
]
}
],
"type": [
"array"
]
},
"summary": ""
},
"summary": "ChainGetRandomnessFromTickets is used to sample the chain for randomness.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainGetTipSet(ctx context.Context, key types.TipSetKey) (*types.TipSet, error) {\n\treturn c.Internal.ChainGetTipSet(ctx, key)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L798"
},
"name": "Filecoin.ChainGetTipSet",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "types.TipSetKey",
"name": "key",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
[
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
{
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
}
]
],
"type": [
"object"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "*types.TipSet",
"name": "*types.TipSet",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
{
"Blocks": null,
"Cids": null,
"Height": 0
}
],
"type": [
"object"
]
},
"summary": ""
},
"summary": "ChainGetTipSet returns the tipset specified by the given TipSetKey.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainGetTipSetByHeight(ctx context.Context, h abi.ChainEpoch, tsk types.TipSetKey) (*types.TipSet, error) {\n\treturn c.Internal.ChainGetTipSetByHeight(ctx, h, tsk)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L734"
},
"name": "Filecoin.ChainGetTipSetByHeight",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "abi.ChainEpoch",
"name": "h",
"required": true,
"schema": {
"description": "Hex representation of the integer",
"examples": [
10101
],
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": [
"string"
]
},
"summary": ""
},
{
"deprecated": false,
"description": "types.TipSetKey",
"name": "tsk",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
[
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
{
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
}
]
],
"type": [
"object"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "*types.TipSet",
"name": "*types.TipSet",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
{
"Blocks": null,
"Cids": null,
"Height": 0
}
],
"type": [
"object"
]
},
"summary": ""
},
"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"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainHasObj(ctx context.Context, o cid.Cid) (bool, error) {\n\treturn c.Internal.ChainHasObj(ctx, o)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L826"
},
"name": "Filecoin.ChainHasObj",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "cid.Cid",
"name": "o",
"required": true,
"schema": {
"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"
}
],
"title": "Content Identifier",
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "bool",
"name": "bool",
"required": true,
"schema": {
"examples": [
true
],
"type": [
"boolean"
]
},
"summary": ""
},
"summary": "ChainHasObj checks if a given CID exists in the chain blockstore.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainHead(ctx context.Context) (*types.TipSet, error) {\n\treturn c.Internal.ChainHead(ctx)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L722"
},
"name": "Filecoin.ChainHead",
"paramStructure": "by-position",
"params": [],
"result": {
"deprecated": false,
"description": "*types.TipSet",
"name": "*types.TipSet",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
{
"Blocks": null,
"Cids": null,
"Height": 0
}
],
"type": [
"object"
]
},
"summary": ""
},
"summary": "ChainHead returns the current head of the chain.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainReadObj(ctx context.Context, obj cid.Cid) ([]byte, error) {\n\treturn c.Internal.ChainReadObj(ctx, obj)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L818"
},
"name": "Filecoin.ChainReadObj",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "cid.Cid",
"name": "obj",
"required": true,
"schema": {
"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"
}
],
"title": "Content Identifier",
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "[]byte",
"name": "[]byte",
"required": true,
"schema": {
"examples": [
"Ynl0ZSBhcnJheQ=="
],
"type": [
"string"
]
},
"summary": ""
},
"summary": "ChainReadObj reads ipld nodes referenced by the specified CID from chain\nblockstore and returns raw bytes.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainSetHead(ctx context.Context, tsk types.TipSetKey) error {\n\treturn c.Internal.ChainSetHead(ctx, tsk)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L834"
},
"name": "Filecoin.ChainSetHead",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "types.TipSetKey",
"name": "tsk",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
[
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
{
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
}
]
],
"type": [
"object"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "Null",
"name": "Null",
"required": true,
"schema": {
"type": [
"null"
]
}
},
"summary": "ChainSetHead forcefully sets current chain head. Use with caution.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainStatObj(ctx context.Context, obj, base cid.Cid) (api.ObjStat, error) {\n\treturn c.Internal.ChainStatObj(ctx, obj, base)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L830"
},
"name": "Filecoin.ChainStatObj",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "cid.Cid",
"name": "obj",
"required": true,
"schema": {
"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"
}
],
"title": "Content Identifier",
"type": [
"string"
]
},
"summary": ""
},
{
"deprecated": false,
"description": "cid.Cid",
"name": "base",
"required": true,
"schema": {
"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"
}
],
"title": "Content Identifier",
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "api.ObjStat",
"name": "api.ObjStat",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
{
"Links": 42,
"Size": 42
}
],
"properties": {
"Links": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Size": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
}
},
"type": [
"object"
]
},
"summary": ""
},
"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"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ChainTipSetWeight(ctx context.Context, tsk types.TipSetKey) (types.BigInt, error) {\n\treturn c.Internal.ChainTipSetWeight(ctx, tsk)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L842"
},
"name": "Filecoin.ChainTipSetWeight",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "types.TipSetKey",
"name": "tsk",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
[
{
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
{
"/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
}
]
],
"type": [
"object"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "types.BigInt",
"name": "types.BigInt",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
"0"
],
"type": [
"object"
]
},
"summary": ""
},
"summary": "ChainTipSetWeight computes weight for the specified tipset.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ClientCalcCommP(ctx context.Context, inpath string) (*api.CommPRet, error) {\n\treturn c.Internal.ClientCalcCommP(ctx, inpath)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L618"
},
"name": "Filecoin.ClientCalcCommP",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "string",
"name": "inpath",
"required": true,
"schema": {
"examples": [
"string value"
],
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "*api.CommPRet",
"name": "*api.CommPRet",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
{
"Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Size": 1024
}
],
"properties": {
"Root": {
"title": "Content Identifier",
"type": "string"
},
"Size": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
}
},
"type": [
"object"
]
},
"summary": ""
},
"summary": "ClientCalcCommP calculates the CommP for a specified file\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ClientCancelDataTransfer(ctx context.Context, transferID datatransfer.TransferID, otherPeer peer.ID, isInitiator bool) error {\n\treturn c.Internal.ClientCancelDataTransfer(ctx, transferID, otherPeer, isInitiator)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L642"
},
"name": "Filecoin.ClientCancelDataTransfer",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "datatransfer.TransferID",
"name": "transferID",
"required": true,
"schema": {
"description": "Hex representation of the integer",
"examples": [
3
],
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": [
"string"
]
},
"summary": ""
},
{
"deprecated": false,
"description": "peer.ID",
"name": "otherPeer",
"required": true,
"schema": {
"examples": [
"12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
],
"type": [
"string"
]
},
"summary": ""
},
{
"deprecated": false,
"description": "bool",
"name": "isInitiator",
"required": true,
"schema": {
"examples": [
true
],
"type": [
"boolean"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "Null",
"name": "Null",
"required": true,
"schema": {
"type": [
"null"
]
}
},
"summary": "ClientCancelDataTransfer cancels a data transfer with the given transfer ID and other peer\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ClientDealPieceCID(ctx context.Context, root cid.Cid) (api.DataCIDSize, error) {\n\treturn c.Internal.ClientDealPieceCID(ctx, root)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L614"
},
"name": "Filecoin.ClientDealPieceCID",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "cid.Cid",
"name": "root",
"required": true,
"schema": {
"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"
}
],
"title": "Content Identifier",
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "api.DataCIDSize",
"name": "api.DataCIDSize",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
{
"PayloadSize": 9,
"PieceCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PieceSize": 1032
}
],
"properties": {
"PayloadSize": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"PieceCID": {
"title": "Content Identifier",
"type": "string"
},
"PieceSize": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
}
},
"type": [
"object"
]
},
"summary": ""
},
"summary": "ClientCalcCommP calculates the CommP and data size of the specified CID\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ClientDealSize(ctx context.Context, root cid.Cid) (api.DataSize, error) {\n\treturn c.Internal.ClientDealSize(ctx, root)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L626"
},
"name": "Filecoin.ClientDealSize",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "cid.Cid",
"name": "root",
"required": true,
"schema": {
"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"
}
],
"title": "Content Identifier",
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "api.DataSize",
"name": "api.DataSize",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
{
"PayloadSize": 9,
"PieceSize": 1032
}
],
"properties": {
"PayloadSize": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"PieceSize": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
}
},
"type": [
"object"
]
},
"summary": ""
},
"summary": "ClientDealSize calculates real deal data size\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ClientFindData(ctx context.Context, root cid.Cid, piece *cid.Cid) ([]api.QueryOffer, error) {\n\treturn c.Internal.ClientFindData(ctx, root, piece)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L574"
},
"name": "Filecoin.ClientFindData",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "cid.Cid",
"name": "root",
"required": true,
"schema": {
"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"
}
],
"title": "Content Identifier",
"type": [
"string"
]
},
"summary": ""
},
{
"deprecated": false,
"description": "*cid.Cid",
"name": "piece",
"required": true,
"schema": {
"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
],
"title": "Content Identifier",
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "[]api.QueryOffer",
"name": "[]api.QueryOffer",
"required": true,
"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": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"PaymentIntervalIncrease": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Piece": {
"title": "Content Identifier",
"type": "string"
},
"Root": {
"title": "Content Identifier",
"type": "string"
},
"Size": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"UnsealPrice": {
"additionalProperties": false,
"type": "object"
}
},
"type": [
"object"
]
}
],
"type": [
"array"
]
},
"summary": ""
},
"summary": "ClientFindData identifies peers that have a certain file, and returns QueryOffers (one per peer).\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ClientGenCar(ctx context.Context, ref api.FileRef, outpath string) error {\n\treturn c.Internal.ClientGenCar(ctx, ref, outpath)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L622"
},
"name": "Filecoin.ClientGenCar",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "api.FileRef",
"name": "ref",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
{
"IsCAR": true,
"Path": "string value"
}
],
"properties": {
"IsCAR": {
"type": "boolean"
},
"Path": {
"type": "string"
}
},
"type": [
"object"
]
},
"summary": ""
},
{
"deprecated": false,
"description": "string",
"name": "outpath",
"required": true,
"schema": {
"examples": [
"string value"
],
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "Null",
"name": "Null",
"required": true,
"schema": {
"type": [
"null"
]
}
},
"summary": "ClientGenCar generates a CAR file for the specified file.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ClientGetDealInfo(ctx context.Context, deal cid.Cid) (*api.DealInfo, error) {\n\treturn c.Internal.ClientGetDealInfo(ctx, deal)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L586"
},
"name": "Filecoin.ClientGetDealInfo",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "cid.Cid",
"name": "deal",
"required": true,
"schema": {
"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"
}
],
"title": "Content Identifier",
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "*api.DealInfo",
"name": "*api.DealInfo",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
{
"CreationTime": "0001-01-01T00:00:00Z",
"DataRef": {
"PieceCid": null,
"PieceSize": 1024,
"Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"TransferType": "string value"
},
"DealID": 5432,
"Duration": 42,
"Message": "string value",
"PieceCID": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"PricePerEpoch": "0",
"ProposalCid": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Provider": "f01234",
"Size": 42,
"State": 42,
"Verified": true
}
],
"properties": {
"CreationTime": {
"format": "date-time",
"type": "string"
},
"DataRef": {
"additionalProperties": false,
"properties": {
"PieceCid": {
"title": "Content Identifier",
"type": "string"
},
"PieceSize": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Root": {
"title": "Content Identifier",
"type": "string"
},
"TransferType": {
"type": "string"
}
},
"type": "object"
},
"DealID": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Duration": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"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": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"State": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Verified": {
"type": "boolean"
}
},
"type": [
"object"
]
},
"summary": ""
},
"summary": "ClientGetDealInfo returns the latest information about a given deal.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ClientGetDealStatus(ctx context.Context, statusCode uint64) (string, error) {\n\treturn c.Internal.ClientGetDealStatus(ctx, statusCode)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L590"
},
"name": "Filecoin.ClientGetDealStatus",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "uint64",
"name": "statusCode",
"required": true,
"schema": {
"description": "Hex representation of the integer",
"examples": [
42
],
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "string",
"name": "string",
"required": true,
"schema": {
"examples": [
"string value"
],
"type": [
"string"
]
},
"summary": ""
},
"summary": "ClientGetDealStatus returns status given a code\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ClientHasLocal(ctx context.Context, root cid.Cid) (bool, error) {\n\treturn c.Internal.ClientHasLocal(ctx, root)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L570"
},
"name": "Filecoin.ClientHasLocal",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "cid.Cid",
"name": "root",
"required": true,
"schema": {
"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"
}
],
"title": "Content Identifier",
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "bool",
"name": "bool",
"required": true,
"schema": {
"examples": [
true
],
"type": [
"boolean"
]
},
"summary": ""
},
"summary": "ClientHasLocal indicates whether a certain CID is locally stored.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ClientImport(ctx context.Context, ref api.FileRef) (*api.ImportRes, error) {\n\treturn c.Internal.ClientImport(ctx, ref)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L566"
},
"name": "Filecoin.ClientImport",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "api.FileRef",
"name": "ref",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
{
"IsCAR": true,
"Path": "string value"
}
],
"properties": {
"IsCAR": {
"type": "boolean"
},
"Path": {
"type": "string"
}
},
"type": [
"object"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "*api.ImportRes",
"name": "*api.ImportRes",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
{
"ImportID": 50,
"Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
}
],
"properties": {
"ImportID": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Root": {
"title": "Content Identifier",
"type": "string"
}
},
"type": [
"object"
]
},
"summary": ""
},
"summary": "ClientImport imports file under the specified path into filestore.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ClientListDataTransfers(ctx context.Context) ([]api.DataTransferChannel, error) {\n\treturn c.Internal.ClientListDataTransfers(ctx)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L630"
},
"name": "Filecoin.ClientListDataTransfers",
"paramStructure": "by-position",
"params": [],
"result": {
"deprecated": false,
"description": "[]api.DataTransferChannel",
"name": "[]api.DataTransferChannel",
"required": true,
"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": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"TransferID": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Transferred": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Voucher": {
"type": "string"
}
},
"type": [
"object"
]
}
],
"type": [
"array"
]
},
"summary": ""
},
"summary": "ClientListTransfers returns the status of all ongoing transfers of data\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ClientListDeals(ctx context.Context) ([]api.DealInfo, error) {\n\treturn c.Internal.ClientListDeals(ctx)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L594"
},
"name": "Filecoin.ClientListDeals",
"paramStructure": "by-position",
"params": [],
"result": {
"deprecated": false,
"description": "[]api.DealInfo",
"name": "[]api.DealInfo",
"required": true,
"schema": {
"examples": [
null
],
"items": [
{
"additionalProperties": false,
"properties": {
"CreationTime": {
"format": "date-time",
"type": "string"
},
"DataRef": {
"additionalProperties": false,
"properties": {
"PieceCid": {
"title": "Content Identifier",
"type": "string"
},
"PieceSize": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Root": {
"title": "Content Identifier",
"type": "string"
},
"TransferType": {
"type": "string"
}
},
"type": "object"
},
"DealID": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Duration": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"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": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"State": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Verified": {
"type": "boolean"
}
},
"type": [
"object"
]
}
],
"type": [
"array"
]
},
"summary": ""
},
"summary": "ClientListDeals returns information about the deals made by the local client.\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ClientListImports(ctx context.Context) ([]api.Import, error) {\n\treturn c.Internal.ClientListImports(ctx)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L558"
},
"name": "Filecoin.ClientListImports",
"paramStructure": "by-position",
"params": [],
"result": {
"deprecated": false,
"description": "[]api.Import",
"name": "[]api.Import",
"required": true,
"schema": {
"examples": [
null
],
"items": [
{
"additionalProperties": false,
"properties": {
"Err": {
"type": "string"
},
"FilePath": {
"type": "string"
},
"Key": {
"pattern": "^0x[a-fA-F0-9]+$",
"title": "integer",
"type": "string"
},
"Root": {
"title": "Content Identifier",
"type": "string"
},
"Source": {
"type": "string"
}
},
"type": [
"object"
]
}
],
"type": [
"array"
]
},
"summary": ""
},
"summary": "ClientListImports lists imported files and their root CIDs\n"
},
{
"deprecated": false,
"description": "```go\nfunc (c *FullNodeStruct) ClientMinerQueryOffer(ctx context.Context, miner address.Address, root cid.Cid, piece *cid.Cid) (api.QueryOffer, error) {\n\treturn c.Internal.ClientMinerQueryOffer(ctx, miner, root, piece)\n}\n```",
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/filecoin-project/lotus/blob/master/api/apistruct/struct.go#L578"
},
"name": "Filecoin.ClientMinerQueryOffer",
"paramStructure": "by-position",
"params": [
{
"deprecated": false,
"description": "address.Address",
"name": "miner",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
"f01234"
],
"type": [
"object"
]
},
"summary": ""
},
{
"deprecated": false,
"description": "cid.Cid",
"name": "root",
"required": true,
"schema": {
"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"
}
],
"title": "Content Identifier",
"type": [
"string"
]
},
"summary": ""
},
{
"deprecated": false,
"description": "*cid.Cid",
"name": "piece",
"required": true,
"schema": {
"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
],
"title": "Content Identifier",
"type": [
"string"
]
},
"summary": ""
}
],
"result": {
"deprecated": false,
"description": "api.QueryOffer",
"name": "api.QueryOffer",
"required": true,
"schema": {
"additionalProperties": false,
"examples": [
{
"Err": "string value",
"MinPrice": "0",
"Miner": "f01234",
"MinerPeer": {
"Address": "f01234",
"ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
"PieceCID": null
},
"PaymentInterval": 42,
"PaymentIntervalIncrease": 42,
"Piece": null,
"Root": {
"/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
},
"Size": 42,
"UnsealPrice": "0"
</