refactor!: filecoin api services events and tests (#974)

Implements `filecoin-api` services, events and tests all over the place. BREAKING CHANGE: see latest specs https://github.com/web3-storage/specs/blob/cbdb706f18567900c5c24d7fb16ccbaf93d0d023/w3-filecoin.md
storacha · Oct 23, 2023 · d86a667 · d86a667
1 parent 3a2cc9b
commit d86a667
Show file tree

Hide file tree

Showing 59 changed files with 8,949 additions and 2,947 deletions.
diff --git a/packages/capabilities/src/filecoin/dealer.js b/packages/capabilities/src/filecoin/dealer.js
@@ -32,7 +32,7 @@ export const aggregateOffer = capability({
      * CID of the DAG-CBOR encoded block with offer details.
      * Service will queue given offer to be validated and handled.
      */
-    pieces: Schema.link(),
+    pieces: Schema.link({ version: 1 }),
   }),
   derives: (claim, from) => {
     return (

diff --git a/packages/capabilities/src/filecoin/index.js b/packages/capabilities/src/filecoin/index.js
@@ -1,6 +1,6 @@
 /**
  * Filecoin Capabilities
- * 
+ *
  * These capabilities are the entrypoint to the filecoin pipeline and are
  * aliases for the filecoin storefront capabilities.
  *
@@ -15,5 +15,5 @@
 export {
   filecoinOffer as offer,
   filecoinSubmit as submit,
-  filecoinAccept as accept
+  filecoinAccept as accept,
 } from './storefront.js'
diff --git a/packages/capabilities/src/filecoin/lib.js b/packages/capabilities/src/filecoin/lib.js
@@ -9,10 +9,12 @@ const FR32_SHA2_256_TRUNC254_PADDED_BINARY_TREE = /** @type {const} */ (0x1011)
  */
 const RAW_CODE = /** @type {const} */ (0x55)
 
-export const PieceLink = /** @type {import('../types').PieceLinkSchema} */ (Schema.link({
-  code: RAW_CODE,
-  version: 1,
-  multihash: {
-    code: FR32_SHA2_256_TRUNC254_PADDED_BINARY_TREE,
-  },
-}))
+export const PieceLink = /** @type {import('../types').PieceLinkSchema} */ (
+  Schema.link({
+    code: RAW_CODE,
+    version: 1,
+    multihash: {
+      code: FR32_SHA2_256_TRUNC254_PADDED_BINARY_TREE,
+    },
+  })
+)
diff --git a/packages/capabilities/src/types.ts b/packages/capabilities/src/types.ts
@@ -1,8 +1,19 @@
 import type { TupleToUnion } from 'type-fest'
 import * as Ucanto from '@ucanto/interface'
 import type { Schema } from '@ucanto/core'
-import { InferInvokedCapability, Unit, DID, DIDKey, Link } from '@ucanto/interface'
-import { Phantom, PieceLink, ProofData, uint64 } from '@web3-storage/data-segment'
+import {
+  InferInvokedCapability,
+  Unit,
+  DID,
+  DIDKey,
+  Link,
+} from '@ucanto/interface'
+import {
+  Phantom,
+  PieceLink,
+  ProofData,
+  uint64,
+} from '@web3-storage/data-segment'
 import { space, info } from './space.js'
 import * as provider from './provider.js'
 import { top } from './top.js'
@@ -161,14 +172,20 @@ export type Space = InferInvokedCapability<typeof space>
 export type SpaceInfo = InferInvokedCapability<typeof info>
 
 // filecoin
+export interface DealMetadata {
+  dataType: uint64
+  dataSource: SingletonMarketSource
+}
 /** @see https://github.com/filecoin-project/go-data-segment/blob/e3257b64fa2c84e0df95df35de409cfed7a38438/datasegment/verifier.go#L8-L14 */
 export interface DataAggregationProof {
   /**
    * Proof the piece is included in the aggregate.
    */
   inclusion: InclusionProof
-  auxDataType: uint64
-  auxDataSource: SingletonMarketSource
+  /**
+   * Filecoin deal metadata.
+   */
+  aux: DealMetadata
 }
 /** @see https://github.com/filecoin-project/go-data-segment/blob/e3257b64fa2c84e0df95df35de409cfed7a38438/datasegment/inclusion.go#L30-L39 */
 export interface InclusionProof {
@@ -213,15 +230,25 @@ export interface FilecoinSubmitSuccess {
 
 export type FilecoinSubmitFailure = InvalidPieceCID | Ucanto.Failure
 
-export type FilecoinAcceptSuccess = DataAggregationProof
+export interface FilecoinAcceptSuccess extends DataAggregationProof {
+  aggregate: PieceLink
+  piece: PieceLink
+}
 
-export type FilecoinAcceptFailure = InvalidContentPiece | Ucanto.Failure
+export type FilecoinAcceptFailure =
+  | InvalidContentPiece
+  | ProofNotFound
+  | Ucanto.Failure
 
 export interface InvalidContentPiece extends Ucanto.Failure {
   name: 'InvalidContentPiece'
   content: PieceLink
 }
 
+export interface ProofNotFound extends Ucanto.Failure {
+  name: 'ProofNotFound'
+}
+
 // filecoin aggregator
 export interface PieceOfferSuccess {
   /**
@@ -256,7 +283,9 @@ export interface AggregateOfferSuccess {
 }
 export type AggregateOfferFailure = Ucanto.Failure
 
-export type AggregateAcceptSuccess = DataAggregationProof
+export interface AggregateAcceptSuccess extends DealMetadata {
+  aggregate: PieceLink
+}
 export type AggregateAcceptFailure = InvalidPiece | Ucanto.Failure
 
 export interface InvalidPiece extends Ucanto.Failure {
@@ -269,7 +298,7 @@ export interface InvalidPiece extends Ucanto.Failure {
 }
 
 export interface InvalidPieceCID extends Ucanto.Failure {
-  name: 'InvalidPieceCID',
+  name: 'InvalidPieceCID'
   piece: PieceLink
 }
 
@@ -283,7 +312,7 @@ export interface DealDetails {
   // TODO: start/end epoch? etc.
 }
 
-export type FilecoinAddress = `f${string}`
+export type FilecoinAddress = string
 
 export type DealInfoFailure = DealNotFound | Ucanto.Failure
 
@@ -343,9 +372,7 @@ export type AggregateOffer = InferInvokedCapability<
 export type AggregateAccept = InferInvokedCapability<
   typeof DealerCaps.aggregateAccept
 >
-export type DealInfo = InferInvokedCapability<
-  typeof DealTrackerCaps.dealInfo
->
+export type DealInfo = InferInvokedCapability<typeof DealTrackerCaps.dealInfo>
 // Top
 export type Top = InferInvokedCapability<typeof top>
 

diff --git a/packages/filecoin-api/package.json b/packages/filecoin-api/package.json
@@ -20,8 +20,8 @@
       "dealer": [
         "dist/src/dealer.d.ts"
       ],
-      "chain-tracker": [
-        "dist/src/chain-tracker.d.ts"
+      "deal-tracker": [
+        "dist/src/deal-tracker.d.ts"
       ],
       "errors": [
         "dist/src/errors.d.ts"
@@ -54,9 +54,9 @@
       "types": "./dist/src/dealer.d.ts",
       "import": "./src/dealer.js"
     },
-    "./chain-tracker": {
-      "types": "./dist/src/chain-tracker.d.ts",
-      "import": "./src/chain-tracker.js"
+    "./deal-tracker": {
+      "types": "./dist/src/deal-tracker.d.ts",
+      "import": "./src/deal-tracker.js"
     },
     "./storefront": {
       "types": "./dist/src/storefront.d.ts",
@@ -86,7 +86,7 @@
     "@ucanto/server": "^8.0.0",
     "@ucanto/transport": "^8.0.0",
     "@web3-storage/capabilities": "workspace:^",
-    "@web3-storage/data-segment": "^3.0.1"
+    "@web3-storage/data-segment": "^3.2.0"
   },
   "devDependencies": {
     "@ipld/car": "^5.1.1",
@@ -108,7 +108,9 @@
       "project": "./tsconfig.json"
     },
     "rules": {
-      "unicorn/expiring-todo-comments": "off"
+      "unicorn/expiring-todo-comments": "off",
+      "unicorn/prefer-number-properties": "off",
+      "jsdoc/check-indentation": "off"
     },
     "env": {
       "mocha": true

diff --git a/packages/filecoin-api/src/aggregator.js b/packages/filecoin-api/src/aggregator.js
diff --git a/packages/filecoin-api/src/aggregator/api.js b/packages/filecoin-api/src/aggregator/api.js
@@ -0,0 +1 @@
+export {}