feat: Impelment InferInvokedCapability per #99 (#100)

* feat: unifiy principals & signers Co-authored-by: Hugo Dias <[email protected]> * fix: tests on core * fix: transport package * chore: update client to 0.9 * feat(validator): update to ucan 0.9 * feat(server): upgrade to 0.9 * fix(principal): invalid test * chore: update dag-ucan dep * feat: rename caveats to nb * fix(server): type checks * fix(validator): increase coverage * fix(docs): rename caveats to nb * feat: improve decoders * fix: types * fix: types for .create / .invoke of capability * fix: nb inference 98 * feat: implement InferInvokedCapability type * fix: remove conflicting type Co-authored-by: Hugo Dias <[email protected]>
storacha · Sep 30, 2022 · fc5a2ac · fc5a2ac
1 parent b752b39
commit fc5a2ac
Show file tree

Hide file tree

Showing 6 changed files with 149 additions and 97 deletions.
diff --git a/packages/interface/src/capability.ts b/packages/interface/src/capability.ts
@@ -140,11 +140,6 @@ export interface TheCapabilityParser<M extends Match<ParsedCapability>>
   ): IssuedInvocationView<M['value']>
 }
 
-export type InferInvokedCapability<C extends Capability> = C
-// keyof C['nb'] extends never
-//   ? { can: C['can']; with: C['with']; nb?: never }
-//   : { can: C['can']; with: C['with']; nb: C['nb'] }
-
 export type InferCreateOptions<R extends Resource, C extends {} | undefined> =
   // If capability has no NB we want to prevent passing it into
   // .create funciton so we make `nb` as optional `never` type so

diff --git a/packages/interface/src/lib.ts b/packages/interface/src/lib.ts
@@ -20,9 +20,12 @@ import {
 import * as UCAN from '@ipld/dag-ucan'
 import {
   CanIssue,
+  Match,
   InvalidAudience,
   Unauthorized,
   UnavailableProof,
+  ParsedCapability,
+  CapabilityParser,
 } from './capability.js'
 import type * as Transport from './transport.js'
 import type { Tuple, Block } from './transport.js'
@@ -387,3 +390,7 @@ export type URI<P extends Protocol = Protocol> = `${P}${string}` &
 export interface PrincipalParser {
   parse(did: UCAN.DID): UCAN.Verifier
 }
+
+export type InferInvokedCapability<
+  C extends CapabilityParser<Match<ParsedCapability>>
+> = C extends CapabilityParser<Match<infer T>> ? T : never
diff --git a/packages/validator/test/inference.spec.js b/packages/validator/test/inference.spec.js
@@ -0,0 +1,95 @@
+import * as Voucher from './voucher.js'
+import { test, assert } from './test.js'
+import { alice, bob, mallory, service as w3 } from './fixtures.js'
+import { capability, URI, Link } from '../src/lib.js'
+import * as API from './types.js'
+
+test('execute capabilty', () =>
+  /**
+   * @param {API.ConnectionView<API.Service>} connection
+   */
+  async connection => {
+    const claim = Voucher.Claim.invoke({
+      issuer: alice,
+      audience: w3,
+      with: alice.did(),
+      nb: {
+        identity: URI.from(`mailto:${alice.did}@web.mail`),
+        product: Link.parse('bafkqaaa'),
+        service: w3.did(),
+      },
+    })
+
+    const proof = Voucher.Redeem.invoke({
+      issuer: alice,
+      audience: w3,
+      with: alice.did(),
+      nb: {
+        product: 'test',
+        identity: 'whatever',
+        account: alice.did(),
+      },
+    })
+
+    const redeem = Voucher.Redeem.invoke({
+      issuer: alice,
+      audience: w3,
+      with: alice.did(),
+      nb: {
+        product: 'test',
+        identity: proof.capabilities[0].nb.identity,
+        account: alice.did(),
+      },
+    })
+
+    const r1 = await redeem.execute(connection)
+    if (!r1.error) {
+      r1.product.toLowerCase()
+    }
+
+    const r2 = await claim.execute(connection)
+    if (!r2.error) {
+      r2.service.toUpperCase()
+    }
+  })
+
+test('can access fields on the proof', () =>
+  /**
+   * @param {API.Delegation<[API.VoucherRedeem]>} proof
+   */
+  proof => {
+    const redeem = Voucher.Redeem.invoke({
+      issuer: alice,
+      audience: w3,
+      with: alice.did(),
+      nb: {
+        product: proof.capabilities[0].nb.product,
+        identity: proof.capabilities[0].nb.identity,
+        account: proof.capabilities[0].nb.account,
+      },
+      proofs: [proof],
+    })
+  })
+
+test('use InferInvokedCapability', () =>
+  /**
+   * @param {API.ConnectionView<API.Service>} connection
+   * @param {API.InferInvokedCapability<typeof Voucher.Redeem>} capability
+   */
+  async (connection, capability) => {
+    const redeem = Voucher.Redeem.invoke({
+      issuer: alice,
+      audience: w3,
+      with: capability.with,
+      nb: {
+        product: capability.nb.product,
+        identity: capability.nb.identity,
+        account: capability.nb.account,
+      },
+    })
+
+    const result = await redeem.execute(connection)
+    if (!result.error) {
+      result.product.toLocaleLowerCase()
+    }
+  })
diff --git a/packages/validator/test/lib.spec.js b/packages/validator/test/lib.spec.js
@@ -1,14 +1,13 @@
 import { test, assert } from './test.js'
 import { access } from '../src/lib.js'
-import { capability, URI, Text, Link, DID } from '../src/lib.js'
+import { capability, URI, Link } from '../src/lib.js'
 import { Failure } from '../src/error.js'
 import * as ed25519 from '@ucanto/principal/ed25519'
 import * as Client from '@ucanto/client'
 
 import { alice, bob, mallory, service as w3 } from './fixtures.js'
 import { UCAN, DID as Principal } from '@ucanto/core'
 import { UnavailableProof } from '../src/error.js'
-import { equalWith, canDelegateURI, fail } from './util.js'
 import * as API from './types.js'
 
 const storeAdd = capability({
@@ -1131,91 +1130,3 @@ test('resolve proof', async () => {
     ],
   })
 })
-
-test('execute capabilty', async () => {
-  const Voucher = capability({
-    can: 'voucher/*',
-    with: DID.match({ method: 'key' }),
-  })
-
-  const Claim = Voucher.derive({
-    to: capability({
-      can: 'voucher/claim',
-      with: DID.match({ method: 'key' }),
-      nb: {
-        product: Link,
-        identity: URI.match({ protocol: 'mailto:' }),
-        service: DID,
-      },
-      derives: (child, parent) => {
-        return (
-          fail(equalWith(child, parent)) ||
-          fail(canDelegateURI(child.nb.identity, parent.nb.identity)) ||
-          fail(
-            canDelegateURI(
-              child.nb.product.toString(),
-              parent.nb.product.toString()
-            )
-          ) ||
-          fail(canDelegateURI(child.nb.service, parent.nb.service)) ||
-          true
-        )
-      },
-    }),
-    derives: equalWith,
-  })
-
-  const claim = Claim.invoke({
-    issuer: alice,
-    audience: w3,
-    with: alice.did(),
-    nb: {
-      identity: URI.from(`mailto:${alice.did}@web.mail`),
-      product: Link.parse('bafkqaaa'),
-      service: w3.did(),
-    },
-  })
-
-  const Redeem = capability({
-    can: 'voucher/redeem',
-    with: URI.match({ protocol: 'did:' }),
-    nb: {
-      product: Text,
-      identity: Text,
-      account: URI.match({ protocol: 'did:' }),
-    },
-  })
-
-  const proof = Redeem.invoke({
-    issuer: alice,
-    audience: w3,
-    with: alice.did(),
-    nb: {
-      product: 'test',
-      identity: 'whatever',
-      account: alice.did(),
-    },
-  })
-
-  /**
-   * @param {API.ConnectionView<API.Service>} connection
-   * @param {API.Delegation<[API.VoucherRedeem]>} proof
-   */
-
-  const demo = async (connection, proof) => {
-    const redeem = Redeem.invoke({
-      issuer: alice,
-      audience: w3,
-      with: alice.did(),
-      nb: {
-        product: 'test',
-        identity: proof.capabilities[0].nb.identity,
-        account: alice.did(),
-      },
-    })
-
-    const r = await redeem.execute(connection)
-
-    const result = await claim.execute(connection)
-  }
-})
diff --git a/packages/validator/test/types.ts b/packages/validator/test/types.ts
@@ -53,7 +53,7 @@ export interface VoucherRedeem
 
 export interface Service {
   voucher: {
-    claim: ServiceMethod<VoucherClaim, undefined, Failure>
-    redeem: ServiceMethod<VoucherRedeem, undefined, Failure>
+    claim: ServiceMethod<VoucherClaim, { service: DID }, Failure>
+    redeem: ServiceMethod<VoucherRedeem, { product: string }, Failure>
   }
 }
diff --git a/packages/validator/test/voucher.js b/packages/validator/test/voucher.js
@@ -0,0 +1,44 @@
+import { equalWith, canDelegateURI, fail } from './util.js'
+import { capability, URI, Text, Link, DID } from '../src/lib.js'
+
+export const Voucher = capability({
+  can: 'voucher/*',
+  with: DID.match({ method: 'key' }),
+})
+
+export const Claim = Voucher.derive({
+  to: capability({
+    can: 'voucher/claim',
+    with: DID.match({ method: 'key' }),
+    nb: {
+      product: Link,
+      identity: URI.match({ protocol: 'mailto:' }),
+      service: DID,
+    },
+    derives: (child, parent) => {
+      return (
+        fail(equalWith(child, parent)) ||
+        fail(canDelegateURI(child.nb.identity, parent.nb.identity)) ||
+        fail(
+          canDelegateURI(
+            child.nb.product.toString(),
+            parent.nb.product.toString()
+          )
+        ) ||
+        fail(canDelegateURI(child.nb.service, parent.nb.service)) ||
+        true
+      )
+    },
+  }),
+  derives: equalWith,
+})
+
+export const Redeem = capability({
+  can: 'voucher/redeem',
+  with: URI.match({ protocol: 'did:' }),
+  nb: {
+    product: Text,
+    identity: Text,
+    account: URI.match({ protocol: 'did:' }),
+  },
+})