added abilities for provider

QEDProtocol · Jun 25, 2024 · 117e46c · 117e46c
1 parent fb32988
commit 117e46c
Show file tree

Hide file tree

Showing 5 changed files with 84 additions and 12 deletions.
diff --git a/docs/ThirdPartyWallets.md b/docs/ThirdPartyWallets.md
@@ -4,26 +4,29 @@ Implementing hardware wallet support for doge-sdk is easy, just implement the in
 
 ```typescript
 
-interface ISignatureResult {
- publicKey: string;
- signature: string;
-}
-
-interface IDogeSignatureRequest {
- transaction: Transaction;
- sigHashType: number;
- inputIndex: number;
-}
 
 interface IDogeTransactionSigner {
  getCompressedPublicKey(): Promise<string>;
  canSignHash(): boolean;
  signHash(hashHex: string): Promise<ISignatureResult>;
  signTransaction(signatureRequest: IDogeSignatureRequest): Promise<ISignatureResult>;
+ getPrivateKeyWIF?(): Promise<string>;
+}
+
+interface IWalletProviderAbilities {
+ addWalletRandom?: boolean;
+ addWalletFromWIF?: boolean;
+ addWalletFromSeed?: boolean;
+ addWalletFromMnemonic?: boolean;
 }
 
 interface IDogeWalletProvider {
  getSigners(): Promise<IDogeTransactionSigner[]>;
+ addWalletRandom?(networkId: DogeNetworkId): Promise<IDogeTransactionSigner>;
+ addWalletBIP39?(networkId: DogeNetworkId, seedPhrase: string, password?: string): Promise<IDogeTransactionSigner>;
+ addWalletBIP44?(networkId: DogeNetworkId, fullDerivationPath: string): Promise<IDogeTransactionSigner>;
+ addWalletBIP178?(networkId: DogeNetworkId, wif: string): Promise<IDogeTransactionSigner>;
+ getAbilities(): IWalletProviderAbilities;
 }
 
 ```
@@ -206,7 +209,7 @@ class LedgerHardwareWalletProvider implements IDogeWalletProvider {
  for (let i = 0; i < numberOfWallets; i++) {
  this.signers.push(
  new LedgerHardwareWalletSigner(
- "44'/0'/" + i + "'/0/0",
+ "44'/3'/" + i + "'/0/0",
  rpc,
  ledgerInstance
  )
@@ -218,6 +221,9 @@ class LedgerHardwareWalletProvider implements IDogeWalletProvider {
  getSigners(): Promise<IDogeTransactionSigner[]> {
  return Promise.resolve(this.signers);
  }
+ getAbilities(): IWalletProviderAbilities {
+ return {};
+ }
 }
 export { LedgerHardwareWalletProvider, LedgerHardwareWalletSigner };
 ```

diff --git a/src/index.ts b/src/index.ts
@@ -57,6 +57,7 @@ export type {
  IDogeWalletSerialized,
  IFullDogeWalletProvider,
  IDogeSignatureRequest,
+ IWalletProviderAbilities,
 } from './wallet/types';
 export * from './wallet';
 

diff --git a/src/wallet/memory/provider.ts b/src/wallet/memory/provider.ts
@@ -1,12 +1,30 @@
 import { DogeNetworkId } from "../../networks/types";
-import { IDogeTransactionSigner, IDogeWalletProvider, IDogeWalletSerialized } from "../types";
+import { IDogeTransactionSigner, IDogeWalletProvider, IDogeWalletSerialized, IWalletProviderAbilities } from "../types";
 import { DogeMemoryWallet } from "./wallet";
 
 class DogeMemoryWalletProvider implements IDogeWalletProvider {
  wallets: DogeMemoryWallet[];
  constructor(wallets: DogeMemoryWallet[] = []) {
  this.wallets = wallets;
  }
+ async addWalletRandom(networkId: DogeNetworkId): Promise<IDogeTransactionSigner> {
+ return this.addRandomWallet(networkId);
+ }
+ addWalletBIP39(networkId: DogeNetworkId, seedPhrase: string, password?: string | undefined): Promise<IDogeTransactionSigner> {
+ throw new Error("addWalletBIP39 not supported for this provider.");
+ }
+ addWalletBIP44(networkId: DogeNetworkId, fullDerivationPath: string): Promise<IDogeTransactionSigner> {
+ throw new Error("addWalletBIP44 not supported for this provider.");
+ }
+ async addWalletBIP178(networkId: DogeNetworkId, wif: string): Promise<IDogeTransactionSigner> {
+ return this.addWalletFromWIF(wif, networkId);
+ }
+ getAbilities(): IWalletProviderAbilities {
+ return {
+ addWalletRandom: true,
+ addWalletFromWIF: true,
+ }
+ }
  getSigners(): Promise<IDogeTransactionSigner[]> {
  return Promise.resolve(this.wallets);
  }

diff --git a/src/wallet/provider.ts b/src/wallet/provider.ts
@@ -10,6 +10,7 @@ import {
  IDogeTransactionSigner,
  IDogeWalletProvider,
  IFullDogeWalletProvider,
+ IWalletProviderAbilities,
 } from "./types";
 
 class FullDogeWalletProvider<T extends IDogeWalletProvider> implements IFullDogeWalletProvider<T> {
@@ -20,6 +21,37 @@ class FullDogeWalletProvider<T extends IDogeWalletProvider> implements IFullDoge
  this.base = base;
  this.useCacheByDefault = useCacheByDefault;
  }
+ addWalletRandom(networkId: DogeNetworkId): Promise<IDogeTransactionSigner> {
+ if(this.base.addWalletRandom){
+ return this.base.addWalletRandom(networkId);
+ }else{
+ throw new Error("addWalletRandom not supported for this provider.");
+ } 
+ }
+ addWalletBIP39(networkId: DogeNetworkId, seedPhrase: string, password?: string | undefined): Promise<IDogeTransactionSigner> {
+ if(this.base.addWalletBIP39){
+ return this.base.addWalletBIP39(networkId, seedPhrase, password);
+ }else{
+ throw new Error("addWalletBIP39 not supported for this provider.");
+ }
+ }
+ addWalletBIP44(networkId: DogeNetworkId, fullDerivationPath: string): Promise<IDogeTransactionSigner> {
+ if(this.base.addWalletBIP44){
+ return this.base.addWalletBIP44(networkId, fullDerivationPath);
+ }else{
+ throw new Error("addWalletBIP44 not supported for this provider.");
+ }
+ }
+ addWalletBIP178(networkId: DogeNetworkId, wif: string): Promise<IDogeTransactionSigner> {
+ if(this.base.addWalletBIP44){
+ return this.base.addWalletBIP44(networkId, wif);
+ }else{
+ throw new Error("addWalletBIP44 not supported for this provider.");
+ }
+ }
+ getAbilities(): IWalletProviderAbilities {
+ return this.base.getAbilities();
+ }
  getBaseProvider(): T {
  return this.base;
  }

diff --git a/src/wallet/types.ts b/src/wallet/types.ts
@@ -1,3 +1,4 @@
+import { DogeNetworkId } from "../networks/types";
 import { Transaction } from "../transaction";
 
 interface ISignatureResult {
@@ -16,10 +17,23 @@ interface IDogeTransactionSigner {
  canSignHash(): boolean;
  signHash(hashHex: string): Promise<ISignatureResult>;
  signTransaction(signatureRequest: IDogeSignatureRequest): Promise<ISignatureResult>;
+ getPrivateKeyWIF?(): Promise<string>;
+}
+
+interface IWalletProviderAbilities {
+ addWalletRandom?: boolean;
+ addWalletFromWIF?: boolean;
+ addWalletFromSeed?: boolean;
+ addWalletFromMnemonic?: boolean;
 }
 
 interface IDogeWalletProvider {
  getSigners(): Promise<IDogeTransactionSigner[]>;
+ addWalletRandom?(networkId: DogeNetworkId): Promise<IDogeTransactionSigner>;
+ addWalletBIP39?(networkId: DogeNetworkId, seedPhrase: string, password?: string): Promise<IDogeTransactionSigner>;
+ addWalletBIP44?(networkId: DogeNetworkId, fullDerivationPath: string): Promise<IDogeTransactionSigner>;
+ addWalletBIP178?(networkId: DogeNetworkId, wif: string): Promise<IDogeTransactionSigner>;
+ getAbilities(): IWalletProviderAbilities;
 }
 
 interface IFullDogeWalletProvider<T extends IDogeWalletProvider> extends IDogeWalletProvider {
@@ -43,4 +57,5 @@ export type {
  IDogeWalletSerialized,
  IFullDogeWalletProvider,
  IDogeSignatureRequest,
+ IWalletProviderAbilities,
 }