@pay-skill/sdk 0.1.7 → 0.2.0

package/src/eip3009.ts

@@ -1,79 +1,79 @@
-/**
- * EIP-3009 TransferWithAuthorization signing for x402 direct settlement.
- *
- * Unlike EIP-2612 permits (which need a nonce from the USDC contract),
- * EIP-3009 uses a random nonce chosen by the signer. Fully local — no
- * server round-trip needed.
- *
- * Domain: { name: "USD Coin", version: "2", chainId, verifyingContract: usdcAddress }
- * Type: TransferWithAuthorization(address from, address to, uint256 value,
- *       uint256 validAfter, uint256 validBefore, bytes32 nonce)
- */
-
-import { type Hex, type Address } from "viem";
-import { privateKeyToAccount } from "viem/accounts";
-import { randomBytes } from "node:crypto";
-
-export interface TransferAuthorization {
-  from: string;
-  to: string;
-  amount: number;
-  nonce: string;
-  v: number;
-  r: string;
-  s: string;
-}
-
-const TRANSFER_AUTH_TYPES = {
-  TransferWithAuthorization: [
-    { name: "from", type: "address" },
-    { name: "to", type: "address" },
-    { name: "value", type: "uint256" },
-    { name: "validAfter", type: "uint256" },
-    { name: "validBefore", type: "uint256" },
-    { name: "nonce", type: "bytes32" },
-  ],
-} as const;
-
-export async function signTransferAuthorization(
-  privateKey: Hex,
-  to: Address,
-  amount: number,
-  chainId: number,
-  usdcAddress: Address,
-): Promise<TransferAuthorization> {
-  const account = privateKeyToAccount(privateKey);
-  const nonce = ("0x" + randomBytes(32).toString("hex")) as Hex;
-
-  const signature = await account.signTypedData({
-    domain: {
-      name: "USD Coin",
-      version: "2",
-      chainId,
-      verifyingContract: usdcAddress,
-    },
-    types: TRANSFER_AUTH_TYPES,
-    primaryType: "TransferWithAuthorization",
-    message: {
-      from: account.address,
-      to,
-      value: BigInt(amount),
-      validAfter: 0n,
-      validBefore: 0n,
-      nonce,
-    },
-  });
-
-  const sigHex = signature.slice(2);
-  const r = `0x${sigHex.slice(0, 64)}`;
-  const s = `0x${sigHex.slice(64, 128)}`;
-  const v = parseInt(sigHex.slice(128, 130), 16);
-
-  return { from: account.address, to, amount, nonce, v, r, s };
-}
-
-export function combinedSignature(auth: TransferAuthorization): string {
-  const r = auth.r.startsWith("0x") ? auth.r.slice(2) : auth.r;
-  const s = auth.s.startsWith("0x") ? auth.s.slice(2) : auth.s;
-  return `0x${r}${s}${auth.v.toString(16).padStart(2, "0")}`;
-}
+/**
+ * EIP-3009 TransferWithAuthorization signing for x402 direct settlement.
+ *
+ * Unlike EIP-2612 permits (which need a nonce from the USDC contract),
+ * EIP-3009 uses a random nonce chosen by the signer. Fully local — no
+ * server round-trip needed.
+ *
+ * Domain: { name: "USD Coin", version: "2", chainId, verifyingContract: usdcAddress }
+ * Type: TransferWithAuthorization(address from, address to, uint256 value,
+ *       uint256 validAfter, uint256 validBefore, bytes32 nonce)
+ */
+
+import { type Hex, type Address } from "viem";
+import { privateKeyToAccount } from "viem/accounts";
+import { randomBytes } from "node:crypto";
+
+export interface TransferAuthorization {
+  from: string;
+  to: string;
+  amount: number;
+  nonce: string;
+  v: number;
+  r: string;
+  s: string;
+}
+
+const TRANSFER_AUTH_TYPES = {
+  TransferWithAuthorization: [
+    { name: "from", type: "address" },
+    { name: "to", type: "address" },
+    { name: "value", type: "uint256" },
+    { name: "validAfter", type: "uint256" },
+    { name: "validBefore", type: "uint256" },
+    { name: "nonce", type: "bytes32" },
+  ],
+} as const;
+
+export async function signTransferAuthorization(
+  privateKey: Hex,
+  to: Address,
+  amount: number,
+  chainId: number,
+  usdcAddress: Address,
+): Promise<TransferAuthorization> {
+  const account = privateKeyToAccount(privateKey);
+  const nonce = ("0x" + randomBytes(32).toString("hex")) as Hex;
+
+  const signature = await account.signTypedData({
+    domain: {
+      name: "USD Coin",
+      version: "2",
+      chainId,
+      verifyingContract: usdcAddress,
+    },
+    types: TRANSFER_AUTH_TYPES,
+    primaryType: "TransferWithAuthorization",
+    message: {
+      from: account.address,
+      to,
+      value: BigInt(amount),
+      validAfter: 0n,
+      validBefore: 0n,
+      nonce,
+    },
+  });
+
+  const sigHex = signature.slice(2);
+  const r = `0x${sigHex.slice(0, 64)}`;
+  const s = `0x${sigHex.slice(64, 128)}`;
+  const v = parseInt(sigHex.slice(128, 130), 16);
+
+  return { from: account.address, to, amount, nonce, v, r, s };
+}
+
+export function combinedSignature(auth: TransferAuthorization): string {
+  const r = auth.r.startsWith("0x") ? auth.r.slice(2) : auth.r;
+  const s = auth.s.startsWith("0x") ? auth.s.slice(2) : auth.s;
+  return `0x${r}${s}${auth.v.toString(16).padStart(2, "0")}`;
+}

package/src/errors.ts

@@ -1,48 +1,55 @@
-/** Base error for all pay SDK errors. */
-export class PayError extends Error {
-  readonly code: string;
-
-  constructor(message: string, code = "pay_error") {
-    super(message);
-    this.name = "PayError";
-    this.code = code;
-  }
-}
-
-/** Input validation failed. */
-export class PayValidationError extends PayError {
-  readonly field?: string;
-
-  constructor(message: string, field?: string) {
-    super(message, "validation_error");
-    this.name = "PayValidationError";
-    this.field = field;
-  }
-}
-
-/** Network or server communication failed. */
-export class PayNetworkError extends PayError {
-  constructor(message: string) {
-    super(message, "network_error");
-    this.name = "PayNetworkError";
-  }
-}
-
-/** Server returned an error response. */
-export class PayServerError extends PayError {
-  readonly statusCode: number;
-
-  constructor(message: string, statusCode: number) {
-    super(message, "server_error");
-    this.name = "PayServerError";
-    this.statusCode = statusCode;
-  }
-}
-
-/** Insufficient USDC balance. */
-export class PayInsufficientFundsError extends PayError {
-  constructor(message = "Insufficient USDC balance") {
-    super(message, "insufficient_funds");
-    this.name = "PayInsufficientFundsError";
-  }
-}
+/** Base error for all pay SDK errors. */
+export class PayError extends Error {
+  readonly code: string;
+
+  constructor(message: string, code = "pay_error") {
+    super(message);
+    this.name = "PayError";
+    this.code = code;
+  }
+}
+
+/** Input validation failed. */
+export class PayValidationError extends PayError {
+  readonly field?: string;
+
+  constructor(message: string, field?: string) {
+    super(message, "validation_error");
+    this.name = "PayValidationError";
+    this.field = field;
+  }
+}
+
+/** Network or server communication failed. */
+export class PayNetworkError extends PayError {
+  constructor(message: string) {
+    super(message, "network_error");
+    this.name = "PayNetworkError";
+  }
+}
+
+/** Server returned an error response. */
+export class PayServerError extends PayError {
+  readonly statusCode: number;
+
+  constructor(message: string, statusCode: number) {
+    super(message, "server_error");
+    this.name = "PayServerError";
+    this.statusCode = statusCode;
+  }
+}
+
+/** Insufficient USDC balance. Includes fund link hint for agents. */
+export class PayInsufficientFundsError extends PayError {
+  readonly balance: number;
+  readonly required: number;
+
+  constructor(message: string, balance = 0, required = 0) {
+    const hint =
+      '\nUse wallet.createFundLink({ message: "Need funds" }) to request funding.';
+    super(message + hint, "insufficient_funds");
+    this.name = "PayInsufficientFundsError";
+    this.balance = balance;
+    this.required = required;
+  }
+}

package/src/index.ts

@@ -1,51 +1,24 @@
-export { PayClient, DEFAULT_API_URL } from "./client.js";
-export type { PayClientOptions } from "./client.js";
-
-export {
-  PayError,
-  PayValidationError,
-  PayNetworkError,
-  PayServerError,
-  PayInsufficientFundsError,
-} from "./errors.js";
-
-export type {
-  DirectPaymentResult,
-  DiscoverOptions,
-  DiscoverService,
-  Tab,
-  TabStatus,
-  StatusResponse,
-  WebhookRegistration,
-} from "./models.js";
-
-export type { Signer } from "./signer.js";
-export {
-  CliSigner,
-  RawKeySigner,
-  CallbackSigner,
-  createSigner,
-} from "./signer.js";
-
-export { OwsSigner } from "./ows-signer.js";
-export type { OwsSignerOptions } from "./ows-signer.js";
-
-export { Wallet, PrivateKeySigner } from "./wallet.js";
-export type {
-  WalletOptions,
-  FundLinkOptions,
-  PermitResult,
-} from "./wallet.js";
-
-export {
-  buildAuthHeaders,
-  buildAuthHeadersWithSigner,
-  computeEip712Hash,
-} from "./auth.js";
-export type { AuthConfig, AuthHeaders } from "./auth.js";
-
-export {
-  signTransferAuthorization,
-  combinedSignature,
-} from "./eip3009.js";
-export type { TransferAuthorization } from "./eip3009.js";
+export {
+  PayError,
+  PayValidationError,
+  PayNetworkError,
+  PayServerError,
+  PayInsufficientFundsError,
+} from "./errors.js";
+
+export { Wallet, discover } from "./wallet.js";
+export type {
+  Amount,
+  WalletOptions,
+  OwsWalletOptions,
+  SendResult,
+  Tab,
+  ChargeResult,
+  Balance,
+  Status,
+  DiscoverService,
+  DiscoverOptions,
+  FundLinkOptions,
+  WebhookRegistration,
+  MintResult,
+} from "./wallet.js";

package/src/keychain.ts

@@ -0,0 +1,18 @@
+/**
+ * OS keychain reader — reads the private key stored by `pay` CLI.
+ * Service: "pay", account: "default".
+ *
+ * keytar is an optional dependency. If not installed, returns null.
+ */
+
+export async function readFromKeychain(): Promise<string | null> {
+  try {
+    const moduleName = "keytar";
+    const keytar = (await import(moduleName)) as {
+      default: { getPassword(service: string, account: string): Promise<string | null> };
+    };
+    return await keytar.default.getPassword("pay", "default");
+  } catch {
+    return null;
+  }
+}