near-safe 0.2.0 → 0.3.0

package/dist/esm/lib/safe.js

@@ -1,19 +1,20 @@
-import { ethers } from "ethers";
 import { getProxyFactoryDeployment, getSafeL2SingletonDeployment, } from "@safe-global/safe-deployments";
 import { getSafe4337ModuleDeployment, getSafeModuleSetupDeployment, } from "@safe-global/safe-modules-deployments";
-import { PLACEHOLDER_SIG, packGas, packPaymasterData } from "../util";
+import { encodeFunctionData, encodePacked, getCreate2Address, keccak256, parseAbi, toHex, zeroAddress, } from "viem";
+import { PLACEHOLDER_SIG, getClient, packGas, packPaymasterData, } from "../util";
 /**
  * All contracts used in account creation & execution
  */
 export class ContractSuite {
-    provider;
+    // Used only for stateless contract reads.
+    dummyClient;
     singleton;
     proxyFactory;
     m4337;
     moduleSetup;
     entryPoint;
-    constructor(provider, singleton, proxyFactory, m4337, moduleSetup, entryPoint) {
-        this.provider = provider;
+    constructor(client, singleton, proxyFactory, m4337, moduleSetup, entryPoint) {
+        this.dummyClient = client;
         this.singleton = singleton;
         this.proxyFactory = proxyFactory;
         this.m4337 = m4337;
@@ -22,108 +23,154 @@ export class ContractSuite {
     }
     static async init() {
         // TODO - this is a cheeky hack.
-        const provider = new ethers.JsonRpcProvider("https://rpc2.sepolia.org");
-        const safeDeployment = (fn) => getDeployment(fn, { provider, version: "1.4.1" });
+        const client = getClient(11155111);
+        const safeDeployment = (fn) => getDeployment(fn, { version: "1.4.1" });
         const m4337Deployment = async (fn) => {
-            return getDeployment(fn, { provider, version: "0.3.0" });
+            return getDeployment(fn, { version: "0.3.0" });
         };
-        // Need this first to get entryPoint address
-        const m4337 = await m4337Deployment(getSafe4337ModuleDeployment);
-        const [singleton, proxyFactory, moduleSetup, supportedEntryPoint] = await Promise.all([
+        const [singleton, proxyFactory, moduleSetup, m4337] = await Promise.all([
             safeDeployment(getSafeL2SingletonDeployment),
             safeDeployment(getProxyFactoryDeployment),
             m4337Deployment(getSafeModuleSetupDeployment),
-            m4337.SUPPORTED_ENTRYPOINT(),
+            m4337Deployment(getSafe4337ModuleDeployment),
         ]);
-        const entryPoint = new ethers.Contract(supportedEntryPoint, ["function getNonce(address, uint192 key) view returns (uint256 nonce)"], provider);
-        console.log("Initialized ERC4337 & Safe Module Contracts:", {
-            singleton: await singleton.getAddress(),
-            proxyFactory: await proxyFactory.getAddress(),
-            m4337: await m4337.getAddress(),
-            moduleSetup: await moduleSetup.getAddress(),
-            entryPoint: await entryPoint.getAddress(),
+        // console.log("Initialized ERC4337 & Safe Module Contracts:", {
+        //   singleton: await singleton.getAddress(),
+        //   proxyFactory: await proxyFactory.getAddress(),
+        //   m4337: await m4337.getAddress(),
+        //   moduleSetup: await moduleSetup.getAddress(),
+        //   entryPoint: await entryPoint.getAddress(),
+        // });
+        return new ContractSuite(client, singleton, proxyFactory, m4337, moduleSetup, 
+        // EntryPoint:
+        {
+            address: (await client.readContract({
+                address: m4337.address,
+                abi: m4337.abi,
+                functionName: "SUPPORTED_ENTRYPOINT",
+            })),
+            abi: parseAbi([
+                "function getNonce(address, uint192 key) view returns (uint256 nonce)",
+            ]),
         });
-        return new ContractSuite(provider, singleton, proxyFactory, m4337, moduleSetup, entryPoint);
     }
     async addressForSetup(setup, saltNonce) {
         // bytes32 salt = keccak256(abi.encodePacked(keccak256(initializer), saltNonce));
         // cf: https://github.com/safe-global/safe-smart-account/blob/499b17ad0191b575fcadc5cb5b8e3faeae5391ae/contracts/proxies/SafeProxyFactory.sol#L58
-        const salt = ethers.keccak256(ethers.solidityPacked(["bytes32", "uint256"], [ethers.keccak256(setup), saltNonce || 0]));
+        const salt = keccak256(encodePacked(["bytes32", "uint256"], [keccak256(setup), BigInt(saltNonce || "0")]));
         // abi.encodePacked(type(SafeProxy).creationCode, uint256(uint160(_singleton)));
         // cf: https://github.com/safe-global/safe-smart-account/blob/499b17ad0191b575fcadc5cb5b8e3faeae5391ae/contracts/proxies/SafeProxyFactory.sol#L29
-        const initCode = ethers.solidityPacked(["bytes", "uint256"], [
-            await this.proxyFactory.proxyCreationCode(),
-            await this.singleton.getAddress(),
+        const initCode = encodePacked(["bytes", "uint256"], [
+            (await this.dummyClient.readContract({
+                address: this.proxyFactory.address,
+                abi: this.proxyFactory.abi,
+                functionName: "proxyCreationCode",
+            })),
+            BigInt(this.singleton.address),
         ]);
-        return ethers.getCreate2Address(await this.proxyFactory.getAddress(), salt, ethers.keccak256(initCode));
+        return getCreate2Address({
+            from: this.proxyFactory.address,
+            salt,
+            bytecodeHash: keccak256(initCode),
+        });
     }
-    async getSetup(owners) {
-        const setup = await this.singleton.interface.encodeFunctionData("setup", [
-            owners,
-            1, // We use sign threshold of 1.
-            this.moduleSetup.target,
-            this.moduleSetup.interface.encodeFunctionData("enableModules", [
-                [this.m4337.target],
-            ]),
-            this.m4337.target,
-            ethers.ZeroAddress,
-            0,
-            ethers.ZeroAddress,
-        ]);
-        return setup;
+    getSetup(owners) {
+        return encodeFunctionData({
+            abi: this.singleton.abi,
+            functionName: "setup",
+            args: [
+                owners,
+                1, // We use sign threshold of 1.
+                this.moduleSetup.address,
+                encodeFunctionData({
+                    abi: this.moduleSetup.abi,
+                    functionName: "enableModules",
+                    args: [[this.m4337.address]],
+                }),
+                this.m4337.address,
+                zeroAddress,
+                0,
+                zeroAddress,
+            ],
+        });
+    }
+    addOwnerData(newOwner) {
+        return encodeFunctionData({
+            abi: this.singleton.abi,
+            functionName: "addOwnerWithThreshold",
+            args: [newOwner, 1],
+        });
     }
     async getOpHash(unsignedUserOp) {
         const { factory, factoryData, verificationGasLimit, callGasLimit, maxPriorityFeePerGas, maxFeePerGas, } = unsignedUserOp;
-        return this.m4337.getOperationHash({
-            ...unsignedUserOp,
-            initCode: factory
-                ? ethers.solidityPacked(["address", "bytes"], [factory, factoryData])
-                : "0x",
-            accountGasLimits: packGas(verificationGasLimit, callGasLimit),
-            gasFees: packGas(maxPriorityFeePerGas, maxFeePerGas),
-            paymasterAndData: packPaymasterData(unsignedUserOp),
-            signature: PLACEHOLDER_SIG,
+        const opHash = await this.dummyClient.readContract({
+            address: this.m4337.address,
+            abi: this.m4337.abi,
+            functionName: "getOperationHash",
+            args: [
+                {
+                    ...unsignedUserOp,
+                    initCode: factory
+                        ? encodePacked(["address", "bytes"], [factory, factoryData])
+                        : "0x",
+                    accountGasLimits: packGas(verificationGasLimit, callGasLimit),
+                    gasFees: packGas(maxPriorityFeePerGas, maxFeePerGas),
+                    paymasterAndData: packPaymasterData(unsignedUserOp),
+                    signature: PLACEHOLDER_SIG,
+                },
+            ],
         });
+        return opHash;
     }
     factoryDataForSetup(safeNotDeployed, setup, safeSaltNonce) {
         return safeNotDeployed
             ? {
-                factory: this.proxyFactory.target,
-                factoryData: this.proxyFactory.interface.encodeFunctionData("createProxyWithNonce", [this.singleton.target, setup, safeSaltNonce]),
+                factory: this.proxyFactory.address,
+                factoryData: encodeFunctionData({
+                    abi: this.proxyFactory.abi,
+                    functionName: "createProxyWithNonce",
+                    args: [this.singleton.address, setup, safeSaltNonce],
+                }),
             }
             : {};
     }
-    async buildUserOp(txData, safeAddress, feeData, setup, safeNotDeployed, safeSaltNonce) {
-        const rawUserOp = {
+    async buildUserOp(nonce, txData, safeAddress, feeData, setup, safeNotDeployed, safeSaltNonce) {
+        return {
             sender: safeAddress,
-            nonce: ethers.toBeHex(await this.entryPoint.getNonce(safeAddress, 0)),
+            nonce: toHex(nonce),
             ...this.factoryDataForSetup(safeNotDeployed, setup, safeSaltNonce),
             // <https://github.com/safe-global/safe-modules/blob/9a18245f546bf2a8ed9bdc2b04aae44f949ec7a0/modules/4337/contracts/Safe4337Module.sol#L172>
-            callData: this.m4337.interface.encodeFunctionData("executeUserOp", [
-                txData.to,
-                BigInt(txData.value),
-                txData.data,
-                txData.operation || 0,
-            ]),
+            callData: encodeFunctionData({
+                abi: this.m4337.abi,
+                functionName: "executeUserOp",
+                args: [
+                    txData.to,
+                    BigInt(txData.value),
+                    txData.data,
+                    txData.operation || 0,
+                ],
+            }),
             ...feeData,
         };
-        return rawUserOp;
+    }
+    async getNonce(address, chainId) {
+        const nonce = (await getClient(chainId).readContract({
+            abi: this.entryPoint.abi,
+            address: this.entryPoint.address,
+            functionName: "getNonce",
+            args: [address, 0],
+        }));
+        return nonce;
     }
 }
-async function getDeployment(fn, { provider, version }) {
-    const { chainId } = await provider.getNetwork();
+async function getDeployment(fn, { version }) {
     const deployment = fn({ version });
     if (!deployment) {
-        throw new Error(`Deployment not found for ${fn.name} version ${version} on chainId ${chainId}`);
-    }
-    let address = deployment.networkAddresses[`${chainId}`];
-    if (!address) {
-        // console.warn(
-        //   `Deployment asset ${fn.name} not listed on chainId ${chainId}, using likely fallback. For more info visit https://github.com/safe-global/safe-modules-deployments`
-        // );
-        // TODO: This is a cheeky hack. Real solution proposed in
-        // https://github.com/Mintbase/near-safe/issues/42
-        address = deployment.networkAddresses["11155111"];
+        throw new Error(`Deployment not found for ${fn.name} version ${version}`);
     }
-    return new ethers.Contract(address, deployment.abi, provider);
+    // TODO: maybe call parseAbi on deployment.abi here.
+    return {
+        address: deployment.networkAddresses["11155111"],
+        abi: deployment.abi,
+    };
 }

package/dist/esm/tx-manager.d.ts

@@ -1,25 +1,27 @@
+import { FinalExecutionOutcome } from "near-api-js/lib/providers";
 import { NearEthAdapter, NearEthTxData, BaseTx } from "near-ca";
+import { Address, Hash, Hex } from "viem";
 import { Erc4337Bundler } from "./lib/bundler";
-import { UserOperation, UserOperationReceipt } from "./types";
-import { MetaTransaction } from "ethers-multisend";
 import { ContractSuite } from "./lib/safe";
-import { Address, Hash, Hex } from "viem";
+import { MetaTransaction, UserOperation, UserOperationReceipt } from "./types";
 export declare class TransactionManager {
     readonly nearAdapter: NearEthAdapter;
     readonly address: Address;
-    readonly entryPointAddress: Address;
     private safePack;
     private setup;
     private pimlicoKey;
     private safeSaltNonce;
     private deployedChains;
-    constructor(nearAdapter: NearEthAdapter, safePack: ContractSuite, pimlicoKey: string, setup: string, safeAddress: Address, entryPointAddress: Address, safeSaltNonce: string);
+    constructor(nearAdapter: NearEthAdapter, safePack: ContractSuite, pimlicoKey: string, setup: string, safeAddress: Address, safeSaltNonce: string);
     static create(config: {
+        accountId: string;
+        mpcContractId: string;
         pimlicoKey: string;
-        nearAdapter: NearEthAdapter;
+        privateKey?: string;
         safeSaltNonce?: string;
     }): Promise<TransactionManager>;
     get mpcAddress(): Address;
+    get mpcContractId(): string;
     getBalance(chainId: number): Promise<bigint>;
     bundlerForChainId(chainId: number): Erc4337Bundler;
     buildTransaction(args: {
@@ -32,6 +34,10 @@ export declare class TransactionManager {
     encodeSignRequest(tx: BaseTx): Promise<NearEthTxData>;
     executeTransaction(chainId: number, userOp: UserOperation): Promise<UserOperationReceipt>;
     safeDeployed(chainId: number): Promise<boolean>;
-    addOwnerTx(address: string): MetaTransaction;
+    addOwnerTx(address: Address): MetaTransaction;
     safeSufficientlyFunded(chainId: number, transactions: MetaTransaction[], gasCost: bigint): Promise<boolean>;
+    broadcastEvm(chainId: number, outcome: FinalExecutionOutcome, unsignedUserOp: UserOperation): Promise<{
+        signature: Hex;
+        receipt: UserOperationReceipt;
+    }>;
 }

package/dist/esm/tx-manager.js

@@ -1,59 +1,65 @@
-import { Network } from "near-ca";
+import { setupAdapter, signatureFromOutcome, } from "near-ca";
+import { serializeSignature } from "viem";
 import { Erc4337Bundler } from "./lib/bundler";
-import { packSignature } from "./util";
-import { encodeMulti } from "ethers-multisend";
+import { encodeMulti } from "./lib/multisend";
 import { ContractSuite } from "./lib/safe";
+import { getClient, isContract, packSignature } from "./util";
 export class TransactionManager {
     nearAdapter;
     address;
-    entryPointAddress;
     safePack;
     setup;
     pimlicoKey;
     safeSaltNonce;
     deployedChains;
-    constructor(nearAdapter, safePack, pimlicoKey, setup, safeAddress, entryPointAddress, safeSaltNonce) {
+    constructor(nearAdapter, safePack, pimlicoKey, setup, safeAddress, safeSaltNonce) {
         this.nearAdapter = nearAdapter;
         this.safePack = safePack;
         this.pimlicoKey = pimlicoKey;
-        this.entryPointAddress = entryPointAddress;
         this.setup = setup;
         this.address = safeAddress;
         this.safeSaltNonce = safeSaltNonce;
         this.deployedChains = new Set();
     }
     static async create(config) {
-        const { nearAdapter, pimlicoKey } = config;
-        const safePack = await ContractSuite.init();
+        const { pimlicoKey } = config;
+        const [nearAdapter, safePack] = await Promise.all([
+            setupAdapter({ ...config }),
+            ContractSuite.init(),
+        ]);
         console.log(`Near Adapter: ${nearAdapter.nearAccountId()} <> ${nearAdapter.address}`);
-        const setup = await safePack.getSetup([nearAdapter.address]);
+        const setup = safePack.getSetup([nearAdapter.address]);
         const safeAddress = await safePack.addressForSetup(setup, config.safeSaltNonce);
-        const entryPointAddress = (await safePack.entryPoint.getAddress());
         console.log(`Safe Address: ${safeAddress}`);
-        return new TransactionManager(nearAdapter, safePack, pimlicoKey, setup, safeAddress, entryPointAddress, config.safeSaltNonce || "0");
+        return new TransactionManager(nearAdapter, safePack, pimlicoKey, setup, safeAddress, config.safeSaltNonce || "0");
     }
     get mpcAddress() {
         return this.nearAdapter.address;
     }
+    get mpcContractId() {
+        return this.nearAdapter.mpcContract.contract.contractId;
+    }
     async getBalance(chainId) {
-        const provider = Network.fromChainId(chainId).client;
-        return await provider.getBalance({ address: this.address });
+        return await getClient(chainId).getBalance({ address: this.address });
     }
     bundlerForChainId(chainId) {
-        return new Erc4337Bundler(this.entryPointAddress, this.pimlicoKey, chainId);
+        return new Erc4337Bundler(this.safePack.entryPoint.address, this.pimlicoKey, chainId);
     }
     async buildTransaction(args) {
         const { transactions, usePaymaster, chainId } = args;
-        const bundler = this.bundlerForChainId(chainId);
-        const gasFees = (await bundler.getGasPrice()).fast;
-        // Build Singular MetaTransaction for Multisend from transaction list.
         if (transactions.length === 0) {
             throw new Error("Empty transaction set!");
         }
+        const bundler = this.bundlerForChainId(chainId);
+        const [gasFees, nonce, safeDeployed] = await Promise.all([
+            bundler.getGasPrice(),
+            this.safePack.getNonce(this.address, chainId),
+            this.safeDeployed(chainId),
+        ]);
+        // Build Singular MetaTransaction for Multisend from transaction list.
         const tx = transactions.length > 1 ? encodeMulti(transactions) : transactions[0];
-        const safeNotDeployed = !(await this.safeDeployed(chainId));
-        const rawUserOp = await this.safePack.buildUserOp(tx, this.address, gasFees, this.setup, safeNotDeployed, this.safeSaltNonce);
-        const paymasterData = await bundler.getPaymasterData(rawUserOp, usePaymaster, safeNotDeployed);
+        const rawUserOp = await this.safePack.buildUserOp(nonce, tx, this.address, gasFees.fast, this.setup, !safeDeployed, this.safeSaltNonce);
+        const paymasterData = await bundler.getPaymasterData(rawUserOp, usePaymaster, !safeDeployed);
         const unsignedUserOp = { ...rawUserOp, ...paymasterData };
         return unsignedUserOp;
     }
@@ -98,11 +104,11 @@ export class TransactionManager {
         return userOpReceipt;
     }
     async safeDeployed(chainId) {
+        // Early exit if already known.
         if (chainId in this.deployedChains) {
             return true;
         }
-        const provider = Network.fromChainId(chainId).client;
-        const deployed = (await provider.getCode({ address: this.address })) !== "0x";
+        const deployed = await isContract(this.address, chainId);
         if (deployed) {
             this.deployedChains.add(chainId);
         }
@@ -112,7 +118,7 @@ export class TransactionManager {
         return {
             to: this.address,
             value: "0",
-            data: this.safePack.singleton.interface.encodeFunctionData("addOwnerWithThreshold", [address, 1]),
+            data: this.safePack.addOwnerData(address),
         };
     }
     async safeSufficientlyFunded(chainId, transactions, gasCost) {
@@ -123,4 +129,19 @@ export class TransactionManager {
         const safeBalance = await this.getBalance(chainId);
         return txValue + gasCost < safeBalance;
     }
+    async broadcastEvm(chainId, outcome, unsignedUserOp) {
+        const signature = packSignature(serializeSignature(signatureFromOutcome(outcome)));
+        try {
+            return {
+                signature,
+                receipt: await this.executeTransaction(chainId, {
+                    ...unsignedUserOp,
+                    signature,
+                }),
+            };
+        }
+        catch (error) {
+            throw new Error(`Failed EVM broadcast: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
 }

package/dist/esm/types.d.ts

@@ -79,4 +79,14 @@ export interface GasPrice {
     maxFeePerGas: Hex;
     maxPriorityFeePerGas: Hex;
 }
+export declare enum OperationType {
+    Call = 0,
+    DelegateCall = 1
+}
+export interface MetaTransaction {
+    readonly to: string;
+    readonly value: string;
+    readonly data: string;
+    readonly operation?: OperationType;
+}
 export {};

package/dist/esm/types.js

@@ -1 +1,5 @@
-export {};
+export var OperationType;
+(function (OperationType) {
+    OperationType[OperationType["Call"] = 0] = "Call";
+    OperationType[OperationType["DelegateCall"] = 1] = "DelegateCall";
+})(OperationType || (OperationType = {}));

package/dist/esm/util.d.ts

@@ -1,10 +1,11 @@
-import { PaymasterData } from "./types.js";
-import { MetaTransaction } from "ethers-multisend";
-import { Hex } from "viem";
+import { Address, Hex, PublicClient } from "viem";
+import { PaymasterData, MetaTransaction } from "./types";
 export declare const PLACEHOLDER_SIG: `0x${string}`;
 type IntLike = Hex | bigint | string | number;
 export declare const packGas: (hi: IntLike, lo: IntLike) => string;
 export declare function packSignature(signature: `0x${string}`, validFrom?: number, validTo?: number): Hex;
 export declare function packPaymasterData(data: PaymasterData): Hex;
 export declare function containsValue(transactions: MetaTransaction[]): boolean;
+export declare function isContract(address: Address, chainId: number): Promise<boolean>;
+export declare function getClient(chainId: number): PublicClient;
 export {};

package/dist/esm/util.js

@@ -1,4 +1,5 @@
-import { concatHex, encodePacked, toHex } from "viem";
+import { Network } from "near-ca";
+import { concatHex, encodePacked, toHex, } from "viem";
 export const PLACEHOLDER_SIG = encodePacked(["uint48", "uint48"], [0, 0]);
 export const packGas = (hi, lo) => encodePacked(["uint128", "uint128"], [BigInt(hi), BigInt(lo)]);
 export function packSignature(signature, validFrom = 0, validTo = 0) {
@@ -17,3 +18,9 @@ export function packPaymasterData(data) {
 export function containsValue(transactions) {
     return transactions.some((tx) => tx.value !== "0");
 }
+export async function isContract(address, chainId) {
+    return (await getClient(chainId).getCode({ address })) !== undefined;
+}
+export function getClient(chainId) {
+    return Network.fromChainId(chainId).client;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "near-safe",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "license": "MIT",
   "description": "An SDK for controlling Ethereum Smart Accounts via ERC4337 from a Near Account.",
   "author": "bh2smith",
@@ -36,18 +36,15 @@
     "example": "tsx examples/send-tx.ts",
     "lint": "eslint . --ignore-pattern dist/",
     "test": "jest",
-    "fmt": "prettier --write '{src,examples,tests}/**/*.{js,jsx,ts,tsx}'",
+    "fmt": "prettier --write '{src,examples,tests}/**/*.{js,jsx,ts,tsx}' && yarn lint --fix",
     "all": "yarn fmt && yarn lint && yarn build"
   },
   "dependencies": {
     "@safe-global/safe-deployments": "^1.37.0",
     "@safe-global/safe-modules-deployments": "^2.2.0",
-    "ethers": "^6.13.1",
-    "ethers-multisend": "^3.1.0",
     "near-api-js": "^5.0.0",
     "near-ca": "^0.5.2",
-    "viem": "^2.16.5",
-    "yargs": "^17.7.2"
+    "viem": "^2.16.5"
   },
   "devDependencies": {
     "@types/jest": "^29.5.12",
@@ -57,11 +54,17 @@
     "@typescript-eslint/parser": "^8.1.0",
     "dotenv": "^16.4.5",
     "eslint": "^9.6.0",
+    "eslint-plugin-import": "^2.30.0",
+    "ethers": "^6.13.1",
     "jest": "^29.7.0",
     "prettier": "^3.3.2",
     "ts-jest": "^29.1.5",
     "tsx": "^4.16.0",
     "typescript": "^5.5.2",
     "yargs": "^17.7.2"
+  },
+  "resolutions": {
+    "glob": "^9.0.0",
+    "base-x": "^3.0.0"
   }
 }