feat: add CLI (#39)

This PR adds the CLI from https://github.com/storacha/w3cli * Renames module `@web3-storage/w3cli` => `@storacha/cli` * Renames command `w3` => `storacha` * Renames env vars `W3_...` => `STORACHA_...` * Uses new service DID and URL `did:web:upload.storacha.network` & `https://upload.storacha.network` * Removes store protocol resolves #1
storacha · Nov 12, 2024 · 112720e · 112720e
1 parent 6eba88d
commit 112720e
Show file tree

Hide file tree

Showing 48 changed files with 6,853 additions and 493 deletions.
diff --git a/.github/release-please-config.json b/.github/release-please-config.json
@@ -9,6 +9,7 @@
   "packages": {
     "packages/access-client": {},
     "packages/blob-index": {},
+    "packages/cli": {},
     "packages/filecoin-api": {},
     "packages/filecoin-client": {},
     "packages/capabilities": {},

diff --git a/.github/release-please-manifest.json b/.github/release-please-manifest.json
@@ -1,6 +1,7 @@
 {
   "packages/access-client": "0.0.0",
   "packages/blob-index": "0.0.0",
+  "packages/cli": "0.0.0",
   "packages/filecoin-api": "0.0.0",
   "packages/filecoin-client": "0.0.0",
   "packages/capabilities": "1.0.0",

diff --git a/.github/workflows/cli.yml b/.github/workflows/cli.yml
@@ -0,0 +1,43 @@
+name: cli
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'packages/cli/**'
+      - 'packages/eslint-config-w3up/**'
+      - '.github/workflows/cli.yml'
+      - 'pnpm-lock.yaml'
+  pull_request:
+    paths:
+      - 'packages/cli/**'
+      - 'packages/eslint-config-w3up/**'
+      - '.github/workflows/cli.yml'
+      - 'pnpm-lock.yaml'
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node_version:
+          - 18
+          - 20
+    defaults:
+      run:
+        working-directory: ./packages/cli
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install
+        uses: pnpm/action-setup@v4
+      - name: Setup
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node_version }}
+          registry-url: https://registry.npmjs.org/
+          cache: 'pnpm'
+      - run: pnpm install
+      - run: pnpm -r --filter @storacha/cli run lint
+      - run: pnpm -r --filter @storacha/cli run check
+      - run: pnpm -r --filter @storacha/cli run test
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -29,6 +29,7 @@ jobs:
       contains(fromJson(needs.release.outputs.paths_released), 'packages/access-client') ||
       contains(fromJson(needs.release.outputs.paths_released), 'packages/blob-index') ||
       contains(fromJson(needs.release.outputs.paths_released), 'packages/capabilities') ||
+      contains(fromJson(needs.release.outputs.paths_released), 'packages/cli') ||
       contains(fromJson(needs.release.outputs.paths_released), 'packages/did-mailto') ||
       contains(fromJson(needs.release.outputs.paths_released), 'packages/upload-client') ||
       contains(fromJson(needs.release.outputs.paths_released), 'packages/upload-api') ||

diff --git a/.github/workflows/w3up-client.yml b/.github/workflows/w3up-client.yml
@@ -1,4 +1,4 @@
-name: w3up-client
+name: client
 on:
   push:
     branches:

diff --git a/packages/access-client/test/agent-use-cases.test.js b/packages/access-client/test/agent-use-cases.test.js
@@ -197,7 +197,7 @@ describe('authorizeWaitAndClaim', async function () {
 describe('getAccountPlan', async function () {
   const accountWithAPlan = 'did:mailto:example.com:i-have-a-plan'
   const accountWithoutAPlan = 'did:mailto:example.com:i-have-no-plan'
-  const product = 'did:web:test.storacha.network'
+  const product = 'did:web:test.upload.storacha.network'
   /** @type {Record<Ucanto.DID, {product: Ucanto.DID, updatedAt: string}>} */
   const plans = {
     [accountWithAPlan]: {

diff --git a/packages/capabilities/test/capabilities/provider.test.js b/packages/capabilities/test/capabilities/provider.test.js
@@ -18,7 +18,7 @@ describe('provider/add', function () {
       audience: service,
       with: account,
       nb: {
-        provider: 'did:web:test.storacha.network',
+        provider: 'did:web:test.upload.storacha.network',
         consumer: space.did(),
       },
       proofs: await createAuthorization({ agent, service, account }),
@@ -36,7 +36,7 @@ describe('provider/add', function () {
       assert.deepEqual(result.ok.audience.did(), service.did())
       assert.equal(result.ok.capability.can, 'provider/add')
       assert.deepEqual(result.ok.capability.nb, {
-        provider: 'did:web:test.storacha.network',
+        provider: 'did:web:test.upload.storacha.network',
         consumer: space.did(),
       })
     }
@@ -51,7 +51,7 @@ describe('provider/add', function () {
       audience: service,
       with: account,
       nb: {
-        provider: 'did:web:test.storacha.network',
+        provider: 'did:web:test.upload.storacha.network',
         consumer: space.did(),
       },
     })
@@ -80,7 +80,7 @@ describe('provider/add', function () {
       audience: service,
       with: account,
       nb: {
-        provider: 'did:web:test.storacha.network',
+        provider: 'did:web:test.upload.storacha.network',
         consumer: space.did(),
       },
       proofs: [delegation],
@@ -110,7 +110,7 @@ describe('provider/add', function () {
       audience: service,
       with: account,
       nb: {
-        provider: 'did:web:test.storacha.network',
+        provider: 'did:web:test.upload.storacha.network',
         consumer: space.did(),
       },
       proofs: [attestation],
@@ -135,7 +135,7 @@ describe('provider/add', function () {
         with: bobAccount.did(),
         // @ts-ignore
         nb: {
-          provider: 'did:web:test.storacha.network',
+          provider: 'did:web:test.upload.storacha.network',
         },
       })
     }, /Error: Invalid 'nb' - Object contains invalid field "consumer"/)
@@ -149,7 +149,7 @@ describe('provider/add', function () {
         audience: service,
         with: bobAccount.did(),
         nb: {
-          provider: 'did:web:test.storacha.network',
+          provider: 'did:web:test.upload.storacha.network',
           // @ts-expect-error
           consumer: 'did:mailto:storacha.network:user',
         },
@@ -166,7 +166,7 @@ describe('provider/add', function () {
         with: bobAccount.did(),
         // @ts-expect-error - missing provider
         nb: {
-          // provider: 'did:web:test.storacha.network',
+          // provider: 'did:web:test.upload.storacha.network',
           consumer: bob.did(),
         },
       })
@@ -197,7 +197,7 @@ describe('provider/add', function () {
       audience: service,
       with: account,
       nb: {
-        provider: 'did:web:test.storacha.network',
+        provider: 'did:web:test.upload.storacha.network',
         consumer: space.did(),
       },
       proofs: [
@@ -206,7 +206,7 @@ describe('provider/add', function () {
           audience: bob,
           with: account,
           nb: {
-            provider: 'did:web:test.storacha.network',
+            provider: 'did:web:test.upload.storacha.network',
             consumer: space.did(),
           },
           proofs: await createAuthorization({ agent, service, account }),
@@ -233,7 +233,7 @@ describe('provider/add', function () {
       audience: service,
       with: account,
       nb: {
-        provider: 'did:web:test.storacha.network',
+        provider: 'did:web:test.upload.storacha.network',
         consumer: space.did(),
       },
       proofs: [
@@ -242,7 +242,7 @@ describe('provider/add', function () {
           audience: bob,
           with: account,
           nb: {
-            provider: 'did:web:test.storacha.network',
+            provider: 'did:web:test.upload.storacha.network',
           },
           proofs: await createAuthorization({ agent, service, account }),
         }),
@@ -268,7 +268,7 @@ describe('provider/add', function () {
       audience: service,
       with: account,
       nb: {
-        provider: 'did:web:test.storacha.network',
+        provider: 'did:web:test.upload.storacha.network',
         consumer: space.did(),
       },
       proofs: [
@@ -303,7 +303,7 @@ describe('provider/add', function () {
       audience: service,
       with: account,
       nb: {
-        provider: 'did:web:test.storacha.network',
+        provider: 'did:web:test.upload.storacha.network',
         consumer: bob.did(),
       },
       proofs: [
@@ -338,7 +338,7 @@ describe('provider/add', function () {
       audience: service,
       with: account,
       nb: {
-        provider: 'did:web:test.storacha.network',
+        provider: 'did:web:test.upload.storacha.network',
         consumer: bob.did(),
       },
       proofs: [
@@ -379,7 +379,7 @@ describe('provider/add', function () {
       audience: service,
       with: 'did:mailto:mallory.com:bob',
       nb: {
-        provider: 'did:web:test.storacha.network',
+        provider: 'did:web:test.upload.storacha.network',
         consumer: bob.did(),
       },
       proofs: [
@@ -428,7 +428,7 @@ describe('provider/add', function () {
           with: account.did(),
           nb: {
             consumer: space.did(),
-            provider: 'did:web:test.storacha.network',
+            provider: 'did:web:test.upload.storacha.network',
           },
           // NOTE: no proofs!
         })

diff --git a/packages/capabilities/test/helpers/fixtures.js b/packages/capabilities/test/helpers/fixtures.js
@@ -31,7 +31,7 @@ export const malloryAccount = Absentee.from({
 
 export const service = Signer.parse(
   'MgCYKXoHVy7Vk4/QjcEGi+MCqjntUiasxXJ8uJKY0qh11e+0Bs8WsdqGK7xothgrDzzWD0ME7ynPjz2okXDh8537lId8='
-).withDID('did:web:test.storacha.network')
+).withDID('did:web:test.upload.storacha.network')
 
 export const readmeCID = parseLink(
   'bafybeihqfdg2ereoijjoyrqzr2x2wsasqm2udurforw7pa3tvbnxhojao4'

diff --git a/packages/cli/.gitattributes b/packages/cli/.gitattributes
@@ -0,0 +1,2 @@
+*      text=auto
+*.car -text
diff --git a/packages/cli/.gitignore b/packages/cli/.gitignore
@@ -0,0 +1 @@
+node_modules