@snowbridge/provider-ethers 1.0.0

package/.turbo/turbo-build.log

@@ -0,0 +1,5 @@
+
+
+> @snowbridge/provider-ethers@1.0.0 build /Users/alistairsingh/c/snowbridge/web/packages/provider-ethers
+> tsc --build --force
+

package/.turbo/turbo-format.log

@@ -0,0 +1,6 @@
+
+
+> @snowbridge/provider-ethers@1.0.0 format /Users/alistairsingh/c/snowbridge/web/packages/provider-ethers
+> prettier src --write
+
+src/index.tssrc/index.ts 64ms (unchanged)

package/dist/index.d.ts

@@ -0,0 +1,48 @@
+import { AbstractProvider, Contract, ContractTransaction, Interface, InterfaceAbi, TransactionReceipt } from "ethers";
+import type { DepositParamsStruct, EthereumProvider, EthereumProviderTypes, FeeData, GatewayV1OutboundMessageAccepted, GatewayV2OutboundMessageAccepted, IGatewayV1, IGatewayV2, L1AdapterDepositParams, L1LegacySwapRouterExactOutputSingleParams, L1SwapRouterExactOutputSingleParams, MultiAddressStruct, SendParamsStruct, SwapParamsStruct } from "@snowbridge/base-types";
+export interface EthersProviderTypes extends EthereumProviderTypes {
+    Connection: AbstractProvider;
+    Contract: Contract;
+    Abi: InterfaceAbi;
+    TransactionReceipt: TransactionReceipt;
+    ContractTransaction: ContractTransaction;
+}
+export declare class EthersEthereumProvider implements EthereumProvider<EthersProviderTypes> {
+    readonly providerTypes: EthersProviderTypes;
+    static gatewayV1Interface: Interface;
+    static gatewayV2Interface: Interface;
+    createProvider(url: string): AbstractProvider;
+    destroyProvider(provider: AbstractProvider): void;
+    destroyContract(contract: Contract): Promise<void>;
+    connectContract(address: string, abi: InterfaceAbi, provider: AbstractProvider): Contract;
+    erc20Balance(provider: AbstractProvider, tokenAddress: string, owner: string, spender: string): Promise<{
+        balance: bigint;
+        gatewayAllowance: bigint;
+    }>;
+    gatewayV1SendToken(provider: AbstractProvider, gatewayAddress: string, sender: string, token: string, destinationChain: number, destinationAddress: MultiAddressStruct, destinationFee: bigint, amount: bigint, value: bigint): Promise<ContractTransaction>;
+    gatewayV2RegisterToken(provider: AbstractProvider, gatewayAddress: string, sender: string, token: string, network: number, executionFee: bigint, relayerFee: bigint, value: bigint): Promise<ContractTransaction>;
+    gatewayV2CreateAgent(provider: AbstractProvider, gatewayAddress: string, id: string): Promise<ContractTransaction>;
+    gatewayV2SendMessage(provider: AbstractProvider, gatewayAddress: string, sender: string, xcm: Uint8Array, assets: string[], claimer: Uint8Array, executionFee: bigint, relayerFee: bigint, value: bigint): Promise<ContractTransaction>;
+    l2AdapterSendEtherAndCall(provider: AbstractProvider, adapterAddress: string, sender: string, params: DepositParamsStruct, sendParams: SendParamsStruct, recipient: string, topic: string, value?: bigint): Promise<ContractTransaction>;
+    l2AdapterSendTokenAndCall(provider: AbstractProvider, adapterAddress: string, sender: string, params: DepositParamsStruct, swapParams: SwapParamsStruct, sendParams: SendParamsStruct, recipient: string, topic: string): Promise<ContractTransaction>;
+    evmParachainTransferAssetsUsingTypeAndThenAddress(provider: AbstractProvider, precompileAddress: string, sourceAccount: string, destination: [number, string[]], assets: [string, bigint][], assetsTransferType: number, remoteFeesIdIndex: number, feesTransferType: number, customXcmHex: string): Promise<ContractTransaction>;
+    encodeFunctionData(abi: InterfaceAbi, method: string, args: readonly unknown[]): string;
+    decodeFunctionResult<T = unknown>(abi: InterfaceAbi, method: string, data: string): T;
+    encodeNativeAsset(tokenAddress: string, amount: bigint): string;
+    l1AdapterDepositNativeEther(params: L1AdapterDepositParams, recipient: string, topic: string): string;
+    l1AdapterDepositToken(params: L1AdapterDepositParams, recipient: string, topic: string): string;
+    l1SwapRouterExactOutputSingle(params: L1SwapRouterExactOutputSingleParams): string;
+    l1LegacySwapRouterExactOutputSingle(params: L1LegacySwapRouterExactOutputSingleParams): string;
+    beneficiaryMultiAddress(beneficiary: string): MultiAddressStruct;
+    estimateGas(provider: AbstractProvider, tx: ContractTransaction): Promise<bigint>;
+    getTransactionCount(provider: AbstractProvider, address: string, blockTag?: "latest" | "pending"): Promise<number>;
+    getBalance(provider: AbstractProvider, address: string): Promise<bigint>;
+    getFeeData(provider: AbstractProvider): Promise<FeeData>;
+    parseUnits(value: string, decimals: number): bigint;
+    gatewayOperatingMode(gateway: Contract & (IGatewayV1 | IGatewayV2)): Promise<bigint>;
+    gatewayChannelOperatingModeOf(gateway: Contract & IGatewayV1, channelId: string): Promise<bigint>;
+    isContractAddress(provider: AbstractProvider, address: string): Promise<boolean>;
+    scanGatewayV1OutboundMessageAccepted(receipt: TransactionReceipt): GatewayV1OutboundMessageAccepted | null;
+    scanGatewayV2OutboundMessageAccepted(receipt: TransactionReceipt): GatewayV2OutboundMessageAccepted | null;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,gBAAgB,EAChB,QAAQ,EACR,mBAAmB,EAEnB,SAAS,EACT,YAAY,EAGZ,kBAAkB,EAEnB,MAAM,QAAQ,CAAC;AAChB,OAAO,KAAK,EAEV,mBAAmB,EACnB,gBAAgB,EAChB,qBAAqB,EACrB,OAAO,EACP,gCAAgC,EAChC,gCAAgC,EAChC,UAAU,EACV,UAAU,EAEV,sBAAsB,EACtB,yCAAyC,EACzC,mCAAmC,EACnC,kBAAkB,EAClB,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,wBAAwB,CAAC;AAYhC,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB;IAChE,UAAU,EAAE,gBAAgB,CAAC;IAC7B,QAAQ,EAAE,QAAQ,CAAC;IACnB,GAAG,EAAE,YAAY,CAAC;IAClB,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,mBAAmB,EAAE,mBAAmB,CAAC;CAC1C;AAED,qBAAa,sBACX,YAAW,gBAAgB,CAAC,mBAAmB,CAAC;IAEhD,SAAiB,aAAa,EAAE,mBAAmB,CAAC;IAEpD,MAAM,CAAC,kBAAkB,YAAkC;IAC3D,MAAM,CAAC,kBAAkB,YAAkC;IAE3D,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB;IAO7C,eAAe,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI;IAI3C,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxD,eAAe,CACb,OAAO,EAAE,MAAM,EACf,GAAG,EAAE,YAAY,EACjB,QAAQ,EAAE,gBAAgB,GACzB,QAAQ;IAIL,YAAY,CAChB,QAAQ,EAAE,gBAAgB,EAC1B,YAAY,EAAE,MAAM,EACpB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,GACd,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,MAAM,CAAA;KAAE,CAAC;IAanD,kBAAkB,CACtB,QAAQ,EAAE,gBAAgB,EAC1B,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,gBAAgB,EAAE,MAAM,EACxB,kBAAkB,EAAE,kBAAkB,EACtC,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,mBAAmB,CAAC;IAkBzB,sBAAsB,CAC1B,QAAQ,EAAE,gBAAgB,EAC1B,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,mBAAmB,CAAC;IAczB,oBAAoB,CACxB,QAAQ,EAAE,gBAAgB,EAC1B,cAAc,EAAE,MAAM,EACtB,EAAE,EAAE,MAAM,GACT,OAAO,CAAC,mBAAmB,CAAC;IASzB,oBAAoB,CACxB,QAAQ,EAAE,gBAAgB,EAC1B,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,UAAU,EACf,MAAM,EAAE,MAAM,EAAE,EAChB,OAAO,EAAE,UAAU,EACnB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,mBAAmB,CAAC;IAczB,yBAAyB,CAC7B,QAAQ,EAAE,gBAAgB,EAC1B,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,mBAAmB,EAC3B,UAAU,EAAE,gBAAgB,EAC5B,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,EACb,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,mBAAmB,CAAC;IAazB,yBAAyB,CAC7B,QAAQ,EAAE,gBAAgB,EAC1B,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,mBAAmB,EAC3B,UAAU,EAAE,gBAAgB,EAC5B,UAAU,EAAE,gBAAgB,EAC5B,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,mBAAmB,CAAC;IAazB,iDAAiD,CACrD,QAAQ,EAAE,gBAAgB,EAC1B,iBAAiB,EAAE,MAAM,EACzB,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAC/B,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAC1B,kBAAkB,EAAE,MAAM,EAC1B,iBAAiB,EAAE,MAAM,EACzB,gBAAgB,EAAE,MAAM,EACxB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,mBAAmB,CAAC;IAsB/B,kBAAkB,CAChB,GAAG,EAAE,YAAY,EACjB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,SAAS,OAAO,EAAE,GACvB,MAAM;IAIT,oBAAoB,CAAC,CAAC,GAAG,OAAO,EAC9B,GAAG,EAAE,YAAY,EACjB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,GACX,CAAC;IAIJ,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;IAO/D,2BAA2B,CACzB,MAAM,EAAE,sBAAsB,EAC9B,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,GACZ,MAAM;IAOT,qBAAqB,CACnB,MAAM,EAAE,sBAAsB,EAC9B,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,GACZ,MAAM;IAOT,6BAA6B,CAC3B,MAAM,EAAE,mCAAmC,GAC1C,MAAM;IAOT,mCAAmC,CACjC,MAAM,EAAE,yCAAyC,GAChD,MAAM;IAOT,uBAAuB,CAAC,WAAW,EAAE,MAAM,GAAG,kBAAkB;IAwB1D,WAAW,CACf,QAAQ,EAAE,gBAAgB,EAC1B,EAAE,EAAE,mBAAmB,GACtB,OAAO,CAAC,MAAM,CAAC;IAIZ,mBAAmB,CACvB,QAAQ,EAAE,gBAAgB,EAC1B,OAAO,EAAE,MAAM,EACf,QAAQ,GAAE,QAAQ,GAAG,SAAoB,GACxC,OAAO,CAAC,MAAM,CAAC;IAIZ,UAAU,CACd,QAAQ,EAAE,gBAAgB,EAC1B,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC;IAIZ,UAAU,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAS9D,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;IAI7C,oBAAoB,CACxB,OAAO,EAAE,QAAQ,GAAG,CAAC,UAAU,GAAG,UAAU,CAAC,GAC5C,OAAO,CAAC,MAAM,CAAC;IAIZ,6BAA6B,CACjC,OAAO,EAAE,QAAQ,GAAG,UAAU,EAC9B,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,CAAC;IAIZ,iBAAiB,CACrB,QAAQ,EAAE,gBAAgB,EAC1B,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,OAAO,CAAC;IAYnB,oCAAoC,CAClC,OAAO,EAAE,kBAAkB,GAC1B,gCAAgC,GAAG,IAAI;IAuB1C,oCAAoC,CAClC,OAAO,EAAE,kBAAkB,GAC1B,gCAAgC,GAAG,IAAI;CAiC3C"}

package/dist/index.js

@@ -0,0 +1,225 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EthersEthereumProvider = void 0;
+const ethers_1 = require("ethers");
+const base_types_1 = require("@snowbridge/base-types");
+class EthersEthereumProvider {
+    createProvider(url) {
+        if (url.startsWith("http")) {
+            return new ethers_1.JsonRpcProvider(url);
+        }
+        return new ethers_1.WebSocketProvider(url);
+    }
+    destroyProvider(provider) {
+        provider.destroy();
+    }
+    async destroyContract(contract) {
+        await contract.removeAllListeners();
+    }
+    connectContract(address, abi, provider) {
+        return new ethers_1.Contract(address, abi, provider);
+    }
+    async erc20Balance(provider, tokenAddress, owner, spender) {
+        const tokenContract = this.connectContract(tokenAddress, base_types_1.IERC20_ABI, provider);
+        const [balance, gatewayAllowance] = await Promise.all([
+            tokenContract.balanceOf(owner),
+            tokenContract.allowance(owner, spender),
+        ]);
+        return { balance, gatewayAllowance };
+    }
+    async gatewayV1SendToken(provider, gatewayAddress, sender, token, destinationChain, destinationAddress, destinationFee, amount, value) {
+        const gateway = this.connectContract(gatewayAddress, base_types_1.IGATEWAY_V1_ABI, provider);
+        return await gateway
+            .getFunction("sendToken")
+            .populateTransaction(token, destinationChain, destinationAddress, destinationFee, amount, { value, from: sender });
+    }
+    async gatewayV2RegisterToken(provider, gatewayAddress, sender, token, network, executionFee, relayerFee, value) {
+        const gateway = this.connectContract(gatewayAddress, base_types_1.IGATEWAY_V2_ABI, provider);
+        return await gateway
+            .getFunction("v2_registerToken")
+            .populateTransaction(token, network, executionFee, relayerFee, {
+            value,
+            from: sender,
+        });
+    }
+    async gatewayV2CreateAgent(provider, gatewayAddress, id) {
+        const gateway = this.connectContract(gatewayAddress, base_types_1.IGATEWAY_V2_ABI, provider);
+        return await gateway.getFunction("v2_createAgent").populateTransaction(id);
+    }
+    async gatewayV2SendMessage(provider, gatewayAddress, sender, xcm, assets, claimer, executionFee, relayerFee, value) {
+        const gateway = this.connectContract(gatewayAddress, base_types_1.IGATEWAY_V2_ABI, provider);
+        return await gateway
+            .getFunction("v2_sendMessage")
+            .populateTransaction(xcm, assets, claimer, executionFee, relayerFee, {
+            value,
+            from: sender,
+        });
+    }
+    async l2AdapterSendEtherAndCall(provider, adapterAddress, sender, params, sendParams, recipient, topic, value) {
+        const adapter = this.connectContract(adapterAddress, base_types_1.SNOWBRIDGE_L2_ADAPTOR_ABI, provider);
+        const txOptions = value === undefined ? { from: sender } : { from: sender, value };
+        return await adapter
+            .getFunction("sendEtherAndCall")
+            .populateTransaction(params, sendParams, recipient, topic, txOptions);
+    }
+    async l2AdapterSendTokenAndCall(provider, adapterAddress, sender, params, swapParams, sendParams, recipient, topic) {
+        const adapter = this.connectContract(adapterAddress, base_types_1.SNOWBRIDGE_L2_ADAPTOR_ABI, provider);
+        return await adapter
+            .getFunction("sendTokenAndCall")
+            .populateTransaction(params, swapParams, sendParams, recipient, topic, {
+            from: sender,
+        });
+    }
+    async evmParachainTransferAssetsUsingTypeAndThenAddress(provider, precompileAddress, sourceAccount, destination, assets, assetsTransferType, remoteFeesIdIndex, feesTransferType, customXcmHex) {
+        const precompile = this.connectContract(precompileAddress, base_types_1.MOONBEAM_PALLET_XCM_PRECOMPILE_ABI, provider);
+        const tx = await precompile
+            .getFunction("transferAssetsUsingTypeAndThenAddress((uint8,bytes[]),(address,uint256)[],uint8,uint8,uint8,bytes)")
+            .populateTransaction(destination, assets, assetsTransferType, remoteFeesIdIndex, feesTransferType, customXcmHex);
+        tx.from = sourceAccount;
+        return tx;
+    }
+    encodeFunctionData(abi, method, args) {
+        return new ethers_1.Interface(abi).encodeFunctionData(method, args);
+    }
+    decodeFunctionResult(abi, method, data) {
+        return new ethers_1.Interface(abi).decodeFunctionResult(method, data);
+    }
+    encodeNativeAsset(tokenAddress, amount) {
+        return ethers_1.AbiCoder.defaultAbiCoder().encode(["uint8", "address", "uint128"], [0, tokenAddress, amount]);
+    }
+    l1AdapterDepositNativeEther(params, recipient, topic) {
+        return new ethers_1.Interface(base_types_1.SNOWBRIDGE_L1_ADAPTOR_ABI).encodeFunctionData("depositNativeEther", [params, recipient, topic]);
+    }
+    l1AdapterDepositToken(params, recipient, topic) {
+        return new ethers_1.Interface(base_types_1.SNOWBRIDGE_L1_ADAPTOR_ABI).encodeFunctionData("depositToken", [params, recipient, topic]);
+    }
+    l1SwapRouterExactOutputSingle(params) {
+        return new ethers_1.Interface(base_types_1.SWAP_ROUTER_ABI).encodeFunctionData("exactOutputSingle", [params]);
+    }
+    l1LegacySwapRouterExactOutputSingle(params) {
+        return new ethers_1.Interface(base_types_1.SWAP_LEGACY_ROUTER_ABI).encodeFunctionData("exactOutputSingle", [params]);
+    }
+    beneficiaryMultiAddress(beneficiary) {
+        const abi = ethers_1.AbiCoder.defaultAbiCoder();
+        let kind;
+        if (/^0x[a-fA-F0-9]{40}$/.test(beneficiary)) {
+            kind = 2;
+        }
+        else if (/^0x[a-fA-F0-9]{64}$/.test(beneficiary)) {
+            kind = 1;
+        }
+        else {
+            throw new Error("Unknown Beneficiary address format.");
+        }
+        let data;
+        switch (kind) {
+            case 1:
+                data = abi.encode(["bytes32"], [beneficiary]);
+                break;
+            case 2:
+                data = abi.encode(["bytes20"], [beneficiary]);
+                break;
+            default:
+                throw new Error(`Unknown Beneficiary kind {kind}.`);
+        }
+        return { kind, data };
+    }
+    async estimateGas(provider, tx) {
+        return await provider.estimateGas(tx);
+    }
+    async getTransactionCount(provider, address, blockTag = "latest") {
+        return await provider.getTransactionCount(address, blockTag);
+    }
+    async getBalance(provider, address) {
+        return await provider.getBalance(address);
+    }
+    async getFeeData(provider) {
+        const feeData = await provider.getFeeData();
+        return {
+            gasPrice: feeData.gasPrice ?? null,
+            maxFeePerGas: feeData.maxFeePerGas ?? null,
+            maxPriorityFeePerGas: feeData.maxPriorityFeePerGas ?? null,
+        };
+    }
+    parseUnits(value, decimals) {
+        return (0, ethers_1.parseUnits)(value, decimals);
+    }
+    async gatewayOperatingMode(gateway) {
+        return BigInt(await gateway.operatingMode());
+    }
+    async gatewayChannelOperatingModeOf(gateway, channelId) {
+        return BigInt(await gateway.channelOperatingModeOf(channelId));
+    }
+    async isContractAddress(provider, address) {
+        if (!/^0x[a-fA-F0-9]{40}$/.test(address)) {
+            return false;
+        }
+        try {
+            const code = await provider.getCode(address);
+            return code !== "0x";
+        }
+        catch {
+            return false;
+        }
+    }
+    scanGatewayV1OutboundMessageAccepted(receipt) {
+        for (const log of receipt.logs) {
+            try {
+                const event = EthersEthereumProvider.gatewayV1Interface.parseLog({
+                    topics: [...log.topics],
+                    data: log.data,
+                });
+                if (event && event.name === "OutboundMessageAccepted") {
+                    return {
+                        channelId: String(event.args[0]),
+                        nonce: BigInt(event.args[1]),
+                        messageId: String(event.args[2]),
+                        blockHash: receipt.blockHash,
+                        blockNumber: receipt.blockNumber,
+                        txHash: receipt.hash,
+                        txIndex: receipt.index,
+                    };
+                }
+            }
+            catch { }
+        }
+        return null;
+    }
+    scanGatewayV2OutboundMessageAccepted(receipt) {
+        for (const log of receipt.logs) {
+            try {
+                const event = EthersEthereumProvider.gatewayV2Interface.parseLog({
+                    topics: [...log.topics],
+                    data: log.data,
+                });
+                if (event && event.name === "OutboundMessageAccepted") {
+                    const payload = event.args[1];
+                    return {
+                        nonce: BigInt(event.args[0]),
+                        payload: {
+                            origin: String(payload.origin),
+                            assets: payload.assets.map((asset) => [
+                                Number(asset.kind),
+                                String(asset.data),
+                            ]),
+                            xcm: [Number(payload.xcm.kind), String(payload.xcm.data)],
+                            claimer: String(payload.claimer),
+                            value: BigInt(payload.value),
+                            executionFee: BigInt(payload.executionFee),
+                            relayerFee: BigInt(payload.relayerFee),
+                        },
+                        blockHash: receipt.blockHash,
+                        blockNumber: receipt.blockNumber,
+                        txHash: receipt.hash,
+                        txIndex: receipt.index,
+                    };
+                }
+            }
+            catch { }
+        }
+        return null;
+    }
+}
+exports.EthersEthereumProvider = EthersEthereumProvider;
+EthersEthereumProvider.gatewayV1Interface = new ethers_1.Interface(base_types_1.IGATEWAY_V1_ABI);
+EthersEthereumProvider.gatewayV2Interface = new ethers_1.Interface(base_types_1.IGATEWAY_V2_ABI);

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@snowbridge/provider-ethers",
+  "version": "1.0.0",
+  "description": "Snowbridge ethers provider implementation",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Snowfork/snowbridge.git",
+    "directory": "web/packages/provider-ethers"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "devDependencies": {
+    "@types/node": "24.6.2",
+    "@typescript-eslint/eslint-plugin": "8.45.0",
+    "@typescript-eslint/parser": "8.45.0",
+    "eslint": "9.37.0",
+    "eslint-config-prettier": "10.1.8",
+    "prettier": "3.6.2",
+    "ts-node": "10.9.2",
+    "tsconfig-paths": "4.2.0",
+    "typescript": "5.9.3"
+  },
+  "dependencies": {
+    "ethers": "6.16.0",
+    "@snowbridge/base-types": "1.0.0"
+  },
+  "scripts": {
+    "build": "tsc --build --force",
+    "lint": "eslint .",
+    "format": "prettier src --write"
+  }
+}

package/src/index.ts

@@ -0,0 +1,474 @@
+import {
+  AbiCoder,
+  AbstractProvider,
+  Contract,
+  ContractTransaction,
+  FeeData as EthersFeeData,
+  Interface,
+  InterfaceAbi,
+  JsonRpcProvider,
+  parseUnits,
+  TransactionReceipt,
+  WebSocketProvider,
+} from "ethers";
+import type {
+  BeefyClient,
+  DepositParamsStruct,
+  EthereumProvider,
+  EthereumProviderTypes,
+  FeeData,
+  GatewayV1OutboundMessageAccepted,
+  GatewayV2OutboundMessageAccepted,
+  IGatewayV1,
+  IGatewayV2,
+  IERC20,
+  L1AdapterDepositParams,
+  L1LegacySwapRouterExactOutputSingleParams,
+  L1SwapRouterExactOutputSingleParams,
+  MultiAddressStruct,
+  SendParamsStruct,
+  SwapParamsStruct,
+} from "@snowbridge/base-types";
+import {
+  IERC20_ABI,
+  IGATEWAY_V1_ABI,
+  IGATEWAY_V2_ABI,
+  MOONBEAM_PALLET_XCM_PRECOMPILE_ABI,
+  SNOWBRIDGE_L1_ADAPTOR_ABI,
+  SNOWBRIDGE_L2_ADAPTOR_ABI,
+  SWAP_LEGACY_ROUTER_ABI,
+  SWAP_ROUTER_ABI,
+} from "@snowbridge/base-types";
+
+export interface EthersProviderTypes extends EthereumProviderTypes {
+  Connection: AbstractProvider;
+  Contract: Contract;
+  Abi: InterfaceAbi;
+  TransactionReceipt: TransactionReceipt;
+  ContractTransaction: ContractTransaction;
+}
+
+export class EthersEthereumProvider
+  implements EthereumProvider<EthersProviderTypes>
+{
+  declare readonly providerTypes: EthersProviderTypes;
+
+  static gatewayV1Interface = new Interface(IGATEWAY_V1_ABI);
+  static gatewayV2Interface = new Interface(IGATEWAY_V2_ABI);
+
+  createProvider(url: string): AbstractProvider {
+    if (url.startsWith("http")) {
+      return new JsonRpcProvider(url);
+    }
+    return new WebSocketProvider(url);
+  }
+
+  destroyProvider(provider: AbstractProvider): void {
+    provider.destroy();
+  }
+
+  async destroyContract(contract: Contract): Promise<void> {
+    await contract.removeAllListeners();
+  }
+
+  connectContract(
+    address: string,
+    abi: InterfaceAbi,
+    provider: AbstractProvider,
+  ): Contract {
+    return new Contract(address, abi, provider);
+  }
+
+  async erc20Balance(
+    provider: AbstractProvider,
+    tokenAddress: string,
+    owner: string,
+    spender: string,
+  ): Promise<{ balance: bigint; gatewayAllowance: bigint }> {
+    const tokenContract = this.connectContract(
+      tokenAddress,
+      IERC20_ABI,
+      provider,
+    ) as Contract & IERC20;
+    const [balance, gatewayAllowance] = await Promise.all([
+      tokenContract.balanceOf(owner),
+      tokenContract.allowance(owner, spender),
+    ]);
+    return { balance, gatewayAllowance };
+  }
+
+  async gatewayV1SendToken(
+    provider: AbstractProvider,
+    gatewayAddress: string,
+    sender: string,
+    token: string,
+    destinationChain: number,
+    destinationAddress: MultiAddressStruct,
+    destinationFee: bigint,
+    amount: bigint,
+    value: bigint,
+  ): Promise<ContractTransaction> {
+    const gateway = this.connectContract(
+      gatewayAddress,
+      IGATEWAY_V1_ABI,
+      provider,
+    );
+    return await gateway
+      .getFunction("sendToken")
+      .populateTransaction(
+        token,
+        destinationChain,
+        destinationAddress,
+        destinationFee,
+        amount,
+        { value, from: sender },
+      );
+  }
+
+  async gatewayV2RegisterToken(
+    provider: AbstractProvider,
+    gatewayAddress: string,
+    sender: string,
+    token: string,
+    network: number,
+    executionFee: bigint,
+    relayerFee: bigint,
+    value: bigint,
+  ): Promise<ContractTransaction> {
+    const gateway = this.connectContract(
+      gatewayAddress,
+      IGATEWAY_V2_ABI,
+      provider,
+    );
+    return await gateway
+      .getFunction("v2_registerToken")
+      .populateTransaction(token, network, executionFee, relayerFee, {
+        value,
+        from: sender,
+      });
+  }
+
+  async gatewayV2CreateAgent(
+    provider: AbstractProvider,
+    gatewayAddress: string,
+    id: string,
+  ): Promise<ContractTransaction> {
+    const gateway = this.connectContract(
+      gatewayAddress,
+      IGATEWAY_V2_ABI,
+      provider,
+    );
+    return await gateway.getFunction("v2_createAgent").populateTransaction(id);
+  }
+
+  async gatewayV2SendMessage(
+    provider: AbstractProvider,
+    gatewayAddress: string,
+    sender: string,
+    xcm: Uint8Array,
+    assets: string[],
+    claimer: Uint8Array,
+    executionFee: bigint,
+    relayerFee: bigint,
+    value: bigint,
+  ): Promise<ContractTransaction> {
+    const gateway = this.connectContract(
+      gatewayAddress,
+      IGATEWAY_V2_ABI,
+      provider,
+    );
+    return await gateway
+      .getFunction("v2_sendMessage")
+      .populateTransaction(xcm, assets, claimer, executionFee, relayerFee, {
+        value,
+        from: sender,
+      });
+  }
+
+  async l2AdapterSendEtherAndCall(
+    provider: AbstractProvider,
+    adapterAddress: string,
+    sender: string,
+    params: DepositParamsStruct,
+    sendParams: SendParamsStruct,
+    recipient: string,
+    topic: string,
+    value?: bigint,
+  ): Promise<ContractTransaction> {
+    const adapter = this.connectContract(
+      adapterAddress,
+      SNOWBRIDGE_L2_ADAPTOR_ABI,
+      provider,
+    );
+    const txOptions =
+      value === undefined ? { from: sender } : { from: sender, value };
+    return await adapter
+      .getFunction("sendEtherAndCall")
+      .populateTransaction(params, sendParams, recipient, topic, txOptions);
+  }
+
+  async l2AdapterSendTokenAndCall(
+    provider: AbstractProvider,
+    adapterAddress: string,
+    sender: string,
+    params: DepositParamsStruct,
+    swapParams: SwapParamsStruct,
+    sendParams: SendParamsStruct,
+    recipient: string,
+    topic: string,
+  ): Promise<ContractTransaction> {
+    const adapter = this.connectContract(
+      adapterAddress,
+      SNOWBRIDGE_L2_ADAPTOR_ABI,
+      provider,
+    );
+    return await adapter
+      .getFunction("sendTokenAndCall")
+      .populateTransaction(params, swapParams, sendParams, recipient, topic, {
+        from: sender,
+      });
+  }
+
+  async evmParachainTransferAssetsUsingTypeAndThenAddress(
+    provider: AbstractProvider,
+    precompileAddress: string,
+    sourceAccount: string,
+    destination: [number, string[]],
+    assets: [string, bigint][],
+    assetsTransferType: number,
+    remoteFeesIdIndex: number,
+    feesTransferType: number,
+    customXcmHex: string,
+  ): Promise<ContractTransaction> {
+    const precompile = this.connectContract(
+      precompileAddress,
+      MOONBEAM_PALLET_XCM_PRECOMPILE_ABI,
+      provider,
+    );
+    const tx = await precompile
+      .getFunction(
+        "transferAssetsUsingTypeAndThenAddress((uint8,bytes[]),(address,uint256)[],uint8,uint8,uint8,bytes)",
+      )
+      .populateTransaction(
+        destination,
+        assets,
+        assetsTransferType,
+        remoteFeesIdIndex,
+        feesTransferType,
+        customXcmHex,
+      );
+    tx.from = sourceAccount;
+    return tx;
+  }
+
+  encodeFunctionData(
+    abi: InterfaceAbi,
+    method: string,
+    args: readonly unknown[],
+  ): string {
+    return new Interface(abi).encodeFunctionData(method, args);
+  }
+
+  decodeFunctionResult<T = unknown>(
+    abi: InterfaceAbi,
+    method: string,
+    data: string,
+  ): T {
+    return new Interface(abi).decodeFunctionResult(method, data) as T;
+  }
+
+  encodeNativeAsset(tokenAddress: string, amount: bigint): string {
+    return AbiCoder.defaultAbiCoder().encode(
+      ["uint8", "address", "uint128"],
+      [0, tokenAddress, amount],
+    );
+  }
+
+  l1AdapterDepositNativeEther(
+    params: L1AdapterDepositParams,
+    recipient: string,
+    topic: string,
+  ): string {
+    return new Interface(SNOWBRIDGE_L1_ADAPTOR_ABI).encodeFunctionData(
+      "depositNativeEther",
+      [params, recipient, topic],
+    );
+  }
+
+  l1AdapterDepositToken(
+    params: L1AdapterDepositParams,
+    recipient: string,
+    topic: string,
+  ): string {
+    return new Interface(SNOWBRIDGE_L1_ADAPTOR_ABI).encodeFunctionData(
+      "depositToken",
+      [params, recipient, topic],
+    );
+  }
+
+  l1SwapRouterExactOutputSingle(
+    params: L1SwapRouterExactOutputSingleParams,
+  ): string {
+    return new Interface(SWAP_ROUTER_ABI).encodeFunctionData(
+      "exactOutputSingle",
+      [params],
+    );
+  }
+
+  l1LegacySwapRouterExactOutputSingle(
+    params: L1LegacySwapRouterExactOutputSingleParams,
+  ): string {
+    return new Interface(SWAP_LEGACY_ROUTER_ABI).encodeFunctionData(
+      "exactOutputSingle",
+      [params],
+    );
+  }
+
+  beneficiaryMultiAddress(beneficiary: string): MultiAddressStruct {
+    const abi = AbiCoder.defaultAbiCoder();
+    let kind: number;
+    if (/^0x[a-fA-F0-9]{40}$/.test(beneficiary)) {
+      kind = 2;
+    } else if (/^0x[a-fA-F0-9]{64}$/.test(beneficiary)) {
+      kind = 1;
+    } else {
+      throw new Error("Unknown Beneficiary address format.");
+    }
+    let data: string;
+    switch (kind) {
+      case 1:
+        data = abi.encode(["bytes32"], [beneficiary]);
+        break;
+      case 2:
+        data = abi.encode(["bytes20"], [beneficiary]);
+        break;
+      default:
+        throw new Error(`Unknown Beneficiary kind {kind}.`);
+    }
+    return { kind, data };
+  }
+
+  async estimateGas(
+    provider: AbstractProvider,
+    tx: ContractTransaction,
+  ): Promise<bigint> {
+    return await provider.estimateGas(tx);
+  }
+
+  async getTransactionCount(
+    provider: AbstractProvider,
+    address: string,
+    blockTag: "latest" | "pending" = "latest",
+  ): Promise<number> {
+    return await provider.getTransactionCount(address, blockTag);
+  }
+
+  async getBalance(
+    provider: AbstractProvider,
+    address: string,
+  ): Promise<bigint> {
+    return await provider.getBalance(address);
+  }
+
+  async getFeeData(provider: AbstractProvider): Promise<FeeData> {
+    const feeData: EthersFeeData = await provider.getFeeData();
+    return {
+      gasPrice: feeData.gasPrice ?? null,
+      maxFeePerGas: feeData.maxFeePerGas ?? null,
+      maxPriorityFeePerGas: feeData.maxPriorityFeePerGas ?? null,
+    };
+  }
+
+  parseUnits(value: string, decimals: number): bigint {
+    return parseUnits(value, decimals);
+  }
+
+  async gatewayOperatingMode(
+    gateway: Contract & (IGatewayV1 | IGatewayV2),
+  ): Promise<bigint> {
+    return BigInt(await gateway.operatingMode());
+  }
+
+  async gatewayChannelOperatingModeOf(
+    gateway: Contract & IGatewayV1,
+    channelId: string,
+  ): Promise<bigint> {
+    return BigInt(await gateway.channelOperatingModeOf(channelId));
+  }
+
+  async isContractAddress(
+    provider: AbstractProvider,
+    address: string,
+  ): Promise<boolean> {
+    if (!/^0x[a-fA-F0-9]{40}$/.test(address)) {
+      return false;
+    }
+    try {
+      const code = await provider.getCode(address);
+      return code !== "0x";
+    } catch {
+      return false;
+    }
+  }
+
+  scanGatewayV1OutboundMessageAccepted(
+    receipt: TransactionReceipt,
+  ): GatewayV1OutboundMessageAccepted | null {
+    for (const log of receipt.logs) {
+      try {
+        const event = EthersEthereumProvider.gatewayV1Interface.parseLog({
+          topics: [...log.topics],
+          data: log.data,
+        });
+        if (event && event.name === "OutboundMessageAccepted") {
+          return {
+            channelId: String(event.args[0]),
+            nonce: BigInt(event.args[1]),
+            messageId: String(event.args[2]),
+            blockHash: receipt.blockHash,
+            blockNumber: receipt.blockNumber,
+            txHash: receipt.hash,
+            txIndex: receipt.index,
+          };
+        }
+      } catch {}
+    }
+    return null;
+  }
+
+  scanGatewayV2OutboundMessageAccepted(
+    receipt: TransactionReceipt,
+  ): GatewayV2OutboundMessageAccepted | null {
+    for (const log of receipt.logs) {
+      try {
+        const event = EthersEthereumProvider.gatewayV2Interface.parseLog({
+          topics: [...log.topics],
+          data: log.data,
+        });
+        if (event && event.name === "OutboundMessageAccepted") {
+          const payload = event.args[1];
+          return {
+            nonce: BigInt(event.args[0]),
+            payload: {
+              origin: String(payload.origin),
+              assets: payload.assets.map((asset: MultiAddressStruct) => [
+                Number(asset.kind),
+                String(asset.data),
+              ]),
+              xcm: [Number(payload.xcm.kind), String(payload.xcm.data)],
+              claimer: String(payload.claimer),
+              value: BigInt(payload.value),
+              executionFee: BigInt(payload.executionFee),
+              relayerFee: BigInt(payload.relayerFee),
+            },
+            blockHash: receipt.blockHash,
+            blockNumber: receipt.blockNumber,
+            txHash: receipt.hash,
+            txIndex: receipt.index,
+          };
+        }
+      } catch {}
+    }
+    return null;
+  }
+}

package/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "target": "es2021",
+    "module": "commonjs",
+    "strict": true,
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "dist",
+    "allowSyntheticDefaultImports": true,
+    "declaration": true,
+    "declarationMap": true,
+    "baseUrl": ".",
+    "rootDir": "src",
+    "noEmitOnError": true,
+    "skipLibCheck": true,
+    "allowJs": true
+  },
+  "ts-node": {
+    "require": ["tsconfig-paths/register"]
+  },
+  "exclude": ["node_modules", "dist"],
+  "include": ["src/**/*.ts"],
+  "references": []
+}