From 9b80dff49338a83482475284b7bd9f3ea81672c0 Mon Sep 17 00:00:00 2001 From: Milan Steiner <69144826+msteiner96@users.noreply.github.com> Date: Tue, 22 Feb 2022 11:43:16 +0100 Subject: [PATCH] Rename launchpadledger (#1056) * Rename LaunchpadLedger to LedgerConnector * Added changelog entry * Update CHANGELOG.md Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com> * Rename property ledger to connector Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com> --- CHANGELOG.md | 2 ++ packages/ledger-amino/src/index.ts | 2 +- .../{launchpadledger.ts => ledgerconnector.ts} | 6 +++--- packages/ledger-amino/src/ledgersigner.ts | 16 ++++++++-------- 4 files changed, 14 insertions(+), 12 deletions(-) rename packages/ledger-amino/src/{launchpadledger.ts => ledgerconnector.ts} (98%) diff --git a/CHANGELOG.md b/CHANGELOG.md index bab4dccb7d..e084e52d2a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -36,8 +36,10 @@ and this project adheres to you if multiple different protobuf type URLs map to the same Amino type identifier which should not be the case anyways. - @cosmjs/stargate: Added support for slashing queries ([#927]) +- @cosmjs/ledger-amino: Renamed `LaunchpadLedger` to `LedgerConnector` ([#955]) [#927]: https://github.com/cosmos/cosmjs/issues/927 +[#955]: https://github.com/cosmos/cosmjs/issues/955 [#989]: https://github.com/cosmos/cosmjs/issues/989 [#994]: https://github.com/cosmos/cosmjs/issues/994 [#1011]: https://github.com/cosmos/cosmjs/issues/1011 diff --git a/packages/ledger-amino/src/index.ts b/packages/ledger-amino/src/index.ts index 4261666b99..a0102ed080 100644 --- a/packages/ledger-amino/src/index.ts +++ b/packages/ledger-amino/src/index.ts @@ -1,2 +1,2 @@ -export { AddressAndPubkey, LaunchpadLedger } from "./launchpadledger"; +export { AddressAndPubkey, LedgerConnector } from "./ledgerconnector"; export { LedgerSigner } from "./ledgersigner"; diff --git a/packages/ledger-amino/src/launchpadledger.ts b/packages/ledger-amino/src/ledgerconnector.ts similarity index 98% rename from packages/ledger-amino/src/launchpadledger.ts rename to packages/ledger-amino/src/ledgerconnector.ts index 40831ef12f..94173d939f 100644 --- a/packages/ledger-amino/src/launchpadledger.ts +++ b/packages/ledger-amino/src/ledgerconnector.ts @@ -28,7 +28,7 @@ const cosmosBech32Prefix = "cosmos"; const cosmosLedgerAppName = "Cosmos"; const requiredCosmosAppVersion = "1.5.3"; -export interface LaunchpadLedgerOptions { +export interface LedgerConnectorOptions { readonly hdPaths?: readonly HdPath[]; readonly prefix?: string; readonly testModeAllowed?: boolean; @@ -57,7 +57,7 @@ export interface AddressAndPubkey { readonly pubkey: Secp256k1Pubkey; } -export class LaunchpadLedger { +export class LedgerConnector { private readonly testModeAllowed: boolean; private readonly hdPaths: readonly HdPath[]; private readonly prefix: string; @@ -65,7 +65,7 @@ export class LaunchpadLedger { private readonly minLedgerAppVersion: string; private readonly app: CosmosApp; - public constructor(transport: Transport, options: LaunchpadLedgerOptions = {}) { + public constructor(transport: Transport, options: LedgerConnectorOptions = {}) { const defaultOptions = { hdPaths: [cosmosHdPath], prefix: cosmosBech32Prefix, diff --git a/packages/ledger-amino/src/ledgersigner.ts b/packages/ledger-amino/src/ledgersigner.ts index 7ed6d80a5e..2fa85edc51 100644 --- a/packages/ledger-amino/src/ledgersigner.ts +++ b/packages/ledger-amino/src/ledgersigner.ts @@ -10,25 +10,25 @@ import { import { HdPath } from "@cosmjs/crypto"; import Transport from "@ledgerhq/hw-transport"; -import { AddressAndPubkey, LaunchpadLedger, LaunchpadLedgerOptions } from "./launchpadledger"; +import { AddressAndPubkey, LedgerConnector, LedgerConnectorOptions } from "./ledgerconnector"; export class LedgerSigner implements OfflineAminoSigner { - private readonly ledger: LaunchpadLedger; + private readonly connector: LedgerConnector; private readonly hdPaths: readonly HdPath[]; private accounts?: readonly AccountData[]; - public constructor(transport: Transport, options: LaunchpadLedgerOptions = {}) { + public constructor(transport: Transport, options: LedgerConnectorOptions = {}) { this.hdPaths = options.hdPaths || [makeCosmoshubPath(0)]; - this.ledger = new LaunchpadLedger(transport, options); + this.connector = new LedgerConnector(transport, options); } public async getAccounts(): Promise { if (!this.accounts) { - const pubkeys = await this.ledger.getPubkeys(); + const pubkeys = await this.connector.getPubkeys(); this.accounts = await Promise.all( pubkeys.map(async (pubkey) => ({ algo: "secp256k1" as const, - address: await this.ledger.getCosmosAddress(pubkey), + address: await this.connector.getCosmosAddress(pubkey), pubkey: pubkey, })), ); @@ -46,7 +46,7 @@ export class LedgerSigner implements OfflineAminoSigner { * @param path The HD path to show the address for. If unset, this is the first account. */ public async showAddress(path?: HdPath): Promise { - return this.ledger.showAddress(path); + return this.connector.showAddress(path); } public async signAmino(signerAddress: string, signDoc: StdSignDoc): Promise { @@ -60,7 +60,7 @@ export class LedgerSigner implements OfflineAminoSigner { const message = serializeSignDoc(signDoc); const accountForAddress = accounts[accountIndex]; const hdPath = this.hdPaths[accountIndex]; - const signature = await this.ledger.sign(message, hdPath); + const signature = await this.connector.sign(message, hdPath); return { signed: signDoc, signature: encodeSecp256k1Signature(accountForAddress.pubkey, signature),