range-export: make gen

filecoin-project · Feb 14, 2023 · 5359c2c · 5359c2c
1 parent 8629463
commit 5359c2c
Show file tree

Hide file tree

Showing 12 changed files with 48 additions and 175 deletions.
diff --git a/api/mocks/mock_full.go b/api/mocks/mock_full.go
diff --git a/api/proxy_gen.go b/api/proxy_gen.go
diff --git a/api/v0api/proxy_gen.go b/api/v0api/proxy_gen.go
diff --git a/api/v0api/v0mocks/mock_full.go b/api/v0api/v0mocks/mock_full.go
diff --git a/build/openrpc/full.json.gz b/build/openrpc/full.json.gz
diff --git a/build/openrpc/gateway.json.gz b/build/openrpc/gateway.json.gz
diff --git a/build/openrpc/miner.json.gz b/build/openrpc/miner.json.gz
diff --git a/build/openrpc/worker.json.gz b/build/openrpc/worker.json.gz
diff --git a/documentation/en/api-v0-methods.md b/documentation/en/api-v0-methods.md
@@ -13,8 +13,6 @@
 * [Chain](#Chain)
   * [ChainDeleteObj](#ChainDeleteObj)
   * [ChainExport](#ChainExport)
-  * [ChainExportRange](#ChainExportRange)
-  * [ChainExportRangeInternal](#ChainExportRangeInternal)
   * [ChainGetBlock](#ChainGetBlock)
   * [ChainGetBlockMessages](#ChainGetBlockMessages)
   * [ChainGetGenesis](#ChainGetGenesis)
@@ -423,80 +421,6 @@ Inputs:
 
 Response: `"Ynl0ZSBhcnJheQ=="`
 
-### ChainExportRange
-
-
-Perms: read
-
-Inputs:
-```json
-[
-  [
-    {
-      "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
-    },
-    {
-      "/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
-    }
-  ],
-  [
-    {
-      "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
-    },
-    {
-      "/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
-    }
-  ],
-  {
-    "WriteBufferSize": 123,
-    "Workers": 9,
-    "CacheSize": 123,
-    "IncludeMessages": true,
-    "IncludeReceipts": true,
-    "IncludeStateRoots": true
-  }
-]
-```
-
-Response: `"Ynl0ZSBhcnJheQ=="`
-
-### ChainExportRangeInternal
-
-
-Perms: read
-
-Inputs:
-```json
-[
-  [
-    {
-      "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
-    },
-    {
-      "/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
-    }
-  ],
-  [
-    {
-      "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
-    },
-    {
-      "/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
-    }
-  ],
-  {
-    "WriteBufferSize": 123,
-    "Workers": 9,
-    "CacheSize": 123,
-    "IncludeMessages": true,
-    "IncludeReceipts": true,
-    "IncludeStateRoots": true
-  }
-]
-```
-
-Response: `{}`
-
 ### ChainGetBlock
 ChainGetBlock returns the block specified by the given CID.
 

diff --git a/documentation/en/api-v1-unstable-methods.md b/documentation/en/api-v1-unstable-methods.md
@@ -13,7 +13,6 @@
   * [ChainCheckBlockstore](#ChainCheckBlockstore)
   * [ChainDeleteObj](#ChainDeleteObj)
   * [ChainExport](#ChainExport)
-  * [ChainExportRange](#ChainExportRange)
   * [ChainExportRangeInternal](#ChainExportRangeInternal)
   * [ChainGetBlock](#ChainGetBlock)
   * [ChainGetBlockMessages](#ChainGetBlockMessages)
@@ -474,47 +473,18 @@ Inputs:
 
 Response: `"Ynl0ZSBhcnJheQ=="`
 
-### ChainExportRange
-
-
-Perms: read
-
-Inputs:
-```json
-[
-  [
-    {
-      "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
-    },
-    {
-      "/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
-    }
-  ],
-  [
-    {
-      "/": "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
-    },
-    {
-      "/": "bafy2bzacebp3shtrn43k7g3unredz7fxn4gj533d3o43tqn2p2ipxxhrvchve"
-    }
-  ],
-  {
-    "WriteBufferSize": 123,
-    "Workers": 9,
-    "CacheSize": 123,
-    "IncludeMessages": true,
-    "IncludeReceipts": true,
-    "IncludeStateRoots": true
-  }
-]
-```
-
-Response: `"Ynl0ZSBhcnJheQ=="`
-
 ### ChainExportRangeInternal
+ChainExportRangeInternal triggers the export of a chain
+CAR-snapshot directly to disk. It is similar to ChainExport,
+except, depending on options, the snapshot can include receipts,
+messages and stateroots for the length between the specified head
+and tail, thus producing "archival-grade" snapshots that include
+all the on-chain data.  The header chain is included back to
+genesis and these snapshots can be used to initialize Filecoin
+nodes.
 
 
-Perms: read
+Perms: admin
 
 Inputs:
 ```json
@@ -537,8 +507,7 @@ Inputs:
   ],
   {
     "WriteBufferSize": 123,
-    "Workers": 9,
-    "CacheSize": 123,
+    "NumWorkers": 123,
     "IncludeMessages": true,
     "IncludeReceipts": true,
     "IncludeStateRoots": true

diff --git a/documentation/en/cli-lotus.md b/documentation/en/cli-lotus.md
@@ -2110,6 +2110,7 @@ COMMANDS:
      get                               Get chain DAG node by path
      bisect                            bisect chain for an event
      export                            export chain to a car file
+     export-range                      export chain to a car file
      slash-consensus                   Report consensus fault
      gas-price                         Estimate gas prices
      inspect-usage                     Inspect block space usage of a given tipset
@@ -2291,6 +2292,25 @@ OPTIONS:
    
 ```
 
+### lotus chain export-range
+```
+NAME:
+   lotus chain export-range - export chain to a car file
+
+USAGE:
+   lotus chain export-range [command options] [arguments...]
+
+OPTIONS:
+   --head value          specify tipset to start the export from (higher epoch) (default: "@head")
+   --messages            specify if messages should be include (default: false)
+   --receipts            specify if receipts should be include (default: false)
+   --stateroots          specify if stateroots should be include (default: false)
+   --tail value          specify tipset to end the export at (lower epoch) (default: "@tail")
+   --workers value       specify the number of workers (default: 1)
+   --write-buffer value  specify write buffer size (default: 1048576)
+   
+```
+
 ### lotus chain slash-consensus
 ```
 NAME:

diff --git a/go.mod b/go.mod
@@ -153,6 +153,7 @@ require (
 	go.opentelemetry.io/otel/bridge/opencensus v0.33.0
 	go.opentelemetry.io/otel/exporters/jaeger v1.2.0
 	go.opentelemetry.io/otel/sdk v1.11.1
+	go.uber.org/atomic v1.10.0
 	go.uber.org/fx v1.15.0
 	go.uber.org/multierr v1.8.0
 	go.uber.org/zap v1.23.0
@@ -334,7 +335,6 @@ require (
 	go.opentelemetry.io/otel/metric v0.33.0 // indirect
 	go.opentelemetry.io/otel/sdk/metric v0.33.0 // indirect
 	go.opentelemetry.io/otel/trace v1.11.1 // indirect
-	go.uber.org/atomic v1.10.0 // indirect
 	go.uber.org/dig v1.12.0 // indirect
 	go4.org v0.0.0-20200411211856-f5505b9728dd // indirect
 	golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4 // indirect