cerc-io/lotus
16
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 27 Wiki Activity
596b31fb9e
lotus/documentation/en/api-methods-miner.md
Łukasz Magiera 63f13977ce Make docsgen more deterministic
2020-11-12 20:18:39 +01:00

24 KiB
Raw Blame History

Groups

Closing

Perms: read

Inputs: null

Response: {}

Session

Perms: read

Inputs: null

Response: "07070707-0707-0707-0707-070707070707"

Shutdown

Perms: admin

Inputs: null

Response: {}

Version

Perms: read

Inputs: null

Response:

{
  "Version": "string value",
  "APIVersion": 4352,
  "BlockDelay": 42
}

Actor

ActorAddress

There are not yet any comments for this method.

Perms: read

Inputs: null

Response: "f01234"

ActorSectorSize

There are not yet any comments for this method.

Perms: read

Inputs:

[
  "f01234"
]

Response: 34359738368

Auth

AuthNew

Perms: admin

Inputs:

[
  null
]

Response: "Ynl0ZSBhcnJheQ=="

AuthVerify

Perms: read

Inputs:

[
  "string value"
]

Response: null

Create

CreateBackup

CreateBackup creates node backup onder the specified file name. The method requires that the lotus-miner is running with the LOTUS_BACKUP_BASE_PATH environment variable set to some path, and that the path specified when calling CreateBackup is within the base path

Perms: admin

Inputs:

[
  "string value"
]

Response: {}

Deals

DealsConsiderOfflineRetrievalDeals

There are not yet any comments for this method.

Perms: read

Inputs: null

Response: true

DealsConsiderOfflineStorageDeals

There are not yet any comments for this method.

Perms: read

Inputs: null

Response: true

DealsConsiderOnlineRetrievalDeals

There are not yet any comments for this method.

Perms: read

Inputs: null

Response: true

DealsConsiderOnlineStorageDeals

There are not yet any comments for this method.

Perms: read

Inputs: null

Response: true

DealsImportData

There are not yet any comments for this method.

Perms: write

Inputs:

[
  {
    "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
  },
  "string value"
]

Response: {}

DealsList

There are not yet any comments for this method.

Perms: read

Inputs: null

Response: null

DealsPieceCidBlocklist

There are not yet any comments for this method.

Perms: read

Inputs: null

Response: null

DealsSetConsiderOfflineRetrievalDeals

There are not yet any comments for this method.

Perms: admin

Inputs:

[
  true
]

Response: {}

DealsSetConsiderOfflineStorageDeals

There are not yet any comments for this method.

Perms: admin

Inputs:

[
  true
]

Response: {}

DealsSetConsiderOnlineRetrievalDeals

There are not yet any comments for this method.

Perms: admin

Inputs:

[
  true
]

Response: {}

DealsSetConsiderOnlineStorageDeals

There are not yet any comments for this method.

Perms: admin

Inputs:

[
  true
]

Response: {}

DealsSetPieceCidBlocklist

There are not yet any comments for this method.

Perms: admin

Inputs:

[
  null
]

Response: {}

I

ID

Perms: read

Inputs: null

Response: "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"

Log

LogList

Perms: write

Inputs: null

Response: null

LogSetLevel

Perms: write

Inputs:

[
  "string value",
  "string value"
]

Response: {}

Market

MarketCancelDataTransfer

ClientCancelDataTransfer cancels a data transfer with the given transfer ID and other peer

Perms: read

Inputs:

[
  3,
  "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
  true
]

Response: {}

MarketDataTransferUpdates

There are not yet any comments for this method.

Perms: write

Inputs: null

Response:

{
  "TransferID": 3,
  "Status": 1,
  "BaseCID": {
    "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
  },
  "IsInitiator": true,
  "IsSender": true,
  "Voucher": "string value",
  "Message": "string value",
  "OtherPeer": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
  "Transferred": 42
}

MarketGetAsk

There are not yet any comments for this method.

Perms: read

Inputs: null

Response:

{
  "Ask": {
    "Price": "0",
    "VerifiedPrice": "0",
    "MinPieceSize": 1032,
    "MaxPieceSize": 1032,
    "Miner": "f01234",
    "Timestamp": 10101,
    "Expiry": 10101,
    "SeqNo": 42
  },
  "Signature": {
    "Type": 2,
    "Data": "Ynl0ZSBhcnJheQ=="
  }
}

MarketGetDealUpdates

There are not yet any comments for this method.

Perms: read

Inputs: null

Response:

{
  "Proposal": {
    "PieceCID": {
      "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
    },
    "PieceSize": 1032,
    "VerifiedDeal": true,
    "Client": "f01234",
    "Provider": "f01234",
    "Label": "string value",
    "StartEpoch": 10101,
    "EndEpoch": 10101,
    "StoragePricePerEpoch": "0",
    "ProviderCollateral": "0",
    "ClientCollateral": "0"
  },
  "ClientSignature": {
    "Type": 2,
    "Data": "Ynl0ZSBhcnJheQ=="
  },
  "ProposalCid": {
    "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
  },
  "AddFundsCid": null,
  "PublishCid": null,
  "Miner": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
  "Client": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
  "State": 42,
  "PiecePath": ".lotusminer/fstmp123",
  "MetadataPath": ".lotusminer/fstmp123",
  "SlashEpoch": 10101,
  "FastRetrieval": true,
  "Message": "string value",
  "StoreID": 12,
  "FundsReserved": "0",
  "Ref": {
    "TransferType": "string value",
    "Root": {
      "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
    },
    "PieceCid": null,
    "PieceSize": 1024
  },
  "AvailableForRetrieval": true,
  "DealID": 5432,
  "CreationTime": "0001-01-01T00:00:00Z",
  "TransferChannelId": {
    "Initiator": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
    "Responder": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
    "ID": 3
  }
}

MarketGetRetrievalAsk

There are not yet any comments for this method.

Perms: read

Inputs: null

Response:

{
  "PricePerByte": "0",
  "UnsealPrice": "0",
  "PaymentInterval": 42,
  "PaymentIntervalIncrease": 42
}

MarketImportDealData

There are not yet any comments for this method.

Perms: write

Inputs:

[
  {
    "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
  },
  "string value"
]

Response: {}

MarketListDataTransfers

There are not yet any comments for this method.

Perms: write

Inputs: null

Response: null

MarketListDeals

There are not yet any comments for this method.

Perms: read

Inputs: null

Response: null

MarketListIncompleteDeals

There are not yet any comments for this method.

Perms: read

Inputs: null

Response: null

MarketListRetrievalDeals

There are not yet any comments for this method.

Perms: read

Inputs: null

Response: null

MarketRestartDataTransfer

MinerRestartDataTransfer attempts to restart a data transfer with the given transfer ID and other peer

Perms: read

Inputs:

[
  3,
  "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf",
  true
]

Response: {}

MarketSetAsk

There are not yet any comments for this method.

Perms: admin

Inputs:

[
  "0",
  "0",
  10101,
  1032,
  1032
]

Response: {}

MarketSetRetrievalAsk

There are not yet any comments for this method.

Perms: admin

Inputs:

[
  {
    "PricePerByte": "0",
    "UnsealPrice": "0",
    "PaymentInterval": 42,
    "PaymentIntervalIncrease": 42
  }
]

Response: {}

Mining

MiningBase

There are not yet any comments for this method.

Perms: read

Inputs: null

Response:

{
  "Cids": null,
  "Blocks": null,
  "Height": 0
}

Net

NetAddrsListen

Perms: read

Inputs: null

Response:

{
  "Addrs": null,
  "ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
}

NetAgentVersion

Perms: read

Inputs:

[
  "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
]

Response: "string value"

NetAutoNatStatus

Perms: read

Inputs: null

Response:

{
  "Reachability": 1,
  "PublicAddr": "string value"
}

NetBandwidthStats

Perms: read

Inputs: null

Response:

{
  "TotalIn": 9,
  "TotalOut": 9,
  "RateIn": 12.3,
  "RateOut": 12.3
}

NetBandwidthStatsByPeer

Perms: read

Inputs: null

Response:

{
  "12D3KooWSXmXLJmBR1M7i9RW9GQPNUhZSzXKzxDHWtAgNuJAbyEJ": {
    "TotalIn": 174000,
    "TotalOut": 12500,
    "RateIn": 100,
    "RateOut": 50
  }
}

NetBandwidthStatsByProtocol

Perms: read

Inputs: null

Response:

{
  "/fil/hello/1.0.0": {
    "TotalIn": 174000,
    "TotalOut": 12500,
    "RateIn": 100,
    "RateOut": 50
  }
}

NetConnect

Perms: write

Inputs:

[
  {
    "Addrs": null,
    "ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
  }
]

Response: {}

NetConnectedness

Perms: read

Inputs:

[
  "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
]

Response: 1

NetDisconnect

Perms: write

Inputs:

[
  "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
]

Response: {}

NetFindPeer

Perms: read

Inputs:

[
  "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
]

Response:

{
  "Addrs": null,
  "ID": "12D3KooWGzxzKZYveHXtpG6AsrUJBcWxHBFS2HsEoGTxrMLvKXtf"
}

NetPeers

Perms: read

Inputs: null

Response: null

NetPubsubScores

Perms: read

Inputs: null

Response: null

Pieces

PiecesGetCIDInfo

There are not yet any comments for this method.

Perms: read

Inputs:

[
  {
    "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
  }
]

Response:

{
  "CID": {
    "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
  },
  "PieceBlockLocations": null
}

PiecesGetPieceInfo

There are not yet any comments for this method.

Perms: read

Inputs:

[
  {
    "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
  }
]

Response:

{
  "PieceCID": {
    "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
  },
  "Deals": null
}

PiecesListCidInfos

There are not yet any comments for this method.

Perms: read

Inputs: null

Response: null

PiecesListPieces

There are not yet any comments for this method.

Perms: read

Inputs: null

Response: null

Pledge

PledgeSector

Temp api for testing

Perms: write

Inputs: null

Response: {}

Return

ReturnAddPiece

Perms: admin

Inputs:

[
  {
    "Sector": {
      "Miner": 1000,
      "Number": 9
    },
    "ID": "07070707-0707-0707-0707-070707070707"
  },
  {
    "Size": 1032,
    "PieceCID": {
      "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
    }
  },
  "string value"
]

Response: {}

ReturnFetch

Perms: admin

Inputs:

[
  {
    "Sector": {
      "Miner": 1000,
      "Number": 9
    },
    "ID": "07070707-0707-0707-0707-070707070707"
  },
  "string value"
]

Response: {}

ReturnFinalizeSector

Perms: admin

Inputs:

[
  {
    "Sector": {
      "Miner": 1000,
      "Number": 9
    },
    "ID": "07070707-0707-0707-0707-070707070707"
  },
  "string value"
]

Response: {}

ReturnMoveStorage

Perms: admin

Inputs:

[
  {
    "Sector": {
      "Miner": 1000,
      "Number": 9
    },
    "ID": "07070707-0707-0707-0707-070707070707"
  },
  "string value"
]

Response: {}

ReturnReadPiece

Perms: admin

Inputs:

[
  {
    "Sector": {
      "Miner": 1000,
      "Number": 9
    },
    "ID": "07070707-0707-0707-0707-070707070707"
  },
  true,
  "string value"
]

Response: {}

ReturnReleaseUnsealed

Perms: admin

Inputs:

[
  {
    "Sector": {
      "Miner": 1000,
      "Number": 9
    },
    "ID": "07070707-0707-0707-0707-070707070707"
  },
  "string value"
]

Response: {}

ReturnSealCommit1

Perms: admin

Inputs:

[
  {
    "Sector": {
      "Miner": 1000,
      "Number": 9
    },
    "ID": "07070707-0707-0707-0707-070707070707"
  },
  null,
  "string value"
]

Response: {}

ReturnSealCommit2

Perms: admin

Inputs:

[
  {
    "Sector": {
      "Miner": 1000,
      "Number": 9
    },
    "ID": "07070707-0707-0707-0707-070707070707"
  },
  null,
  "string value"
]

Response: {}

ReturnSealPreCommit1

Perms: admin

Inputs:

[
  {
    "Sector": {
      "Miner": 1000,
      "Number": 9
    },
    "ID": "07070707-0707-0707-0707-070707070707"
  },
  null,
  "string value"
]

Response: {}

ReturnSealPreCommit2

Perms: admin

Inputs:

[
  {
    "Sector": {
      "Miner": 1000,
      "Number": 9
    },
    "ID": "07070707-0707-0707-0707-070707070707"
  },
  {
    "Unsealed": {
      "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
    },
    "Sealed": {
      "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
    }
  },
  "string value"
]

Response: {}

ReturnUnsealPiece

Perms: admin

Inputs:

[
  {
    "Sector": {
      "Miner": 1000,
      "Number": 9
    },
    "ID": "07070707-0707-0707-0707-070707070707"
  },
  "string value"
]

Response: {}

Sealing

SealingAbort

There are not yet any comments for this method.

Perms: admin

Inputs:

[
  {
    "Sector": {
      "Miner": 1000,
      "Number": 9
    },
    "ID": "07070707-0707-0707-0707-070707070707"
  }
]

Response: {}

SealingSchedDiag

SealingSchedDiag dumps internal sealing scheduler state

Perms: admin

Inputs:

[
  true
]

Response: {}

Sector

SectorGetExpectedSealDuration

SectorGetExpectedSealDuration gets the expected time for a sector to seal

Perms: read

Inputs: null

Response: 60000000000

SectorGetSealDelay

SectorGetSealDelay gets the time that a newly-created sector waits for more deals before it starts sealing

Perms: read

Inputs: null

Response: 60000000000

SectorMarkForUpgrade

There are not yet any comments for this method.

Perms: admin

Inputs:

[
  9
]

Response: {}

SectorRemove

There are not yet any comments for this method.

Perms: admin

Inputs:

[
  9
]

Response: {}

SectorSetExpectedSealDuration

SectorSetExpectedSealDuration sets the expected time for a sector to seal

Perms: write

Inputs:

[
  60000000000
]

Response: {}

SectorSetSealDelay

SectorSetSealDelay sets the time that a newly-created sector waits for more deals before it starts sealing

Perms: write

Inputs:

[
  60000000000
]

Response: {}

SectorStartSealing

SectorStartSealing can be called on sectors in Empty or WaitDeals states to trigger sealing early

Perms: write

Inputs:

[
  9
]

Response: {}

Sectors

SectorsList

List all staged sectors

Perms: read

Inputs: null

Response: null

SectorsRefs

There are not yet any comments for this method.

Perms: read

Inputs: null

Response:

{
  "98000": [
    {
      "SectorID": 100,
      "Offset": 10485760,
      "Size": 1048576
    }
  ]
}

SectorsStatus

Get the status of a given sector by ID

Perms: read

Inputs:

[
  9,
  true
]

Response:

{
  "SectorID": 9,
  "State": "Proving",
  "CommD": null,
  "CommR": null,
  "Proof": "Ynl0ZSBhcnJheQ==",
  "Deals": null,
  "Ticket": {
    "Value": null,
    "Epoch": 10101
  },
  "Seed": {
    "Value": null,
    "Epoch": 10101
  },
  "PreCommitMsg": null,
  "CommitMsg": null,
  "Retries": 42,
  "ToUpgrade": true,
  "LastErr": "string value",
  "Log": null,
  "SealProof": 3,
  "Activation": 10101,
  "Expiration": 10101,
  "DealWeight": "0",
  "VerifiedDealWeight": "0",
  "InitialPledge": "0",
  "OnTime": 10101,
  "Early": 10101
}

SectorsUpdate

There are not yet any comments for this method.

Perms: admin

Inputs:

[
  9,
  "Proving"
]

Response: {}

Storage

StorageAddLocal

There are not yet any comments for this method.

Perms: admin

Inputs:

[
  "string value"
]

Response: {}

StorageAttach

Perms: admin

Inputs:

[
  {
    "ID": "76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8",
    "URLs": null,
    "Weight": 42,
    "CanSeal": true,
    "CanStore": true
  },
  {
    "Capacity": 9,
    "Available": 9,
    "Reserved": 9
  }
]

Response: {}

StorageBestAlloc

Perms: admin

Inputs:

[
  1,
  34359738368,
  "sealing"
]

Response: null

StorageDeclareSector

Perms: admin

Inputs:

[
  "76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8",
  {
    "Miner": 1000,
    "Number": 9
  },
  1,
  true
]

Response: {}

StorageDropSector

Perms: admin

Inputs:

[
  "76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8",
  {
    "Miner": 1000,
    "Number": 9
  },
  1
]

Response: {}

StorageFindSector

Perms: admin

Inputs:

[
  {
    "Miner": 1000,
    "Number": 9
  },
  1,
  34359738368,
  true
]

Response: null

StorageInfo

Perms: admin

Inputs:

[
  "76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8"
]

Response:

{
  "ID": "76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8",
  "URLs": null,
  "Weight": 42,
  "CanSeal": true,
  "CanStore": true
}

StorageList

There are not yet any comments for this method.

Perms: admin

Inputs: null

Response:

{
  "76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8": [
    {
      "Miner": 1000,
      "Number": 100,
      "SectorFileType": 2
    }
  ]
}

StorageLocal

There are not yet any comments for this method.

Perms: admin

Inputs: null

Response:

{
  "76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8": "/data/path"
}

StorageLock

Perms: admin

Inputs:

[
  {
    "Miner": 1000,
    "Number": 9
  },
  1,
  1
]

Response: {}

StorageReportHealth

Perms: admin

Inputs:

[
  "76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8",
  {
    "Stat": {
      "Capacity": 9,
      "Available": 9,
      "Reserved": 9
    },
    "Err": "string value"
  }
]

Response: {}

StorageStat

There are not yet any comments for this method.

Perms: admin

Inputs:

[
  "76f1988b-ef30-4d7e-b3ec-9a627f4ba5a8"
]

Response:

{
  "Capacity": 9,
  "Available": 9,
  "Reserved": 9
}

StorageTryLock

Perms: admin

Inputs:

[
  {
    "Miner": 1000,
    "Number": 9
  },
  1,
  1
]

Response: true

Worker

WorkerConnect

WorkerConnect tells the node to connect to workers RPC

Perms: admin

Inputs:

[
  "string value"
]

Response: {}

WorkerJobs

There are not yet any comments for this method.

Perms: admin

Inputs: null

Response:

{
  "ef8d99a2-6865-4189-8ffa-9fef0f806eee": [
    {
      "ID": {
        "Sector": {
          "Miner": 1000,
          "Number": 100
        },
        "ID": "76081ba0-61bd-45a5-bc08-af05f1c26e5d"
      },
      "Sector": {
        "Miner": 1000,
        "Number": 100
      },
      "Task": "seal/v0/precommit/2",
      "RunWait": 0,
      "Start": "2020-11-12T09:22:07Z",
      "Hostname": "host"
    }
  ]
}

WorkerStats

There are not yet any comments for this method.

Perms: admin

Inputs: null

Response:

{
  "ef8d99a2-6865-4189-8ffa-9fef0f806eee": {
    "Info": {
      "Hostname": "host",
      "Resources": {
        "MemPhysical": 274877906944,
        "MemSwap": 128849018880,
        "MemReserved": 2147483648,
        "CPUs": 64,
        "GPUs": [
          "aGPU 1337"
        ]
      }
    },
    "Enabled": true,
    "MemUsedMin": 0,
    "MemUsedMax": 0,
    "GpuUsed": false,
    "CpuUse": 0
  }
}