-
Notifications
You must be signed in to change notification settings - Fork 146
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for latest ledger app #1925
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TarikGul
commented
Jul 10, 2024
bee344
approved these changes
Jul 12, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great job
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR focuses on giving
@polkadot/hw-ledger
the most recent support for the new ledger app -PolkadotGenericApp
. This required a lot of large changes from the originalLedger
class that was exposed. To avoid any breaking changes for legacy users we have created a new class calledLedgerGeneric
which focuses on the new changes and implements thePolkadotGenericApp
. The interface has additions and major changes to the args that were accepted previously. Below I will lay out the new changes and how they work.BREAKING CHANGE This PR
deprecates
class Ledger
.Whats New?
class LedgerGeneric
Initializing
new LedgerGeneric(transport: TransportType, chain: Chain, slip44: number, chainId?: string, metaUrl?: string): Promise<LedgerAddress>
:chainId
andmetaUrl
work together when you want to leverage atxMetadataSvrUrl
within Zondax/ledger-substrate-js. This is specific for usingsign
andsignRaw
.When you want to use your own metadata you can use
signWithMetadata
.getAddress
public async getAddress (ss58Prefix: number, confirm = false, accountIndex = 0, addressOffset = 0): Promise<LedgerVersion>
:sign
public async sign (message: Uint8Array, accountIndex?: number, addressOffset?: number): Promise<LedgerSignature>
:signRaw
public async signRaw (message: Uint8Array, accountIndex?: number, addressOffset?: number): Promise<LedgerSignature>
:signWithMetadata
public async signWithMetadata (message: Uint8Array, accountIndex?: number, addressOffset?: number, options?: Partial<AccountOptionsGeneric>): Promise<LedgerSignature>