@cityofzion/bs-ethereum 1.2.4 → 1.4.0

package/dist/BSEthereum.d.ts

@@ -23,6 +23,6 @@ export declare class BSEthereum<BSCustomName extends string = string> implements
     decrypt(json: string, password: string): Promise<Account>;
     encrypt(key: string, password: string): Promise<string>;
     transfer(param: TransferParam): Promise<string>;
-    calculateTransferFee({ intent }: TransferParam): Promise<string>;
+    calculateTransferFee(param: TransferParam): Promise<string>;
     resolveNameServiceDomain(domainName: string): Promise<string>;
 }

package/dist/BSEthereum.js

@@ -144,13 +144,12 @@ class BSEthereum {
                     throw new Error('You must provide getLedgerTransport function to use Ledger');
                 ledgerTransport = yield this.ledgerService.getLedgerTransport(param.senderAccount);
             }
-            let signTransactionFunction;
+            let signer;
             if (ledgerTransport) {
-                signTransactionFunction = yield this.ledgerService.getSignTransactionFunction(ledgerTransport);
+                signer = new LedgerServiceEthereum_1.LedgerSigner(ledgerTransport, provider);
             }
             else {
-                const wallet = new ethers_1.ethers.Wallet(param.senderAccount.key, provider);
-                signTransactionFunction = wallet.signTransaction.bind(wallet);
+                signer = new ethers_1.ethers.Wallet(param.senderAccount.key, provider);
             }
             const decimals = (_a = param.intent.tokenDecimals) !== null && _a !== void 0 ? _a : 18;
             const amount = ethersBigNumber.parseFixed(param.intent.amount, decimals);
@@ -168,29 +167,39 @@ class BSEthereum {
                 ]);
                 transactionParams = yield contract.populateTransaction.transfer(param.intent.receiverAddress, amount);
             }
-            const voidSigner = new ethers_1.ethers.VoidSigner(param.senderAccount.address, provider);
-            const transaction = yield voidSigner.populateTransaction(transactionParams);
-            const signedTransaction = yield signTransactionFunction(transaction);
-            const transactionResponse = yield provider.sendTransaction(signedTransaction);
-            return transactionResponse.hash;
+            const transaction = yield signer.sendTransaction(transactionParams);
+            return transaction.hash;
         });
     }
-    calculateTransferFee({ intent }) {
+    calculateTransferFee(param) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const provider = new ethers_1.ethers.providers.JsonRpcProvider(this.network.url);
+            let ledgerTransport;
+            if (param.isLedger) {
+                if (!this.ledgerService.getLedgerTransport)
+                    throw new Error('You must provide getLedgerTransport function to use Ledger');
+                ledgerTransport = yield this.ledgerService.getLedgerTransport(param.senderAccount);
+            }
+            let signer;
+            if (ledgerTransport) {
+                signer = new LedgerServiceEthereum_1.LedgerSigner(ledgerTransport, provider);
+            }
+            else {
+                signer = new ethers_1.ethers.Wallet(param.senderAccount.key, provider);
+            }
             const gasPrice = yield provider.getGasPrice();
             let estimated;
-            const isNative = constants_1.NATIVE_ASSETS.some(asset => asset.hash === intent.tokenHash);
-            const decimals = (_a = intent.tokenDecimals) !== null && _a !== void 0 ? _a : 18;
-            const amount = ethersBigNumber.parseFixed(intent.amount, decimals);
+            const isNative = constants_1.NATIVE_ASSETS.some(asset => asset.hash === param.intent.tokenHash);
+            const decimals = (_a = param.intent.tokenDecimals) !== null && _a !== void 0 ? _a : 18;
+            const amount = ethersBigNumber.parseFixed(param.intent.amount, decimals);
             if (!isNative) {
-                const contract = new ethers_1.ethers.Contract(intent.tokenHash, ['function transfer(address to, uint amount) returns (bool)'], provider);
-                estimated = yield contract.estimateGas.transfer(intent.receiverAddress, amount);
+                const contract = new ethers_1.ethers.Contract(param.intent.tokenHash, ['function transfer(address to, uint amount) returns (bool)'], signer);
+                estimated = yield contract.estimateGas.transfer(param.intent.receiverAddress, amount);
             }
             else {
-                estimated = yield provider.estimateGas({
-                    to: intent.receiverAddress,
+                estimated = yield signer.estimateGas({
+                    to: param.intent.receiverAddress,
                     value: amount,
                 });
             }

package/dist/LedgerServiceEthereum.d.ts

@@ -1,11 +1,22 @@
-import { Account, LedgerService } from '@cityofzion/blockchain-service';
+import { Account, LedgerService, LedgerServiceEmitter } from '@cityofzion/blockchain-service';
 import Transport from '@ledgerhq/hw-transport';
-import { ethers } from 'ethers';
-export declare class LedgerServiceEthereum implements LedgerService {
+import { ethers, Signer } from 'ethers';
+import { TypedDataSigner } from '@ethersproject/abstract-signer';
+export declare class LedgerSigner extends Signer implements TypedDataSigner {
     #private;
+    constructor(transport: Transport, provider?: ethers.providers.Provider, emitter?: LedgerServiceEmitter);
+    connect(provider: ethers.providers.Provider): LedgerSigner;
+    getAddress(): Promise<string>;
+    getPublicKey(): Promise<string>;
+    signMessage(message: string | ethers.utils.Bytes): Promise<string>;
+    signTransaction(transaction: ethers.utils.Deferrable<ethers.providers.TransactionRequest>): Promise<string>;
+    _signTypedData(domain: ethers.TypedDataDomain, types: Record<string, ethers.TypedDataField[]>, value: Record<string, any>): Promise<string>;
+}
+export declare class LedgerServiceEthereum implements LedgerService {
     getLedgerTransport?: ((account: Account) => Promise<Transport>) | undefined;
+    emitter: LedgerServiceEmitter;
     constructor(getLedgerTransport?: ((account: Account) => Promise<Transport>) | undefined);
     getAddress(transport: Transport): Promise<string>;
     getPublicKey(transport: Transport): Promise<string>;
-    getSignTransactionFunction(transport: Transport): Promise<(transaction: ethers.providers.TransactionRequest) => Promise<string>>;
+    getSigner(transport: Transport): LedgerSigner;
 }

package/dist/LedgerServiceEthereum.js

@@ -31,51 +31,158 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
 var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _LedgerServiceEthereum_defaultPath;
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _LedgerSigner_instances, _LedgerSigner_transport, _LedgerSigner_emitter, _LedgerSigner_path, _LedgerSigner_retry;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LedgerServiceEthereum = void 0;
+exports.LedgerServiceEthereum = exports.LedgerSigner = void 0;
 const hw_app_eth_1 = __importStar(require("@ledgerhq/hw-app-eth"));
 const ethers_1 = require("ethers");
+const properties_1 = require("@ethersproject/properties");
+const constants_1 = require("./constants");
+const events_1 = __importDefault(require("events"));
+class LedgerSigner extends ethers_1.Signer {
+    constructor(transport, provider, emitter) {
+        super();
+        _LedgerSigner_instances.add(this);
+        _LedgerSigner_transport.set(this, void 0);
+        _LedgerSigner_emitter.set(this, void 0);
+        _LedgerSigner_path.set(this, void 0);
+        __classPrivateFieldSet(this, _LedgerSigner_path, constants_1.DEFAULT_PATH, "f");
+        __classPrivateFieldSet(this, _LedgerSigner_transport, transport, "f");
+        __classPrivateFieldSet(this, _LedgerSigner_emitter, emitter, "f");
+        (0, properties_1.defineReadOnly)(this, 'provider', provider);
+    }
+    connect(provider) {
+        return new LedgerSigner(__classPrivateFieldGet(this, _LedgerSigner_transport, "f"), provider);
+    }
+    getAddress() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const ledgerApp = new hw_app_eth_1.default(__classPrivateFieldGet(this, _LedgerSigner_transport, "f"));
+            const { address } = yield __classPrivateFieldGet(this, _LedgerSigner_instances, "m", _LedgerSigner_retry).call(this, () => ledgerApp.getAddress(__classPrivateFieldGet(this, _LedgerSigner_path, "f")));
+            return ethers_1.ethers.utils.getAddress(address);
+        });
+    }
+    getPublicKey() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const ledgerApp = new hw_app_eth_1.default(__classPrivateFieldGet(this, _LedgerSigner_transport, "f"));
+            const { publicKey } = yield __classPrivateFieldGet(this, _LedgerSigner_instances, "m", _LedgerSigner_retry).call(this, () => ledgerApp.getAddress(__classPrivateFieldGet(this, _LedgerSigner_path, "f")));
+            return '0x' + publicKey;
+        });
+    }
+    signMessage(message) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (typeof message === 'string') {
+                message = ethers_1.ethers.utils.toUtf8Bytes(message);
+            }
+            const ledgerApp = new hw_app_eth_1.default(__classPrivateFieldGet(this, _LedgerSigner_transport, "f"));
+            (_a = __classPrivateFieldGet(this, _LedgerSigner_emitter, "f")) === null || _a === void 0 ? void 0 : _a.emit('getSignatureStart');
+            const obj = yield __classPrivateFieldGet(this, _LedgerSigner_instances, "m", _LedgerSigner_retry).call(this, () => ledgerApp.signPersonalMessage(__classPrivateFieldGet(this, _LedgerSigner_path, "f"), ethers_1.ethers.utils.hexlify(message).substring(2)));
+            (_b = __classPrivateFieldGet(this, _LedgerSigner_emitter, "f")) === null || _b === void 0 ? void 0 : _b.emit('getSignatureEnd');
+            // Normalize the signature for Ethers
+            obj.r = '0x' + obj.r;
+            obj.s = '0x' + obj.s;
+            return ethers_1.ethers.utils.joinSignature(obj);
+        });
+    }
+    signTransaction(transaction) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const ledgerApp = new hw_app_eth_1.default(__classPrivateFieldGet(this, _LedgerSigner_transport, "f"));
+            const tx = yield ethers_1.ethers.utils.resolveProperties(transaction);
+            const unsignedTransaction = Object.assign(Object.assign({}, tx), { nonce: tx.nonce ? ethers_1.ethers.BigNumber.from(transaction.nonce).toNumber() : undefined });
+            const serializedUnsignedTransaction = ethers_1.ethers.utils.serializeTransaction(unsignedTransaction).substring(2);
+            const resolution = yield hw_app_eth_1.ledgerService.resolveTransaction(serializedUnsignedTransaction, {}, {});
+            (_a = __classPrivateFieldGet(this, _LedgerSigner_emitter, "f")) === null || _a === void 0 ? void 0 : _a.emit('getSignatureStart');
+            const signature = yield __classPrivateFieldGet(this, _LedgerSigner_instances, "m", _LedgerSigner_retry).call(this, () => ledgerApp.signTransaction(__classPrivateFieldGet(this, _LedgerSigner_path, "f"), serializedUnsignedTransaction, resolution));
+            (_b = __classPrivateFieldGet(this, _LedgerSigner_emitter, "f")) === null || _b === void 0 ? void 0 : _b.emit('getSignatureEnd');
+            return ethers_1.ethers.utils.serializeTransaction(unsignedTransaction, {
+                v: ethers_1.ethers.BigNumber.from('0x' + signature.v).toNumber(),
+                r: '0x' + signature.r,
+                s: '0x' + signature.s,
+            });
+        });
+    }
+    _signTypedData(domain, types, value) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const populated = yield ethers_1.ethers.utils._TypedDataEncoder.resolveNames(domain, types, value, (name) => __awaiter(this, void 0, void 0, function* () {
+                if (!this.provider)
+                    throw new Error('Cannot resolve ENS names without a provider');
+                const resolved = yield this.provider.resolveName(name);
+                if (!resolved)
+                    throw new Error('No address found for domain name');
+                return resolved;
+            }));
+            const payload = ethers_1.ethers.utils._TypedDataEncoder.getPayload(populated.domain, types, populated.value);
+            const ledgerApp = new hw_app_eth_1.default(__classPrivateFieldGet(this, _LedgerSigner_transport, "f"));
+            (_a = __classPrivateFieldGet(this, _LedgerSigner_emitter, "f")) === null || _a === void 0 ? void 0 : _a.emit('getSignatureStart');
+            const obj = yield __classPrivateFieldGet(this, _LedgerSigner_instances, "m", _LedgerSigner_retry).call(this, () => ledgerApp.signEIP712Message(__classPrivateFieldGet(this, _LedgerSigner_path, "f"), payload));
+            (_b = __classPrivateFieldGet(this, _LedgerSigner_emitter, "f")) === null || _b === void 0 ? void 0 : _b.emit('getSignatureEnd');
+            // Normalize the signature for Ethers
+            obj.r = '0x' + obj.r;
+            obj.s = '0x' + obj.s;
+            return ethers_1.ethers.utils.joinSignature(obj);
+        });
+    }
+}
+exports.LedgerSigner = LedgerSigner;
+_LedgerSigner_transport = new WeakMap(), _LedgerSigner_emitter = new WeakMap(), _LedgerSigner_path = new WeakMap(), _LedgerSigner_instances = new WeakSet(), _LedgerSigner_retry = function _LedgerSigner_retry(callback) {
+    // eslint-disable-next-line no-async-promise-executor
+    return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+        // Wait up to 5 seconds
+        for (let i = 0; i < 50; i++) {
+            try {
+                const result = yield callback();
+                return resolve(result);
+            }
+            catch (error) {
+                if (error.id !== 'TransportLocked') {
+                    return reject(error);
+                }
+            }
+            yield wait(100);
+        }
+        return reject(new Error('timeout'));
+    }));
+};
 class LedgerServiceEthereum {
     constructor(getLedgerTransport) {
         this.getLedgerTransport = getLedgerTransport;
-        _LedgerServiceEthereum_defaultPath.set(this, "44'/60'/0'/0/0");
+        this.emitter = new events_1.default();
     }
     getAddress(transport) {
         return __awaiter(this, void 0, void 0, function* () {
-            const ledgerApp = new hw_app_eth_1.default(transport);
-            const { address } = yield ledgerApp.getAddress(__classPrivateFieldGet(this, _LedgerServiceEthereum_defaultPath, "f"));
-            return address;
+            const signer = new LedgerSigner(transport);
+            return yield signer.getAddress();
         });
     }
     getPublicKey(transport) {
         return __awaiter(this, void 0, void 0, function* () {
-            const ledgerApp = new hw_app_eth_1.default(transport);
-            const { publicKey } = yield ledgerApp.getAddress(__classPrivateFieldGet(this, _LedgerServiceEthereum_defaultPath, "f"));
-            return '0x' + publicKey;
+            const signer = new LedgerSigner(transport);
+            return yield signer.getPublicKey();
         });
     }
-    getSignTransactionFunction(transport) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return (transaction) => __awaiter(this, void 0, void 0, function* () {
-                const ledgerApp = new hw_app_eth_1.default(transport);
-                const unsignedTransaction = Object.assign(Object.assign({}, transaction), { nonce: transaction.nonce ? ethers_1.ethers.BigNumber.from(transaction.nonce).toNumber() : undefined });
-                const serializedUnsignedTransaction = ethers_1.ethers.utils.serializeTransaction(unsignedTransaction).substring(2);
-                const resolution = yield hw_app_eth_1.ledgerService.resolveTransaction(serializedUnsignedTransaction, {}, {});
-                const signature = yield ledgerApp.signTransaction(__classPrivateFieldGet(this, _LedgerServiceEthereum_defaultPath, "f"), serializedUnsignedTransaction, resolution);
-                return ethers_1.ethers.utils.serializeTransaction(unsignedTransaction, {
-                    v: ethers_1.ethers.BigNumber.from('0x' + signature.v).toNumber(),
-                    r: '0x' + signature.r,
-                    s: '0x' + signature.s,
-                });
-            });
-        });
+    getSigner(transport) {
+        return new LedgerSigner(transport, undefined, this.emitter);
     }
 }
 exports.LedgerServiceEthereum = LedgerServiceEthereum;
-_LedgerServiceEthereum_defaultPath = new WeakMap();
+function wait(duration) {
+    return new Promise(resolve => {
+        setTimeout(resolve, duration);
+    });
+}

package/dist/constants.d.ts

@@ -14,3 +14,4 @@ export declare const GHOSTMARKET_CHAIN_BY_NETWORK_TYPE: Partial<Record<NetworkTy
 export declare const DERIVATION_PATH = "m/44'/60'/0'/0/?";
 export declare const RPC_LIST_BY_NETWORK_TYPE: Record<NetworkType, string[]>;
 export declare const DEFAULT_URL_BY_NETWORK_TYPE: Record<NetworkType, string>;
+export declare const DEFAULT_PATH = "44'/60'/0'/0/0";

package/dist/constants.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_URL_BY_NETWORK_TYPE = exports.RPC_LIST_BY_NETWORK_TYPE = exports.DERIVATION_PATH = exports.GHOSTMARKET_CHAIN_BY_NETWORK_TYPE = exports.GHOSTMARKET_URL_BY_NETWORK_TYPE = exports.BITQUERY_MIRROR_NETWORK_BY_NETWORK_TYPE = exports.BITQUERY_MIRROR_URL = exports.NATIVE_ASSETS = exports.TOKENS = void 0;
+exports.DEFAULT_PATH = exports.DEFAULT_URL_BY_NETWORK_TYPE = exports.RPC_LIST_BY_NETWORK_TYPE = exports.DERIVATION_PATH = exports.GHOSTMARKET_CHAIN_BY_NETWORK_TYPE = exports.GHOSTMARKET_URL_BY_NETWORK_TYPE = exports.BITQUERY_MIRROR_NETWORK_BY_NETWORK_TYPE = exports.BITQUERY_MIRROR_URL = exports.NATIVE_ASSETS = exports.TOKENS = void 0;
 const common_json_1 = __importDefault(require("./assets/tokens/common.json"));
 exports.TOKENS = {
     mainnet: [...common_json_1.default],
@@ -49,3 +49,4 @@ exports.DEFAULT_URL_BY_NETWORK_TYPE = {
     testnet: exports.RPC_LIST_BY_NETWORK_TYPE.testnet[0],
     custom: exports.RPC_LIST_BY_NETWORK_TYPE.custom[0],
 };
+exports.DEFAULT_PATH = "44'/60'/0'/0/0";

package/dist/index.d.ts

@@ -4,4 +4,4 @@ export * from './constants';
 export * from './BitqueryBDSEthereum';
 export * from './BitqueryEDSEthereum';
 export * from './RpcBDSEthereum';
-export * from './RpcNDSEthereum';
+export * from './LedgerServiceEthereum';

package/dist/index.js

@@ -20,4 +20,4 @@ __exportStar(require("./constants"), exports);
 __exportStar(require("./BitqueryBDSEthereum"), exports);
 __exportStar(require("./BitqueryEDSEthereum"), exports);
 __exportStar(require("./RpcBDSEthereum"), exports);
-__exportStar(require("./RpcNDSEthereum"), exports);
+__exportStar(require("./LedgerServiceEthereum"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cityofzion/bs-ethereum",
-  "version": "1.2.4",
+  "version": "1.4.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": "https://github.com/CityOfZion/blockchain-services",
@@ -21,7 +21,9 @@
     "@ledgerhq/hw-transport-node-hid": "~6.28.5",
     "@ledgerhq/hw-transport": "~6.30.5",
     "@ledgerhq/hw-app-eth": "~6.35.7",
-    "@cityofzion/blockchain-service": "0.11.2"
+    "@ethersproject/abstract-signer": "~5.7.0",
+    "@ethersproject/properties": "~5.7.0",
+    "@cityofzion/blockchain-service": "0.12.0"
   },
   "devDependencies": {
     "@types/jest": "29.5.3",