feat: import space from base64 string #122
Closed
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
tweak w3cli to make it easier to use in CI where you want to provide state via env vars... aka what if this flow could all be done from w3cli https://gist.github.com/alanshaw/e949abfcf6728f590ac9fa083dba5648 Service suggestion: 1. Create a keypair for the server ```sh npx ucan-key ed --json ``` Note down `did` and `key` values! 1. Install the w3cli: ```sh npm i -g @web3-storage/w3cli ``` 1. Authorize your agent to use spaces owned by your email address: ```sh w3 authorize [email protected] ``` 1. Create a space for where the uploads will be registered: ```sh w3 space create myspacename w3 space register ``` 1. Delegate from your local machine to the server: ```sh w3 delegation create <did_from_ucan-key_command_above> --can 'store/add' --can 'upload/add' | base64 ``` 1. Set up environment variables `W3_PRINCIPAL` with the output of `key` from step 1 and `SPACE_PROOF_BASE64` with the output of step 4. 1. Install w3cli in your CI workflow, import the space from `SPACE_PROOF_BASE64` and upload your files ```sh w3cli space add --base64 $SPACE_PROOF_BASE64 w3cli up <./path to your file> ``` DONE! by setting `W3_PRINCIPAL` you w3cli in ci will use the key you generated, and the new w3cli space add --base64 <proof string> flag lets you import and use a space proof from a string. License: MIT Signed-off-by: Oli Evans <[email protected]>
olizilla
commented
Nov 11, 2023
| ? await proofFromString(opts.base64) | ||
| : await proofFromPath(proofPath) | ||
| const space = await client.addSpace(proof) | ||
| await client.setCurrentSpace(space.did()) |
There was a problem hiding this comment.
I reckon space add should set the current space. It was annoying to have to do that manually after calling space add. This is what space create does, so this would be consistent.
License: MIT Signed-off-by: Oli Evans <[email protected]>
alanshaw
approved these changes
Nov 12, 2023
gobengo
reviewed
Nov 17, 2023
| @@ -121,7 +121,8 @@ cli | |||
| .action(registerSpace) | |||
|
|
|||
| cli | |||
| .command('space add <proof>') | |||
| .command('space add [proof]') | |||
| .option('--base64', 'provide proof as base64 encoded string') | |||
There was a problem hiding this comment.
IMO it would be helpful for noobs to know more about what is expected as the bytes that are base64d. iirc the idea is we accept any UCAN serialization? but esp car files?
(e.g. do you want base64(cidOfProofCar) or base64(proofCarWithDagUcanCbor)) ?
This was referenced Jan 10, 2024
|
Superceeded by #158 |
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.
tweak w3cli to make it easier to use in CI where you want to provide state via env vars... aka what if this flow could all be done from w3cli https://gist.github.com/alanshaw/e949abfcf6728f590ac9fa083dba5648
tl;dr what if instead of custom code, the server side of this dance looked like
by setting
W3_PRINCIPALyou w3cli in ci will use the key you generated, and the neww3cli space add --base64 <proof string>flag lets you import and use a space proof from a string.Serving suggestion:
on your local machine
Create a keypair for the server
Note down
didandkeyvalues!Install the w3cli:
Authorize your agent to use spaces owned by your email address:
Create a space for where the uploads will be registered:
Delegate from your local machine to the server:
in CI or ephemeral server
W3_PRINCIPALwith the output ofkeyfrom step 1 andSPACE_PROOF_BASE64with the output of step 5 above.SPACE_PROOF_BASE64and upload your filesDONE!
License: MIT