iso-ucan 0.5.0 → 0.5.1

package/dist/src/envelope.d.ts

@@ -52,7 +52,7 @@ export function sign(options: EnvelopeSignOptions): Promise<{
  * @param {EnvelopeEncodeOptions} options
  *
  */
-export function encode(options: EnvelopeEncodeOptions): ByteView<(Uint8Array<ArrayBufferLike> | SignaturePayload<unknown>)[]>;
+export function encode(options: EnvelopeEncodeOptions): ByteView<(Uint8Array<ArrayBufferLike> | SignaturePayload<unknown>)[], ArrayBufferLike>;
 /**
  * Decode a UCAN envelope
  *

package/dist/src/envelope.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"envelope.d.ts","sourceRoot":"","sources":["../../src/envelope.js"],"names":[],"mappings":"AAYA;;;;;;;;GAQG;AACH,6CALG;IAA6B,IAAI,EAAzB,WAAW;IACM,OAAO,EAAxB,OAAO;IACU,OAAO;IAC8B,aAAa,EAAnE,OAAO,sBAAsB,EAAE,aAAa;CACtD,oBAgBA;AAED;;;;GAIG;AACH,8CAFW,UAAU;;;;EAkCpB;AAED;;;;;GAKG;AACH,6CAHW,OAAO,GACL,OAAO,IAAI,iBAAiB,CAIxC;AAED;;;;;GAKG;AACH,6CAHW,OAAO,GACL,OAAO,IAAI,iBAAiB,CAIxC;AAED;;;GAGG;AACH,8BAFW,mBAAmB;;;GAgB7B;AAED;;;;;;GAMG;AACH,gCAHW,qBAAqB,yEAS/B;AAED;;;;;;;GAOG;AACH,uBAL2B,IAAI,SAAlB,WAAa,WAEf,qBAAqB,GACnB,gBAAgB,IAAI,CAAC,CAgCjC;AAtKD;;;GAGG;AAEH,cAAc;AACd,sBAAuB,YAAY,CAAA;iCALuK,YAAY;6BAAZ,YAAY;sCAAZ,YAAY;uCAAZ,YAAY;uCAAZ,YAAY;yCAAZ,YAAY;2CAAZ,YAAY;8BACzL,cAAc;2CAD+J,YAAY;qCAAZ,YAAY"}
+{"version":3,"file":"envelope.d.ts","sourceRoot":"","sources":["../../src/envelope.js"],"names":[],"mappings":"AAYA;;;;;;;;GAQG;AACH,6CALG;IAA6B,IAAI,EAAzB,WAAW;IACM,OAAO,EAAxB,OAAO;IACU,OAAO;IAC8B,aAAa,EAAnE,OAAO,sBAAsB,EAAE,aAAa;CACtD,oBAgBA;AAED;;;;GAIG;AACH,8CAFW,UAAU;;;;EAkCpB;AAED;;;;;GAKG;AACH,6CAHW,OAAO,GACL,OAAO,IAAI,iBAAiB,CAIxC;AAED;;;;;GAKG;AACH,6CAHW,OAAO,GACL,OAAO,IAAI,iBAAiB,CAIxC;AAED;;;GAGG;AACH,8BAFW,mBAAmB;;;GAgB7B;AAED;;;;;;GAMG;AACH,gCAHW,qBAAqB,0FAS/B;AAED;;;;;;;GAOG;AACH,uBAL2B,IAAI,SAAlB,WAAa,WAEf,qBAAqB,GACnB,gBAAgB,IAAI,CAAC,CAgCjC;AAtKD;;;GAGG;AAEH,cAAc;AACd,sBAAuB,YAAY,CAAA;iCALuK,YAAY;6BAAZ,YAAY;sCAAZ,YAAY;uCAAZ,YAAY;uCAAZ,YAAY;yCAAZ,YAAY;2CAAZ,YAAY;8BACzL,cAAc;2CAD+J,YAAY;qCAAZ,YAAY"}

package/dist/src/invocation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"invocation.d.ts","sourceRoot":"","sources":["../../src/invocation.js"],"names":[],"mappings":"AAqLA;;;;GAIG;AACH,sCAHW,OAAO,YAAY,EAAE,iBAAiB,UACtC,UAAU,EAAE,WA6DtB;AAtOD;;;GAGG;AAEH;;GAEG;AACH;IA0BE;;;OAGG;IACH,qBAFW,OAAO,YAAY,EAAE,qBAAqB,uBAgDpD;IAED;;OAEG;IACH,uBAFW,OAAO,YAAY,EAAE,iBAAiB,uBA0DhD;IA9HD;;;;;;OAMG;IACH,sBALW,OAAO,YAAY,EAAE,eAAe,CAAC,KAAK,CAAC,SAC3C,UAAU,OACV,GAAG,eACH,UAAU,EAAE,EAQtB;IAvBD;;OAEG;IACH,aAFU,UAAU,EAAE,CAEX;IAEX;;OAEG;IACH,KAFU,GAAG,CAEV;IAUD,sDAAwB;IACxB,gDAA+B;IAC/B,mCAAkB;CAqHrB;gCAjJ4B,iBAAiB;yBACxB,cAAc"}
+{"version":3,"file":"invocation.d.ts","sourceRoot":"","sources":["../../src/invocation.js"],"names":[],"mappings":"AAsLA;;;;GAIG;AACH,sCAHW,OAAO,YAAY,EAAE,iBAAiB,UACtC,UAAU,EAAE,WA6DtB;AAtOD;;;GAGG;AAEH;;GAEG;AACH;IA0BE;;;OAGG;IACH,qBAFW,OAAO,YAAY,EAAE,qBAAqB,uBAgDpD;IAED;;OAEG;IACH,uBAFW,OAAO,YAAY,EAAE,iBAAiB,uBA0DhD;IA9HD;;;;;;OAMG;IACH,sBALW,OAAO,YAAY,EAAE,eAAe,CAAC,KAAK,CAAC,SAC3C,UAAU,OACV,GAAG,eACH,UAAU,EAAE,EAQtB;IAvBD;;OAEG;IACH,aAFU,UAAU,EAAE,CAEX;IAEX;;OAEG;IACH,KAFU,GAAG,CAEV;IAUD,sDAAwB;IACxB,gDAA+B;IAC/B,mCAAkB;CAqHrB;gCAjJ4B,iBAAiB;yBACxB,cAAc"}

package/dist/src/rpc/receipt.d.ts

@@ -75,7 +75,7 @@ export function receipt<Result extends z.ZodType, Error extends z.ZodType>(resul
  * produces when serialized through `JSON.stringify`) and normalizes to a
  * {@link CID}.
  */
-export const cidSchema: z.ZodUnion<readonly [z.ZodCustom<CID<unknown, number, number, import("multiformats").Version>, CID<unknown, number, number, import("multiformats").Version>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodObject<{
+export const cidSchema: z.ZodUnion<readonly [z.ZodInstanceOf<CID<unknown, number, number, import("multiformats").Version>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodObject<{
     '/': z.ZodString;
 }, z.core.$strip>, z.ZodTransform<string, {
     '/': string;
@@ -100,7 +100,7 @@ export const receiptServerError: z.ZodObject<{
     error: z.ZodObject<{
         code: z.ZodLiteral<"SERVER_ERROR">;
         message: z.ZodString;
-        cid: z.ZodOptional<z.ZodUnion<readonly [z.ZodCustom<CID<unknown, number, number, import("multiformats").Version>, CID<unknown, number, number, import("multiformats").Version>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodObject<{
+        cid: z.ZodOptional<z.ZodUnion<readonly [z.ZodInstanceOf<CID<unknown, number, number, import("multiformats").Version>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodObject<{
             '/': z.ZodString;
         }, z.core.$strip>, z.ZodTransform<string, {
             '/': string;

package/dist/src/utils.d.ts

@@ -53,6 +53,21 @@ export function validateIssuerAndSignature(envelope: import("./types.js").Decode
  * @param {import('iso-did').Resolver} [didResolver]
  */
 export function verifySignature(envelope: import("./types.js").DecodedEnvelope<PayloadSpec>, signatureVerifierResolver: import("iso-signatures/verifiers/resolver.js").Resolver, didResolver?: import("iso-did").Resolver): Promise<boolean>;
+/**
+ * Check if a command is covered by (equal to or a segment-wise child of) another command.
+ *
+ * Commands are compared by path segment, not by string prefix: `/crypto` covers
+ * `/crypto` and `/crypto/sign` but not `/cryptocurrency`. The command `/` covers
+ * every command.
+ *
+ * Both commands are expected to be valid per {@link assertIsValidCommand}, so
+ * `${parent}/` is always a real segment boundary.
+ *
+ * @param {string} parent - The broader command, e.g. from a delegation.
+ * @param {string} child - The command that must be attenuated from `parent`.
+ * @returns {boolean}
+ */
+export function commandCovers(parent: string, child: string): boolean;
 /**
  * Asserts that a UCAN command string is syntactically valid.
  * If the command is invalid, it throws a descriptive error.

package/dist/src/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.js"],"names":[],"mappings":"AASA;;GAEG;AAEH;;;;;GAKG;AACH,2CAHW,OAAO,YAAY,EAAE,eAAe,CAAC,WAAW,CAAC;;;EAe3D;AAED,uCAEC;AAED;;;GAGG;AACH,8BAFW,OAAO,YAAY,EAAE,eAAe,CAAC,WAAW,CAAC,iCAW3D;AAED;;;;;GAKG;AACH,2CAHW,OAAO,eAAe,EAAE,aAAa,WACrC,OAAO,sBAAsB,EAAE,aAAa,WA+BtD;AAED;;;;;GAKG;AACH,sCAHW,MAAM,GAAG,IAAI,QACb,MAAM,QAchB;AAED;;;;;GAKG;AACH,sCAHW,MAAM,QACN,MAAM,QAMhB;AAED;;;;;GAKG;AACH,qDAHW,OAAO,YAAY,EAAE,eAAe,CAAC,WAAW,CAAC,gBACjD,OAAO,SAAS,EAAE,QAAQ,gBAYpC;AAED;;;;;;GAMG;AACH,0CAJW,OAAO,YAAY,EAAE,eAAe,CAAC,WAAW,CAAC,6BACjD,OAAO,sCAAsC,EAAE,QAAQ,gBACvD,OAAO,SAAS,EAAE,QAAQ,oBAwBpC;AAED;;;;;;;;;;;;;GAaG;AACH,8CAJW,MAAM,GAEJ,IAAI,CAuChB;AAED;;;;;;;;;;;;;GAaG;AACH,mCAXW,OAAO,GAEL,IAAI,CAehB;AACD;;;;GAIG;AACH,iCAFW,OAAO,QASjB;AAED;;;;;;GAMG;AACH,iCAJW,OAAO,GAEL,IAAI,CAWhB;AAED;;;;;GAKG;AACH,sCAHW,OAAO,kBAAkB,EAAE,GAAG,gBAC9B,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,OAAO,CAAC,iBAQxC;AAED;;;;;;GAMG;AACH,uCAHG;IAAgC,GAAG;IACV,GAAG;CAAC,iBAU/B;AAgED;;GAEG;AACH,qCAFW,OAAO,QASjB;AAED;;;;;;GAMG;AACH,gCAJW,OAAO,GACL,KAAK,IAAI,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAKjD;AAnFD,iJAeI;AACJ,4KAAyD;AAEzD,oGAGE;AAEF;;GAEG;AAEH;;GAEG;AACH,mKA4BI;AAEJ,kLAA8C;uBApCjC,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC;iCAjUP,YAAY;oBARtB,kBAAkB;oBADlB,SAAS;kBAGX,QAAQ"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.js"],"names":[],"mappings":"AASA;;GAEG;AAEH;;;;;GAKG;AACH,2CAHW,OAAO,YAAY,EAAE,eAAe,CAAC,WAAW,CAAC;;;EAe3D;AAED,uCAEC;AAED;;;GAGG;AACH,8BAFW,OAAO,YAAY,EAAE,eAAe,CAAC,WAAW,CAAC,iCAW3D;AAED;;;;;GAKG;AACH,2CAHW,OAAO,eAAe,EAAE,aAAa,WACrC,OAAO,sBAAsB,EAAE,aAAa,WA+BtD;AAED;;;;;GAKG;AACH,sCAHW,MAAM,GAAG,IAAI,QACb,MAAM,QAchB;AAED;;;;;GAKG;AACH,sCAHW,MAAM,QACN,MAAM,QAMhB;AAED;;;;;GAKG;AACH,qDAHW,OAAO,YAAY,EAAE,eAAe,CAAC,WAAW,CAAC,gBACjD,OAAO,SAAS,EAAE,QAAQ,gBAYpC;AAED;;;;;;GAMG;AACH,0CAJW,OAAO,YAAY,EAAE,eAAe,CAAC,WAAW,CAAC,6BACjD,OAAO,sCAAsC,EAAE,QAAQ,gBACvD,OAAO,SAAS,EAAE,QAAQ,oBAwBpC;AAED;;;;;;;;;;;;;GAaG;AACH,sCAJW,MAAM,SACN,MAAM,GACJ,OAAO,CAKnB;AAED;;;;;;;;;;;;;GAaG;AACH,8CAJW,MAAM,GAEJ,IAAI,CAuChB;AAED;;;;;;;;;;;;;GAaG;AACH,mCAXW,OAAO,GAEL,IAAI,CAehB;AACD;;;;GAIG;AACH,iCAFW,OAAO,QASjB;AAED;;;;;;GAMG;AACH,iCAJW,OAAO,GAEL,IAAI,CAWhB;AAED;;;;;GAKG;AACH,sCAHW,OAAO,kBAAkB,EAAE,GAAG,gBAC9B,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,OAAO,CAAC,iBAQxC;AAED;;;;;;GAMG;AACH,uCAHG;IAAgC,GAAG;IACV,GAAG;CAAC,iBAU/B;AAgED;;GAEG;AACH,qCAFW,OAAO,QASjB;AAED;;;;;;GAMG;AACH,gCAJW,OAAO,GACL,KAAK,IAAI,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAKjD;AAnFD,iJAeI;AACJ,4KAAyD;AAEzD,oGAGE;AAEF;;GAEG;AAEH;;GAEG;AACH,mKA4BI;AAEJ,kLAA8C;uBApCjC,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC;iCApVP,YAAY;oBARtB,kBAAkB;oBADlB,SAAS;kBAGX,QAAQ"}

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Hugo Dias <hugomrdias@gmail.com> (hugodias.me)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "iso-ucan",
   "type": "module",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Isomorphic UCAN",
   "author": "Hugo Dias <hugomrdias@gmail.com> (hugodias.me)",
   "license": "MIT",
@@ -95,24 +95,24 @@
     "dist/src/**/*.d.ts.map"
   ],
   "dependencies": {
-    "@ipld/dag-cbor": "^9.2.5",
+    "@ipld/dag-cbor": "^10.0.2",
     "@standard-schema/spec": "^1.1.0",
     "@standard-schema/utils": "^0.3.0",
     "iobuffer": "^6.0.1",
-    "iso-kv": "^3.1.1",
-    "iso-web": "^2.1.0",
-    "it-merge": "^3.0.12",
-    "multiformats": "^13.4.1",
-    "zod": "^4.3.6",
-    "iso-base": "^4.3.1",
-    "iso-did": "^2.1.1",
-    "iso-signatures": "^0.5.1"
+    "iso-base": "^4.4.0",
+    "iso-did": "^3.0.0",
+    "iso-kv": "^3.2.0",
+    "iso-signatures": "^0.5.2",
+    "iso-web": "^4.0.0",
+    "it-merge": "^3.0.15",
+    "multiformats": "^14.0.5",
+    "zod": "^4.6.5"
   },
   "devDependencies": {
-    "@types/node": "^25.6.0",
+    "@types/node": "^26.6.2",
     "delay": "^7.0.0",
-    "playwright-test": "^14.1.13",
-    "typescript": "5.9.3"
+    "playwright-test": "^15.0.1",
+    "typescript": "^6.0.3"
   },
   "publishConfig": {
     "provenance": true

package/readme.md

@@ -1,6 +1,23 @@
 # iso-ucan [![NPM Version](https://img.shields.io/npm/v/iso-ucan.svg)](https://www.npmjs.com/package/iso-ucan) [![License](https://img.shields.io/npm/l/iso-ucan.svg)](https://github.com/hugomrdias/iso-repo/blob/main/license) [![iso-ucan](https://github.com/hugomrdias/iso-repo/actions/workflows/iso-ucan.yml/badge.svg)](https://github.com/hugomrdias/iso-repo/actions/workflows/iso-ucan.yml)
 
-> Isomorphic UCAN
+> Isomorphic UCAN primitives for delegations, invocations, proof storage, and
+> typed RPC.
+
+## Overview
+
+UCAN is a local-first authorization model where permissions are
+cryptographically signed, delegated, and verified without relying on a central
+authority. See [ucan.xyz](https://ucan.xyz/) for more background.
+
+`iso-ucan` provides:
+
+- Typed capabilities backed by schema validation.
+- Delegation and invocation builders for UCAN authorization flows.
+- Proof storage with pluggable `iso-kv` drivers.
+- Signer and verifier support through `iso-signatures`.
+- EIP-191 wallet signing support through `iso-signatures` `EIP191Signer`.
+- Filsnap-powered UCAN signature insights in MetaMask signature popups.
+- A typed RPC layer for request/response APIs built on UCAN invocations.
 
 ## Install
 
@@ -43,39 +60,59 @@ const invoker = await EdDSASigner.generate()
 const nowInSeconds = Math.floor(Date.now() / 1000)
 
 const ownerDelegation = await AccountCap.delegate({
-iss: owner,
-aud: bob,
-sub: owner,
-pol: [],
-exp: nowInSeconds + 1000,
+  iss: owner,
+  aud: bob,
+  sub: owner,
+  pol: [],
+  exp: nowInSeconds + 1000,
 })
 
 await store.set(ownerDelegation)
 
 const bobDelegation = await AccountCap.delegate({
-iss: bob,
-aud: invoker,
-sub: owner,
-pol: [],
-exp: nowInSeconds + 1000,
+  iss: bob,
+  aud: invoker,
+  sub: owner,
+  pol: [],
+  exp: nowInSeconds + 1000,
 })
 
 await store.set(bobDelegation)
 
 const invocation = await AccountCreateCap.invoke({
-iss: invoker,
-sub: owner,
-args: {
+  iss: invoker,
+  sub: owner,
+  args: {
     type: 'account',
     properties: {
-    name: 'John Doe',
+      name: 'John Doe',
     },
-},
-store,
-exp: nowInSeconds + 1000,
+  },
+  store,
+  exp: nowInSeconds + 1000,
 })
 ```
 
+## EIP-191 wallet signing
+
+`iso-ucan` can use EIP-191 wallet signatures through `EIP191Signer` from
+`iso-signatures`. That lets UCAN delegations and invocations be issued by an
+Ethereum account exposed through an EIP-1193 provider, such as an injected
+MetaMask wallet, while verification is handled by the matching EIP-191 verifier
+from `iso-signatures`.
+
+[`examples/eip191`](../../examples/eip191) shows this flow in a browser web
+app. It uses `wagmi` to connect the wallet, wraps the provider in
+`EIP191Signer`, then creates and verifies UCAN delegations and invocations
+directly in the browser.
+
+The example uses `filsnap-adapter` to install or enable
+[Filsnap](https://github.com/filecoin-project/filsnap), the Filecoin Wallet
+MetaMask Snap. Filsnap supports UCAN signature insights for EIP-191 signers, so
+when the app asks MetaMask to sign a UCAN delegation, the MetaMask signature
+popup can show a readable summary of the issuer, audience, subject, command,
+expiration, and raw payload.
+
 ## RPC
 
 `iso-ucan/rpc` is a small request/response layer on top of UCAN

package/src/invocation.js

@@ -9,6 +9,7 @@ import {
   assertMeta,
   assertNonce,
   cid,
+  commandCovers,
   expOrTtl,
   verifySignature,
 } from './utils.js'
@@ -235,9 +236,9 @@ export function assertProofs(payload, proofs) {
       )
     }
 
-    if (!next.cmd.startsWith(current.cmd)) {
+    if (!commandCovers(current.cmd, next.cmd)) {
       throw new Error(
-        `UCAN Invocation command mismatch, expected ${current.cmd} to be a broader than ${next.cmd}`
+        `UCAN Invocation command mismatch, expected ${current.cmd} to cover ${next.cmd}`
       )
     }
   }

package/src/utils.js

@@ -168,6 +168,25 @@ export async function verifySignature(
   return true
 }
 
+/**
+ * Check if a command is covered by (equal to or a segment-wise child of) another command.
+ *
+ * Commands are compared by path segment, not by string prefix: `/crypto` covers
+ * `/crypto` and `/crypto/sign` but not `/cryptocurrency`. The command `/` covers
+ * every command.
+ *
+ * Both commands are expected to be valid per {@link assertIsValidCommand}, so
+ * `${parent}/` is always a real segment boundary.
+ *
+ * @param {string} parent - The broader command, e.g. from a delegation.
+ * @param {string} child - The command that must be attenuated from `parent`.
+ * @returns {boolean}
+ */
+export function commandCovers(parent, child) {
+  if (parent === '/') return child.startsWith('/')
+  return child === parent || child.startsWith(`${parent}/`)
+}
+
 /**
  * Asserts that a UCAN command string is syntactically valid.
  * If the command is invalid, it throws a descriptive error.