feat: add blob protocol to upload-client (#1425)

storacha · May 13, 2024 · 49aef56 · 49aef56
1 parent 9982d12
commit 49aef56
Show file tree

Hide file tree

Showing 23 changed files with 1,704 additions and 211 deletions.
diff --git a/packages/access-client/src/types.ts b/packages/access-client/src/types.ts
@@ -46,6 +46,9 @@ import type {
   UCANRevoke,
   UCANRevokeSuccess,
   UCANRevokeFailure,
+  UCANConclude,
+  UCANConcludeSuccess,
+  UCANConcludeFailure,
   AccountDID,
   ProviderDID,
   SpaceDID,
@@ -132,6 +135,11 @@ export interface Service {
   }
   ucan: {
     revoke: ServiceMethod<UCANRevoke, UCANRevokeSuccess, UCANRevokeFailure>
+    conclude: ServiceMethod<
+      UCANConclude,
+      UCANConcludeSuccess,
+      UCANConcludeFailure
+    >
   }
   plan: {
     get: ServiceMethod<PlanGet, PlanGetSuccess, PlanGetFailure>

diff --git a/packages/capabilities/src/types.ts b/packages/capabilities/src/types.ts
@@ -571,7 +571,7 @@ export type BlobAllocateFailure = NotEnoughStorageCapacity | Ucanto.Failure
 
 // Blob accept
 export interface BlobAcceptSuccess {
-  // A Link for a delegation with site commiment for the added blob.
+  // A Link for a delegation with site commitment for the added blob.
   site: Link
 }
 

diff --git a/packages/filecoin-api/src/errors.js b/packages/filecoin-api/src/errors.js
@@ -43,6 +43,10 @@ export class RecordNotFound extends Server.Failure {
     return this.message
   }
 
+  describe() {
+    return `Record not found`
+  }
+
   get name() {
     return RecordNotFoundErrorName
   }

diff --git a/packages/upload-api/src/blob/add.js b/packages/upload-api/src/blob/add.js
@@ -161,6 +161,11 @@ async function allocate({ context, blob, space, cause }) {
 
   // 3. if not already allocated (or expired) execute `blob/allocate`
   if (!blobAllocateReceipt) {
+    // Create allocation task and save it
+    const saveTask = await context.tasksStorage.put(task)
+    if (!saveTask.ok) {
+      return saveTask
+    }
     // Execute allocate invocation
     const allocateRes = await allocate.execute(context.getServiceConnection())
     if (allocateRes.out.error) {

diff --git a/packages/upload-api/src/errors.js b/packages/upload-api/src/errors.js
@@ -30,6 +30,10 @@ export class RecordNotFound extends Server.Failure {
     return this.message
   }
 
+  describe() {
+    return `Record not found`
+  }
+
   get name() {
     return RecordNotFoundErrorName
   }

diff --git a/packages/upload-api/test/storage/index.js b/packages/upload-api/test/storage/index.js
@@ -30,7 +30,7 @@ export async function getServiceStorageImplementations(options) {
   const dudewhereBucket = new DudewhereBucket()
   const revocationsStorage = new RevocationsStorage()
   const plansStorage = new PlansStorage()
-  const usageStorage = new UsageStorage(storeTable)
+  const usageStorage = new UsageStorage(storeTable, allocationsStorage)
   const provisionsStorage = new ProvisionsStorage(options.providers)
   const subscriptionsStorage = new SubscriptionsStorage(provisionsStorage)
   const delegationsStorage = new DelegationsStorage()

diff --git a/packages/upload-api/test/storage/usage-storage.js b/packages/upload-api/test/storage/usage-storage.js
@@ -2,9 +2,26 @@
 
 /** @implements {UsageStore} */
 export class UsageStorage {
-  /** @param {import('./store-table.js').StoreTable} storeTable */
-  constructor(storeTable) {
+  /**
+   * @param {import('./store-table.js').StoreTable} storeTable
+   * @param {import('./allocations-storage.js').AllocationsStorage} allocationsStorage
+   */
+  constructor(storeTable, allocationsStorage) {
     this.storeTable = storeTable
+    this.allocationsStorage = allocationsStorage
+  }
+
+  get items() {
+    return [
+      ...this.storeTable.items.map((item) => ({
+        ...item,
+        cause: item.invocation,
+      })),
+      ...this.allocationsStorage.items.map((item) => ({
+        ...item,
+        size: item.blob.size,
+      })),
+    ]
   }
 
   /**
@@ -13,11 +30,11 @@ export class UsageStorage {
    * @param {{ from: Date, to: Date }} period
    */
   async report(provider, space, period) {
-    const before = this.storeTable.items.filter((item) => {
+    const before = this.items.filter((item) => {
       const insertTime = new Date(item.insertedAt).getTime()
       return item.space === space && insertTime < period.from.getTime()
     })
-    const during = this.storeTable.items.filter((item) => {
+    const during = this.items.filter((item) => {
       const insertTime = new Date(item.insertedAt).getTime()
       return (
         item.space === space &&
@@ -39,7 +56,7 @@ export class UsageStorage {
         size: { initial, final },
         events: during.map((item) => {
           return {
-            cause: item.invocation.link(),
+            cause: /** @type {import('../types.js').Link} */ (item.cause),
             delta: item.size,
             receiptAt: item.insertedAt,
           }

diff --git a/packages/upload-client/package.json b/packages/upload-client/package.json
@@ -71,6 +71,7 @@
     "@ipld/dag-cbor": "^9.0.6",
     "@ipld/dag-ucan": "^3.4.0",
     "@ipld/unixfs": "^2.1.1",
+    "@ucanto/core": "^10.0.1",
     "@ucanto/client": "^9.0.1",
     "@ucanto/interface": "^10.0.1",
     "@ucanto/transport": "^9.1.1",