@relayprotocol/relay-ethers-wallet-adapter 22.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Reservoir
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,44 @@
+<h3 align="center">Adapted Ethers Wallet Adapter</h3>
+
+### Installation
+
+```
+yarn add @relayprotocol/relay-ethers-wallet-adapter @relayprotocol/relay-sdk
+```
+
+Also make sure to install the peer dependencies required by the adapter if your application doesn't already include them:
+
+```
+yarn add ethers viem @relayprotocol/relay-sdk
+```
+
+### Usage
+
+To use the adapter simply pass in your ethers signer and receive a normalized AdaptedWallet object:
+
+```
+import { getClient } from "@relayprotocol/relay-sdk";
+import { adaptEthersSigner } from "@relayprotocol/relay-ethers-wallet-adapter";
+import { useSigner } from "wagmi";
+
+const { data: signer } = useSigner();
+const wallet = adaptEthersSigner(signer);
+
+const quote = getClient().actions.getQuote({
+  chainId: 7777777,
+  toChainId: 8453,
+  txs: [{ to: "0x30385bce01da4b415cae1db21d41e9f6eab3ba50", value: "1000000" }],
+  wallet: wallet,
+}, true);
+
+getClient().actions.execute({
+  quote: quote,
+  wallet: wallet,
+  onProgress: (steps) => {
+    console.log(steps);
+  },
+});
+
+```
+
+In the code snippet above we use the wagmi `useSigner` method, which is not required, you can create your ethers signer however you wish. We then adapt the signer to the AdaptedWallet object and pass this into any of the SDK methods. Here we pass it into the call method along with the other required parameters.

package/_cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/_cjs/src/adapter.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adaptEthersSigner = void 0;
+const relay_sdk_1 = require("@relayprotocol/relay-sdk");
+const utils_js_1 = require("ethers/lib/utils.js");
+const viem_1 = require("viem");
+const adaptEthersSigner = (signer, transport) => {
+    return {
+        vmType: 'evm',
+        transport,
+        getChainId: () => {
+            return signer.getChainId();
+        },
+        address: async () => {
+            return signer.getAddress();
+        },
+        handleSignMessageStep: async (stepItem) => {
+            const client = (0, relay_sdk_1.getClient)();
+            const signData = stepItem.data?.sign;
+            let signature;
+            if (signData) {
+                if (signData.signatureKind === 'eip191') {
+                    client.log(['Execute Steps: Signing with eip191'], relay_sdk_1.LogLevel.Verbose);
+                    if (signData.message.match(/0x[0-9a-fA-F]{64}/)) {
+                        signature = await signer.signMessage((0, utils_js_1.arrayify)(signData.message));
+                    }
+                    else {
+                        signature = await signer.signMessage(signData.message);
+                    }
+                }
+                else if (signData.signatureKind === 'eip712') {
+                    client.log(['Execute Steps: Signing with eip712'], relay_sdk_1.LogLevel.Verbose);
+                    signature = await signer._signTypedData(signData.domain, signData.types, signData.value);
+                }
+            }
+            return signature;
+        },
+        handleSendTransactionStep: async (_, stepItem) => {
+            const stepData = stepItem.data;
+            const transaction = await signer.sendTransaction({
+                data: stepData.data,
+                to: stepData.to,
+                from: stepData.from,
+                value: (0, viem_1.hexToBigInt)(stepData.value || 0),
+                ...(stepData.maxFeePerGas && {
+                    maxFeePerGas: (0, viem_1.hexToBigInt)(stepData.maxFeePerGas)
+                }),
+                ...(stepData.maxPriorityFeePerGas && {
+                    maxPriorityFeePerGas: (0, viem_1.hexToBigInt)(stepData.maxPriorityFeePerGas)
+                }),
+                ...(stepData.gas && {
+                    gasLimit: (0, viem_1.hexToBigInt)(stepData.gas)
+                })
+            });
+            return transaction.hash;
+        },
+        handleConfirmTransactionStep: async (txHash, chainId, onReplaced, onCancelled) => {
+            const client = (0, relay_sdk_1.getClient)();
+            const chain = client.chains.find((chain) => chain.id === chainId);
+            const viemClient = (0, viem_1.createPublicClient)({
+                chain: chain?.viemChain,
+                transport: transport ? (0, viem_1.fallback)([transport, (0, viem_1.http)()]) : (0, viem_1.http)()
+            });
+            const receipt = await viemClient.waitForTransactionReceipt({
+                hash: txHash,
+                onReplaced: (replacement) => {
+                    if (replacement.reason === 'cancelled') {
+                        onCancelled();
+                        throw Error('Transaction cancelled');
+                    }
+                    onReplaced(replacement.transaction.hash);
+                }
+            });
+            return receipt;
+        },
+        switchChain: (chainId) => {
+            try {
+                return window.ethereum.request({
+                    method: 'wallet_switchEthereumChain',
+                    params: [{ chainId: (0, utils_js_1.hexValue)(chainId) }]
+                });
+            }
+            catch (error) {
+                console.error('Failed to switch chain:', error);
+            }
+        }
+    };
+};
+exports.adaptEthersSigner = adaptEthersSigner;
+//# sourceMappingURL=adapter.js.map

package/_cjs/src/adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../../src/adapter.ts"],"names":[],"mappings":";;;AACA,wDAIiC;AAEjC,kDAAwD;AACxD,+BAQa;AAEN,MAAM,iBAAiB,GAAG,CAC/B,MAAc,EACd,SAA2C,EAC5B,EAAE;IACjB,OAAO;QACL,MAAM,EAAE,KAAK;QACb,SAAS;QACT,UAAU,EAAE,GAAG,EAAE;YACf,OAAO,MAAM,CAAC,UAAU,EAAE,CAAA;QAC5B,CAAC;QACD,OAAO,EAAE,KAAK,IAAI,EAAE;YAClB,OAAO,MAAM,CAAC,UAAU,EAAE,CAAA;QAC5B,CAAC;QACD,qBAAqB,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;YACxC,MAAM,MAAM,GAAG,IAAA,qBAAS,GAAE,CAAA;YAC1B,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;YACpC,IAAI,SAA6B,CAAA;YACjC,IAAI,QAAQ,EAAE,CAAC;gBAEb,IAAI,QAAQ,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;oBACxC,MAAM,CAAC,GAAG,CAAC,CAAC,oCAAoC,CAAC,EAAE,oBAAQ,CAAC,OAAO,CAAC,CAAA;oBACpE,IAAI,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,mBAAmB,CAAC,EAAE,CAAC;wBAEhD,SAAS,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,IAAA,mBAAQ,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAA;oBAClE,CAAC;yBAAM,CAAC;wBACN,SAAS,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;oBACxD,CAAC;gBACH,CAAC;qBAAM,IAAI,QAAQ,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;oBAC/C,MAAM,CAAC,GAAG,CAAC,CAAC,oCAAoC,CAAC,EAAE,oBAAQ,CAAC,OAAO,CAAC,CAAA;oBACpE,SAAS,GAAG,MACV,MACD,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAA;gBACnE,CAAC;YACH,CAAC;YACD,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,yBAAyB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE;YAC/C,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAA;YAC9B,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC;gBAC/C,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,EAAE,EAAE,QAAQ,CAAC,EAAE;gBACf,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,KAAK,EAAE,IAAA,kBAAW,EAAE,QAAQ,CAAC,KAAa,IAAI,CAAC,CAAC;gBAChD,GAAG,CAAC,QAAQ,CAAC,YAAY,IAAI;oBAC3B,YAAY,EAAE,IAAA,kBAAW,EAAC,QAAQ,CAAC,YAAmB,CAAC;iBACxD,CAAC;gBACF,GAAG,CAAC,QAAQ,CAAC,oBAAoB,IAAI;oBACnC,oBAAoB,EAAE,IAAA,kBAAW,EAC/B,QAAQ,CAAC,oBAA2B,CACrC;iBACF,CAAC;gBACF,GAAG,CAAC,QAAQ,CAAC,GAAG,IAAI;oBAClB,QAAQ,EAAE,IAAA,kBAAW,EAAC,QAAQ,CAAC,GAAU,CAAC;iBAC3C,CAAC;aACH,CAAC,CAAA;YAEF,OAAO,WAAW,CAAC,IAAqB,CAAA;QAC1C,CAAC;QACD,4BAA4B,EAAE,KAAK,EACjC,MAAM,EACN,OAAO,EACP,UAAU,EACV,WAAW,EACX,EAAE;YACF,MAAM,MAAM,GAAG,IAAA,qBAAS,GAAE,CAAA;YAC1B,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,OAAO,CAAC,CAAA;YAEjE,MAAM,UAAU,GAAG,IAAA,yBAAkB,EAAC;gBACpC,KAAK,EAAE,KAAK,EAAE,SAAS;gBACvB,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,IAAA,eAAQ,EAAC,CAAC,SAAS,EAAE,IAAA,WAAI,GAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,GAAE;aAC9D,CAAC,CAAA;YAEF,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,yBAAyB,CAAC;gBACzD,IAAI,EAAE,MAAiB;gBACvB,UAAU,EAAE,CAAC,WAAW,EAAE,EAAE;oBAC1B,IAAI,WAAW,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;wBACvC,WAAW,EAAE,CAAA;wBACb,MAAM,KAAK,CAAC,uBAAuB,CAAC,CAAA;oBACtC,CAAC;oBACD,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;gBAC1C,CAAC;aACF,CAAC,CAAA;YAEF,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,WAAW,EAAE,CAAC,OAAe,EAAE,EAAE;YAC/B,IAAI,CAAC;gBACH,OAAQ,MAAc,CAAC,QAAQ,CAAC,OAAO,CAAC;oBACtC,MAAM,EAAE,4BAA4B;oBACpC,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,IAAA,mBAAQ,EAAC,OAAO,CAAC,EAAE,CAAC;iBACzC,CAAC,CAAA;YACJ,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAA;YACjD,CAAC;QACH,CAAC;KACF,CAAA;AACH,CAAC,CAAA;AAhGY,QAAA,iBAAiB,qBAgG7B"}

package/_cjs/src/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./adapter.js"), exports);
+//# sourceMappingURL=index.js.map

package/_cjs/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,uDAA4B"}