@nevermined-io/core-kit 0.1.21 → 0.1.22

package/dist/models/AgentX402AccessToken.d.ts

@@ -1,14 +1,44 @@
 import { PublicClient } from 'viem';
 import { SmartAccount } from 'viem/account-abstraction';
-export type AgentX402AccessToken = {
-    x402Version: number;
-    scheme: string;
+/**
+ * x402 Resource information
+ */
+export type X402Resource = {
+    url: string;
+    description?: string;
+    mimeType?: string;
+};
+/**
+ * x402 Accepted scheme - nvm:erc4337 specific fields
+ */
+export type X402Accepted = {
+    scheme: 'nvm:erc4337';
     network: string;
-    subscriberAddress: `0x${string}`;
-    agentId?: string;
+    planId: string;
+    extra: {
+        version: string;
+        agentId?: string;
+        httpVerb?: string;
+    };
+};
+/**
+ * x402 Access Token aligned with x402 v2 spec
+ *
+ * Key changes from previous version:
+ * - `subscriberAddress` moved to `payload.authorization.from`
+ * - `planId` is now in `accepted` (required)
+ * - `agentId` moved to `accepted.extra.agentId` (optional)
+ * - `scheme` and `network` moved to `accepted`
+ * - Added `resource` and `extensions` for x402 v2 alignment
+ */
+export type AgentX402AccessToken = {
+    x402Version: 2;
+    resource?: X402Resource;
+    accepted: X402Accepted;
     payload: {
         signature: `0x${string}`;
         authorization: {
+            from: `0x${string}`;
             sessionKeysProvider: string;
             sessionKeys: {
                 id: string;
@@ -16,6 +46,7 @@ export type AgentX402AccessToken = {
             }[];
         };
     };
+    extensions: Record<string, unknown>;
 };
 export type NeverminedTypedDataDomain = {
     name: 'Nevermined';
@@ -36,6 +67,10 @@ export type NeverminedTypedData = {
         type: 'SessionKey[]';
     }];
     Authorization: [
+        {
+            name: 'from';
+            type: 'address';
+        },
         {
             name: 'sessionKeysProvider';
             type: 'string';
@@ -48,14 +83,57 @@ export type NeverminedTypedData = {
 };
 export declare const NeverminedTypedDataTypes: NeverminedTypedData;
 export type NeverminedTypedDataMessage = {
+    from: `0x${string}`;
     sessionKeysProvider: string;
     sessionKeys: {
         id: string;
         data: string;
     }[];
 };
-export declare const generateAgentX402AccessToken: (subscriber: SmartAccount, orderSessionKey: string, burnSessionKey: string, publicClient: PublicClient, agentId?: string) => Promise<AgentX402AccessToken>;
-export declare const verifyAgentX402AccessToken: (accessToken: AgentX402AccessToken, publicClient: PublicClient, subscriberAddress: `0x${string}`) => Promise<boolean>;
+/**
+ * Options for generating an x402 access token
+ */
+export type GenerateX402TokenOptions = {
+    subscriber: SmartAccount;
+    orderSessionKey: string;
+    redeemSessionKey: string;
+    publicClient: PublicClient;
+    planId: string;
+    /** Scheme version (e.g., '1') - stored in accepted.extra.version */
+    schemeVersion?: string;
+    agentId?: string;
+    resource?: X402Resource;
+    httpVerb?: string;
+};
+/**
+ * Generate an x402 access token aligned with x402 v2 spec
+ *
+ * @param options - Token generation options
+ * @returns x402 access token with EIP-712 signature
+ */
+export declare const generateAgentX402AccessToken: (options: GenerateX402TokenOptions) => Promise<AgentX402AccessToken>;
+/**
+ * Verify an x402 access token signature
+ *
+ * @param accessToken - The x402 access token to verify
+ * @param publicClient - Viem public client
+ * @returns true if signature is valid
+ */
+export declare const verifyAgentX402AccessToken: (accessToken: AgentX402AccessToken, publicClient: PublicClient) => Promise<boolean>;
+/**
+ * Validation result for x402 token structure
+ */
+export type X402TokenValidationResult = {
+    valid: boolean;
+    errors: string[];
+};
+/**
+ * Validate the structure of an x402 access token
+ *
+ * @param token - The token to validate (unknown type for safety)
+ * @returns Validation result with errors if any
+ */
+export declare const validateX402TokenStructure: (token: unknown) => X402TokenValidationResult;
 export declare const b64EncodeX402AccessToken: (accessToken: AgentX402AccessToken) => string;
 export declare const b64DecodeX402AccessToken: (encoded: string) => AgentX402AccessToken;
 //# sourceMappingURL=AgentX402AccessToken.d.ts.map

package/dist/models/AgentX402AccessToken.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AgentX402AccessToken.d.ts","sourceRoot":"","sources":["../../src/models/AgentX402AccessToken.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,YAAY,EAAgC,MAAM,MAAM,CAAA;AAC5E,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAEvD,MAAM,MAAM,oBAAoB,GAAG;IACjC,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,iBAAiB,EAAE,KAAK,MAAM,EAAE,CAAA;IAChC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE;QACP,SAAS,EAAE,KAAK,MAAM,EAAE,CAAA;QACxB,aAAa,EAAE;YACb,mBAAmB,EAAE,MAAM,CAAA;YAC3B,WAAW,EAAE;gBAAE,EAAE,EAAE,MAAM,CAAC;gBAAC,IAAI,EAAE,MAAM,CAAA;aAAE,EAAE,CAAA;SAC5C,CAAA;KACF,CAAA;CACF,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,YAAY,CAAA;IAClB,OAAO,EAAE,GAAG,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,iBAAiB,EAAE,KAAK,MAAM,EAAE,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,EAAE,CAAC;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,IAAI,EAAE,QAAQ,CAAA;KAAE,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,QAAQ,CAAA;KAAE,CAAC,CAAA;IAC9E,WAAW,EAAE,CAAC;QAAE,IAAI,EAAE,aAAa,CAAC;QAAC,IAAI,EAAE,cAAc,CAAA;KAAE,CAAC,CAAA;IAC5D,aAAa,EAAE;QACb;YAAE,IAAI,EAAE,qBAAqB,CAAC;YAAC,IAAI,EAAE,QAAQ,CAAA;SAAE;QAC/C;YAAE,IAAI,EAAE,aAAa,CAAC;YAAC,IAAI,EAAE,cAAc,CAAA;SAAE;KAC9C,CAAA;CACF,CAAA;AAED,eAAO,MAAM,wBAAwB,EAAE,mBAUtC,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,mBAAmB,EAAE,MAAM,CAAA;IAC3B,WAAW,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAC5C,CAAA;AAED,eAAO,MAAM,4BAA4B,GACvC,YAAY,YAAY,EACxB,iBAAiB,MAAM,EACvB,gBAAgB,MAAM,EACtB,cAAc,YAAY,EAC1B,UAAU,MAAM,KACf,OAAO,CAAC,oBAAoB,CAiD9B,CAAA;AAED,eAAO,MAAM,0BAA0B,GACrC,aAAa,oBAAoB,EACjC,cAAc,YAAY,EAC1B,mBAAmB,KAAK,MAAM,EAAE,KAC/B,OAAO,CAAC,OAAO,CAiBjB,CAAA;AAED,eAAO,MAAM,wBAAwB,GAAI,aAAa,oBAAoB,KAAG,MAE5E,CAAA;AAED,eAAO,MAAM,wBAAwB,GAAI,SAAS,MAAM,KAAG,oBAE1D,CAAA"}
+{"version":3,"file":"AgentX402AccessToken.d.ts","sourceRoot":"","sources":["../../src/models/AgentX402AccessToken.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,YAAY,EAAgC,MAAM,MAAM,CAAA;AAC5E,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAEvD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,EAAE,aAAa,CAAA;IACrB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE;QACL,OAAO,EAAE,MAAM,CAAA;QACf,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,CAAA;CACF,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,WAAW,EAAE,CAAC,CAAA;IACd,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,QAAQ,EAAE,YAAY,CAAA;IACtB,OAAO,EAAE;QACP,SAAS,EAAE,KAAK,MAAM,EAAE,CAAA;QACxB,aAAa,EAAE;YACb,IAAI,EAAE,KAAK,MAAM,EAAE,CAAA;YACnB,mBAAmB,EAAE,MAAM,CAAA;YAC3B,WAAW,EAAE;gBAAE,EAAE,EAAE,MAAM,CAAC;gBAAC,IAAI,EAAE,MAAM,CAAA;aAAE,EAAE,CAAA;SAC5C,CAAA;KACF,CAAA;IACD,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,YAAY,CAAA;IAClB,OAAO,EAAE,GAAG,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,iBAAiB,EAAE,KAAK,MAAM,EAAE,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,EAAE,CAAC;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,IAAI,EAAE,QAAQ,CAAA;KAAE,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,QAAQ,CAAA;KAAE,CAAC,CAAA;IAC9E,WAAW,EAAE,CAAC;QAAE,IAAI,EAAE,aAAa,CAAC;QAAC,IAAI,EAAE,cAAc,CAAA;KAAE,CAAC,CAAA;IAC5D,aAAa,EAAE;QACb;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,SAAS,CAAA;SAAE;QACjC;YAAE,IAAI,EAAE,qBAAqB,CAAC;YAAC,IAAI,EAAE,QAAQ,CAAA;SAAE;QAC/C;YAAE,IAAI,EAAE,aAAa,CAAC;YAAC,IAAI,EAAE,cAAc,CAAA;SAAE;KAC9C,CAAA;CACF,CAAA;AAED,eAAO,MAAM,wBAAwB,EAAE,mBAWtC,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,KAAK,MAAM,EAAE,CAAA;IACnB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,WAAW,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAC5C,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,UAAU,EAAE,YAAY,CAAA;IACxB,eAAe,EAAE,MAAM,CAAA;IACvB,gBAAgB,EAAE,MAAM,CAAA;IACxB,YAAY,EAAE,YAAY,CAAA;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,oEAAoE;IACpE,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,GACvC,SAAS,wBAAwB,KAChC,OAAO,CAAC,oBAAoB,CA0E9B,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,GACrC,aAAa,oBAAoB,EACjC,cAAc,YAAY,KACzB,OAAO,CAAC,OAAO,CAoBjB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,KAAK,EAAE,OAAO,CAAA;IACd,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,GAAI,OAAO,OAAO,KAAG,yBAgF3D,CAAA;AAED,eAAO,MAAM,wBAAwB,GAAI,aAAa,oBAAoB,KAAG,MAE5E,CAAA;AAED,eAAO,MAAM,wBAAwB,GAAI,SAAS,MAAM,KAAG,oBAE1D,CAAA"}

package/dist/models/AgentX402AccessToken.js

@@ -6,16 +6,25 @@ export const NeverminedTypedDataTypes = {
     ],
     SessionKeys: [{ name: 'sessionKeys', type: 'SessionKey[]' }],
     Authorization: [
+        { name: 'from', type: 'address' },
         { name: 'sessionKeysProvider', type: 'string' },
         { name: 'sessionKeys', type: 'SessionKey[]' },
     ],
 };
-export const generateAgentX402AccessToken = async (subscriber, orderSessionKey, burnSessionKey, publicClient, agentId) => {
+/**
+ * Generate an x402 access token aligned with x402 v2 spec
+ *
+ * @param options - Token generation options
+ * @returns x402 access token with EIP-712 signature
+ */
+export const generateAgentX402AccessToken = async (options) => {
+    const { subscriber, orderSessionKey, redeemSessionKey, publicClient, planId, schemeVersion = '1', agentId, resource, httpVerb, } = options;
     // hash the session keys
-    const burnSessionKeyHash = keccak256(toBytes(burnSessionKey));
+    const redeemSessionKeyHash = keccak256(toBytes(redeemSessionKey));
     const orderSessionKeyHash = keccak256(toBytes(orderSessionKey));
-    // generate the message
+    // generate the message with `from` address
     const message = {
+        from: subscriber.address,
         sessionKeysProvider: 'zerodev',
         sessionKeys: [
             {
@@ -24,7 +33,7 @@ export const generateAgentX402AccessToken = async (subscriber, orderSessionKey,
             },
             {
                 id: 'redeem',
-                data: burnSessionKeyHash,
+                data: redeemSessionKeyHash,
             },
         ],
     };
@@ -42,19 +51,39 @@ export const generateAgentX402AccessToken = async (subscriber, orderSessionKey,
         message,
     };
     const signature = await subscriber.signTypedData(eip712Data);
+    // Get network in CAIP-2 format (eip155:chainId)
+    const chainId = publicClient.chain?.id;
+    const network = chainId ? `eip155:${chainId}` : publicClient.chain?.name;
     return {
         x402Version: 2,
-        scheme: 'contract',
-        network: publicClient.chain?.name,
-        subscriberAddress: subscriber.address,
-        ...(agentId && { agentId }),
+        ...(resource && { resource }),
+        accepted: {
+            scheme: 'nvm:erc4337',
+            network,
+            planId,
+            extra: {
+                version: schemeVersion,
+                ...(agentId && { agentId }),
+                ...(httpVerb && { httpVerb }),
+            },
+        },
         payload: {
             signature,
             authorization: message,
         },
+        extensions: {},
     };
 };
-export const verifyAgentX402AccessToken = async (accessToken, publicClient, subscriberAddress) => {
+/**
+ * Verify an x402 access token signature
+ *
+ * @param accessToken - The x402 access token to verify
+ * @param publicClient - Viem public client
+ * @returns true if signature is valid
+ */
+export const verifyAgentX402AccessToken = async (accessToken, publicClient) => {
+    // Extract subscriber address from payload.authorization.from
+    const subscriberAddress = accessToken.payload.authorization.from;
     const domain = {
         name: 'Nevermined',
         version: '1',
@@ -72,6 +101,82 @@ export const verifyAgentX402AccessToken = async (accessToken, publicClient, subs
     });
     return isValid;
 };
+/**
+ * Validate the structure of an x402 access token
+ *
+ * @param token - The token to validate (unknown type for safety)
+ * @returns Validation result with errors if any
+ */
+export const validateX402TokenStructure = (token) => {
+    const errors = [];
+    if (!token || typeof token !== 'object') {
+        return { valid: false, errors: ['Token must be an object'] };
+    }
+    const t = token;
+    // Validate x402Version
+    if (t.x402Version !== 2) {
+        errors.push('x402Version must be 2');
+    }
+    // Validate accepted object
+    if (!t.accepted || typeof t.accepted !== 'object') {
+        errors.push('accepted is required');
+    }
+    else {
+        const accepted = t.accepted;
+        if (accepted.scheme !== 'nvm:erc4337') {
+            errors.push('scheme must be nvm:erc4337');
+        }
+        if (!accepted.network || typeof accepted.network !== 'string') {
+            errors.push('network is required in accepted');
+        }
+        if (!accepted.planId || typeof accepted.planId !== 'string') {
+            errors.push('planId is required in accepted');
+        }
+        // Validate extra
+        if (!accepted.extra || typeof accepted.extra !== 'object') {
+            errors.push('extra is required in accepted');
+        }
+        else {
+            const extra = accepted.extra;
+            if (!extra.version || typeof extra.version !== 'string') {
+                errors.push('version is required in accepted.extra');
+            }
+        }
+    }
+    // Validate payload
+    if (!t.payload || typeof t.payload !== 'object') {
+        errors.push('payload is required');
+    }
+    else {
+        const payload = t.payload;
+        if (!payload.signature || typeof payload.signature !== 'string') {
+            errors.push('signature is required in payload');
+        }
+        if (!payload.authorization || typeof payload.authorization !== 'object') {
+            errors.push('authorization is required in payload');
+        }
+        else {
+            const auth = payload.authorization;
+            if (!auth.from || typeof auth.from !== 'string') {
+                errors.push('from address is required in payload.authorization');
+            }
+            else if (!auth.from.startsWith('0x')) {
+                errors.push('from must be a valid hex address');
+            }
+            if (!auth.sessionKeysProvider || typeof auth.sessionKeysProvider !== 'string') {
+                errors.push('sessionKeysProvider is required in payload.authorization');
+            }
+            if (!Array.isArray(auth.sessionKeys)) {
+                errors.push('sessionKeys array is required in payload.authorization');
+            }
+        }
+    }
+    // Validate extensions (must be present, even if empty)
+    if (t.extensions === undefined) {
+        errors.push('extensions is required (can be empty object)');
+    }
+    return { valid: errors.length === 0, errors };
+};
 export const b64EncodeX402AccessToken = (accessToken) => {
     return Buffer.from(JSON.stringify(accessToken)).toString('base64');
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nevermined-io/core-kit",
-  "version": "0.1.21",
+  "version": "0.1.22",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",