near-safe 0.2.0 → 0.2.1

package/README.md

@@ -27,15 +27,16 @@ yarn install
 Create a `.env` (or use our `.env.sample`) file in the root of the project and add the following environment variables:
 
 ```sh
-ETH_RPC=https://rpc2.sepolia.org
-
 NEAR_ACCOUNT_ID=
-NEAR_ACCOUNT_PRIVATE_KEY=
-
 # Head to https://www.pimlico.io/ for an API key
 PIMLICO_KEY=
 ```
 
+To use the CLI tool provided here in `examples/*` you will also need to provide a privateKey for your Near account.
+
+```sh
+NEAR_ACCOUNT_PRIVATE_KEY=
+```
 
 ## Usage
 

package/dist/cjs/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./tx-manager";
 export * from "./types";
 export * from "./util";
+export { Network, BaseTx, SignRequestData, populateTx } from "near-ca";

package/dist/cjs/index.js

@@ -14,6 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.populateTx = exports.Network = void 0;
 __exportStar(require("./tx-manager"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./util"), exports);
+var near_ca_1 = require("near-ca");
+Object.defineProperty(exports, "Network", { enumerable: true, get: function () { return near_ca_1.Network; } });
+Object.defineProperty(exports, "populateTx", { enumerable: true, get: function () { return near_ca_1.populateTx; } });

package/dist/cjs/lib/bundler.d.ts

@@ -1,5 +1,5 @@
 import { ethers } from "ethers";
-import { GasPrices, PaymasterData, UnsignedUserOperation, UserOperation, UserOperationReceipt } from "../types.js";
+import { GasPrices, PaymasterData, UnsignedUserOperation, UserOperation, UserOperationReceipt } from "../types";
 export declare class Erc4337Bundler {
     provider: ethers.JsonRpcProvider;
     entryPointAddress: string;

package/dist/cjs/lib/bundler.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Erc4337Bundler = void 0;
 // TODO: Ethers dependency is only for Generic HTTP Provider
 const ethers_1 = require("ethers");
-const util_js_1 = require("../util.js");
 const viem_1 = require("viem");
+const util_1 = require("../util");
 function bundlerUrl(chainId, apikey) {
     return `https://api.pimlico.io/v2/${chainId}/rpc?apikey=${apikey}`;
 }
@@ -23,7 +23,7 @@ class Erc4337Bundler {
         if (usePaymaster) {
             console.log("Requesting paymaster data...");
             const data = this.provider.send("pm_sponsorUserOperation", [
-                { ...rawUserOp, signature: util_js_1.PLACEHOLDER_SIG },
+                { ...rawUserOp, signature: util_1.PLACEHOLDER_SIG },
                 this.entryPointAddress,
             ]);
             return data;

package/dist/cjs/lib/multisend.d.ts

@@ -0,0 +1,3 @@
+import { MetaTransaction } from "../types";
+export declare const MULTI_SEND_ABI: string[];
+export declare function encodeMulti(transactions: readonly MetaTransaction[], multiSendContractAddress?: string): MetaTransaction;

package/dist/cjs/lib/multisend.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MULTI_SEND_ABI = void 0;
+exports.encodeMulti = encodeMulti;
+const viem_1 = require("viem");
+const types_1 = require("../types");
+exports.MULTI_SEND_ABI = ["function multiSend(bytes memory transactions)"];
+const MULTISEND_141 = "0x38869bf66a61cF6bDB996A6aE40D5853Fd43B526";
+const MULTISEND_CALLONLY_141 = "0x9641d764fc13c8B624c04430C7356C1C7C8102e2";
+/// Encodes the transaction as packed bytes of:
+/// - `operation` as a `uint8` with `0` for a `call` or `1` for a `delegatecall` (=> 1 byte),
+/// - `to` as an `address` (=> 20 bytes),
+/// - `value` as a `uint256` (=> 32 bytes),
+/// -  length of `data` as a `uint256` (=> 32 bytes),
+/// - `data` as `bytes`.
+const encodeMetaTx = (tx) => (0, viem_1.encodePacked)(["uint8", "address", "uint256", "uint256", "bytes"], [
+    tx.operation || types_1.OperationType.Call,
+    tx.to,
+    BigInt(tx.value),
+    BigInt((0, viem_1.size)(tx.data)),
+    tx.data,
+]);
+const remove0x = (hexString) => hexString.slice(2);
+// Encodes a batch of module transactions into a single multiSend module transaction.
+// A module transaction is an object with fields corresponding to a Gnosis Safe's (i.e., Zodiac IAvatar's) `execTransactionFromModule` method parameters.
+function encodeMulti(transactions, multiSendContractAddress = transactions.some((t) => t.operation === types_1.OperationType.DelegateCall)
+    ? MULTISEND_141
+    : MULTISEND_CALLONLY_141) {
+    const encodedTransactions = "0x" + transactions.map(encodeMetaTx).map(remove0x).join("");
+    return {
+        operation: types_1.OperationType.DelegateCall,
+        to: multiSendContractAddress,
+        value: "0x00",
+        data: (0, viem_1.encodeFunctionData)({
+            abi: (0, viem_1.parseAbi)(exports.MULTI_SEND_ABI),
+            functionName: "multiSend",
+            args: [encodedTransactions],
+        }),
+    };
+}

package/dist/cjs/lib/safe.d.ts

@@ -1,7 +1,6 @@
 import { ethers } from "ethers";
-import { GasPrice, UnsignedUserOperation, UserOperation } from "../types";
-import { MetaTransaction } from "ethers-multisend";
 import { Address, Hash, Hex } from "viem";
+import { GasPrice, MetaTransaction, UnsignedUserOperation, UserOperation } from "../types";
 /**
  * All contracts used in account creation & execution
  */

package/dist/cjs/lib/safe.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContractSuite = void 0;
-const ethers_1 = require("ethers");
 const safe_deployments_1 = require("@safe-global/safe-deployments");
 const safe_modules_deployments_1 = require("@safe-global/safe-modules-deployments");
+const ethers_1 = require("ethers");
 const util_1 = require("../util");
 /**
  * All contracts used in account creation & execution

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

@@ -1,9 +1,9 @@
+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;
@@ -15,8 +15,10 @@ export declare class TransactionManager {
     private deployedChains;
     constructor(nearAdapter: NearEthAdapter, safePack: ContractSuite, pimlicoKey: string, setup: string, safeAddress: Address, entryPointAddress: Address, safeSaltNonce: string);
     static create(config: {
+        accountId: string;
+        mpcContractId: string;
         pimlicoKey: string;
-        nearAdapter: NearEthAdapter;
+        privateKey?: string;
         safeSaltNonce?: string;
     }): Promise<TransactionManager>;
     get mpcAddress(): Address;
@@ -34,4 +36,8 @@ export declare class TransactionManager {
     safeDeployed(chainId: number): Promise<boolean>;
     addOwnerTx(address: string): MetaTransaction;
     safeSufficientlyFunded(chainId: number, transactions: MetaTransaction[], gasCost: bigint): Promise<boolean>;
+    broadcastEvm(chainId: number, outcome: FinalExecutionOutcome, unsignedUserOp: UserOperation): Promise<{
+        signature: Hex;
+        receipt: UserOperationReceipt;
+    }>;
 }

package/dist/cjs/tx-manager.js

@@ -2,10 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TransactionManager = void 0;
 const near_ca_1 = require("near-ca");
+const viem_1 = require("viem");
 const bundler_1 = require("./lib/bundler");
-const util_1 = require("./util");
-const ethers_multisend_1 = require("ethers-multisend");
+const multisend_1 = require("./lib/multisend");
 const safe_1 = require("./lib/safe");
+const util_1 = require("./util");
 class TransactionManager {
     constructor(nearAdapter, safePack, pimlicoKey, setup, safeAddress, entryPointAddress, safeSaltNonce) {
         this.nearAdapter = nearAdapter;
@@ -18,8 +19,11 @@ class TransactionManager {
         this.deployedChains = new Set();
     }
     static async create(config) {
-        const { nearAdapter, pimlicoKey } = config;
-        const safePack = await safe_1.ContractSuite.init();
+        const { pimlicoKey } = config;
+        const [nearAdapter, safePack] = await Promise.all([
+            (0, near_ca_1.setupAdapter)({ ...config }),
+            safe_1.ContractSuite.init(),
+        ]);
         console.log(`Near Adapter: ${nearAdapter.nearAccountId()} <> ${nearAdapter.address}`);
         const setup = await safePack.getSetup([nearAdapter.address]);
         const safeAddress = await safePack.addressForSetup(setup, config.safeSaltNonce);
@@ -45,7 +49,7 @@ class TransactionManager {
         if (transactions.length === 0) {
             throw new Error("Empty transaction set!");
         }
-        const tx = transactions.length > 1 ? (0, ethers_multisend_1.encodeMulti)(transactions) : transactions[0];
+        const tx = transactions.length > 1 ? (0, multisend_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);
@@ -118,5 +122,20 @@ class TransactionManager {
         const safeBalance = await this.getBalance(chainId);
         return txValue + gasCost < safeBalance;
     }
+    async broadcastEvm(chainId, outcome, unsignedUserOp) {
+        const signature = (0, util_1.packSignature)((0, viem_1.serializeSignature)((0, near_ca_1.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)}`);
+        }
+    }
 }
 exports.TransactionManager = TransactionManager;

package/dist/cjs/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/cjs/types.js

@@ -1,2 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperationType = void 0;
+var OperationType;
+(function (OperationType) {
+    OperationType[OperationType["Call"] = 0] = "Call";
+    OperationType[OperationType["DelegateCall"] = 1] = "DelegateCall";
+})(OperationType || (exports.OperationType = OperationType = {}));

package/dist/cjs/util.d.ts

@@ -1,6 +1,5 @@
-import { PaymasterData } from "./types.js";
-import { MetaTransaction } from "ethers-multisend";
 import { Hex } 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;

package/dist/esm/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./tx-manager";
 export * from "./types";
 export * from "./util";
+export { Network, BaseTx, SignRequestData, populateTx } from "near-ca";

package/dist/esm/index.js

@@ -1,3 +1,4 @@
 export * from "./tx-manager";
 export * from "./types";
 export * from "./util";
+export { Network, populateTx } from "near-ca";

package/dist/esm/lib/bundler.d.ts

@@ -1,5 +1,5 @@
 import { ethers } from "ethers";
-import { GasPrices, PaymasterData, UnsignedUserOperation, UserOperation, UserOperationReceipt } from "../types.js";
+import { GasPrices, PaymasterData, UnsignedUserOperation, UserOperation, UserOperationReceipt } from "../types";
 export declare class Erc4337Bundler {
     provider: ethers.JsonRpcProvider;
     entryPointAddress: string;

package/dist/esm/lib/bundler.js

@@ -1,7 +1,7 @@
 // TODO: Ethers dependency is only for Generic HTTP Provider
 import { ethers } from "ethers";
-import { PLACEHOLDER_SIG } from "../util.js";
 import { toHex } from "viem";
+import { PLACEHOLDER_SIG } from "../util";
 function bundlerUrl(chainId, apikey) {
     return `https://api.pimlico.io/v2/${chainId}/rpc?apikey=${apikey}`;
 }

package/dist/esm/lib/multisend.d.ts

@@ -0,0 +1,3 @@
+import { MetaTransaction } from "../types";
+export declare const MULTI_SEND_ABI: string[];
+export declare function encodeMulti(transactions: readonly MetaTransaction[], multiSendContractAddress?: string): MetaTransaction;

package/dist/esm/lib/multisend.js

@@ -0,0 +1,36 @@
+import { encodeFunctionData, encodePacked, parseAbi, size, } from "viem";
+import { OperationType } from "../types";
+export const MULTI_SEND_ABI = ["function multiSend(bytes memory transactions)"];
+const MULTISEND_141 = "0x38869bf66a61cF6bDB996A6aE40D5853Fd43B526";
+const MULTISEND_CALLONLY_141 = "0x9641d764fc13c8B624c04430C7356C1C7C8102e2";
+/// Encodes the transaction as packed bytes of:
+/// - `operation` as a `uint8` with `0` for a `call` or `1` for a `delegatecall` (=> 1 byte),
+/// - `to` as an `address` (=> 20 bytes),
+/// - `value` as a `uint256` (=> 32 bytes),
+/// -  length of `data` as a `uint256` (=> 32 bytes),
+/// - `data` as `bytes`.
+const encodeMetaTx = (tx) => encodePacked(["uint8", "address", "uint256", "uint256", "bytes"], [
+    tx.operation || OperationType.Call,
+    tx.to,
+    BigInt(tx.value),
+    BigInt(size(tx.data)),
+    tx.data,
+]);
+const remove0x = (hexString) => hexString.slice(2);
+// Encodes a batch of module transactions into a single multiSend module transaction.
+// A module transaction is an object with fields corresponding to a Gnosis Safe's (i.e., Zodiac IAvatar's) `execTransactionFromModule` method parameters.
+export function encodeMulti(transactions, multiSendContractAddress = transactions.some((t) => t.operation === OperationType.DelegateCall)
+    ? MULTISEND_141
+    : MULTISEND_CALLONLY_141) {
+    const encodedTransactions = "0x" + transactions.map(encodeMetaTx).map(remove0x).join("");
+    return {
+        operation: OperationType.DelegateCall,
+        to: multiSendContractAddress,
+        value: "0x00",
+        data: encodeFunctionData({
+            abi: parseAbi(MULTI_SEND_ABI),
+            functionName: "multiSend",
+            args: [encodedTransactions],
+        }),
+    };
+}

package/dist/esm/lib/safe.d.ts

@@ -1,7 +1,6 @@
 import { ethers } from "ethers";
-import { GasPrice, UnsignedUserOperation, UserOperation } from "../types";
-import { MetaTransaction } from "ethers-multisend";
 import { Address, Hash, Hex } from "viem";
+import { GasPrice, MetaTransaction, UnsignedUserOperation, UserOperation } from "../types";
 /**
  * All contracts used in account creation & execution
  */

package/dist/esm/lib/safe.js

@@ -1,6 +1,6 @@
-import { ethers } from "ethers";
 import { getProxyFactoryDeployment, getSafeL2SingletonDeployment, } from "@safe-global/safe-deployments";
 import { getSafe4337ModuleDeployment, getSafeModuleSetupDeployment, } from "@safe-global/safe-modules-deployments";
+import { ethers } from "ethers";
 import { PLACEHOLDER_SIG, packGas, packPaymasterData } from "../util";
 /**
  * All contracts used in account creation & execution

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

@@ -1,9 +1,9 @@
+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;
@@ -15,8 +15,10 @@ export declare class TransactionManager {
     private deployedChains;
     constructor(nearAdapter: NearEthAdapter, safePack: ContractSuite, pimlicoKey: string, setup: string, safeAddress: Address, entryPointAddress: Address, safeSaltNonce: string);
     static create(config: {
+        accountId: string;
+        mpcContractId: string;
         pimlicoKey: string;
-        nearAdapter: NearEthAdapter;
+        privateKey?: string;
         safeSaltNonce?: string;
     }): Promise<TransactionManager>;
     get mpcAddress(): Address;
@@ -34,4 +36,8 @@ export declare class TransactionManager {
     safeDeployed(chainId: number): Promise<boolean>;
     addOwnerTx(address: string): 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,8 +1,9 @@
-import { Network } from "near-ca";
+import { Network, 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 { packSignature } from "./util";
 export class TransactionManager {
     nearAdapter;
     address;
@@ -23,8 +24,11 @@ export class TransactionManager {
         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 safeAddress = await safePack.addressForSetup(setup, config.safeSaltNonce);
@@ -123,4 +127,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,6 +1,5 @@
-import { PaymasterData } from "./types.js";
-import { MetaTransaction } from "ethers-multisend";
 import { Hex } 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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "near-safe",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "license": "MIT",
   "description": "An SDK for controlling Ethereum Smart Accounts via ERC4337 from a Near Account.",
   "author": "bh2smith",
@@ -36,14 +36,13 @@
     "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",
@@ -57,6 +56,7 @@
     "@typescript-eslint/parser": "^8.1.0",
     "dotenv": "^16.4.5",
     "eslint": "^9.6.0",
+    "eslint-plugin-import": "^2.30.0",
     "jest": "^29.7.0",
     "prettier": "^3.3.2",
     "ts-jest": "^29.1.5",