@cashie/core-lib 1.0.0

package/dist/intent/encoder.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+import { Hex } from 'viem';
+import { PaymentIntent } from './types.js';
+/**
+ * Encodes a payment intent for hashing.
+ *
+ * dependencies, and identityMintPayloads are not encoded in the payment intent.
+ *
+ * @param paymentIntent - The payment intent to encode
+ * @returns The encoded payment intent as a hex string
+ */
+export declare function encodePaymentIntent(paymentIntent: PaymentIntent): Hex;
+/**
+ * Returns keccak256(encodePaymentIntent(paymentIntent)).
+ *
+ * @param paymentIntent - The payment intent to hash
+ * @returns The hash of the payment intent
+ */
+export declare function getPaymentIntentHash(paymentIntent: PaymentIntent): `0x${string}`;

package/dist/intent/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types.js';
+export * from './encoder.js';

package/dist/intent/types.d.ts

@@ -0,0 +1,88 @@
+import { Address, Hex } from 'viem';
+import { IdentityMintSignPayloadWithSignature } from '../identity/types.js';
+export declare enum CashieRouterActions {
+    PAYMENT_C2B = "payment-c2b",
+    PAYMENT_B2B = "payment-b2b",
+    PAYMENT_B2C = "payment-b2c",
+    DEPOSIT = "deposit",
+    WITHDRAW = "withdraw"
+}
+export type RewardItem = {
+    recipient: Address;
+    rewardAmount: Hex;
+    rewardTokenAddress: Address;
+};
+export type RewardIntentDetails = {
+    /**
+     * The address of the payer of the reward.
+     */
+    rewardPayer: Address;
+    /**
+     * The reward items of the payment.
+     */
+    rewardItems: RewardItem[];
+    /**
+     * The ERC-7710 permission context used to redeem the reward.
+     */
+    rewardPermissionContext: Hex;
+    /**
+     * The delegation manager address.
+     */
+    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;
+    /**
+     * The address to send payment to.
+     */
+    recipient: Address;
+    /**
+     * The address of the payer of the payment.
+     */
+    payer: Address;
+    /**
+     * The identity mint payload with signature of the payment.
+     */
+    identityMintPayloads: IdentityMintSignPayloadWithSignature[];
+    /**
+     * The ERC20 token address(stablecoin address).
+     */
+    tokenAddress: Address;
+    /**
+     * The amount of the payment.
+     */
+    allowance: Hex;
+    /**
+     * 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;
+    /**
+     * Optional but when present then fields for factory and factoryData are required as defined in ERC-4337.
+     */
+    dependencies: {
+        factory: Address;
+        factoryData: Hex;
+    }[];
+    /**
+     * The salt of the payment intent.
+     */
+    salt: Hex;
+};

package/dist/router/index.d.ts

@@ -0,0 +1 @@
+export * from './types.js';

package/dist/router/types.d.ts

@@ -0,0 +1,12 @@
+import { ReceiptType } from '../data/index.js';
+import { Hex } from 'viem';
+export type ReceiptBadgeRouterMintPayload = {
+    /**
+     * The salt of the receipt
+     */
+    salt: Hex;
+    /**
+     * The type of the receipt
+     */
+    receiptType: ReceiptType;
+};

package/dist/shared/either.d.ts

@@ -0,0 +1,68 @@
+export declare abstract class Either<L, R> {
+    protected value: L | R;
+    constructor(value: L | R);
+    /**
+     * Transforms the value in a `Right`, does nothing for a `Left`.
+     */
+    abstract map<U>(f: (value: R) => U): Either<L, U>;
+    /**
+     * Chains computations that return an `Either`.
+     * Propagates `Left` if the current value is `Left`.
+     */
+    abstract flatMap<U>(f: (value: R) => Either<L, U>): Either<L, U>;
+    /**
+     * Returns the value inside a `Right` or the provided default value if `Left`.
+     */
+    abstract getOrElse(defaultValue: R): R;
+    /**
+     * Determines if the instance is `Left`.
+     */
+    abstract isLeft(): boolean;
+    /**
+     * Determines if the instance is `Right`.
+     */
+    abstract isRight(): boolean;
+    /**
+     * Returns a string representation of the instance.
+     *
+     * @returns A string representation of the instance.
+     */
+    toString(): string;
+    /**
+     * Handles both `Left` and `Right` cases with provided functions.
+     *
+     * @param onLeft - Function to handle `Left`.
+     * @param onRight - Function to handle `Right`.
+     * @returns The result of the function that matches the instance.
+     */
+    fold<U>(onLeft: (error: L) => U, onRight: (value: R) => U): U;
+    foldAsync<U>(onLeft: (error: L) => Promise<U>, onRight: (value: R) => Promise<U>): Promise<U>;
+    /**
+     * Factory method for creating a `Right` instance.
+     *
+     * @param value - The value to wrap in a `Right`.
+     * @returns A `Right` instance.
+     */
+    static of<R>(value: R): Either<never, R>;
+    /**
+     * Factory method for creating a `Left` instance.
+     *
+     * @param value - The value to wrap in a `Left`.
+     * @returns A `Left` instance.
+     */
+    static Left<L, R>(value: L): Either<L, R>;
+    /**
+     * Factory method for creating a `Right` instance.
+     *
+     * @param value - The value to wrap in a `Right`.
+     * @returns A `Right` instance.
+     */
+    static Right<L, R>(value: R): Either<L, R>;
+}
+/**
+ * Determines if the provided value is an instance of `Either`.
+ *
+ * @param value - The value to check.
+ * @returns `true` if the value is an instance of `Either`, `false` otherwise.
+ */
+export declare const isEither: <L>(value: unknown) => value is Either<L, unknown>;

package/dist/shared/errorCode.d.ts

@@ -0,0 +1,115 @@
+export type ErrorDetails = {
+    code: number;
+    message: string;
+};
+/**
+ * The EIP1193 error code enum
+ */
+export declare enum EIP1193_ERROR_CODES {
+    /**
+     * The user rejected the request.
+     */
+    USER_REJECTED_REQUEST = 4001,
+    /**
+     * The specified address is not connected or not in the wallet
+     */
+    UNAUTHORIZED_ACCESS_ACCOUNT = 4100,
+    /**
+     * The Provider does not support the requested method.
+     */
+    UNSUPPORTED_METHOD = 4200,
+    /**
+     * The Provider is disconnected from all chains.
+     */
+    DISCONNECTED = 4900,
+    /**
+     * The Provider is not connected to the requested chain.
+     */
+    CHAIN_DISCONNECTED = 4901
+}
+/**
+ * The EIP5792 error code enum
+ */
+export declare enum EIP5792_ERROR_CODES {
+    /**
+     * This wallet does not support a capability that was not marked as optional
+     * Related RPCs: wallet_sendCalls
+     */
+    UNSUPPORTED_NON_OPTIONAL_CAPABILITY = 5700,
+    /**
+     * This wallet does not support the specified chain id
+     * Related RPCs: wallet_sendCalls
+     */
+    UNSUPPORTED_CHAIN_ID = 5710,
+    /**
+     * There is already a bundle submitted with this id
+     * Related RPCs: wallet_sendCalls
+     */
+    DUPLICATE_BUNDLE_ID = 5720,
+    /**
+     * This bundle id is unknown / has not been submitted
+     * Related RPCs: wallet_getCallsStatus, wallet_showCallsStatus
+     */
+    UNKNOWN_BUNDLE_ID = 5730,
+    /**
+     * The call bundle is too large for the wallet to process
+     * Related RPCs: wallet_sendCalls
+     */
+    BUNDLE_TOO_LARGE = 5740,
+    /**
+     * The wallet can support atomicity after an upgrade, but the user rejected the upgrade
+     * Related RPCs: wallet_sendCalls
+     */
+    ATOMIC_READY_WALLET_REJECTED_UPGRADE = 5750,
+    /**
+     * The wallet does not support atomic execution but the request requires it
+     * Related RPCs: wallet_sendCalls
+     */
+    ATOMICITY_NOT_SUPPORTED = 5760
+}
+/**
+ * The ERC-7715 error code enum
+ */
+export declare enum ERC7715_ERROR_CODES {
+    /**
+     * The specified method is not authorized for the given origin
+     * Related RPCs:
+     */
+    UNAUTHORIZED_ACCESS_RESTRICTED_METHOD = 4101
+}
+/**
+ * The fatal error code enum
+ */
+export declare enum FATAL_ERROR_CODES {
+    INTERNAL_ERROR = -32001,
+    NO_SECURE_CONNECTION_ESTABLISHED = -32002
+}
+export declare enum COMMON_ERROR_CODES {
+    INVALID_PARAMS = -32602
+}
+/**
+ * Get the error message for a given error code
+ *
+ * @param code - The error code
+ * @returns The error message
+ * @throws An 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 {
+    /**
+     * MUST be an integer number
+     * SHOULD adhere to the specifications in the Error Standards section below
+     *
+     * @see https://eips.ethereum.org/EIPS/eip-1193#error-standards
+     */
+    code: number;
+    /**
+     * SHOULD contain any other useful information about the error
+     */
+    data?: unknown;
+    constructor({ message, code, data, }: {
+        message: string;
+        code: number;
+        data?: unknown;
+    });
+}

package/dist/shared/index.d.ts

@@ -0,0 +1,3 @@
+export * from './errorCode.js';
+export * from './either.js';
+export * from './types/index.js';

package/dist/shared/types/eip-7702.types.d.ts

@@ -0,0 +1,21 @@
+import { Hex, Address } from 'viem';
+export type CashieSigned7702Authorization = {
+    /** The r component of the signature */
+    r: Hex;
+    /** The s component of the signature. */
+    s: Hex;
+    /** The v component of the signature. */
+    v: number;
+    /** The y-parity value of the signature. */
+    yParity: number;
+    /** Address of the contract to delegate to. */
+    address: Address;
+    /** Chain ID. */
+    chainId: Hex;
+    /** Nonce of the EOA to delegate to. */
+    nonceHex: Hex;
+    metadata: {
+        /** The address of the EOA that signed the authorization. */
+        eoaAddress: Address;
+    };
+};

package/dist/shared/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './rpc.types.js';
+export * from './payment-protocol.types.js';
+export * from './eip-7702.types.js';

package/dist/shared/types/payment-protocol.types.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The account type for a Cashie account
+ */
+export declare enum CashieAccountType {
+    /**
+     * (Default) The individual account type
+     */
+    INDIVIDUAL = 0,
+    /**
+     * The business account type
+     */
+    BUSINESS = 1
+}
+/**
+ * The labels for the Cashie account types
+ */
+export declare const CASHIE_ACCOUNT_TYPE_LABELS: Record<CashieAccountType, string>;

package/dist/shared/types/rpc.types.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The JSON-RPC request object.
+ */
+export type JsonRpcRequest = {
+    jsonrpc: '2.0';
+    method: string;
+    params: unknown[];
+    id: number | string;
+};
+/**
+ * Same-origin proxy for protocol-chain JSON-RPC. The browser must use this path
+ * instead of a public RPC URL so server RPC credentials stay off the client.
+ */
+export declare const PROTOCOL_RPC_PROXY_PATH = "/api/public/protocol-rpc";

package/dist/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './utils.js';

package/dist/utils/utils.d.ts

@@ -0,0 +1,17 @@
+import { Hex } from 'viem';
+/**
+ * Generates a random salt for the payment intent.
+ *
+ * @returns The random salt as a hex string.
+ */
+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
+ * @returns the URL`
+ */
+export declare function assertUrl(url: string): string;

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@cashie/core-lib",
+  "version": "1.0.0",
+  "description": "A core library for the Cashie Protocol",
+  "homepage": "https://github.com/transeptorlabs/cashie-core/blob/main/packages/core-lib/README.md",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/transeptorlabs/cashie-core.git"
+  },
+  "bugs": {
+    "url": "https://github.com/transeptorlabs/cashie-core/issues"
+  },
+  "license": "MIT",
+  "author": "Transeptor Labs",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    "require": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs"
+    },
+    "import": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "yarn build:esbuild && yarn build:types",
+    "build:esbuild": "node ./build-package.mjs",
+    "build:types": "tsc --emitDeclarationOnly",
+    "build:docs": "typedoc",
+    "build:pack": "yarn build && yarn pack --filename ../../deps/cashie-core-lib-0.0.0.tgz",
+    "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: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",
+    "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write && yarn lint:dependencies",
+    "test": "vitest run --config ./vitest.config.ts --coverage",
+    "test:watch": "vitest --config ./vitest.config.ts"
+  },
+  "dependencies": {
+    "uuid": "9.0.1",
+    "viem": "2.37.3",
+    "zod": "4.1.11"
+  },
+  "devDependencies": {
+    "@types/node": "20.10.0",
+    "@types/uuid": "9.0.7",
+    "typescript": "5.6.3"
+  },
+  "engines": {
+    "node": ">=22.14.0"
+  },
+  "packageManager": "yarn@4.7.0",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}