Add TerraLedgerWallet

Author: alecande11

README.md

@@ -26,6 +26,9 @@ wallet
   .then(({ address }) => console.log(address))
 ```
 
+> If you are using `TerraLedgerWallet` you can specify more options on the connect function, to select a custom derivation index (default is 0) and to use bluetooth (default is USB)
+ 
+
 Get the balance (wallet must be already connected):
 ```js
 wallet
@@ -67,11 +70,12 @@ wallet
   })
 ```
 
-> You can use the same functions on the `KeplrWallet` and `MetaMaskWallet` to send a tx from those wallets
+> You can use the same functions on the `TerraLedgerWallet`,`KeplrWallet` and `MetaMaskWallet` to send a tx from those wallets
 > 
 > You can find more info about the available functions on the [Wallet inteface](/src/wallets/Wallet.ts#25)
 
 
+
 ## Coming soon
 
 - More IBC chains

package/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@terra-money/bridge-sdk",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.2",
   "description": "",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -41,8 +41,13 @@
   "dependencies": {
     "@axelar-network/axelarjs-sdk": "^0.11.4",
     "@cosmjs/stargate": "^0.28.11",
+    "@ledgerhq/hw-transport-web-ble": "^6.27.6",
     "@metamask/onboarding": "^1.0.1",
+    "@terra-money/ledger-terra-js": "^1.3.0",
     "@terra-money/terra.js": "^3.1.5",
+    "@walletconnect/core": "^1.8.0",
+    "@walletconnect/iso-crypto": "^1.8.0",
+    "@walletconnect/utils": "^1.8.0",
     "ethers": "^5.6.9"
   }
 }

package/package.json

@@ -2,3 +2,4 @@ export * from './Wallet'
 export * from './station/StationWallet'
 export * from './keplr/KeplrWallet'
 export * from './metamask/MetaMaskWallet'
+export * from './terraLedger/TerraLedgerWallet'

package/src/wallets/index.ts

@@ -0,0 +1,204 @@
+import {
+  Coin,
+  CreateTxOptions,
+  LCDClient,
+  MsgTransfer,
+  Wallet,
+} from '@terra-money/terra.js'
+import { LedgerKey } from "@terra-money/ledger-terra-js"
+import BluetoothTransport from "@ledgerhq/hw-transport-web-ble"
+import { BridgeType } from '../../const/bridges'
+import { ChainType, ibcChannels } from '../../const/chains'
+import { getAxelarDepositAddress } from '../../packages/axelar'
+import { QueryResult, Tx, TxResult, Wallet as WalletInterface } from '../Wallet'
+
+
+export class TerraLedgerWallet implements WalletInterface {
+  private address: string = ''
+  private key: LedgerKey | undefined = undefined
+
+  isSupported(): boolean {
+    // supported on chrome and edge (only on desktop)
+    return (
+      !navigator.userAgent.match(/Android|iPhone/i) &&
+      !!navigator.userAgent.match(/chrome|chromium|edg/i)
+    )
+  }
+
+  isInstalled(): boolean {
+    return true
+  }
+
+  async connect(chain: ChainType, options?: { index?: number, bluetooth?: boolean }): Promise<{ address: string }> {
+    if (!this.supportedChains.includes(chain)) {
+      throw new Error(`${chain} is not supported by ${this.description.name}`)
+    }
+
+    const transport = options?.bluetooth
+      ? await BluetoothTransport.create(120000)
+      : undefined
+
+    const key = await LedgerKey.create(transport, options?.index || 0)
+    const address = (await key.showAddressAndPubKey()).bech32_address
+
+    this.key = key
+    this.address = address
+    return { address }
+  }
+
+  async getBalance(
+    token: string,
+  ): Promise<QueryResult<number>> {
+    if (!this.address) {
+      return {
+        success: false,
+        error: `You must connect the wallet before the query`,
+      }
+    }
+
+    const lcd = new LCDClient({
+      URL: 'https://phoenix-lcd.terra.dev',
+      chainID: 'phoenix-1',
+    })
+
+    if (token.startsWith('terra1')) {
+      const result = (await lcd.wasm.contractQuery(token, {
+        balance: {
+          address: this.address,
+        },
+      })) as {
+        data: {
+          balance: string
+        }
+      }
+
+      return {
+        success: true,
+        data: parseInt(result.data.balance),
+      }
+    } else {
+      const result = await lcd.bank.balance(this.address)
+      const coin = result[0].get(token)
+
+      return {
+        success: true,
+        data: coin?.amount?.toNumber() || 0,
+      }
+    }
+  }
+
+  async transfer(tx: Tx): Promise<TxResult> {
+    if (!this.address || !this.key) {
+      return {
+        success: false,
+        error: `You must connect the wallet before the transfer`,
+      }
+    }
+    if (!this.supportedChains.includes(tx.src)) {
+      return {
+        success: false,
+        error: `${tx.src} is not supported by ${this.description.name}`,
+      }
+    }
+    if (tx.src === tx.dst) {
+      return {
+        success: false,
+        error: `Source chain and destination chain must be different`,
+      }
+    }
+
+    const lcd = new LCDClient({
+      URL: 'https://phoenix-lcd.terra.dev',
+      chainID: 'phoenix-1',
+    })
+    const wallet = new Wallet(lcd, this.key)
+
+    switch (tx.bridge) {
+      case BridgeType.ibc:
+        // @ts-expect-error
+        if (!ibcChannels[tx.src]?.[tx.dst]) {
+          return {
+            success: false,
+            error: `One of the chains is not supported by IBC, select a different bridge`,
+          }
+        }
+
+
+        const ibcTx: CreateTxOptions = {
+          msgs: [
+            new MsgTransfer(
+              'transfer',
+              // @ts-expect-error
+              ibcChannels[tx.src][tx.dst],
+              new Coin(tx.coin.denom, tx.coin.amount),
+              this.address,
+              tx.address,
+              undefined,
+              (Date.now() + 120 * 1000) * 1e6,
+            ),
+          ],
+        }
+
+        const ibcRes = await lcd.tx.broadcastSync(await wallet.createAndSignTx(ibcTx))
+
+        return {
+          success: !!ibcRes.height,
+          txhash: ibcRes.txhash,
+          error: ibcRes.raw_log,
+        }
+
+      case BridgeType.axelar:
+        const depositAddress = await getAxelarDepositAddress(
+          tx.address,
+          tx.src,
+          tx.dst,
+          tx.coin.denom,
+        )
+
+        if (!depositAddress)
+          return {
+            success: false,
+            error: "Can't generate the Axelar deposit address",
+          }
+
+        const axlTx: CreateTxOptions = {
+          msgs: [
+            new MsgTransfer(
+              'transfer',
+              // @ts-expect-error
+              ibcChannels[tx.src]?.axelar,
+              new Coin(tx.coin.denom, tx.coin.amount),
+              this.address,
+              depositAddress,
+              undefined,
+              (Date.now() + 120 * 1000) * 1e6,
+            ),
+          ],
+        }
+
+        const res = await lcd.tx.broadcastSync(await wallet.createAndSignTx(axlTx))
+
+        return {
+          success: !!res.height,
+          txhash: res.txhash,
+          error: res.raw_log,
+        }
+
+      case BridgeType.wormhole:
+        // TODO: handle wormhole
+
+        return {
+          success: false,
+          error: 'wormole is not yet supported',
+        }
+    }
+  }
+
+  supportedChains = [ChainType.terra]
+
+  description = {
+    name: 'Terra Ledger',
+    icon: 'https://assets.terra.money/bridge/ledgerTerra.png',
+    installLink: 'https://ledger.com/',
+  }
+}

package/src/wallets/terraLedger/TerraLedgerWallet.ts

@@ -0,0 +1,59 @@
+import { TerraLedgerWallet, ChainType } from '@terra-money/bridge-sdk'
+import { useState } from 'react'
+
+export default function LedgerTerraWallet() {
+  const [address, setAddress] = useState<string | undefined>()
+  const [balance, setBalance] = useState<number>(0)
+  const wallet = new TerraLedgerWallet()
+
+  return (
+    <section>
+      <h3>
+        <img src={wallet.description.icon} alt={wallet.description.name} />
+        {wallet.description.name}
+      </h3>
+
+      <p>
+        Supported:{' '}
+        {wallet.isSupported() ? (
+          <b className='green'>Yes</b>
+        ) : (
+          <b className='red'>No</b>
+        )}
+      </p>
+      <p>
+        Installed:{' '}
+        {wallet.isInstalled() ? (
+          <b className='green'>Yes</b>
+        ) : (
+          <b className='red'>No</b>
+        )}
+      </p>
+      {address ? (
+        <>
+          <p className='blue'>
+            <b>{address}</b>
+          </p>
+          <p>Balance: {balance} uluna</p>
+        </>
+      ) : (
+        <>
+          <p className='red'>
+            <b>Not connected</b>
+          </p>
+          <button
+            onClick={async () => {
+              setAddress((await wallet.connect(ChainType.terra)).address)
+              const balResult = await wallet.getBalance('uluna')
+              if (balResult.success) {
+                setBalance(balResult.data)
+              }
+            }}
+          >
+            Connect
+          </button>
+        </>
+      )}
+    </section>
+  )
+}

template/package-lock.json

@@ -5,6 +5,7 @@ import './index.css'
 import Keplr from './Keplr'
 import Metamask from './Metamask'
 import Station from './Station'
+import LedgerTerra from './LedgerTerra'
 
 const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement)
 root.render(
@@ -14,6 +15,7 @@ root.render(
       <a href='https://github.com/terra-money/bridge-sdk' target='_blank' rel='noreferrer'>GitHub</a>
     </header>
     <Station />
+    <LedgerTerra />
     <Keplr />
     <Metamask />
   </React.StrictMode>,