@cashie/core-lib 1.1.0 → 1.3.0

package/dist/intent/encoder.d.ts

@@ -1,22 +1,39 @@
 /**
- * Canonical intent encoding for stable `paymentIntentHash` (Redis, APIs, optional router event arg).
- * AA orchestration and full {@link PaymentIntent} payloads stay in the node/wallet layer.
+ * Canonical intent encoding for a stable `intentHash` (Redis, APIs, optional
+ * router event arg). `data` is encoded per action so hashes cannot collide
+ * across actions. AA orchestration fields stay in the node/wallet layer.
  */
 import { Hex } from 'viem';
-import { PaymentIntent } from './types.js';
+import { Intent, IntentActions } from './types.js';
 /**
- * Encodes a payment intent for hashing.
+ * Encodes intent `data` for hashing. Encoding is action-specific so data
+ * hashes cannot collide across actions.
  *
- * dependencies, and identityMintPayloads are not encoded in the payment intent.
+ * @param intent - The intent whose data to encode
+ * @returns The encoded data as a hex string
+ */
+export declare function encodeIntentData<TIntentAction extends IntentActions>(intent: Intent<TIntentAction>): Hex;
+/**
+ * Returns keccak256(encodeIntentData(intent)).
+ *
+ * @param intent - The intent whose data to hash
+ * @returns The hash of the action-specific data
+ */
+export declare function getIntentDataHash<TIntentAction extends IntentActions>(intent: Intent<TIntentAction>): `0x${string}`;
+/**
+ * Encodes an intent for hashing.
+ *
+ * permissionContext is not encoded. `data` is hashed per action and included
+ * as `dataHash`.
  *
- * @param paymentIntent - The payment intent to encode
- * @returns The encoded payment intent as a hex string
+ * @param intent - The intent to encode
+ * @returns The encoded intent as a hex string
  */
-export declare function encodePaymentIntent(paymentIntent: PaymentIntent): Hex;
+export declare function encodeIntent<TIntentAction extends IntentActions>(intent: Intent<TIntentAction>): Hex;
 /**
- * Returns keccak256(encodePaymentIntent(paymentIntent)).
+ * Returns keccak256(encodeIntent(intent)).
  *
- * @param paymentIntent - The payment intent to hash
- * @returns The hash of the payment intent
+ * @param intent - The intent to hash
+ * @returns The hash of the intent
  */
-export declare function getPaymentIntentHash(paymentIntent: PaymentIntent): `0x${string}`;
+export declare function getIntentHash<TIntentAction extends IntentActions>(intent: Intent<TIntentAction>): Hex;

package/dist/intent/types.d.ts

@@ -1,18 +1,34 @@
 import { Address, Hex } from 'viem';
 import { IdentityMintSignPayloadWithSignature } from '../identity/types.js';
-export declare enum CashieRouterActions {
+export declare enum PaymentIntentActions {
     PAYMENT_C2B = "payment-c2b",
     PAYMENT_B2B = "payment-b2b",
     PAYMENT_B2C = "payment-b2c",
     DEPOSIT = "deposit",
     WITHDRAW = "withdraw"
 }
+export declare enum AccountIntentActions {
+    DEACTIVATE_ACCOUNT = "deactivate-account",
+    RECOVER_ACCOUNT = "recover-account",
+    FREEZE_ACCOUNT = "freeze-account"
+}
+export declare const IntentActions: {
+    readonly DEACTIVATE_ACCOUNT: AccountIntentActions.DEACTIVATE_ACCOUNT;
+    readonly RECOVER_ACCOUNT: AccountIntentActions.RECOVER_ACCOUNT;
+    readonly FREEZE_ACCOUNT: AccountIntentActions.FREEZE_ACCOUNT;
+    readonly PAYMENT_C2B: PaymentIntentActions.PAYMENT_C2B;
+    readonly PAYMENT_B2B: PaymentIntentActions.PAYMENT_B2B;
+    readonly PAYMENT_B2C: PaymentIntentActions.PAYMENT_B2C;
+    readonly DEPOSIT: PaymentIntentActions.DEPOSIT;
+    readonly WITHDRAW: PaymentIntentActions.WITHDRAW;
+};
+export type IntentActions = PaymentIntentActions | AccountIntentActions;
 export type RewardItem = {
     recipient: Address;
     rewardAmount: Hex;
     rewardTokenAddress: Address;
 };
-export type RewardIntentDetails = {
+export type RewardData = {
     /**
      * The address of the payer of the reward.
      */
@@ -30,18 +46,7 @@ export type RewardIntentDetails = {
      */
     rewardDelegationManager: Address;
 };
-/**
- * RPC payload for executing a payment intent
- */
-export type PaymentIntent = {
-    /**
-     * The action of the payment intent.
-     */
-    action: CashieRouterActions;
-    /**
-     * hex-encoding of uint256
-     */
-    chainId: Hex;
+export type PaymentIntentData = {
     /**
      * The address to send payment to.
      */
@@ -65,15 +70,7 @@ export type PaymentIntent = {
     /**
      * The reward intent details of the payment.
      */
-    rewardIntentDetails?: RewardIntentDetails;
-    /**
-     * The ERC-7710 permission context used to redeem the payment.
-     */
-    permissionContext: Hex;
-    /**
-     * The delegation manager address.
-     */
-    delegationManager: Address;
+    rewardData?: RewardData;
     /**
      * Optional but when present then fields for factory and factoryData are required as defined in ERC-4337.
      */
@@ -81,8 +78,54 @@ export type PaymentIntent = {
         factory: Address;
         factoryData: Hex;
     }[];
+};
+type BaseAccountData = {
+    accountAddress: Address;
+};
+export type IntentDataMapping = {
+    [IntentActions.PAYMENT_C2B]: PaymentIntentData;
+    [IntentActions.PAYMENT_B2B]: PaymentIntentData;
+    [IntentActions.PAYMENT_B2C]: PaymentIntentData;
+    [IntentActions.DEPOSIT]: PaymentIntentData;
+    [IntentActions.WITHDRAW]: PaymentIntentData;
+    [IntentActions.DEACTIVATE_ACCOUNT]: BaseAccountData & {
+        permissionContexts: Hex[];
+    };
+    [IntentActions.RECOVER_ACCOUNT]: BaseAccountData;
+    [IntentActions.FREEZE_ACCOUNT]: BaseAccountData & {
+        /**
+         * The timestamp the account will stay frozen until. (unix timestamp in seconds)
+         */
+        timestamp: number;
+    };
+};
+/**
+ * RPC payload for executing a intent
+ */
+export type Intent<TIntentAction extends IntentActions> = {
+    /**
+     * The action of the intent.
+     */
+    action: TIntentAction;
+    /**
+     * hex-encoding of uint256
+     */
+    chainId: Hex;
     /**
      * The salt of the payment intent.
      */
     salt: Hex;
+    /**
+     * The ERC-7710 permission context used to redeem the intent.
+     */
+    permissionContext: Hex;
+    /**
+     * The ERC-7710 delegation manager address.
+     */
+    delegationManager: Address;
+    /**
+     * The data of the intent.
+     */
+    data: IntentDataMapping[TIntentAction];
 };
+export {};

package/dist/shared/errorCode.d.ts

@@ -92,7 +92,7 @@ export declare enum COMMON_ERROR_CODES {
  *
  * @param code - The error code
  * @returns The error message
- * @throws An error if the error code is not found
+ * @throws {Error} if the error code is not found
  */
 export declare const getErrorMessage: (code: EIP1193_ERROR_CODES | EIP5792_ERROR_CODES | ERC7715_ERROR_CODES | FATAL_ERROR_CODES | COMMON_ERROR_CODES) => ErrorDetails;
 export declare class RpcError extends Error {

package/dist/utils/utils.d.ts

@@ -9,9 +9,9 @@ export declare function generateSalt(): Hex;
  * Assert that the URL starts with https or http
  *
  * @param url - The URL to assert.
- * @throws an error if the URL is required
- * @throws an error if the URL does not start with https or http
- * @throws an error if the URL is not a valid URL
+ * @throws {Error} if the URL is required
+ * @throws {Error} if the URL does not start with https or http
+ * @throws {Error} if the URL is not a valid URL
  * @returns the URL`
  */
 export declare function assertUrl(url: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cashie/core-lib",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "A core library for the Cashie Protocol",
   "homepage": "https://github.com/transeptorlabs/cashie-core/blob/main/packages/core-lib/README.md",
   "repository": {
@@ -38,7 +38,7 @@
     "generate:abis": "node ./scripts/generate-abis.mjs",
     "generate:abis:build": "node ./scripts/generate-abis.mjs --build",
     "generate:abis:check": "node ./scripts/generate-abis.mjs --check",
-    "lint:eslint": "eslint . --ext ts --cache",
+    "lint:eslint": "yarn run -T eslint . --cache",
     "lint:dependencies": "yarn dedupe",
     "lint:misc": "prettier '**/*.json' '**/*.md' '**/*.yml' '!**/CHANGELOG.md' '!.yarnrc.yml' --ignore-path .gitignore --no-error-on-unmatched-pattern",
     "lint": "yarn lint:eslint && yarn lint:misc --check && yarn lint:dependencies --check",
@@ -47,7 +47,7 @@
     "test:watch": "vitest --config ./vitest.config.ts"
   },
   "dependencies": {
-    "uuid": "9.0.1",
+    "uuid": "14.0.0",
     "viem": "2.37.3",
     "zod": "4.1.11"
   },