Skip to content
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.

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

feat: blob protocol draft #115

Merged
merged 21 commits into from
Mar 22, 2024
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
fix: broken link
  • Loading branch information
Gozala committed Mar 19, 2024
commit 6784ecd247c5da7069ffc5b3239d454ae93911ac
2 changes: 1 addition & 1 deletion w3-store.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
| Issuer | A [principal] delegating capabilities to another [principal]. It is the signer of the [UCAN]. Specified in the `iss` field of a UCAN. |
| Audience | Principal access is shared with. Specified in the `aud` field of a UCAN. |


Check failure on line 44 in w3-store.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Multiple consecutive blank lines [Expected: 1; Actual: 2]

w3-store.md:44 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
### Space

A namespace, often referred as a "space", is an owned resource that can be shared. It corresponds to a unique asymmetric cryptographic keypair and is identified by a [`did:key`] URI. The `store/` and `upload/` capabilities can be used to manage content stored in the given space at given storage provider.
Expand Down Expand Up @@ -71,7 +71,7 @@

### Storage Provider

The audience of the invocation (`aud` field) MUST be the [provider] DID of the storage provider implementing this protocol.

Check failure on line 74 in w3-store.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Link fragments should be valid [Context: "#provider"]

w3-store.md:74 MD051/link-fragments Link fragments should be valid [Context: "#provider"]

### Storage Space

Expand Down Expand Up @@ -116,7 +116,7 @@

Capability invocation MUST set `nb.size` field to the byte size of the [content archive][CAR].


Check failure on line 119 in w3-store.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Multiple consecutive blank lines [Expected: 1; Actual: 2]

w3-store.md:119 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
##### Store Add Origin

> Status: Deprecated 🛑
Expand Down Expand Up @@ -347,7 +347,7 @@
}
```


Check failure on line 350 in w3-store.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Multiple consecutive blank lines [Expected: 1; Actual: 2]

w3-store.md:350 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
#### Store Remove Receipt

Capability provider MUST issue signed receipt containing `StoreRemoveResult`.
Expand Down Expand Up @@ -501,7 +501,7 @@

Authorized agent MAY invoke `upload/add` capability on the [space] subject (`with` field) to request that provider (`aud` field) include content identified by `nb.root` in the list of content entries for the space.

It is expected that CARs containing content are stored in the space using [`store/add`] capability. Provider MAY enforce this invariant by failing invocation or choose to succeed invocation but fail to serve the content when requested.

Check failure on line 504 in w3-store.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Link fragments should be valid [Expected: #store-add; Actual: #Store-Add] [Context: "#Store-Add"]

w3-store.md:504 MD051/link-fragments Link fragments should be valid [Expected: #store-add; Actual: #Store-Add] [Context: "#Store-Add"]

> ⚠️ Behavior of calling `upload/add` with a same `root` and different `shards` is not specified by the protocol. w3up reference implementation allows such invocations and updates `shards` to union of all shards across invocations.

Expand Down Expand Up @@ -744,7 +744,7 @@

Authorized agent MAY invoke `upload/list` capability on the [space] subject (`with` field) to list upload entries at the time of the invocation.


Check failure on line 747 in w3-store.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Multiple consecutive blank lines [Expected: 1; Actual: 2]

w3-store.md:747 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
#### Upload List Capability

##### Upload List IPLD Schema
Expand Down Expand Up @@ -843,10 +843,10 @@
}
```


Check failure on line 846 in w3-store.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Multiple consecutive blank lines [Expected: 1; Actual: 2]

w3-store.md:846 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]

Check failure on line 847 in w3-store.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Multiple consecutive blank lines [Expected: 1; Actual: 3]

w3-store.md:847 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 3]
[ucan-spec-top]: https://github.com/ucan-wg/spec#52-top

Check failure on line 848 in w3-store.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Link and image reference definitions should be needed [Unused link or image reference definition: "ucan-spec-top"] [Context: "[ucan-spec-top]: https://githu..."]

w3-store.md:848:1 MD053/link-image-reference-definitions Link and image reference definitions should be needed [Unused link or image reference definition: "ucan-spec-top"] [Context: "[ucan-spec-top]: https://githu..."]
[invocation-spec-pr]: https://github.com/web3-storage/specs/pull/34

Check failure on line 849 in w3-store.md

View workflow job for this annotation

GitHub Actions / markdown-link-check

Link and image reference definitions should be needed [Unused link or image reference definition: "invocation-spec-pr"] [Context: "[invocation-spec-pr]: https://..."]

w3-store.md:849:1 MD053/link-image-reference-definitions Link and image reference definitions should be needed [Unused link or image reference definition: "invocation-spec-pr"] [Context: "[invocation-spec-pr]: https://..."]

[CAR]:https://ipld.io/specs/transport/car/
[Content Address]:https://web3.storage/docs/concepts/content-addressing/
Expand All @@ -868,4 +868,4 @@
[provision]:#provision
[DID]:https://www.w3.org/TR/did-core/
[Content Archive Identifier]:#content-archive-identifier
[`store/add`]:Store-Add
[`store/add`]:#Store-Add
Loading