@getpara/ethers-v6-integration 0.1.0

package/dist/cjs/ethersSigner.js

@@ -0,0 +1,116 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParaEthersSigner = void 0;
+const ethers_1 = require("ethers");
+const core_sdk_1 = require("@getpara/core-sdk");
+class ParaEthersSigner extends ethers_1.ethers.AbstractSigner {
+    /**
+     * Signs a message.
+     *
+     * @param para - the ParaCore instance
+     * @param provider - the ethers provider to use. If not present, will use the default ethers.Provider.
+     * @param walletId - optional wallet ID to use. If not present, will use the first wallet found.
+     * @param messageSigningTimeoutMs - optional timeout in milliseconds. If not present, defaults to 30 seconds.
+     **/
+    constructor(para, provider, walletId, messageSigningTimeoutMs) {
+        super(provider);
+        this.currentWalletId = para.findWalletId(walletId, { type: ['EVM'] });
+        this.para = para;
+        this.messageSigningTimeoutMs = messageSigningTimeoutMs;
+    }
+    getAddress() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.para.wallets[this.currentWalletId].address;
+        });
+    }
+    connect(provider) {
+        return new ParaEthersSigner(this.para, provider, this.currentWalletId);
+    }
+    /**
+     * Signs a message.
+     *
+     * @param message - the message to be signed
+     **/
+    signMessage(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const hashedMessage = ethers_1.ethers.hashMessage(message);
+            const base64HashedMessage = (0, core_sdk_1.hexStringToBase64)(hashedMessage);
+            const res = yield this.para.signMessage({
+                walletId: this.currentWalletId,
+                messageBase64: base64HashedMessage,
+                timeoutMs: this.messageSigningTimeoutMs,
+            });
+            const signature = res.signature;
+            return `0x${signature}`;
+        });
+    }
+    validateTx(tx) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { to, from } = yield ethers_1.ethers.resolveProperties({
+                to: tx.to ? ethers_1.ethers.resolveAddress(tx.to, this.provider) : undefined,
+                from: tx.from ? ethers_1.ethers.resolveAddress(tx.from, this.provider) : undefined,
+            });
+            if (to) {
+                tx.to = to;
+            }
+            if (from) {
+                tx.from = from;
+            }
+            if (tx.from) {
+                ethers_1.ethers.assertArgument(ethers_1.ethers.getAddress(tx.from).toLowerCase() === (yield this.getAddress()).toLowerCase(), 'transaction from address mismatch', 'tx.from', tx.from);
+                delete tx.from;
+            }
+            return ethers_1.ethers.Transaction.from(tx);
+        });
+    }
+    signTransaction(tx) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const txObj = yield this.validateTx(tx);
+            txObj.signature = {
+                r: '0x0',
+                s: '0x0',
+                v: 0,
+            };
+            const res = yield this.para.signTransaction({
+                walletId: this.currentWalletId,
+                rlpEncodedTxBase64: (0, core_sdk_1.hexStringToBase64)(txObj.serialized),
+                chainId: `${txObj.chainId}`,
+            });
+            const signature = res.signature;
+            const btx = ethers_1.ethers.Transaction.from(tx);
+            btx.signature = `0x${signature}`;
+            return btx.serialized;
+        });
+    }
+    signTypedData(domain, types, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const populated = yield ethers_1.ethers.TypedDataEncoder.resolveNames(domain, types, value, (name) => __awaiter(this, void 0, void 0, function* () {
+                ethers_1.ethers.assert(this.provider != null, 'cannot resolve ENS names without a provider', 'UNSUPPORTED_OPERATION', {
+                    operation: 'resolveName',
+                    info: { name },
+                });
+                const address = yield this.provider.resolveName(name);
+                ethers_1.ethers.assert(address != null, 'unconfigured ENS name', 'UNCONFIGURED_NAME', {
+                    value: name,
+                });
+                return address;
+            }));
+            const res = yield this.para.signMessage({
+                walletId: this.currentWalletId,
+                messageBase64: (0, core_sdk_1.hexStringToBase64)(ethers_1.ethers.TypedDataEncoder.hash(populated.domain, types, populated.value)),
+            });
+            const signature = res.signature;
+            return `0x${signature}`;
+        });
+    }
+}
+exports.ParaEthersSigner = ParaEthersSigner;

package/dist/cjs/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./ethersSigner.js"), exports);

package/dist/cjs/package.json

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

package/dist/esm/ethersSigner.js

@@ -0,0 +1,112 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { ethers } from 'ethers';
+import { hexStringToBase64 } from '@getpara/core-sdk';
+export class ParaEthersSigner extends ethers.AbstractSigner {
+    /**
+     * Signs a message.
+     *
+     * @param para - the ParaCore instance
+     * @param provider - the ethers provider to use. If not present, will use the default ethers.Provider.
+     * @param walletId - optional wallet ID to use. If not present, will use the first wallet found.
+     * @param messageSigningTimeoutMs - optional timeout in milliseconds. If not present, defaults to 30 seconds.
+     **/
+    constructor(para, provider, walletId, messageSigningTimeoutMs) {
+        super(provider);
+        this.currentWalletId = para.findWalletId(walletId, { type: ['EVM'] });
+        this.para = para;
+        this.messageSigningTimeoutMs = messageSigningTimeoutMs;
+    }
+    getAddress() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.para.wallets[this.currentWalletId].address;
+        });
+    }
+    connect(provider) {
+        return new ParaEthersSigner(this.para, provider, this.currentWalletId);
+    }
+    /**
+     * Signs a message.
+     *
+     * @param message - the message to be signed
+     **/
+    signMessage(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const hashedMessage = ethers.hashMessage(message);
+            const base64HashedMessage = hexStringToBase64(hashedMessage);
+            const res = yield this.para.signMessage({
+                walletId: this.currentWalletId,
+                messageBase64: base64HashedMessage,
+                timeoutMs: this.messageSigningTimeoutMs,
+            });
+            const signature = res.signature;
+            return `0x${signature}`;
+        });
+    }
+    validateTx(tx) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { to, from } = yield ethers.resolveProperties({
+                to: tx.to ? ethers.resolveAddress(tx.to, this.provider) : undefined,
+                from: tx.from ? ethers.resolveAddress(tx.from, this.provider) : undefined,
+            });
+            if (to) {
+                tx.to = to;
+            }
+            if (from) {
+                tx.from = from;
+            }
+            if (tx.from) {
+                ethers.assertArgument(ethers.getAddress(tx.from).toLowerCase() === (yield this.getAddress()).toLowerCase(), 'transaction from address mismatch', 'tx.from', tx.from);
+                delete tx.from;
+            }
+            return ethers.Transaction.from(tx);
+        });
+    }
+    signTransaction(tx) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const txObj = yield this.validateTx(tx);
+            txObj.signature = {
+                r: '0x0',
+                s: '0x0',
+                v: 0,
+            };
+            const res = yield this.para.signTransaction({
+                walletId: this.currentWalletId,
+                rlpEncodedTxBase64: hexStringToBase64(txObj.serialized),
+                chainId: `${txObj.chainId}`,
+            });
+            const signature = res.signature;
+            const btx = ethers.Transaction.from(tx);
+            btx.signature = `0x${signature}`;
+            return btx.serialized;
+        });
+    }
+    signTypedData(domain, types, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const populated = yield ethers.TypedDataEncoder.resolveNames(domain, types, value, (name) => __awaiter(this, void 0, void 0, function* () {
+                ethers.assert(this.provider != null, 'cannot resolve ENS names without a provider', 'UNSUPPORTED_OPERATION', {
+                    operation: 'resolveName',
+                    info: { name },
+                });
+                const address = yield this.provider.resolveName(name);
+                ethers.assert(address != null, 'unconfigured ENS name', 'UNCONFIGURED_NAME', {
+                    value: name,
+                });
+                return address;
+            }));
+            const res = yield this.para.signMessage({
+                walletId: this.currentWalletId,
+                messageBase64: hexStringToBase64(ethers.TypedDataEncoder.hash(populated.domain, types, populated.value)),
+            });
+            const signature = res.signature;
+            return `0x${signature}`;
+        });
+    }
+}

package/dist/esm/index.js

@@ -0,0 +1 @@
+export * from './ethersSigner.js';

package/dist/esm/package.json

@@ -0,0 +1 @@
+{"type":"module","sideEffects":false}

package/dist/types/ethersSigner.d.ts

@@ -0,0 +1,27 @@
+import { ethers } from 'ethers';
+import ParaCore from '@getpara/core-sdk';
+export declare class ParaEthersSigner extends ethers.AbstractSigner {
+    private para;
+    private currentWalletId;
+    private messageSigningTimeoutMs?;
+    /**
+     * Signs a message.
+     *
+     * @param para - the ParaCore instance
+     * @param provider - the ethers provider to use. If not present, will use the default ethers.Provider.
+     * @param walletId - optional wallet ID to use. If not present, will use the first wallet found.
+     * @param messageSigningTimeoutMs - optional timeout in milliseconds. If not present, defaults to 30 seconds.
+     **/
+    constructor(para: ParaCore, provider?: null | ethers.Provider, walletId?: string, messageSigningTimeoutMs?: number);
+    getAddress(): Promise<string>;
+    connect(provider: ethers.Provider | null): ParaEthersSigner;
+    /**
+     * Signs a message.
+     *
+     * @param message - the message to be signed
+     **/
+    signMessage(message: string | Uint8Array): Promise<string>;
+    private validateTx;
+    signTransaction(tx: ethers.TransactionRequest): Promise<string>;
+    signTypedData(domain: ethers.TypedDataDomain, types: Record<string, Array<ethers.TypedDataField>>, value: Record<string, any>): Promise<string>;
+}

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from './ethersSigner.js';

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@getpara/ethers-v6-integration",
+  "version": "0.1.0",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "typings": "dist/types/index.d.ts",
+  "sideEffects": false,
+  "dependencies": {
+    "@getpara/core-sdk": "0.1.0"
+  },
+  "scripts": {
+    "build": "yarn build:cjs && yarn build:esm && yarn build:types",
+    "build:cjs": "rm -rf dist/cjs && tsc --module commonjs --outDir dist/cjs && printf '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
+    "build:esm": "rm -rf dist/esm && tsc --module es6 --outDir dist/esm && printf '{\"type\":\"module\",\"sideEffects\":false}' > dist/esm/package.json",
+    "build:types": "rm -rf dist/types && tsc --module es6 --declarationDir dist/types --emitDeclarationOnly --declaration"
+  },
+  "devDependencies": {
+    "ethers": "6.x",
+    "typescript": "5.1.6"
+  },
+  "peerDependencies": {
+    "ethers": "6.x"
+  },
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "gitHead": "625aaa94001a5461dcde8d6775c3b73f3862c76c"
+}