refactor!: filecoin capabilities

refactor: switch to rust piece CID calculator (#930) Currently blocked on top level await issue. --------- Co-authored-by: Irakli Gozalishvili <[email protected]> feat: add piece CID to car metadata chore(main): release upload-client 9.4.0 (#935) :robot: I have created a release *beep* *boop* --- [9.4.0](upload-client-v9.3.0...upload-client-v9.4.0) (2023-09-20) * add piece CID to car metadata ([1e52687](1e52687)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). fix: only aggregate CID in aggregate offer success response Update packages/capabilities/src/filecoin/aggregator.js Co-authored-by: Vasco Santos <[email protected]> Update packages/capabilities/src/filecoin/aggregator.js Co-authored-by: Vasco Santos <[email protected]> Update packages/capabilities/src/filecoin/dealer.js Co-authored-by: Vasco Santos <[email protected]> Update packages/capabilities/src/types.ts Co-authored-by: Vasco Santos <[email protected]> Update packages/capabilities/src/types.ts Co-authored-by: Vasco Santos <[email protected]> fix: add missing ContentNotFound definition for filecoin offer failure refactor: storefront caps fix: type errors fix: add missing filecoin submit success and failure types
storacha · Oct 24, 2023 · c0b97bf · c0b97bf
1 parent 84ebb2d
commit c0b97bf
Show file tree

Hide file tree

Showing 13 changed files with 1,310 additions and 342 deletions.
diff --git a/packages/capabilities/package.json b/packages/capabilities/package.json
@@ -31,6 +31,26 @@
       "types": "./dist/src/*.d.ts",
       "import": "./src/*.js"
     },
+    "./filecoin": {
+      "types": "./dist/src/filecoin/index.d.ts",
+      "import": "./src/filecoin/index.js"
+    },
+    "./filecoin/storefront": {
+      "types": "./dist/src/filecoin/storefront.d.ts",
+      "import": "./src/filecoin/storefront.js"
+    },
+    "./filecoin/aggregator": {
+      "types": "./dist/src/filecoin/aggregator.d.ts",
+      "import": "./src/filecoin/aggregator.js"
+    },
+    "./filecoin/deal-tracker": {
+      "types": "./dist/src/filecoin/deal-tracker.d.ts",
+      "import": "./src/filecoin/deal-tracker.js"
+    },
+    "./filecoin/dealer": {
+      "types": "./dist/src/filecoin/dealer.d.ts",
+      "import": "./src/filecoin/dealer.js"
+    },
     "./types": "./dist/src/types.d.ts"
   },
   "typesVersions": {

diff --git a/packages/capabilities/readme.md b/packages/capabilities/readme.md
@@ -30,6 +30,10 @@ import * as Types from '@web3-storage/capabilities/types'
 import * as Upload from '@web3-storage/capabilities/upload'
 import * as Utils from '@web3-storage/capabilities/utils'
 import * as Voucher from '@web3-storage/capabilities/voucher'
+import * as Filecoin from '@web3-storage/capabilities/filecoin'
+import * as Aggregator from '@web3-storage/capabilities/filecoin/aggregator'
+import * as DealTracker from '@web3-storage/capabilities/filecoin/deal-tracker'
+import * as Dealer from '@web3-storage/capabilities/filecoin/dealer'
 
 // This package has a "main" entrypoint but we recommend the usage of the specific imports above
 ```

diff --git a/packages/capabilities/src/filecoin.js b/packages/capabilities/src/filecoin.js
diff --git a/packages/capabilities/src/filecoin/aggregator.js b/packages/capabilities/src/filecoin/aggregator.js
@@ -0,0 +1,76 @@
+/**
+ * Filecoin Aggregator Capabilities
+ *
+ * These can be imported directly with:
+ * ```js
+ * import * as Aggregator from '@web3-storage/capabilities/filecoin/aggregator'
+ * ```
+ *
+ * @module
+ */
+
+import { capability, Schema, ok } from '@ucanto/validator'
+import { PieceLink } from './lib.js'
+import { equal, equalWith, checkLink, and } from '../utils.js'
+
+/**
+ * Capability that allows a Storefront to request that a piece be aggregated
+ * for inclusion in an upcoming an Filecoin deal.
+ */
+export const pieceOffer = capability({
+  can: 'piece/offer',
+  /**
+   * DID of an authorized Storefront.
+   */
+  with: Schema.did(),
+  nb: Schema.struct({
+    /**
+     * CID of the piece.
+     */
+    piece: PieceLink,
+    /**
+     * Grouping of joining segments into an aggregate.
+     */
+    group: Schema.text(),
+  }),
+  derives: (claim, from) => {
+    return (
+      and(equalWith(claim, from)) ||
+      and(checkLink(claim.nb.piece, from.nb.piece, 'nb.piece')) ||
+      and(equal(claim.nb.group, from.nb.group, 'nb.group')) ||
+      ok({})
+    )
+  },
+})
+
+/**
+ * Capability that allows an Aggregator to signal a piece has been accepted
+ * or rejected for inclusion in an aggregate.
+ */
+export const pieceAccept = capability({
+  can: 'piece/accept',
+  /**
+   * DID of the Aggregator.
+   */
+  with: Schema.did(),
+  nb: Schema.struct({
+    /**
+     * CID of the piece.
+     *
+     * @see https://github.com/filecoin-project/FIPs/pull/758/files
+     */
+    piece: PieceLink,
+    /**
+     * Grouping of joining segments into an aggregate.
+     */
+    group: Schema.text(),
+  }),
+  derives: (claim, from) => {
+    return (
+      and(equalWith(claim, from)) ||
+      and(checkLink(claim.nb.piece, from.nb.piece, 'nb.piece')) ||
+      and(equal(claim.nb.group, from.nb.group, 'nb.group')) ||
+      ok({})
+    )
+  },
+})