CU-86dtu8ra6 - NEON3 - Ledger - MultiAccount support

common/changes/@cityofzion/blockchain-service/CU-86dtu8ra6_2024-07-11-23-11.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@cityofzion/blockchain-service",
+      "comment": "Adapt interfaces to support ledger multi account",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@cityofzion/blockchain-service"
+}

common/changes/@cityofzion/bs-ethereum/CU-86dtu8ra6_2024-07-11-23-11.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@cityofzion/bs-ethereum",
+      "comment": "Add support to ledger multi account",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@cityofzion/bs-ethereum"
+}

common/changes/@cityofzion/bs-neo-legacy/CU-86dtu8ra6_2024-07-11-23-11.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@cityofzion/bs-neo-legacy",
+      "comment": "Remove AccountWithDerivationPath type",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@cityofzion/bs-neo-legacy"
+}

common/changes/@cityofzion/bs-neo3/CU-86dtu8ra6_2024-07-11-23-11.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@cityofzion/bs-neo3",
+      "comment": "Add support to ledger multi account",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@cityofzion/bs-neo3"
+}

packages/blockchain-service/src/BSAggregator.ts

@@ -1,4 +1,4 @@
-import { AccountWithDerivationPath, BlockchainService, PartialNetwork } from './interfaces'
+import { Account, BlockchainService, PartialNetwork } from './interfaces'
 
 export class BSAggregator<
   BSCustomName extends string = string,
@@ -55,12 +55,12 @@ export class BSAggregator<
   async generateAccountFromMnemonicAllBlockchains(
     mnemonic: string,
     skippedAddresses?: string[]
-  ): Promise<Map<BSCustomName, AccountWithDerivationPath[]>> {
-    const mnemonicAccounts = new Map<BSCustomName, AccountWithDerivationPath[]>()
+  ): Promise<Map<BSCustomName, Account[]>> {
+    const mnemonicAccounts = new Map<BSCustomName, Account[]>()
 
     const promises = this.#blockchainServices.map(async service => {
       let index = 0
-      const accounts: AccountWithDerivationPath[] = []
+      const accounts: Account[] = []
       let hasError = false
 
       while (!hasError) {

packages/blockchain-service/src/interfaces.ts

@@ -5,10 +5,9 @@ export type Account = {
   key: string
   type: 'wif' | 'privateKey' | 'publicKey'
   address: string
+  derivationIndex?: number
 }
-export type AccountWithDerivationPath = Account & {
-  derivationPath: string
-}
+
 export interface Token {
   symbol: string
   name: string
@@ -52,7 +51,7 @@ export interface BlockchainService<BSCustomName extends string = string, BSAvail
   tokens: Token[]
   network: Network<BSAvailableNetworks>
   setNetwork: (partialNetwork: PartialNetwork<BSAvailableNetworks>) => void
-  generateAccountFromMnemonic(mnemonic: string | string, index: number): AccountWithDerivationPath
+  generateAccountFromMnemonic(mnemonic: string | string, index: number): Account
   generateAccountFromKey(key: string): Account
   decrypt(keyOrJson: string, password: string): Promise<Account>
   encrypt(key: string, password: string): Promise<string>
@@ -243,8 +242,8 @@ export type LedgerServiceEmitter = TypedEmitter<{
 export interface LedgerService {
   emitter: LedgerServiceEmitter
   getLedgerTransport?: (account: Account) => Promise<Transport>
-  getAddress(transport: Transport): Promise<string>
-  getPublicKey(transport: Transport): Promise<string>
+  getAccounts(transport: Transport): Promise<Account[]>
+  getAccount(transport: Transport, index: number): Promise<Account>
 }
 
 export type SwapRoute = {

packages/bs-ethereum/package.json

@@ -11,7 +11,7 @@
   ],
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
-    "test": "jest --config jest.config.ts",
+    "test": "jest --verbose --config jest.config.ts",
     "lint": "eslint .",
     "format": "eslint --fix"
   },

packages/bs-ethereum/src/BSEthereum.ts

@@ -1,6 +1,5 @@
 import {
   Account,
-  AccountWithDerivationPath,
   BSCalculableFee,
   BSWithLedger,
   BSWithNameService,
@@ -58,7 +57,7 @@ export class BSEthereum<BSCustomName extends string = string>
     getLedgerTransport?: (account: Account) => Promise<Transport>
   ) {
     this.blockchainName = blockchainName
-    this.ledgerService = new LedgerServiceEthereum(getLedgerTransport)
+    this.ledgerService = new LedgerServiceEthereum(this.blockchainDataService, getLedgerTransport)
     this.derivationPath = DERIVATION_PATH
     this.tokens = [NATIVE_ASSET_BY_NETWORK_ID[network.id]]
     this.feeToken = NATIVE_ASSET_BY_NETWORK_ID[network.id]
@@ -107,15 +106,15 @@ export class BSEthereum<BSCustomName extends string = string>
     return true
   }
 
-  generateAccountFromMnemonic(mnemonic: string[] | string, index: number): AccountWithDerivationPath {
+  generateAccountFromMnemonic(mnemonic: string[] | string, index: number): Account {
     const path = this.derivationPath.replace('?', index.toString())
     const wallet = ethers.Wallet.fromMnemonic(Array.isArray(mnemonic) ? mnemonic.join(' ') : mnemonic, path)
 
     return {
       address: wallet.address,
       key: wallet.privateKey,
       type: 'privateKey',
-      derivationPath: path,
+      derivationIndex: index,
     }
   }
 
@@ -153,22 +152,7 @@ export class BSEthereum<BSCustomName extends string = string>
   }
 
   async transfer(param: TransferParam): Promise<string> {
-    const provider = new ethers.providers.JsonRpcProvider(this.network.url)
-
-    let ledgerTransport: Transport | undefined
-
-    if (param.isLedger) {
-      if (!this.ledgerService.getLedgerTransport)
-        throw new Error('You must provide getLedgerTransport function to use Ledger')
-      ledgerTransport = await this.ledgerService.getLedgerTransport(param.senderAccount)
-    }
-
-    let signer: ethers.Signer
-    if (ledgerTransport) {
-      signer = new LedgerSigner(ledgerTransport, provider)
-    } else {
-      signer = new ethers.Wallet(param.senderAccount.key, provider)
-    }
+    const signer = await this.#generateSigner(param.senderAccount, param.isLedger)
 
     const decimals = param.intent.tokenDecimals ?? 18
     const amount = ethersBigNumber.parseFixed(param.intent.amount, decimals)
@@ -196,20 +180,7 @@ export class BSEthereum<BSCustomName extends string = string>
   async calculateTransferFee(param: TransferParam): Promise<string> {
     const provider = new ethers.providers.JsonRpcProvider(this.network.url)
 
-    let ledgerTransport: Transport | undefined
-
-    if (param.isLedger) {
-      if (!this.ledgerService.getLedgerTransport)
-        throw new Error('You must provide getLedgerTransport function to use Ledger')
-      ledgerTransport = await this.ledgerService.getLedgerTransport(param.senderAccount)
-    }
-
-    let signer: ethers.Signer
-    if (ledgerTransport) {
-      signer = new LedgerSigner(ledgerTransport, provider)
-    } else {
-      signer = new ethers.Wallet(param.senderAccount.key, provider)
-    }
+    const signer = await this.#generateSigner(param.senderAccount, param.isLedger)
 
     const gasPrice = await provider.getGasPrice()
 
@@ -243,4 +214,21 @@ export class BSEthereum<BSCustomName extends string = string>
     if (!address) throw new Error('No address found for domain name')
     return address
   }
+
+  async #generateSigner(account: Account, isLedger?: boolean): Promise<ethers.Signer> {
+    const provider = new ethers.providers.JsonRpcProvider(this.network.url)
+
+    if (isLedger) {
+      if (!this.ledgerService.getLedgerTransport)
+        throw new Error('You must provide getLedgerTransport function to use Ledger')
+
+      if (typeof account.derivationIndex !== 'number')
+        throw new Error('Your account must have derivationIndex to use Ledger')
+
+      const ledgerTransport = await this.ledgerService.getLedgerTransport(account)
+      return new LedgerSigner(ledgerTransport, account.derivationIndex, provider)
+    }
+
+    return new ethers.Wallet(account.key, provider)
+  }
 }