Skip to content

Commit

Permalink
feat: more readme contexts
Browse files Browse the repository at this point in the history
fix: typo
  • Loading branch information
annielz authored and krish-nr committed May 25, 2023
1 parent f1afdfb commit 9f1acd6
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 2 deletions.
2 changes: 1 addition & 1 deletion core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Infrastructure interface includes:
* [PieceOp](./piecestore/piecestore.go): PieceOp is the helper interface for piece key
operator and piece size calculate.
* [SPDB](./spdb/spdb.go): SPDB is the interface to records the SP metadata.
* [BSDB](./bsdb/bsdb.go): BSDB is the interface to records the chain metadata.
* [BSDB](./bsdb/bsdb.go): BSDB is the interface to records the greenfield chain metadata.
* [TaskQueue](./taskqueue/README.md): Task is the interface to the smallest unit of
SP background service interaction. Task scheduling and execution are directly related
to the order of task arrival, so task queue is a relatively important basic interface
Expand Down
4 changes: 4 additions & 0 deletions docs/introduction/01-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ serve as the gatekeeper for user rights and authentications.

- **P2P** used to interact with the control flow of the payload data, eg: GetSecondaryApproval.

- **Metadata** used to provide efficient query interface to achieve low latency and high-performance SP requirements.

- **PieceStore** interacts with underlying storage vendors, eg. AWS S3, MinIO.

- **SPDB** stores all the contexts of the background jobs and the metadata of the SP.

- **BSDB** stores all the events' data from the greenfield chain and provides them to the metadata service of SP.
1 change: 1 addition & 0 deletions docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ This section dives into the internals of the Greenfield Storage Provider impleme
- [PieceStore](modules/01-piece_store.md)
- [Redundancy](modules/02-redundancy.md)
- [Storage Provider DB](modules/03-sp_db.md)
- [Block Syncer DB](modules/04-bs_db.md)
- Key Workflow
- [Get Approval](workflow/01-get_approval.md)
- [Upload Payload](workflow/02-put_payload_data.md)
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ replace (
github.com/cometbft/cometbft => github.com/bnb-chain/greenfield-cometbft v0.0.1
github.com/confio/ics23/go => github.com/cosmos/cosmos-sdk/ics23/go v0.8.0
github.com/cosmos/cosmos-sdk => github.com/bnb-chain/greenfield-cosmos-sdk v0.2.0
github.com/forbole/juno/v4 => github.com/bnb-chain/juno/v4 v4.0.0-20230524124328-9580fb539071
github.com/forbole/juno/v4 => github.com/bnb-chain/juno/v4 1d98a9519eac7da2e34025053df3e92ec3fe160f
github.com/gogo/protobuf => github.com/regen-network/protobuf v1.3.3-alpha.regen.1
github.com/syndtr/goleveldb => github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7
)
Expand Down

0 comments on commit 9f1acd6

Please sign in to comment.