Skip to content

wip: propose admin/block/inspect capability #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
travis wants to merge 2 commits into
base: main
Choose a base branch
from
Open

wip: propose admin/block/inspect capability #80

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
16f37ac
wip: propose `admin/blocks/inspect` capability
travis Sep 13, 2023
6a34997
fix: linter demands newline
travis Sep 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 26 additions & 4 deletions w3-admin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,12 +162,12 @@ system tracks, e.g. the spaces the content identified by a given CID has been up

#### returns

The `uploads` property will be a list of spaces the given root CID's content has been uploaded to, along
The `spaces` property will be a list of spaces the given root CID's content has been uploaded to, along
with the date it was uploaded.

```typescript
{
uploads: Array<{space: SpaceDID, insertedAt: Date}>
spaces: Array<{space: SpaceDID, insertedAt: Date}>
}
```

Expand All @@ -183,11 +183,33 @@ e.g. the spaces the CAR identified by a given CID has been stored in and the dat

#### returns

The `stores` property will be a list of spaces the specified shard was stored in, along with the date on
The `spaces` property will be a list of spaces the specified shard was stored in, along with the date on
which it was stored.

```typescript
{
stores: Array<{space: SpaceDID, insertedAt: Date}>
spaces: Array<{space: SpaceDID, insertedAt: Date}>
}
```

### `admin/block/inspect`

Get information about a block by CID. This does not return the actual data identified by the CID, just metadata our
system tracks. Specifically, when invoked this capability should return information about the CAR the block
has been packed into in our system.

### inputs

`link: CID`

### returns

The `carpath` property will be a string representing the location the block's parent CAR is stored in our system.

```typescript
{
carpath: string,
length: number,
offset: number
}
```