chore(capabilities): top level filecoin cap

storacha · Dec 18, 2024 · 202a0fd · 202a0fd
1 parent 12e2e69
commit 202a0fd
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/packages/capabilities/src/filecoin/index.js b/packages/capabilities/src/filecoin/index.js
@@ -17,4 +17,5 @@ export {
   filecoinSubmit as submit,
   filecoinAccept as accept,
   filecoinInfo as info,
+  filecoin as filecoin,
 } from './storefront.js'
diff --git a/packages/capabilities/src/filecoin/storefront.js b/packages/capabilities/src/filecoin/storefront.js
@@ -13,6 +13,18 @@ import { capability, Schema, ok } from '@ucanto/validator'
 import { PieceLink } from './lib.js'
 import { equalWith, checkLink, and } from '../utils.js'
 
+/**
+ * Top-level capability for Filecoin operations.
+ */
+export const filecoin = capability({
+  can: 'filecoin/*',
+  /**
+   * DID of the space the content is stored in.
+   */
+  with: Schema.did(),
+  derives: equalWith,
+})
+
 /**
  * Capability allowing an agent to _request_ storing a content piece in
  * Filecoin.

diff --git a/packages/capabilities/src/types.ts b/packages/capabilities/src/types.ts
@@ -808,6 +808,9 @@ export interface AdminStoreInspectSuccess {
 }
 export type AdminStoreInspectFailure = Ucanto.Failure
 // Filecoin
+export type Filecoin = InferInvokedCapability<
+  typeof StorefrontCaps.filecoin
+>
 export type FilecoinOffer = InferInvokedCapability<
   typeof StorefrontCaps.filecoinOffer
 >
@@ -921,6 +924,7 @@ export type ServiceAbilityArray = [
   RateLimitAdd['can'],
   RateLimitRemove['can'],
   RateLimitList['can'],
+  Filecoin['can'],
   FilecoinOffer['can'],
   FilecoinSubmit['can'],
   FilecoinAccept['can'],