Skip to content

Commit

Permalink
file CID => piece CID
Browse files Browse the repository at this point in the history
  • Loading branch information
kochetkov-av committed Jul 28, 2020
1 parent c1e1e73 commit 107d0a7
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The CID Checker as a service provides two REST endpoints, where you need to spec

3. The back-end automates the process of fetching the new data, which requires thousands of JSON RCP calls for every loop.

4. Effective and reliable Mongo DB database with indexes provides fast paginated search by Deal ID, File CID, Miner ID.
4. Effective and reliable Mongo DB database with indexes provides fast paginated search by Deal ID, Piece CID, Miner ID.

5. UI provides rich details on deals.
For the end user it doesn't require any developer skills to quickly get information on deals.
Expand All @@ -44,12 +44,12 @@ If you are a total beginner to this, start here!

**Use remote CID checker service:**
1. Navigate to the website: [www.filecoin.tools](https://deploy-preview-20--filecoincidchecker.netlify.app/)
2. See the list of all file CIDs and related information:
2. See the list of all piece CIDs and related information:
- Deal ID
- Miner ID
- Sector number
- Status
3. Search a record by a File CID, Deal ID, or Miner ID
3. Search a record by a Piece CID, Deal ID, or Miner ID
4. Click on a chosen record and see other related details

**If you are running an own Filecoin (Lotus) node:**
Expand Down Expand Up @@ -96,7 +96,7 @@ Two API endpoints available:
#### :8080/deals
Get deals information about all deals from the database.
#### :8080/deals/:selector
Get deals by selector: File CID, Miner ID and Deal ID.
Get deals by selector: Piece CID, Miner ID and Deal ID.

Both endpoints support pagination.

Expand Down
8 changes: 4 additions & 4 deletions SRS/SRS_confirm_5Jun.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ Scenario: Retrieve the info related to all CIDs
```
>
```gherkin=
Feature: search info by the file CID
Feature: search info by the piece CID
# indexing the Filecoin state by the CID
Scenario: Query the info related to file CID
When User enters the file CID into the Search window
Scenario: Query the info related to piece CID
When User enters the piece CID into the Search window
Then the APP lists the Miners storing this CID,
sectors they are storing,
and the state as a colored indicator
Expand Down Expand Up @@ -70,7 +70,7 @@ User->APP: 1.URL
Note right of APP: Navigating to the URL
APP-->User: List of CIDs
User->APP: 2.File CID
User->APP: 2.Piece CID
Note right of APP: indexing the latest state by the CID
APP-->User: List of Miners storing this file
Expand Down
2 changes: 1 addition & 1 deletion internals/api/handlers/deals.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ type DealsResponse struct {
}

// CreateDealsHandler creates handler for /deals requests.
// Returns deals information by deal ID (not CID, just integer id), file CID or miner id (not CID, id in string form similar to "t01000").
// Returns deals information by deal ID (not CID, just integer id), piece CID or miner id (not CID, id in string form similar to "t01000").
func CreateDealsHandler(dealsRepo repos.DealsRepo, sectorsRepo repos.SectorsRepo) gin.HandlerFunc {
return func(c *gin.Context) {
selector := c.Param("selector")
Expand Down

0 comments on commit 107d0a7

Please sign in to comment.