near-safe 0.1.0 → 0.1.1

package/README.md

@@ -33,7 +33,7 @@ NEAR_ACCOUNT_ID=
 NEAR_ACCOUNT_PRIVATE_KEY=
 
 # Head to https://www.pimlico.io/ for an API key
-ERC4337_BUNDLER_URL=
+PIMLICO_KEY=
 ```
 
 

package/dist/cjs/lib/safe.js

@@ -19,7 +19,15 @@ class ContractSuite {
     }
     static async init(provider) {
         const safeDeployment = (fn) => getDeployment(fn, { provider, version: "1.4.1" });
-        const m4337Deployment = (fn) => getDeployment(fn, { provider, version: "0.3.0" });
+        const m4337Deployment = async (fn) => {
+            try {
+                return await getDeployment(fn, { provider, version: "0.3.0" });
+            }
+            catch (error) {
+                console.warn(error.message, "using v0.2.0");
+                return getDeployment(fn, { provider, version: "0.2.0" });
+            }
+        };
         // Need this first to get entryPoint address
         const m4337 = await m4337Deployment(safe_modules_deployments_1.getSafe4337ModuleDeployment);
         const [singleton, proxyFactory, moduleSetup, supportedEntryPoint] = await Promise.all([
@@ -29,6 +37,13 @@ class ContractSuite {
             m4337.SUPPORTED_ENTRYPOINT(),
         ]);
         const entryPoint = new ethers_1.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(),
+        });
         return new ContractSuite(provider, singleton, proxyFactory, m4337, moduleSetup, entryPoint);
     }
     async addressForSetup(setup, saltNonce) {
@@ -102,7 +117,7 @@ async function getDeployment(fn, { provider, version }) {
     const { chainId } = await provider.getNetwork();
     const deployment = fn({ version });
     if (!deployment || !deployment.networkAddresses[`${chainId}`]) {
-        throw new Error(`Deployment not found for version ${version} and chainId ${chainId}`);
+        throw new Error(`Deployment not found for ${fn.name} version ${version} on chainId ${chainId}`);
     }
     return new ethers_1.ethers.Contract(deployment.networkAddresses[`${chainId}`], deployment.abi, provider);
 }

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

@@ -10,18 +10,24 @@ export declare class TransactionManager {
     private safePack;
     private bundler;
     private setup;
-    readonly safeAddress: string;
+    readonly address: string;
+    readonly chainId: number;
     private safeSaltNonce;
     private _safeNotDeployed;
-    constructor(provider: ethers.JsonRpcProvider, nearAdapter: NearEthAdapter, safePack: ContractSuite, bundler: Erc4337Bundler, setup: string, safeAddress: string, safeSaltNonce: string, safeNotDeployed: boolean);
+    constructor(provider: ethers.JsonRpcProvider, nearAdapter: NearEthAdapter, safePack: ContractSuite, bundler: Erc4337Bundler, setup: string, chainId: number, safeAddress: string, safeSaltNonce: string, safeNotDeployed: boolean);
     static create(config: {
         ethRpc: string;
-        erc4337BundlerUrl: string;
+        pimlicoKey: string;
         nearAdapter: NearEthAdapter;
         safeSaltNonce?: string;
     }): Promise<TransactionManager>;
+    static fromChainId(args: {
+        chainId: number;
+        nearAdapter: NearEthAdapter;
+        pimlicoKey: string;
+    }): Promise<TransactionManager>;
     get safeNotDeployed(): boolean;
-    get nearEOA(): `0x${string}`;
+    get mpcAddress(): `0x${string}`;
     getSafeBalance(): Promise<bigint>;
     buildTransaction(args: {
         transactions: MetaTransaction[];

package/dist/cjs/tx-manager.js

@@ -2,42 +2,53 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TransactionManager = void 0;
 const ethers_1 = require("ethers");
+const near_ca_1 = require("near-ca");
 const bundler_1 = require("./lib/bundler");
 const util_1 = require("./util");
 const near_1 = require("./lib/near");
 const ethers_multisend_1 = require("ethers-multisend");
 const safe_1 = require("./lib/safe");
 class TransactionManager {
-    constructor(provider, nearAdapter, safePack, bundler, setup, safeAddress, safeSaltNonce, safeNotDeployed) {
+    constructor(provider, nearAdapter, safePack, bundler, setup, chainId, safeAddress, safeSaltNonce, safeNotDeployed) {
         this.provider = provider;
         this.nearAdapter = nearAdapter;
         this.safePack = safePack;
         this.bundler = bundler;
         this.setup = setup;
-        this.safeAddress = safeAddress;
+        this.chainId = chainId;
+        this.address = safeAddress;
         this.safeSaltNonce = safeSaltNonce;
         this._safeNotDeployed = safeNotDeployed;
     }
     static async create(config) {
-        const adapter = config.nearAdapter;
+        const { nearAdapter, pimlicoKey } = config;
         const provider = new ethers_1.ethers.JsonRpcProvider(config.ethRpc);
+        const chainId = (await provider.getNetwork()).chainId;
         const safePack = await safe_1.ContractSuite.init(provider);
-        console.log(`Near Adapter: ${adapter.nearAccountId()} <> ${adapter.address}`);
-        const bundler = new bundler_1.Erc4337Bundler(config.erc4337BundlerUrl, await safePack.entryPoint.getAddress());
-        const setup = await safePack.getSetup([adapter.address]);
+        console.log(`Near Adapter: ${nearAdapter.nearAccountId()} <> ${nearAdapter.address}`);
+        const bundler = new bundler_1.Erc4337Bundler(`https://api.pimlico.io/v2/${chainId}/rpc?apikey=${pimlicoKey}`, await safePack.entryPoint.getAddress());
+        const setup = await safePack.getSetup([nearAdapter.address]);
         const safeAddress = await safePack.addressForSetup(setup, config.safeSaltNonce);
         const safeNotDeployed = (await provider.getCode(safeAddress)) === "0x";
         console.log(`Safe Address: ${safeAddress} - deployed? ${!safeNotDeployed}`);
-        return new TransactionManager(provider, adapter, safePack, bundler, setup, safeAddress, config.safeSaltNonce || "0", safeNotDeployed);
+        return new TransactionManager(provider, nearAdapter, safePack, bundler, setup, parseInt(chainId.toString()), safeAddress, config.safeSaltNonce || "0", safeNotDeployed);
+    }
+    static async fromChainId(args) {
+        const { pimlicoKey, nearAdapter } = args;
+        return TransactionManager.create({
+            ethRpc: near_ca_1.Network.fromChainId(args.chainId).rpcUrl,
+            pimlicoKey,
+            nearAdapter,
+        });
     }
     get safeNotDeployed() {
         return this._safeNotDeployed;
     }
-    get nearEOA() {
+    get mpcAddress() {
         return this.nearAdapter.address;
     }
     async getSafeBalance() {
-        return await this.provider.getBalance(this.safeAddress);
+        return await this.provider.getBalance(this.address);
     }
     async buildTransaction(args) {
         const { transactions, usePaymaster } = args;
@@ -48,7 +59,7 @@ class TransactionManager {
             throw new Error("Empty transaction set!");
         }
         const tx = transactions.length > 1 ? (0, ethers_multisend_1.encodeMulti)(transactions) : transactions[0];
-        const rawUserOp = await this.safePack.buildUserOp(tx, this.safeAddress, gasFees, this.setup, this.safeNotDeployed, this.safeSaltNonce);
+        const rawUserOp = await this.safePack.buildUserOp(tx, this.address, gasFees, this.setup, this.safeNotDeployed, this.safeSaltNonce);
         const paymasterData = await this.bundler.getPaymasterData(rawUserOp, usePaymaster, this.safeNotDeployed);
         const unsignedUserOp = { ...rawUserOp, ...paymasterData };
         return unsignedUserOp;
@@ -62,6 +73,9 @@ class TransactionManager {
     }
     async encodeSignRequest(tx) {
         // TODO - This is sloppy and ignores ChainId!
+        if (tx.chainId !== this.chainId) {
+            throw new Error(`Transaciton request for invalid ChainId ${tx.chainId} != ${this.chainId}`);
+        }
         const unsignedUserOp = await this.buildTransaction({
             transactions: [
                 {
@@ -90,12 +104,12 @@ class TransactionManager {
         console.log("userOp Receipt", userOpReceipt);
         // Update safeNotDeployed after the first transaction
         this._safeNotDeployed =
-            (await this.provider.getCode(this.safeAddress)) === "0x";
+            (await this.provider.getCode(this.address)) === "0x";
         return userOpReceipt;
     }
     addOwnerTx(address) {
         return {
-            to: this.safeAddress,
+            to: this.address,
             value: "0",
             data: this.safePack.singleton.interface.encodeFunctionData("addOwnerWithThreshold", [address, 1]),
         };

package/dist/esm/lib/safe.js

@@ -22,7 +22,15 @@ export class ContractSuite {
     }
     static async init(provider) {
         const safeDeployment = (fn) => getDeployment(fn, { provider, version: "1.4.1" });
-        const m4337Deployment = (fn) => getDeployment(fn, { provider, version: "0.3.0" });
+        const m4337Deployment = async (fn) => {
+            try {
+                return await getDeployment(fn, { provider, version: "0.3.0" });
+            }
+            catch (error) {
+                console.warn(error.message, "using v0.2.0");
+                return getDeployment(fn, { provider, version: "0.2.0" });
+            }
+        };
         // Need this first to get entryPoint address
         const m4337 = await m4337Deployment(getSafe4337ModuleDeployment);
         const [singleton, proxyFactory, moduleSetup, supportedEntryPoint] = await Promise.all([
@@ -32,6 +40,13 @@ export class ContractSuite {
             m4337.SUPPORTED_ENTRYPOINT(),
         ]);
         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(),
+        });
         return new ContractSuite(provider, singleton, proxyFactory, m4337, moduleSetup, entryPoint);
     }
     async addressForSetup(setup, saltNonce) {
@@ -104,7 +119,7 @@ async function getDeployment(fn, { provider, version }) {
     const { chainId } = await provider.getNetwork();
     const deployment = fn({ version });
     if (!deployment || !deployment.networkAddresses[`${chainId}`]) {
-        throw new Error(`Deployment not found for version ${version} and chainId ${chainId}`);
+        throw new Error(`Deployment not found for ${fn.name} version ${version} on chainId ${chainId}`);
     }
     return new ethers.Contract(deployment.networkAddresses[`${chainId}`], deployment.abi, provider);
 }

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

@@ -10,18 +10,24 @@ export declare class TransactionManager {
     private safePack;
     private bundler;
     private setup;
-    readonly safeAddress: string;
+    readonly address: string;
+    readonly chainId: number;
     private safeSaltNonce;
     private _safeNotDeployed;
-    constructor(provider: ethers.JsonRpcProvider, nearAdapter: NearEthAdapter, safePack: ContractSuite, bundler: Erc4337Bundler, setup: string, safeAddress: string, safeSaltNonce: string, safeNotDeployed: boolean);
+    constructor(provider: ethers.JsonRpcProvider, nearAdapter: NearEthAdapter, safePack: ContractSuite, bundler: Erc4337Bundler, setup: string, chainId: number, safeAddress: string, safeSaltNonce: string, safeNotDeployed: boolean);
     static create(config: {
         ethRpc: string;
-        erc4337BundlerUrl: string;
+        pimlicoKey: string;
         nearAdapter: NearEthAdapter;
         safeSaltNonce?: string;
     }): Promise<TransactionManager>;
+    static fromChainId(args: {
+        chainId: number;
+        nearAdapter: NearEthAdapter;
+        pimlicoKey: string;
+    }): Promise<TransactionManager>;
     get safeNotDeployed(): boolean;
-    get nearEOA(): `0x${string}`;
+    get mpcAddress(): `0x${string}`;
     getSafeBalance(): Promise<bigint>;
     buildTransaction(args: {
         transactions: MetaTransaction[];

package/dist/esm/tx-manager.js

@@ -1,4 +1,5 @@
 import { ethers } from "ethers";
+import { Network } from "near-ca";
 import { Erc4337Bundler } from "./lib/bundler";
 import { packSignature } from "./util";
 import { getNearSignature } from "./lib/near";
@@ -10,39 +11,50 @@ export class TransactionManager {
     safePack;
     bundler;
     setup;
-    safeAddress;
+    address;
+    chainId;
     safeSaltNonce;
     _safeNotDeployed;
-    constructor(provider, nearAdapter, safePack, bundler, setup, safeAddress, safeSaltNonce, safeNotDeployed) {
+    constructor(provider, nearAdapter, safePack, bundler, setup, chainId, safeAddress, safeSaltNonce, safeNotDeployed) {
         this.provider = provider;
         this.nearAdapter = nearAdapter;
         this.safePack = safePack;
         this.bundler = bundler;
         this.setup = setup;
-        this.safeAddress = safeAddress;
+        this.chainId = chainId;
+        this.address = safeAddress;
         this.safeSaltNonce = safeSaltNonce;
         this._safeNotDeployed = safeNotDeployed;
     }
     static async create(config) {
-        const adapter = config.nearAdapter;
+        const { nearAdapter, pimlicoKey } = config;
         const provider = new ethers.JsonRpcProvider(config.ethRpc);
+        const chainId = (await provider.getNetwork()).chainId;
         const safePack = await ContractSuite.init(provider);
-        console.log(`Near Adapter: ${adapter.nearAccountId()} <> ${adapter.address}`);
-        const bundler = new Erc4337Bundler(config.erc4337BundlerUrl, await safePack.entryPoint.getAddress());
-        const setup = await safePack.getSetup([adapter.address]);
+        console.log(`Near Adapter: ${nearAdapter.nearAccountId()} <> ${nearAdapter.address}`);
+        const bundler = new Erc4337Bundler(`https://api.pimlico.io/v2/${chainId}/rpc?apikey=${pimlicoKey}`, await safePack.entryPoint.getAddress());
+        const setup = await safePack.getSetup([nearAdapter.address]);
         const safeAddress = await safePack.addressForSetup(setup, config.safeSaltNonce);
         const safeNotDeployed = (await provider.getCode(safeAddress)) === "0x";
         console.log(`Safe Address: ${safeAddress} - deployed? ${!safeNotDeployed}`);
-        return new TransactionManager(provider, adapter, safePack, bundler, setup, safeAddress, config.safeSaltNonce || "0", safeNotDeployed);
+        return new TransactionManager(provider, nearAdapter, safePack, bundler, setup, parseInt(chainId.toString()), safeAddress, config.safeSaltNonce || "0", safeNotDeployed);
+    }
+    static async fromChainId(args) {
+        const { pimlicoKey, nearAdapter } = args;
+        return TransactionManager.create({
+            ethRpc: Network.fromChainId(args.chainId).rpcUrl,
+            pimlicoKey,
+            nearAdapter,
+        });
     }
     get safeNotDeployed() {
         return this._safeNotDeployed;
     }
-    get nearEOA() {
+    get mpcAddress() {
         return this.nearAdapter.address;
     }
     async getSafeBalance() {
-        return await this.provider.getBalance(this.safeAddress);
+        return await this.provider.getBalance(this.address);
     }
     async buildTransaction(args) {
         const { transactions, usePaymaster } = args;
@@ -53,7 +65,7 @@ export class TransactionManager {
             throw new Error("Empty transaction set!");
         }
         const tx = transactions.length > 1 ? encodeMulti(transactions) : transactions[0];
-        const rawUserOp = await this.safePack.buildUserOp(tx, this.safeAddress, gasFees, this.setup, this.safeNotDeployed, this.safeSaltNonce);
+        const rawUserOp = await this.safePack.buildUserOp(tx, this.address, gasFees, this.setup, this.safeNotDeployed, this.safeSaltNonce);
         const paymasterData = await this.bundler.getPaymasterData(rawUserOp, usePaymaster, this.safeNotDeployed);
         const unsignedUserOp = { ...rawUserOp, ...paymasterData };
         return unsignedUserOp;
@@ -67,6 +79,9 @@ export class TransactionManager {
     }
     async encodeSignRequest(tx) {
         // TODO - This is sloppy and ignores ChainId!
+        if (tx.chainId !== this.chainId) {
+            throw new Error(`Transaciton request for invalid ChainId ${tx.chainId} != ${this.chainId}`);
+        }
         const unsignedUserOp = await this.buildTransaction({
             transactions: [
                 {
@@ -95,12 +110,12 @@ export class TransactionManager {
         console.log("userOp Receipt", userOpReceipt);
         // Update safeNotDeployed after the first transaction
         this._safeNotDeployed =
-            (await this.provider.getCode(this.safeAddress)) === "0x";
+            (await this.provider.getCode(this.address)) === "0x";
         return userOpReceipt;
     }
     addOwnerTx(address) {
         return {
-            to: this.safeAddress,
+            to: this.address,
             value: "0",
             data: this.safePack.singleton.interface.encodeFunctionData("addOwnerWithThreshold", [address, 1]),
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "near-safe",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "license": "MIT",
   "description": "An SDK for controlling Ethereum Smart Accounts via ERC4337 from a Near Account.",
   "author": "bh2smith",