@gol/sdk 0.1.0-next.0 → 0.3.0

package/dist/owner.d.ts

@@ -0,0 +1,209 @@
+import { type Address, type Hex, type PublicClient } from "viem";
+import { type AccountFamily, type OwnerAccountCall } from "./account-dialects.js";
+import type { PreparedGasPolicy, PreparedPolicyRevocation, PreparedMandateSafetyAction } from "./types.js";
+/** Circle USDC on Base Sepolia, the only transfer asset in this candidate. */
+export declare const BASE_SEPOLIA_USDC: "0x036CbD53842c5426634e7929541eC2318f3dCF7e";
+export declare const ENTRY_POINT_V07: "0x0000000071727De22E5E9d8BAf0edAc6f37da032";
+export interface TransferPolicyInput {
+    asset?: Address;
+    recipients: readonly Address[];
+    maxPerActionBaseUnits: bigint;
+    maxTotalBaseUnits: bigint;
+}
+/**
+ * Canonical bounded `fungible_asset.transfer@1` policy (encoding section 3):
+ * action, asset, and recipient allowlists plus per-action and lifetime caps.
+ */
+export declare function encodeTransferPolicy(input: TransferPolicyInput): Hex;
+export type SignatureFormat = "safe_threshold" | "nexus_k1" | "kernel_root" | "alchemy_entity_zero";
+export interface TypedDataPayload {
+    domain: Record<string, unknown>;
+    types: Record<string, Array<{
+        name: string;
+        type: string;
+    }>>;
+    primaryType: string;
+    message: Record<string, unknown>;
+}
+export interface WalletSigningPayload {
+    family: AccountFamily;
+    method: "eth_signTypedData_v4";
+    typedData: TypedDataPayload;
+    expectedHash: Hex;
+    digest: Hex;
+    signatureFormat: SignatureFormat;
+}
+/** EIP-712 domain separator of the version 2 core. */
+export declare function coreDomainSeparator(chainId: number, core: Address): Hex;
+export declare function combinedApprovalStructHash(mandateId: Hex, gasPolicyId: Hex): Hex;
+export declare function revocationStructHash(gasPolicyId: Hex, nonce: bigint, deadline: number): Hex;
+export declare function safetyActionStructHash(mandateId: Hex, actionCode: 1 | 2, nonce: bigint, deadline: number): Hex;
+/**
+ * Build the exact `eth_signTypedData_v4` payload whose hash the selected
+ * account's reviewed owner path checks for a core digest.
+ */
+export declare function buildWalletSigningPayload(input: {
+    family: AccountFamily;
+    account: Address;
+    core: Address;
+    structHash: Hex;
+    chainId?: number;
+}): WalletSigningPayload;
+/**
+ * Recompute a payload received from the API. Throws unless it is the exact
+ * reviewed shape for the family, account, and digest.
+ */
+export declare function verifyWalletSigningPayload(payload: WalletSigningPayload, expected: {
+    family: AccountFamily;
+    account: Address;
+    core: Address;
+    structHash: Hex;
+    chainId?: number;
+}): void;
+/** A caller-supplied owner wallet. viem wallet clients and local accounts satisfy it. */
+export interface OwnerSigner {
+    signTypedData(typedData: TypedDataPayload): Promise<Hex>;
+    signMessage?(args: {
+        message: {
+            raw: Hex;
+        };
+    }): Promise<Hex>;
+}
+/** Ask the owner wallet to sign, then pack the reviewed account-family signature. */
+export declare function signWalletSigningPayload(signer: OwnerSigner, payload: WalletSigningPayload): Promise<Hex>;
+/** Integers may arrive as decimal strings from the API. */
+type Numeric = bigint | number | string;
+export interface MandateTermsInput {
+    parentId: Hex;
+    account: Address;
+    agent: Address;
+    accountProfileId: Hex;
+    installEpoch: Numeric;
+    projectId: Hex;
+    mode: Numeric;
+    policyVersion: Numeric;
+    policyHash: Hex;
+    validFrom: Numeric;
+    expiresAt: Numeric;
+    maxDepth: Numeric;
+    maxActiveDescendants: Numeric;
+    approvalExpiresAt: Numeric;
+    salt: Hex;
+}
+export interface GasPolicyInput {
+    mandateId: Hex;
+    account: Address;
+    projectId: Hex;
+    accountProfileId: Hex;
+    installEpoch: Numeric;
+    feeAsset: Address;
+    recipient: Address;
+    attester: Address;
+    maxPerAction: Numeric;
+    maxTotal: Numeric;
+    expiresAt: Numeric;
+    chargeableOutcomes: Numeric;
+    formulaVersion: Numeric;
+    nonce: Numeric;
+}
+/** Calldata for the core. Anyone may send it; authority comes only from the owner signature. */
+export declare function encodeCreateMandateWithGas(terms: MandateTermsInput, mandatePolicy: Hex, gasPolicy: GasPolicyInput, packedOwnerSignature: Hex): Hex;
+/** Relayed revocation with an owner signature; `deadline = 0` and empty signature is the direct owner form. */
+export declare function encodeRevokeGasPolicy(gasPolicyId: Hex, deadline: number, packedOwnerSignature: Hex): Hex;
+/** Relayed owner pause or resume; a direct account call uses deadline 0 and no signature. */
+export declare function encodeSafetyAction(mandateId: Hex, actionCode: 1 | 2, deadline: number, packedOwnerSignature: Hex): Hex;
+/** Make the account call `target` through its own execution path. */
+export declare function accountExecuteCall(family: AccountFamily, account: Address, target: Address, data: Hex): OwnerAccountCall;
+export interface PackedUserOperation {
+    sender: Address;
+    nonce: bigint;
+    initCode: Hex;
+    callData: Hex;
+    accountGasLimits: Hex;
+    preVerificationGas: bigint;
+    gasFees: Hex;
+    paymasterAndData: Hex;
+    signature: Hex;
+}
+export type OwnerOperation = {
+    kind: "safe_transaction";
+    family: "safe";
+    account: Address;
+    nonce: bigint;
+    typedData: TypedDataPayload;
+    expectedHash: Hex;
+    /** Encode `execTransaction` after the owners sign `typedData`. */
+    encode(signatures: Hex): {
+        to: Address;
+        data: Hex;
+        value: 0n;
+    };
+} | {
+    kind: "user_operation";
+    family: Exclude<AccountFamily, "safe">;
+    account: Address;
+    userOperation: PackedUserOperation;
+    userOpHash: Hex;
+    /** The owner wallet signs `userOpHash` with EIP-191 `personal_sign`. */
+    message: {
+        raw: Hex;
+    };
+    /** Direct EntryPoint submission from any funded address, or give the signed operation to a bundler. */
+    encode(ownerSignature: Hex, beneficiary: Address): {
+        to: Address;
+        data: Hex;
+        value: 0n;
+        gas: bigint;
+        userOperation: PackedUserOperation;
+    };
+};
+export interface OwnerOperationOptions {
+    verificationGasLimit?: bigint;
+    callGasLimit?: bigint;
+    preVerificationGas?: bigint;
+    maxFeePerGas?: bigint;
+    maxPriorityFeePerGas?: bigint;
+}
+/** EntryPoint v0.7 user operation hash, computed locally. */
+export declare function userOperationHash(op: PackedUserOperation, chainId?: number): Hex;
+/**
+ * Prepare an owner operation that makes the account perform `call` through its
+ * reviewed owner path: a Safe transaction, or an EntryPoint v0.7 user operation.
+ */
+export declare function prepareOwnerOperation(client: Pick<PublicClient, "getChainId" | "readContract" | "estimateFeesPerGas">, family: AccountFamily, account: Address, call: OwnerAccountCall, options?: OwnerOperationOptions): Promise<OwnerOperation>;
+/** Sign a prepared owner operation with a caller-supplied owner wallet. */
+export declare function signOwnerOperation(signer: OwnerSigner, operation: OwnerOperation): Promise<Hex>;
+export interface PreparedGasPolicyExpectations {
+    account?: Address;
+    agent?: Address;
+    recipients?: readonly Address[];
+    maxPerActionBaseUnits?: bigint;
+    maxTotalBaseUnits?: bigint;
+    maxGasPerActionWei?: bigint;
+    maxGasTotalWei?: bigint;
+    core?: Address;
+}
+/**
+ * Recompute a prepared approval without trusting the API: the policy bytes
+ * against the reviewed intent, mandate and gas-policy IDs, the combined
+ * digest, and the wallet payload. Optional expectations pin what the
+ * application asked for. Throws `prepared_policy_mismatch` on any difference.
+ */
+export declare function verifyPreparedGasPolicy(prepared: PreparedGasPolicy, expected?: PreparedGasPolicyExpectations): void;
+/** Verify, ask the owner wallet to sign, and return the core call anyone may send. */
+export declare function signPreparedGasPolicy(signer: OwnerSigner, prepared: PreparedGasPolicy, expected?: PreparedGasPolicyExpectations): Promise<{
+    to: Address;
+    data: Hex;
+}>;
+/** Verify a prepared relayed revocation, sign it with the owner wallet, and return the core call. */
+export declare function signPreparedRevocation(signer: OwnerSigner, prepared: PreparedPolicyRevocation): Promise<{
+    to: Address;
+    data: Hex;
+}>;
+/** Recompute the core digest and wallet payload before signing an owner pause or resume. */
+export declare function signPreparedSafetyAction(signer: OwnerSigner, prepared: PreparedMandateSafetyAction): Promise<{
+    to: Address;
+    data: Hex;
+}>;
+export {};
+//# sourceMappingURL=owner.d.ts.map

package/dist/owner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"owner.d.ts","sourceRoot":"","sources":["../src/owner.ts"],"names":[],"mappings":"AAAA,OAAO,EAYL,KAAK,OAAO,EACZ,KAAK,GAAG,EACR,KAAK,YAAY,EAClB,MAAM,MAAM,CAAC;AAEd,OAAO,EAKL,KAAK,aAAa,EAClB,KAAK,gBAAgB,EACtB,MAAM,uBAAuB,CAAC;AAO/B,OAAO,KAAK,EACV,iBAAiB,EACjB,wBAAwB,EACxB,2BAA2B,EAC5B,MAAM,YAAY,CAAC;AAEpB,8EAA8E;AAC9E,eAAO,MAAM,iBAAiB,EAC5B,4CAAqD,CAAC;AACxD,eAAO,MAAM,eAAe,EAC1B,4CAAqD,CAAC;AA4BxD,MAAM,WAAW,mBAAmB;IAClC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,UAAU,EAAE,SAAS,OAAO,EAAE,CAAC;IAC/B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAyBD;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,mBAAmB,GAAG,GAAG,CAoBpE;AAMD,MAAM,MAAM,eAAe,GACzB,gBAAgB,GAAG,UAAU,GAAG,aAAa,GAAG,qBAAqB,CAAC;AAExE,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC,CAAC;IAC7D,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,aAAa,CAAC;IACtB,MAAM,EAAE,sBAAsB,CAAC;IAC/B,SAAS,EAAE,gBAAgB,CAAC;IAC5B,YAAY,EAAE,GAAG,CAAC;IAClB,MAAM,EAAE,GAAG,CAAC;IACZ,eAAe,EAAE,eAAe,CAAC;CAClC;AAED,sDAAsD;AACtD,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,GAAG,CAmBvE;AAED,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,GAAG,EACd,WAAW,EAAE,GAAG,GACf,GAAG,CAOL;AAED,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,GAAG,EAChB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,GACf,GAAG,CAYL;AAED,wBAAgB,sBAAsB,CACpC,SAAS,EAAE,GAAG,EACd,UAAU,EAAE,CAAC,GAAG,CAAC,EACjB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,GACf,GAAG,CAaL;AASD;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,EAAE;IAC/C,MAAM,EAAE,aAAa,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,OAAO,CAAC;IACd,UAAU,EAAE,GAAG,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GAAG,oBAAoB,CA+DvB;AAMD;;;GAGG;AACH,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,oBAAoB,EAC7B,QAAQ,EAAE;IACR,MAAM,EAAE,aAAa,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,OAAO,CAAC;IACd,UAAU,EAAE,GAAG,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GACA,IAAI,CAWN;AAED,yFAAyF;AACzF,MAAM,WAAW,WAAW;IAC1B,aAAa,CAAC,SAAS,EAAE,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACzD,WAAW,CAAC,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE;YAAE,GAAG,EAAE,GAAG,CAAA;SAAE,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CAC7D;AAED,qFAAqF;AACrF,wBAAsB,wBAAwB,CAC5C,MAAM,EAAE,WAAW,EACnB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,GAAG,CAAC,CAQd;AAYD,2DAA2D;AAC3D,KAAK,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AACxC,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,GAAG,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;IACf,gBAAgB,EAAE,GAAG,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;IACtB,SAAS,EAAE,GAAG,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;IACd,aAAa,EAAE,OAAO,CAAC;IACvB,UAAU,EAAE,GAAG,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,oBAAoB,EAAE,OAAO,CAAC;IAC9B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,IAAI,EAAE,GAAG,CAAC;CACX;AACD,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,GAAG,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,GAAG,CAAC;IACf,gBAAgB,EAAE,GAAG,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,OAAO,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,cAAc,EAAE,OAAO,CAAC;IACxB,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,gGAAgG;AAChG,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,iBAAiB,EACxB,aAAa,EAAE,GAAG,EAClB,SAAS,EAAE,cAAc,EACzB,oBAAoB,EAAE,GAAG,GACxB,GAAG,CA0CL;AAED,+GAA+G;AAC/G,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,GAAG,EAChB,QAAQ,EAAE,MAAM,EAChB,oBAAoB,EAAE,GAAG,GACxB,GAAG,CAML;AAED,6FAA6F;AAC7F,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,GAAG,EACd,UAAU,EAAE,CAAC,GAAG,CAAC,EACjB,QAAQ,EAAE,MAAM,EAChB,oBAAoB,EAAE,GAAG,GACxB,GAAG,CAML;AAMD,qEAAqE;AACrE,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,OAAO,EACf,IAAI,EAAE,GAAG,GACR,gBAAgB,CA2BlB;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,GAAG,CAAC;IACd,QAAQ,EAAE,GAAG,CAAC;IACd,gBAAgB,EAAE,GAAG,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,OAAO,EAAE,GAAG,CAAC;IACb,gBAAgB,EAAE,GAAG,CAAC;IACtB,SAAS,EAAE,GAAG,CAAC;CAChB;AAED,MAAM,MAAM,cAAc,GACtB;IACE,IAAI,EAAE,kBAAkB,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,gBAAgB,CAAC;IAC5B,YAAY,EAAE,GAAG,CAAC;IAClB,kEAAkE;IAClE,MAAM,CAAC,UAAU,EAAE,GAAG,GAAG;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,GAAG,CAAC;QAAC,KAAK,EAAE,EAAE,CAAA;KAAE,CAAC;CAChE,GACD;IACE,IAAI,EAAE,gBAAgB,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;IACvC,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,EAAE,mBAAmB,CAAC;IACnC,UAAU,EAAE,GAAG,CAAC;IAChB,wEAAwE;IACxE,OAAO,EAAE;QAAE,GAAG,EAAE,GAAG,CAAA;KAAE,CAAC;IACtB,uGAAuG;IACvG,MAAM,CACJ,cAAc,EAAE,GAAG,EACnB,WAAW,EAAE,OAAO,GACnB;QACD,EAAE,EAAE,OAAO,CAAC;QACZ,IAAI,EAAE,GAAG,CAAC;QACV,KAAK,EAAE,EAAE,CAAC;QACV,GAAG,EAAE,MAAM,CAAC;QACZ,aAAa,EAAE,mBAAmB,CAAC;KACpC,CAAC;CACH,CAAC;AAWN,MAAM,WAAW,qBAAqB;IACpC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAKD,6DAA6D;AAC7D,wBAAgB,iBAAiB,CAC/B,EAAE,EAAE,mBAAmB,EACvB,OAAO,SAAwB,GAC9B,GAAG,CA+BL;AAED;;;GAGG;AACH,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,IAAI,CACV,YAAY,EACZ,YAAY,GAAG,cAAc,GAAG,oBAAoB,CACrD,EACD,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,gBAAgB,EACtB,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,cAAc,CAAC,CA+HzB;AAED,2EAA2E;AAC3E,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,WAAW,EACnB,SAAS,EAAE,cAAc,GACxB,OAAO,CAAC,GAAG,CAAC,CAMd;AAMD,MAAM,WAAW,6BAA6B;IAC5C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,UAAU,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;IAChC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAKD;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,iBAAiB,EAC3B,QAAQ,GAAE,6BAAkC,GAC3C,IAAI,CAoIN;AAED,sFAAsF;AACtF,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,iBAAiB,EAC3B,QAAQ,GAAE,6BAAkC,GAC3C,OAAO,CAAC;IAAE,EAAE,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,GAAG,CAAA;CAAE,CAAC,CAerC;AAED,qGAAqG;AACrG,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,wBAAwB,GACjC,OAAO,CAAC;IAAE,EAAE,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,GAAG,CAAA;CAAE,CAAC,CAwBrC;AAED,4FAA4F;AAC5F,wBAAsB,wBAAwB,CAC5C,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,2BAA2B,GACpC,OAAO,CAAC;IAAE,EAAE,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,GAAG,CAAA;CAAE,CAAC,CAoCrC"}