chore: add examples & context to capabilities package readme #375
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gobengo
reviewed
Jan 19, 2023
|
|
||
| ### Using the exported capabilities | ||
|
|
||
| The capability object exposes three methods via the `TheCapabilityParser` interface: `create`, `invoke`, and `delegate`. |
There was a problem hiding this comment.
this could be good docs to have in ucanto itself (too) https://github.com/web3-storage/ucanto/
gobengo
reviewed
Jan 19, 2023
gobengo
reviewed
Jan 19, 2023
packages/capabilities/readme.md
Outdated
| ```ts | ||
| import * as DID from '@ipld/dag-ucan/did' | ||
|
|
||
| const issuer = loadSigningKey() |
There was a problem hiding this comment.
IMO it could be illustrative to show a working version of this
import * as ed25519 from "@ucanto/principal/ed25519";
const issuer = await ed25519.generate();
gobengo
reviewed
Jan 19, 2023
|
|
||
| The `delegate` method allows you to create a ucanto `Delegation`, which allows another principal to invoke the capability. | ||
|
|
||
| `delegate` accepts the same input as `invoke`, however the `nb` field is optional. If `nb` is present, the values provided will act as constraints on the invocations that can be made using the delegation. For example, creating a `store/add` delegation with the `size` caveat set to `1048576` would limit invocations made using the delegation to uploads of no more than 1MiB. |
There was a problem hiding this comment.
For example, creating a
store/adddelegation with thesizecaveat set to1048576would limit invocations made using the delegation to uploads of no more than 1MiB.
Love calling out the use cases like this. I think over time it may be worth having explicit examples of how to include that size caveat using the delegate method.
Another use case I anticipate is "How can I delegate the ability to store a specific CID"?
gobengo
approved these changes
Jan 19, 2023
hugomrdias
approved these changes
Jan 20, 2023
Co-authored-by: Benjamin Goering <[email protected]>
yusefnapora
changed the title
gobengo
added a commit
that referenced
this pull request
Apr 11, 2023
This closes #369 by adding some examples of using the capability objects exposed by the capabilities package and explaining what some of the fancy type signatures are for. Co-authored-by: Benjamin Goering <[email protected]>
Peeja
pushed a commit
to storacha/upload-service
that referenced
this pull request
Jan 17, 2025
🤖 I have created a release *beep* *boop* --- ## [2.1.0](storacha/w3ui@react-uploads-list-v2.0.1...react-uploads-list-v2.1.0) (2023-02-06) ### Features * "Headless" UI components ([#136](storacha/w3ui#136)) ([46583e0](storacha/w3ui@46583e0) ### Bug Fixes * load first page of uploads list in provider ([storacha#288](storacha/w3ui#288)) ([6778d6c](storacha/w3ui@6778d6c)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Travis Vachon <[email protected]>
Peeja
pushed a commit
to storacha/upload-service
that referenced
this pull request
Jan 29, 2025
🤖 I have created a release *beep* *boop* --- ## [2.1.0](storacha/w3ui@react-uploads-list-v2.0.1...react-uploads-list-v2.1.0) (2023-02-06) ### Features * "Headless" UI components ([#136](storacha/w3ui#136)) ([b702889](storacha/w3ui@b702889) ### Bug Fixes * load first page of uploads list in provider ([storacha#288](storacha/w3ui#288)) ([8a79ad9](storacha/w3ui@8a79ad9)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Travis Vachon <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This closes #369 by adding some examples of using the capability objects exposed by the capabilities package and explaining what some of the fancy type signatures are for.