cerc-io/lotus
16
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 27 Wiki Activity
0444435589
lotus/api
History
Peter Rabbitson 0444435589 Expose basic text-based datamodel selector on retrieval 
Syntaxt of selection is located at
https://pkg.go.dev/github.com/ipld/go-ipld-selector-text-lite#SelectorSpecFromPath

Example use, assuming that:
  - The root of the deal is a plain dag-pb unixfs directory
  - The directory is not sharded
  - The user wants to retrieve the first entry in that directory

  lotus client retrieve --miner f0XXXXX --datamodel-path-selector 'Links/0/Hash' bafyROOTCID ~/output

For a much more elaborate example see the top of ./itests/deals_partial_retrieval_test.go
2021-09-10 09:44:11 +02:00
..
client api: Separate the Net interface from Common 2021-07-15 11:41:30 +02:00
docgen Expose basic text-based datamodel selector on retrieval 2021-09-10 09:44:11 +02:00
docgen-openrpc api: Separate the Net interface from Common 2021-07-15 11:41:30 +02:00
mocks cli for checking alerts 2021-08-26 15:45:17 +02:00
types API proxy struct codegen (#5854) 2021-03-23 13:42:56 +01:00
v0api cli for checking alerts 2021-08-26 15:45:17 +02:00
v1api Merge apistruct with the api package 2021-03-25 15:10:08 +01:00
api_common.go cli for checking alerts 2021-08-26 15:45:17 +02:00
api_full.go Expose basic text-based datamodel selector on retrieval 2021-09-10 09:44:11 +02:00
api_gateway.go feat: expose ChainGetPath on the gateway 2021-08-30 16:43:21 -07:00
api_net.go address net interface split review 2021-07-15 15:51:47 +02:00
api_storage.go Show deal sizes is sealing sectors 2021-09-07 18:49:53 +02:00
api_test.go integrate DAG store and CARv2 in deal-making (#6671) 2021-08-16 23:34:32 +01:00
api_wallet.go lotus-wallet: Support permissioned api 2021-05-31 13:56:35 +02:00
api_worker.go remove read task type and run gen and docsgen 2021-06-07 15:03:06 +05:30
cbor_gen.go integrate DAG store and CARv2 in deal-making (#6671) 2021-08-16 23:34:32 +01:00
checkstatuscode_string.go implement MessagePool.CheckMessages 2021-05-07 15:30:04 +02:00
miner_subsystems.go fix docs and nits. 2021-07-28 20:03:25 +01:00
permissioned.go api: Separate the Net interface from Common 2021-07-15 11:41:30 +02:00
proxy_gen.go feat: expose ChainGetPath on the gateway 2021-08-30 16:43:21 -07:00
proxy_util_test.go address net interface split review 2021-07-15 15:51:47 +02:00
proxy_util.go api: Separate the Net interface from Common 2021-07-15 11:41:30 +02:00
README.md api: Add basic package readme 2021-03-25 18:00:29 +01:00
types.go feat(cli): add a list retrievals command 2021-05-27 11:48:25 -07:00
utils.go Update to specs v0.9.6 2020-09-07 15:48:41 -04:00
version.go revert pricelist by version to pricelist by epoch 2021-08-11 09:49:23 -04:00
wrap.go api: Fix Wrap for nested proxy structs 2021-06-28 19:00:37 +02:00

README.md

Lotus API

This package contains all lotus API definitions. Interfaces defined here are exposed as JsonRPC 2.0 endpoints by lotus programs.

Versions

File Alias File Interface Exposed by Version HTTP Endpoint Status Docs
api_common.go v0api/latest.go Common lotus; lotus-miner v0 /rpc/v0 Latest, Stable Methods
api_full.go v1api/latest.go FullNode lotus v1 /rpc/v1 Latest, Work in progress Methods
api_storage.go v0api/latest.go StorageMiner lotus-miner v0 /rpc/v0 Latest, Stable Methods
api_worker.go v0api/latest.go Worker lotus-worker v0 /rpc/v0 Latest, Stable Methods
v0api/full.go FullNode lotus v0 /rpc/v0 Stable Methods