@strimz/sdk 0.1.0

package/dist/eip712.d.cts

@@ -0,0 +1,181 @@
+/**
+ * Canonical EIP-712 typed-data shape.
+ *
+ * Matches the structure every major wallet library accepts —
+ *   viem's `signTypedData`
+ *   ethers' `signer._signTypedData`
+ *   Privy's `signTypedData`
+ *   Reown AppKit's typed-data RPC
+ * — so the SDK can produce typed-data without binding to a specific
+ * wallet client. Consumers pipe the result into whichever signer they
+ * already use.
+ *
+ * No viem/ethers dependency on purpose: the SDK stays minimal, and
+ * apps can choose their own signing stack.
+ */
+interface Eip712Domain {
+    name?: string;
+    version?: string;
+    chainId?: number;
+    verifyingContract?: `0x${string}`;
+    salt?: `0x${string}`;
+}
+interface Eip712Field {
+    name: string;
+    type: string;
+}
+type Eip712Types = Record<string, readonly Eip712Field[]>;
+/**
+ * EIP-712 typed-data definition. `primaryType` names the struct that
+ * gets hashed at the top level (the `types` object usually contains
+ * additional referenced sub-structs).
+ *
+ * `bigint` is used for uint values; wallet libs handle the conversion
+ * to hex/decimal at signing time. If a consumer needs to JSON-serialise
+ * this object, convert bigints to strings at that boundary.
+ */
+interface Eip712TypedData<TPrimary extends string = string> {
+    domain: Eip712Domain;
+    types: Eip712Types;
+    primaryType: TPrimary;
+    message: Record<string, unknown>;
+}
+
+/**
+ * Inputs for the EIP-3009 ReceiveWithAuthorization typed-data.
+ *
+ *  - `chainId` is the EVM chain id (Arc Testnet = 5042002).
+ *  - `token` is the ERC-20 contract whose `receiveWithAuthorization` is
+ *    being invoked — usually USDC at `0x36...` on Arc.
+ *  - `tokenName` and `tokenVersion` form the EIP-712 domain. Real USDC
+ *    on most chains uses `name="USD Coin"` and `version="2"`; tests
+ *    use whatever the mock token reports. Always read these from the
+ *    token contract at runtime to avoid drift.
+ *  - `from` is the payer; the wallet that produces the signature must
+ *    match this address.
+ *  - `to` is the recipient of the funds — for Strimz this is the
+ *    StrimzPayments contract address (the contract pulls funds into
+ *    itself, then forwards the fee + net split).
+ *  - `value` is the gross amount in token base units.
+ *  - `validAfter` / `validBefore` are unix-second timestamps bounding
+ *    the signature's validity. Strimz's default checkout window is
+ *    5 minutes; integrators may widen this for usage-based billing.
+ *  - `nonce` is a single-use 32-byte value. Generate with crypto.randomBytes
+ *    (server) or crypto.getRandomValues (browser). The token contract
+ *    tracks `(authorizer, nonce) -> used` and rejects replays.
+ */
+interface ReceiveWithAuthorizationParams {
+    chainId: number;
+    token: `0x${string}`;
+    tokenName: string;
+    tokenVersion: string;
+    from: `0x${string}`;
+    to: `0x${string}`;
+    value: bigint;
+    validAfter: bigint;
+    validBefore: bigint;
+    nonce: `0x${string}`;
+}
+/**
+ * EIP-712 type definition for `ReceiveWithAuthorization`. Stable —
+ * shared by every EIP-3009 implementation (USDC, EURC, etc.).
+ *
+ * Exported so consumers can introspect or extend with sibling
+ * primitive types (e.g. for x402 batched signing schemes that wrap
+ * multiple authorizations in one signature).
+ */
+declare const RECEIVE_WITH_AUTHORIZATION_TYPES: {
+    readonly ReceiveWithAuthorization: readonly [{
+        readonly name: "from";
+        readonly type: "address";
+    }, {
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+    }, {
+        readonly name: "validAfter";
+        readonly type: "uint256";
+    }, {
+        readonly name: "validBefore";
+        readonly type: "uint256";
+    }, {
+        readonly name: "nonce";
+        readonly type: "bytes32";
+    }];
+};
+/**
+ * Build the typed-data structure for an EIP-3009
+ * `ReceiveWithAuthorization` signature. Returns the canonical shape
+ * compatible with viem, ethers, Privy, and Reown.
+ *
+ * Pass the result to `walletClient.signTypedData(typedData)` (viem)
+ * or `signer._signTypedData(domain, types, message)` (ethers) — the
+ * SDK does not bind to a specific signer.
+ */
+declare function buildReceiveWithAuthorizationTypedData(params: ReceiveWithAuthorizationParams): Eip712TypedData<'ReceiveWithAuthorization'>;
+
+/**
+ * Inputs for the EIP-2612 Permit typed-data.
+ *
+ *  - `chainId`, `token`, `tokenName`, `tokenVersion` form the EIP-712
+ *    domain (same shape as the EIP-3009 builder).
+ *  - `owner` is the token holder authorising the allowance — must match
+ *    the signing wallet.
+ *  - `spender` is the contract that will pull funds — for Strimz
+ *    subscriptions this is the StrimzSubscriptions contract.
+ *  - `value` is the allowance to grant in token base units.
+ *    `type(uint256).max` produces an unlimited allowance and is the
+ *    common case for subscription enrolment.
+ *  - `nonce` is the owner's *current* `nonces(owner)` reading from the
+ *    token contract. The SDK does not fetch this — the caller is
+ *    expected to have just queried it. Race-free: the token rejects
+ *    stale nonces, so a concurrent permit on the same owner just
+ *    causes one to fail predictably.
+ *  - `deadline` is the unix-second timestamp after which the permit
+ *    expires. Strimz default for subscription enrolment is 24h —
+ *    enough headroom for a slow merchant submit pipeline without
+ *    leaving an indefinite signature window.
+ */
+interface PermitParams {
+    chainId: number;
+    token: `0x${string}`;
+    tokenName: string;
+    tokenVersion: string;
+    owner: `0x${string}`;
+    spender: `0x${string}`;
+    value: bigint;
+    nonce: bigint;
+    deadline: bigint;
+}
+/**
+ * EIP-712 type definition for `Permit`. Stable across every EIP-2612
+ * implementation (USDC, EURC, DAI v2, etc.).
+ */
+declare const PERMIT_TYPES: {
+    readonly Permit: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+    }, {
+        readonly name: "nonce";
+        readonly type: "uint256";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint256";
+    }];
+};
+/**
+ * Build the typed-data structure for an EIP-2612 `Permit` signature.
+ * Returns the canonical shape compatible with viem, ethers, Privy,
+ * and Reown.
+ */
+declare function buildPermitTypedData(params: PermitParams): Eip712TypedData<'Permit'>;
+
+export { type Eip712Domain, type Eip712Field, type Eip712TypedData, type Eip712Types, PERMIT_TYPES, type PermitParams, RECEIVE_WITH_AUTHORIZATION_TYPES, type ReceiveWithAuthorizationParams, buildPermitTypedData, buildReceiveWithAuthorizationTypedData };

package/dist/eip712.d.ts

@@ -0,0 +1,181 @@
+/**
+ * Canonical EIP-712 typed-data shape.
+ *
+ * Matches the structure every major wallet library accepts —
+ *   viem's `signTypedData`
+ *   ethers' `signer._signTypedData`
+ *   Privy's `signTypedData`
+ *   Reown AppKit's typed-data RPC
+ * — so the SDK can produce typed-data without binding to a specific
+ * wallet client. Consumers pipe the result into whichever signer they
+ * already use.
+ *
+ * No viem/ethers dependency on purpose: the SDK stays minimal, and
+ * apps can choose their own signing stack.
+ */
+interface Eip712Domain {
+    name?: string;
+    version?: string;
+    chainId?: number;
+    verifyingContract?: `0x${string}`;
+    salt?: `0x${string}`;
+}
+interface Eip712Field {
+    name: string;
+    type: string;
+}
+type Eip712Types = Record<string, readonly Eip712Field[]>;
+/**
+ * EIP-712 typed-data definition. `primaryType` names the struct that
+ * gets hashed at the top level (the `types` object usually contains
+ * additional referenced sub-structs).
+ *
+ * `bigint` is used for uint values; wallet libs handle the conversion
+ * to hex/decimal at signing time. If a consumer needs to JSON-serialise
+ * this object, convert bigints to strings at that boundary.
+ */
+interface Eip712TypedData<TPrimary extends string = string> {
+    domain: Eip712Domain;
+    types: Eip712Types;
+    primaryType: TPrimary;
+    message: Record<string, unknown>;
+}
+
+/**
+ * Inputs for the EIP-3009 ReceiveWithAuthorization typed-data.
+ *
+ *  - `chainId` is the EVM chain id (Arc Testnet = 5042002).
+ *  - `token` is the ERC-20 contract whose `receiveWithAuthorization` is
+ *    being invoked — usually USDC at `0x36...` on Arc.
+ *  - `tokenName` and `tokenVersion` form the EIP-712 domain. Real USDC
+ *    on most chains uses `name="USD Coin"` and `version="2"`; tests
+ *    use whatever the mock token reports. Always read these from the
+ *    token contract at runtime to avoid drift.
+ *  - `from` is the payer; the wallet that produces the signature must
+ *    match this address.
+ *  - `to` is the recipient of the funds — for Strimz this is the
+ *    StrimzPayments contract address (the contract pulls funds into
+ *    itself, then forwards the fee + net split).
+ *  - `value` is the gross amount in token base units.
+ *  - `validAfter` / `validBefore` are unix-second timestamps bounding
+ *    the signature's validity. Strimz's default checkout window is
+ *    5 minutes; integrators may widen this for usage-based billing.
+ *  - `nonce` is a single-use 32-byte value. Generate with crypto.randomBytes
+ *    (server) or crypto.getRandomValues (browser). The token contract
+ *    tracks `(authorizer, nonce) -> used` and rejects replays.
+ */
+interface ReceiveWithAuthorizationParams {
+    chainId: number;
+    token: `0x${string}`;
+    tokenName: string;
+    tokenVersion: string;
+    from: `0x${string}`;
+    to: `0x${string}`;
+    value: bigint;
+    validAfter: bigint;
+    validBefore: bigint;
+    nonce: `0x${string}`;
+}
+/**
+ * EIP-712 type definition for `ReceiveWithAuthorization`. Stable —
+ * shared by every EIP-3009 implementation (USDC, EURC, etc.).
+ *
+ * Exported so consumers can introspect or extend with sibling
+ * primitive types (e.g. for x402 batched signing schemes that wrap
+ * multiple authorizations in one signature).
+ */
+declare const RECEIVE_WITH_AUTHORIZATION_TYPES: {
+    readonly ReceiveWithAuthorization: readonly [{
+        readonly name: "from";
+        readonly type: "address";
+    }, {
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+    }, {
+        readonly name: "validAfter";
+        readonly type: "uint256";
+    }, {
+        readonly name: "validBefore";
+        readonly type: "uint256";
+    }, {
+        readonly name: "nonce";
+        readonly type: "bytes32";
+    }];
+};
+/**
+ * Build the typed-data structure for an EIP-3009
+ * `ReceiveWithAuthorization` signature. Returns the canonical shape
+ * compatible with viem, ethers, Privy, and Reown.
+ *
+ * Pass the result to `walletClient.signTypedData(typedData)` (viem)
+ * or `signer._signTypedData(domain, types, message)` (ethers) — the
+ * SDK does not bind to a specific signer.
+ */
+declare function buildReceiveWithAuthorizationTypedData(params: ReceiveWithAuthorizationParams): Eip712TypedData<'ReceiveWithAuthorization'>;
+
+/**
+ * Inputs for the EIP-2612 Permit typed-data.
+ *
+ *  - `chainId`, `token`, `tokenName`, `tokenVersion` form the EIP-712
+ *    domain (same shape as the EIP-3009 builder).
+ *  - `owner` is the token holder authorising the allowance — must match
+ *    the signing wallet.
+ *  - `spender` is the contract that will pull funds — for Strimz
+ *    subscriptions this is the StrimzSubscriptions contract.
+ *  - `value` is the allowance to grant in token base units.
+ *    `type(uint256).max` produces an unlimited allowance and is the
+ *    common case for subscription enrolment.
+ *  - `nonce` is the owner's *current* `nonces(owner)` reading from the
+ *    token contract. The SDK does not fetch this — the caller is
+ *    expected to have just queried it. Race-free: the token rejects
+ *    stale nonces, so a concurrent permit on the same owner just
+ *    causes one to fail predictably.
+ *  - `deadline` is the unix-second timestamp after which the permit
+ *    expires. Strimz default for subscription enrolment is 24h —
+ *    enough headroom for a slow merchant submit pipeline without
+ *    leaving an indefinite signature window.
+ */
+interface PermitParams {
+    chainId: number;
+    token: `0x${string}`;
+    tokenName: string;
+    tokenVersion: string;
+    owner: `0x${string}`;
+    spender: `0x${string}`;
+    value: bigint;
+    nonce: bigint;
+    deadline: bigint;
+}
+/**
+ * EIP-712 type definition for `Permit`. Stable across every EIP-2612
+ * implementation (USDC, EURC, DAI v2, etc.).
+ */
+declare const PERMIT_TYPES: {
+    readonly Permit: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+    }, {
+        readonly name: "nonce";
+        readonly type: "uint256";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint256";
+    }];
+};
+/**
+ * Build the typed-data structure for an EIP-2612 `Permit` signature.
+ * Returns the canonical shape compatible with viem, ethers, Privy,
+ * and Reown.
+ */
+declare function buildPermitTypedData(params: PermitParams): Eip712TypedData<'Permit'>;
+
+export { type Eip712Domain, type Eip712Field, type Eip712TypedData, type Eip712Types, PERMIT_TYPES, type PermitParams, RECEIVE_WITH_AUTHORIZATION_TYPES, type ReceiveWithAuthorizationParams, buildPermitTypedData, buildReceiveWithAuthorizationTypedData };

package/dist/eip712.js

@@ -0,0 +1,65 @@
+// src/eip712/receive-with-authorization.ts
+var RECEIVE_WITH_AUTHORIZATION_TYPES = {
+  ReceiveWithAuthorization: [
+    { name: "from", type: "address" },
+    { name: "to", type: "address" },
+    { name: "value", type: "uint256" },
+    { name: "validAfter", type: "uint256" },
+    { name: "validBefore", type: "uint256" },
+    { name: "nonce", type: "bytes32" }
+  ]
+};
+function buildReceiveWithAuthorizationTypedData(params) {
+  return {
+    domain: {
+      name: params.tokenName,
+      version: params.tokenVersion,
+      chainId: params.chainId,
+      verifyingContract: params.token
+    },
+    types: RECEIVE_WITH_AUTHORIZATION_TYPES,
+    primaryType: "ReceiveWithAuthorization",
+    message: {
+      from: params.from,
+      to: params.to,
+      value: params.value,
+      validAfter: params.validAfter,
+      validBefore: params.validBefore,
+      nonce: params.nonce
+    }
+  };
+}
+
+// src/eip712/permit.ts
+var PERMIT_TYPES = {
+  Permit: [
+    { name: "owner", type: "address" },
+    { name: "spender", type: "address" },
+    { name: "value", type: "uint256" },
+    { name: "nonce", type: "uint256" },
+    { name: "deadline", type: "uint256" }
+  ]
+};
+function buildPermitTypedData(params) {
+  return {
+    domain: {
+      name: params.tokenName,
+      version: params.tokenVersion,
+      chainId: params.chainId,
+      verifyingContract: params.token
+    },
+    types: PERMIT_TYPES,
+    primaryType: "Permit",
+    message: {
+      owner: params.owner,
+      spender: params.spender,
+      value: params.value,
+      nonce: params.nonce,
+      deadline: params.deadline
+    }
+  };
+}
+
+export { PERMIT_TYPES, RECEIVE_WITH_AUTHORIZATION_TYPES, buildPermitTypedData, buildReceiveWithAuthorizationTypedData };
+//# sourceMappingURL=eip712.js.map
+//# sourceMappingURL=eip712.js.map

package/dist/eip712.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/eip712/receive-with-authorization.ts","../src/eip712/permit.ts"],"names":[],"mappings":";AA8CO,IAAM,gCAAA,GAAmC;AAAA,EAC9C,wBAAA,EAA0B;AAAA,IACxB,EAAE,IAAA,EAAM,MAAA,EAAQ,IAAA,EAAM,SAAA,EAAU;AAAA,IAChC,EAAE,IAAA,EAAM,IAAA,EAAM,IAAA,EAAM,SAAA,EAAU;AAAA,IAC9B,EAAE,IAAA,EAAM,OAAA,EAAS,IAAA,EAAM,SAAA,EAAU;AAAA,IACjC,EAAE,IAAA,EAAM,YAAA,EAAc,IAAA,EAAM,SAAA,EAAU;AAAA,IACtC,EAAE,IAAA,EAAM,aAAA,EAAe,IAAA,EAAM,SAAA,EAAU;AAAA,IACvC,EAAE,IAAA,EAAM,OAAA,EAAS,IAAA,EAAM,SAAA;AAAU;AAErC;AAWO,SAAS,uCACd,MAAA,EAC6C;AAC7C,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ;AAAA,MACN,MAAM,MAAA,CAAO,SAAA;AAAA,MACb,SAAS,MAAA,CAAO,YAAA;AAAA,MAChB,SAAS,MAAA,CAAO,OAAA;AAAA,MAChB,mBAAmB,MAAA,CAAO;AAAA,KAC5B;AAAA,IACA,KAAA,EAAO,gCAAA;AAAA,IACP,WAAA,EAAa,0BAAA;AAAA,IACb,OAAA,EAAS;AAAA,MACP,MAAM,MAAA,CAAO,IAAA;AAAA,MACb,IAAI,MAAA,CAAO,EAAA;AAAA,MACX,OAAO,MAAA,CAAO,KAAA;AAAA,MACd,YAAY,MAAA,CAAO,UAAA;AAAA,MACnB,aAAa,MAAA,CAAO,WAAA;AAAA,MACpB,OAAO,MAAA,CAAO;AAAA;AAChB,GACF;AACF;;;AC/CO,IAAM,YAAA,GAAe;AAAA,EAC1B,MAAA,EAAQ;AAAA,IACN,EAAE,IAAA,EAAM,OAAA,EAAS,IAAA,EAAM,SAAA,EAAU;AAAA,IACjC,EAAE,IAAA,EAAM,SAAA,EAAW,IAAA,EAAM,SAAA,EAAU;AAAA,IACnC,EAAE,IAAA,EAAM,OAAA,EAAS,IAAA,EAAM,SAAA,EAAU;AAAA,IACjC,EAAE,IAAA,EAAM,OAAA,EAAS,IAAA,EAAM,SAAA,EAAU;AAAA,IACjC,EAAE,IAAA,EAAM,UAAA,EAAY,IAAA,EAAM,SAAA;AAAU;AAExC;AAOO,SAAS,qBAAqB,MAAA,EAAiD;AACpF,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ;AAAA,MACN,MAAM,MAAA,CAAO,SAAA;AAAA,MACb,SAAS,MAAA,CAAO,YAAA;AAAA,MAChB,SAAS,MAAA,CAAO,OAAA;AAAA,MAChB,mBAAmB,MAAA,CAAO;AAAA,KAC5B;AAAA,IACA,KAAA,EAAO,YAAA;AAAA,IACP,WAAA,EAAa,QAAA;AAAA,IACb,OAAA,EAAS;AAAA,MACP,OAAO,MAAA,CAAO,KAAA;AAAA,MACd,SAAS,MAAA,CAAO,OAAA;AAAA,MAChB,OAAO,MAAA,CAAO,KAAA;AAAA,MACd,OAAO,MAAA,CAAO,KAAA;AAAA,MACd,UAAU,MAAA,CAAO;AAAA;AACnB,GACF;AACF","file":"eip712.js","sourcesContent":["import type { Eip712TypedData } from './types.js'\n\n/**\n * Inputs for the EIP-3009 ReceiveWithAuthorization typed-data.\n *\n *  - `chainId` is the EVM chain id (Arc Testnet = 5042002).\n *  - `token` is the ERC-20 contract whose `receiveWithAuthorization` is\n *    being invoked — usually USDC at `0x36...` on Arc.\n *  - `tokenName` and `tokenVersion` form the EIP-712 domain. Real USDC\n *    on most chains uses `name=\"USD Coin\"` and `version=\"2\"`; tests\n *    use whatever the mock token reports. Always read these from the\n *    token contract at runtime to avoid drift.\n *  - `from` is the payer; the wallet that produces the signature must\n *    match this address.\n *  - `to` is the recipient of the funds — for Strimz this is the\n *    StrimzPayments contract address (the contract pulls funds into\n *    itself, then forwards the fee + net split).\n *  - `value` is the gross amount in token base units.\n *  - `validAfter` / `validBefore` are unix-second timestamps bounding\n *    the signature's validity. Strimz's default checkout window is\n *    5 minutes; integrators may widen this for usage-based billing.\n *  - `nonce` is a single-use 32-byte value. Generate with crypto.randomBytes\n *    (server) or crypto.getRandomValues (browser). The token contract\n *    tracks `(authorizer, nonce) -> used` and rejects replays.\n */\nexport interface ReceiveWithAuthorizationParams {\n  chainId: number\n  token: `0x${string}`\n  tokenName: string\n  tokenVersion: string\n  from: `0x${string}`\n  to: `0x${string}`\n  value: bigint\n  validAfter: bigint\n  validBefore: bigint\n  nonce: `0x${string}`\n}\n\n/**\n * EIP-712 type definition for `ReceiveWithAuthorization`. Stable —\n * shared by every EIP-3009 implementation (USDC, EURC, etc.).\n *\n * Exported so consumers can introspect or extend with sibling\n * primitive types (e.g. for x402 batched signing schemes that wrap\n * multiple authorizations in one signature).\n */\nexport const RECEIVE_WITH_AUTHORIZATION_TYPES = {\n  ReceiveWithAuthorization: [\n    { name: 'from', type: 'address' },\n    { name: 'to', type: 'address' },\n    { name: 'value', type: 'uint256' },\n    { name: 'validAfter', type: 'uint256' },\n    { name: 'validBefore', type: 'uint256' },\n    { name: 'nonce', type: 'bytes32' },\n  ],\n} as const\n\n/**\n * Build the typed-data structure for an EIP-3009\n * `ReceiveWithAuthorization` signature. Returns the canonical shape\n * compatible with viem, ethers, Privy, and Reown.\n *\n * Pass the result to `walletClient.signTypedData(typedData)` (viem)\n * or `signer._signTypedData(domain, types, message)` (ethers) — the\n * SDK does not bind to a specific signer.\n */\nexport function buildReceiveWithAuthorizationTypedData(\n  params: ReceiveWithAuthorizationParams,\n): Eip712TypedData<'ReceiveWithAuthorization'> {\n  return {\n    domain: {\n      name: params.tokenName,\n      version: params.tokenVersion,\n      chainId: params.chainId,\n      verifyingContract: params.token,\n    },\n    types: RECEIVE_WITH_AUTHORIZATION_TYPES,\n    primaryType: 'ReceiveWithAuthorization',\n    message: {\n      from: params.from,\n      to: params.to,\n      value: params.value,\n      validAfter: params.validAfter,\n      validBefore: params.validBefore,\n      nonce: params.nonce,\n    },\n  }\n}\n","import type { Eip712TypedData } from './types.js'\n\n/**\n * Inputs for the EIP-2612 Permit typed-data.\n *\n *  - `chainId`, `token`, `tokenName`, `tokenVersion` form the EIP-712\n *    domain (same shape as the EIP-3009 builder).\n *  - `owner` is the token holder authorising the allowance — must match\n *    the signing wallet.\n *  - `spender` is the contract that will pull funds — for Strimz\n *    subscriptions this is the StrimzSubscriptions contract.\n *  - `value` is the allowance to grant in token base units.\n *    `type(uint256).max` produces an unlimited allowance and is the\n *    common case for subscription enrolment.\n *  - `nonce` is the owner's *current* `nonces(owner)` reading from the\n *    token contract. The SDK does not fetch this — the caller is\n *    expected to have just queried it. Race-free: the token rejects\n *    stale nonces, so a concurrent permit on the same owner just\n *    causes one to fail predictably.\n *  - `deadline` is the unix-second timestamp after which the permit\n *    expires. Strimz default for subscription enrolment is 24h —\n *    enough headroom for a slow merchant submit pipeline without\n *    leaving an indefinite signature window.\n */\nexport interface PermitParams {\n  chainId: number\n  token: `0x${string}`\n  tokenName: string\n  tokenVersion: string\n  owner: `0x${string}`\n  spender: `0x${string}`\n  value: bigint\n  nonce: bigint\n  deadline: bigint\n}\n\n/**\n * EIP-712 type definition for `Permit`. Stable across every EIP-2612\n * implementation (USDC, EURC, DAI v2, etc.).\n */\nexport const PERMIT_TYPES = {\n  Permit: [\n    { name: 'owner', type: 'address' },\n    { name: 'spender', type: 'address' },\n    { name: 'value', type: 'uint256' },\n    { name: 'nonce', type: 'uint256' },\n    { name: 'deadline', type: 'uint256' },\n  ],\n} as const\n\n/**\n * Build the typed-data structure for an EIP-2612 `Permit` signature.\n * Returns the canonical shape compatible with viem, ethers, Privy,\n * and Reown.\n */\nexport function buildPermitTypedData(params: PermitParams): Eip712TypedData<'Permit'> {\n  return {\n    domain: {\n      name: params.tokenName,\n      version: params.tokenVersion,\n      chainId: params.chainId,\n      verifyingContract: params.token,\n    },\n    types: PERMIT_TYPES,\n    primaryType: 'Permit',\n    message: {\n      owner: params.owner,\n      spender: params.spender,\n      value: params.value,\n      nonce: params.nonce,\n      deadline: params.deadline,\n    },\n  }\n}\n"]}

package/dist/errors.cjs

@@ -0,0 +1,102 @@
+'use strict';
+
+// src/errors.ts
+var StrimzError = class extends Error {
+  code;
+  httpStatus;
+  requestId;
+  param;
+  details;
+  constructor(body, httpStatus) {
+    super(body.message);
+    this.name = "StrimzError";
+    this.code = body.code;
+    this.httpStatus = httpStatus;
+    this.requestId = body.requestId;
+    this.param = body.param;
+    this.details = body.details;
+  }
+};
+var StrimzAuthenticationError = class extends StrimzError {
+  constructor(body, httpStatus) {
+    super(body, httpStatus);
+    this.name = "StrimzAuthenticationError";
+  }
+};
+var StrimzPermissionError = class extends StrimzError {
+  constructor(body, httpStatus) {
+    super(body, httpStatus);
+    this.name = "StrimzPermissionError";
+  }
+};
+var StrimzValidationError = class extends StrimzError {
+  constructor(body, httpStatus) {
+    super(body, httpStatus);
+    this.name = "StrimzValidationError";
+  }
+};
+var StrimzNotFoundError = class extends StrimzError {
+  constructor(body, httpStatus) {
+    super(body, httpStatus);
+    this.name = "StrimzNotFoundError";
+  }
+};
+var StrimzIdempotencyError = class extends StrimzError {
+  constructor(body, httpStatus) {
+    super(body, httpStatus);
+    this.name = "StrimzIdempotencyError";
+  }
+};
+var StrimzRateLimitError = class extends StrimzError {
+  retryAfterMs;
+  constructor(body, httpStatus, retryAfterMs) {
+    super(body, httpStatus);
+    this.name = "StrimzRateLimitError";
+    this.retryAfterMs = retryAfterMs;
+  }
+};
+var StrimzNetworkError = class extends StrimzError {
+  cause;
+  constructor(message, cause) {
+    super({ code: "network_error", message });
+    this.name = "StrimzNetworkError";
+    this.cause = cause;
+  }
+};
+var StrimzTimeoutError = class extends StrimzError {
+  constructor(message) {
+    super({ code: "timeout", message });
+    this.name = "StrimzTimeoutError";
+  }
+};
+var StrimzModeMismatchError = class extends StrimzError {
+  constructor(message) {
+    super({ code: "mode_mismatch", message });
+    this.name = "StrimzModeMismatchError";
+  }
+};
+function classifyError(httpStatus, body, retryAfterMs) {
+  if (httpStatus === 401) return new StrimzAuthenticationError(body, httpStatus);
+  if (httpStatus === 403) return new StrimzPermissionError(body, httpStatus);
+  if (httpStatus === 404) return new StrimzNotFoundError(body, httpStatus);
+  if (httpStatus === 409 && body.code === "idempotency_error") {
+    return new StrimzIdempotencyError(body, httpStatus);
+  }
+  if (httpStatus === 422) return new StrimzValidationError(body, httpStatus);
+  if (httpStatus === 429) return new StrimzRateLimitError(body, httpStatus, retryAfterMs);
+  return new StrimzError(body, httpStatus);
+}
+
+exports.StrimzAuthenticationError = StrimzAuthenticationError;
+exports.StrimzError = StrimzError;
+exports.StrimzIdempotencyError = StrimzIdempotencyError;
+exports.StrimzModeMismatchError = StrimzModeMismatchError;
+exports.StrimzNetworkError = StrimzNetworkError;
+exports.StrimzNotFoundError = StrimzNotFoundError;
+exports.StrimzPermissionError = StrimzPermissionError;
+exports.StrimzRateLimitError = StrimzRateLimitError;
+exports.StrimzTimeoutError = StrimzTimeoutError;
+exports.StrimzValidationError = StrimzValidationError;
+exports.classifyError = classifyError;
+//# sourceMappingURL=errors.cjs.map
+//# sourceMappingURL=errors.cjs.map

package/dist/errors.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/errors.ts"],"names":[],"mappings":";;;AAqCO,IAAM,WAAA,GAAN,cAA0B,KAAA,CAAM;AAAA,EACrB,IAAA;AAAA,EACA,UAAA;AAAA,EACA,SAAA;AAAA,EACA,KAAA;AAAA,EACA,OAAA;AAAA,EAEhB,WAAA,CAAY,MAAuB,UAAA,EAAqB;AACtD,IAAA,KAAA,CAAM,KAAK,OAAO,CAAA;AAClB,IAAA,IAAA,CAAK,IAAA,GAAO,aAAA;AACZ,IAAA,IAAA,CAAK,OAAO,IAAA,CAAK,IAAA;AACjB,IAAA,IAAA,CAAK,UAAA,GAAa,UAAA;AAClB,IAAA,IAAA,CAAK,YAAY,IAAA,CAAK,SAAA;AACtB,IAAA,IAAA,CAAK,QAAQ,IAAA,CAAK,KAAA;AAClB,IAAA,IAAA,CAAK,UAAU,IAAA,CAAK,OAAA;AAAA,EACtB;AACF;AAEO,IAAM,yBAAA,GAAN,cAAwC,WAAA,CAAY;AAAA,EACzD,WAAA,CAAY,MAAuB,UAAA,EAAqB;AACtD,IAAA,KAAA,CAAM,MAAM,UAAU,CAAA;AACtB,IAAA,IAAA,CAAK,IAAA,GAAO,2BAAA;AAAA,EACd;AACF;AAEO,IAAM,qBAAA,GAAN,cAAoC,WAAA,CAAY;AAAA,EACrD,WAAA,CAAY,MAAuB,UAAA,EAAqB;AACtD,IAAA,KAAA,CAAM,MAAM,UAAU,CAAA;AACtB,IAAA,IAAA,CAAK,IAAA,GAAO,uBAAA;AAAA,EACd;AACF;AAEO,IAAM,qBAAA,GAAN,cAAoC,WAAA,CAAY;AAAA,EACrD,WAAA,CAAY,MAAuB,UAAA,EAAqB;AACtD,IAAA,KAAA,CAAM,MAAM,UAAU,CAAA;AACtB,IAAA,IAAA,CAAK,IAAA,GAAO,uBAAA;AAAA,EACd;AACF;AAEO,IAAM,mBAAA,GAAN,cAAkC,WAAA,CAAY;AAAA,EACnD,WAAA,CAAY,MAAuB,UAAA,EAAqB;AACtD,IAAA,KAAA,CAAM,MAAM,UAAU,CAAA;AACtB,IAAA,IAAA,CAAK,IAAA,GAAO,qBAAA;AAAA,EACd;AACF;AAEO,IAAM,sBAAA,GAAN,cAAqC,WAAA,CAAY;AAAA,EACtD,WAAA,CAAY,MAAuB,UAAA,EAAqB;AACtD,IAAA,KAAA,CAAM,MAAM,UAAU,CAAA;AACtB,IAAA,IAAA,CAAK,IAAA,GAAO,wBAAA;AAAA,EACd;AACF;AAEO,IAAM,oBAAA,GAAN,cAAmC,WAAA,CAAY;AAAA,EACpC,YAAA;AAAA,EAChB,WAAA,CAAY,IAAA,EAAuB,UAAA,EAAqB,YAAA,EAAuB;AAC7E,IAAA,KAAA,CAAM,MAAM,UAAU,CAAA;AACtB,IAAA,IAAA,CAAK,IAAA,GAAO,sBAAA;AACZ,IAAA,IAAA,CAAK,YAAA,GAAe,YAAA;AAAA,EACtB;AACF;AAEO,IAAM,kBAAA,GAAN,cAAiC,WAAA,CAAY;AAAA,EACzB,KAAA;AAAA,EACzB,WAAA,CAAY,SAAiB,KAAA,EAAgB;AAC3C,IAAA,KAAA,CAAM,EAAE,IAAA,EAAM,eAAA,EAAiB,OAAA,EAAS,CAAA;AACxC,IAAA,IAAA,CAAK,IAAA,GAAO,oBAAA;AACZ,IAAA,IAAA,CAAK,KAAA,GAAQ,KAAA;AAAA,EACf;AACF;AAEO,IAAM,kBAAA,GAAN,cAAiC,WAAA,CAAY;AAAA,EAClD,YAAY,OAAA,EAAiB;AAC3B,IAAA,KAAA,CAAM,EAAE,IAAA,EAAM,SAAA,EAAW,OAAA,EAAS,CAAA;AAClC,IAAA,IAAA,CAAK,IAAA,GAAO,oBAAA;AAAA,EACd;AACF;AAEO,IAAM,uBAAA,GAAN,cAAsC,WAAA,CAAY;AAAA,EACvD,YAAY,OAAA,EAAiB;AAC3B,IAAA,KAAA,CAAM,EAAE,IAAA,EAAM,eAAA,EAAiB,OAAA,EAAS,CAAA;AACxC,IAAA,IAAA,CAAK,IAAA,GAAO,yBAAA;AAAA,EACd;AACF;AAGO,SAAS,aAAA,CACd,UAAA,EACA,IAAA,EACA,YAAA,EACa;AACb,EAAA,IAAI,eAAe,GAAA,EAAK,OAAO,IAAI,yBAAA,CAA0B,MAAM,UAAU,CAAA;AAC7E,EAAA,IAAI,eAAe,GAAA,EAAK,OAAO,IAAI,qBAAA,CAAsB,MAAM,UAAU,CAAA;AACzE,EAAA,IAAI,eAAe,GAAA,EAAK,OAAO,IAAI,mBAAA,CAAoB,MAAM,UAAU,CAAA;AACvE,EAAA,IAAI,UAAA,KAAe,GAAA,IAAO,IAAA,CAAK,IAAA,KAAS,mBAAA,EAAqB;AAC3D,IAAA,OAAO,IAAI,sBAAA,CAAuB,IAAA,EAAM,UAAU,CAAA;AAAA,EACpD;AACA,EAAA,IAAI,eAAe,GAAA,EAAK,OAAO,IAAI,qBAAA,CAAsB,MAAM,UAAU,CAAA;AACzE,EAAA,IAAI,eAAe,GAAA,EAAK,OAAO,IAAI,oBAAA,CAAqB,IAAA,EAAM,YAAY,YAAY,CAAA;AACtF,EAAA,OAAO,IAAI,WAAA,CAAY,IAAA,EAAM,UAAU,CAAA;AACzC","file":"errors.cjs","sourcesContent":["/**\n * Error hierarchy for the Strimz SDK.\n *\n * Every error thrown by the SDK extends `StrimzError`. The SDK never\n * resolves to `{ ok: false }` — it throws. This matches the Stripe / GitHub\n * SDK convention and keeps call sites linear.\n */\n\nexport type StrimzErrorCode =\n  | 'authentication_error'\n  | 'permission_denied'\n  | 'invalid_request'\n  | 'not_found'\n  | 'idempotency_error'\n  | 'rate_limited'\n  | 'mode_mismatch'\n  | 'merchant_not_found'\n  | 'merchant_inactive'\n  | 'token_not_whitelisted'\n  | 'compliance_blocked'\n  | 'session_expired'\n  | 'session_invalid_state'\n  | 'webhook_signature_invalid'\n  | 'api_error'\n  | 'network_error'\n  | 'timeout'\n  | 'parse_error'\n  | 'unknown'\n\nexport interface StrimzErrorBody {\n  code: StrimzErrorCode\n  message: string\n  param?: string\n  requestId?: string\n  details?: Record<string, unknown>\n}\n\nexport class StrimzError extends Error {\n  public readonly code: StrimzErrorCode\n  public readonly httpStatus: number | undefined\n  public readonly requestId: string | undefined\n  public readonly param: string | undefined\n  public readonly details: Record<string, unknown> | undefined\n\n  constructor(body: StrimzErrorBody, httpStatus?: number) {\n    super(body.message)\n    this.name = 'StrimzError'\n    this.code = body.code\n    this.httpStatus = httpStatus\n    this.requestId = body.requestId\n    this.param = body.param\n    this.details = body.details\n  }\n}\n\nexport class StrimzAuthenticationError extends StrimzError {\n  constructor(body: StrimzErrorBody, httpStatus?: number) {\n    super(body, httpStatus)\n    this.name = 'StrimzAuthenticationError'\n  }\n}\n\nexport class StrimzPermissionError extends StrimzError {\n  constructor(body: StrimzErrorBody, httpStatus?: number) {\n    super(body, httpStatus)\n    this.name = 'StrimzPermissionError'\n  }\n}\n\nexport class StrimzValidationError extends StrimzError {\n  constructor(body: StrimzErrorBody, httpStatus?: number) {\n    super(body, httpStatus)\n    this.name = 'StrimzValidationError'\n  }\n}\n\nexport class StrimzNotFoundError extends StrimzError {\n  constructor(body: StrimzErrorBody, httpStatus?: number) {\n    super(body, httpStatus)\n    this.name = 'StrimzNotFoundError'\n  }\n}\n\nexport class StrimzIdempotencyError extends StrimzError {\n  constructor(body: StrimzErrorBody, httpStatus?: number) {\n    super(body, httpStatus)\n    this.name = 'StrimzIdempotencyError'\n  }\n}\n\nexport class StrimzRateLimitError extends StrimzError {\n  public readonly retryAfterMs: number | undefined\n  constructor(body: StrimzErrorBody, httpStatus?: number, retryAfterMs?: number) {\n    super(body, httpStatus)\n    this.name = 'StrimzRateLimitError'\n    this.retryAfterMs = retryAfterMs\n  }\n}\n\nexport class StrimzNetworkError extends StrimzError {\n  public override readonly cause: unknown\n  constructor(message: string, cause: unknown) {\n    super({ code: 'network_error', message })\n    this.name = 'StrimzNetworkError'\n    this.cause = cause\n  }\n}\n\nexport class StrimzTimeoutError extends StrimzError {\n  constructor(message: string) {\n    super({ code: 'timeout', message })\n    this.name = 'StrimzTimeoutError'\n  }\n}\n\nexport class StrimzModeMismatchError extends StrimzError {\n  constructor(message: string) {\n    super({ code: 'mode_mismatch', message })\n    this.name = 'StrimzModeMismatchError'\n  }\n}\n\n/** Map an HTTP status + body to the right StrimzError subclass. */\nexport function classifyError(\n  httpStatus: number,\n  body: StrimzErrorBody,\n  retryAfterMs?: number,\n): StrimzError {\n  if (httpStatus === 401) return new StrimzAuthenticationError(body, httpStatus)\n  if (httpStatus === 403) return new StrimzPermissionError(body, httpStatus)\n  if (httpStatus === 404) return new StrimzNotFoundError(body, httpStatus)\n  if (httpStatus === 409 && body.code === 'idempotency_error') {\n    return new StrimzIdempotencyError(body, httpStatus)\n  }\n  if (httpStatus === 422) return new StrimzValidationError(body, httpStatus)\n  if (httpStatus === 429) return new StrimzRateLimitError(body, httpStatus, retryAfterMs)\n  return new StrimzError(body, httpStatus)\n}\n"]}

package/dist/errors.d.cts

@@ -0,0 +1,56 @@
+/**
+ * Error hierarchy for the Strimz SDK.
+ *
+ * Every error thrown by the SDK extends `StrimzError`. The SDK never
+ * resolves to `{ ok: false }` — it throws. This matches the Stripe / GitHub
+ * SDK convention and keeps call sites linear.
+ */
+type StrimzErrorCode = 'authentication_error' | 'permission_denied' | 'invalid_request' | 'not_found' | 'idempotency_error' | 'rate_limited' | 'mode_mismatch' | 'merchant_not_found' | 'merchant_inactive' | 'token_not_whitelisted' | 'compliance_blocked' | 'session_expired' | 'session_invalid_state' | 'webhook_signature_invalid' | 'api_error' | 'network_error' | 'timeout' | 'parse_error' | 'unknown';
+interface StrimzErrorBody {
+    code: StrimzErrorCode;
+    message: string;
+    param?: string;
+    requestId?: string;
+    details?: Record<string, unknown>;
+}
+declare class StrimzError extends Error {
+    readonly code: StrimzErrorCode;
+    readonly httpStatus: number | undefined;
+    readonly requestId: string | undefined;
+    readonly param: string | undefined;
+    readonly details: Record<string, unknown> | undefined;
+    constructor(body: StrimzErrorBody, httpStatus?: number);
+}
+declare class StrimzAuthenticationError extends StrimzError {
+    constructor(body: StrimzErrorBody, httpStatus?: number);
+}
+declare class StrimzPermissionError extends StrimzError {
+    constructor(body: StrimzErrorBody, httpStatus?: number);
+}
+declare class StrimzValidationError extends StrimzError {
+    constructor(body: StrimzErrorBody, httpStatus?: number);
+}
+declare class StrimzNotFoundError extends StrimzError {
+    constructor(body: StrimzErrorBody, httpStatus?: number);
+}
+declare class StrimzIdempotencyError extends StrimzError {
+    constructor(body: StrimzErrorBody, httpStatus?: number);
+}
+declare class StrimzRateLimitError extends StrimzError {
+    readonly retryAfterMs: number | undefined;
+    constructor(body: StrimzErrorBody, httpStatus?: number, retryAfterMs?: number);
+}
+declare class StrimzNetworkError extends StrimzError {
+    readonly cause: unknown;
+    constructor(message: string, cause: unknown);
+}
+declare class StrimzTimeoutError extends StrimzError {
+    constructor(message: string);
+}
+declare class StrimzModeMismatchError extends StrimzError {
+    constructor(message: string);
+}
+/** Map an HTTP status + body to the right StrimzError subclass. */
+declare function classifyError(httpStatus: number, body: StrimzErrorBody, retryAfterMs?: number): StrimzError;
+
+export { StrimzAuthenticationError, StrimzError, type StrimzErrorBody, type StrimzErrorCode, StrimzIdempotencyError, StrimzModeMismatchError, StrimzNetworkError, StrimzNotFoundError, StrimzPermissionError, StrimzRateLimitError, StrimzTimeoutError, StrimzValidationError, classifyError };

package/dist/errors.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Error hierarchy for the Strimz SDK.
+ *
+ * Every error thrown by the SDK extends `StrimzError`. The SDK never
+ * resolves to `{ ok: false }` — it throws. This matches the Stripe / GitHub
+ * SDK convention and keeps call sites linear.
+ */
+type StrimzErrorCode = 'authentication_error' | 'permission_denied' | 'invalid_request' | 'not_found' | 'idempotency_error' | 'rate_limited' | 'mode_mismatch' | 'merchant_not_found' | 'merchant_inactive' | 'token_not_whitelisted' | 'compliance_blocked' | 'session_expired' | 'session_invalid_state' | 'webhook_signature_invalid' | 'api_error' | 'network_error' | 'timeout' | 'parse_error' | 'unknown';
+interface StrimzErrorBody {
+    code: StrimzErrorCode;
+    message: string;
+    param?: string;
+    requestId?: string;
+    details?: Record<string, unknown>;
+}
+declare class StrimzError extends Error {
+    readonly code: StrimzErrorCode;
+    readonly httpStatus: number | undefined;
+    readonly requestId: string | undefined;
+    readonly param: string | undefined;
+    readonly details: Record<string, unknown> | undefined;
+    constructor(body: StrimzErrorBody, httpStatus?: number);
+}
+declare class StrimzAuthenticationError extends StrimzError {
+    constructor(body: StrimzErrorBody, httpStatus?: number);
+}
+declare class StrimzPermissionError extends StrimzError {
+    constructor(body: StrimzErrorBody, httpStatus?: number);
+}
+declare class StrimzValidationError extends StrimzError {
+    constructor(body: StrimzErrorBody, httpStatus?: number);
+}
+declare class StrimzNotFoundError extends StrimzError {
+    constructor(body: StrimzErrorBody, httpStatus?: number);
+}
+declare class StrimzIdempotencyError extends StrimzError {
+    constructor(body: StrimzErrorBody, httpStatus?: number);
+}
+declare class StrimzRateLimitError extends StrimzError {
+    readonly retryAfterMs: number | undefined;
+    constructor(body: StrimzErrorBody, httpStatus?: number, retryAfterMs?: number);
+}
+declare class StrimzNetworkError extends StrimzError {
+    readonly cause: unknown;
+    constructor(message: string, cause: unknown);
+}
+declare class StrimzTimeoutError extends StrimzError {
+    constructor(message: string);
+}
+declare class StrimzModeMismatchError extends StrimzError {
+    constructor(message: string);
+}
+/** Map an HTTP status + body to the right StrimzError subclass. */
+declare function classifyError(httpStatus: number, body: StrimzErrorBody, retryAfterMs?: number): StrimzError;
+
+export { StrimzAuthenticationError, StrimzError, type StrimzErrorBody, type StrimzErrorCode, StrimzIdempotencyError, StrimzModeMismatchError, StrimzNetworkError, StrimzNotFoundError, StrimzPermissionError, StrimzRateLimitError, StrimzTimeoutError, StrimzValidationError, classifyError };