Skip to content

Commit c39d824

Browse files
hanabi1224rvagg
andcommitted
Apply suggestions from code review
Co-authored-by: Rod Vagg <[email protected]>
1 parent 11a7291 commit c39d824

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

FRCs/frc-0108.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,10 @@ We propose the below changes to the [V1 Filecoin CAR snapshot format](#v1-specif
6060

6161
```go
6262
type SnapshotMetadata {
63-
Version uint64 // required, format version for SnapshotMetadata. Only "2" is supported since "v1" was implied in the original format that predates `SnapshotMetadata`.
64-
HeadTipsetKey []Cid // required
65-
F3Data *Cid // optional, points to F3Data structure. The only supported codec is "RAW" (0x55).
63+
Version uint64 // Required, format version for SnapshotMetadata.
64+
// Only "2" is supported since "v1" was implied in the original format that predates `SnapshotMetadata`.
65+
HeadTipsetKey []Cid // Required
66+
F3Data *Cid // Optional, points to F3Data structure. The only supported codec is "RAW" (0x55).
6667
}
6768
```
6869

@@ -231,9 +232,13 @@ Node users should experience faster F3 bootstrapping time and less network bandw
231232
## Product Considerations
232233
<!--All FIPs must contain a section that discusses the product implications/considerations relative to the proposed change. Include information that might be important for product discussion. A discussion on how the proposed change will enable better storage-related goods and services to be developed on Filecoin. FIP submissions missing the "Product Considerations" section will be rejected. An FIP cannot proceed to status "Final" without a Product Considerations discussion deemed sufficient by the reviewers.-->
233234

234-
Nodes starting from a snapshot should not rely on the certificate exchange protocol to catch up with the F3 data because we expect this will get slower over time. A slow F3 catchup time leads to, e.g.
235+
### Start-up without initial F3 data
235236

236-
- delay in the readiness of F3-aware RPC APIs
237+
Nodes starting from a snapshot should not rely on the certificate exchange protocol to catch up with the F3 data because we expect this will get slower over time. One outcome of a slow F3 catchup time is a delay in the readiness of F3-aware RPC APIs.
238+
239+
### CAR format expectations
240+
241+
This change introduces a relatively novel use of the CAR format in that it contains one very large block, much larger than typical blocks found in most CAR containers for use with IPLD data. At the time of this proposal, this block size would be approximately TODO MiB and this will only grow over time. While this is not disallowed by the CAR specification, many CAR processing utilities are built on an assumption of classic IPFS style blocks of more more than approximately 1MiB each. Some CAR tooling may struggle to deal with the new proposed format, although handling CAR data outside of the narrow use-case of snapshort imports on Filecoin nodes is not typical or necessarily recommended.
237242

238243
## Implementation
239244
<!--The implementations must be completed before any core FIP is given status "Final", but it need not be completed before the FIP is accepted. While there is merit to the approach of reaching consensus on the specification and rationale before writing code, the principle of "rough consensus and running code" is still useful when it comes to resolving many discussions of API details.-->

0 commit comments

Comments
 (0)