@xchainjs/xchain-doge 0.7.12 → 0.7.13

package/lib/client.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { AssetInfo, FeeRate, PreparedTx, TxHash, TxParams } from '@xchainjs/xchain-client';
+import { AssetInfo, FeeRate, PreparedTx, TxParams } from '@xchainjs/xchain-client';
 import { Address } from '@xchainjs/xchain-util';
 import { Client as UTXOClient, UTXO, UtxoClientParams } from '@xchainjs/xchain-utxo';
 import * as Dogecoin from 'bitcoinjs-lib';
@@ -13,7 +13,7 @@ export declare const defaultDogeParams: UtxoClientParams;
  * Custom Dogecoin client extending UTXOClient.
  * Implements methods for Dogecoin-specific functionality.
  */
-declare class Client extends UTXOClient {
+declare abstract class Client extends UTXOClient {
     /**
      * Constructor for initializing the Dogecoin client.
      * Initializes the client with the provided parameters.
@@ -21,46 +21,12 @@ declare class Client extends UTXOClient {
      * @param {DogecoinClientParams} params Parameters for initializing the Dogecoin client.
      */
     constructor(params?: UtxoClientParams);
-    /**
-     * Get the Dogecoin address.
-     *
-     * Generates a Dogecoin address using the provided phrase and index.
-     * @param {number} index The index of the address to retrieve. Default is 0.
-     * @returns {Address} The Dogecoin address.
-     * @throws {"index must be greater than zero"} Thrown if the index is less than zero.
-     * @throws {"Phrase must be provided"} Thrown if the phrase is not provided.
-     * @throws {"Address not defined"} Thrown if failed to create the address from the phrase.
-     */
-    getAddress(index?: number): Address;
-    /**
-     * Get the current address.
-     * Asynchronous version of getAddress method.
-     * Generates a network-specific key-pair by first converting the buffer to a Wallet-Import-Format (WIF)
-     * The address is then decoded into type P2WPKH and returned.
-     * @returns {Address} The current address.
-     *
-     * @throws {"Phrase must be provided"} Thrown if phrase has not been set before.
-     * @throws {"Address not defined"} Thrown if failed creating account from phrase.
-     */
-    getAddressAsync(index?: number): Promise<string>;
     /**
      * Get Dogecoin asset information.
      *
      * @returns {AssetInfo} Dogecoin asset information.
      */
     getAssetInfo(): AssetInfo;
-    /**
-     * @private
-     * Get private key.
-     *
-     * Private function to get keyPair from the this.phrase
-     *
-     * @param {string} phrase The phrase to be used for generating privkey
-     * @returns {ECPairInterface} The privkey generated from the given phrase
-     *
-     * @throws {"Could not get private key from phrase"} Throws an error if failed creating Doge keys from the given phrase
-     * */
-    private getDogeKeys;
     /**
      * Validate the given address.
      *
@@ -68,16 +34,6 @@ declare class Client extends UTXOClient {
      * @returns {boolean} `true` if the address is valid, otherwise `false`.
      */
     validateAddress(address: string): boolean;
-    /**
-     * Asynchronously transfers Dogecoin.
-     *
-     * Builds, signs, and broadcasts a Dogecoin transaction with the specified parameters.
-     * @param {TxParams & { feeRate?: FeeRate }} params The transfer parameters including transaction details and optional fee rate.
-     * @returns {TxHash} A promise that resolves to the transaction hash once the transfer is completed.
-     */
-    transfer(params: TxParams & {
-        feeRate?: FeeRate;
-    }): Promise<TxHash>;
     /**
      * Builds a Dogecoin transaction (PSBT).
      *

package/lib/clientKeystore.d.ts

@@ -0,0 +1,53 @@
+import { FeeRate, TxHash, TxParams } from '@xchainjs/xchain-client';
+import { Address } from '@xchainjs/xchain-util';
+import { Client } from './client';
+/**
+ * Custom Doge client extended to support keystore functionality
+ */
+declare class ClientKeystore extends Client {
+    /**
+     * Get the Dogecoin address.
+     *
+     * Generates a Dogecoin address using the provided phrase and index.
+     * @param {number} index The index of the address to retrieve. Default is 0.
+     * @returns {Address} The Dogecoin address.
+     * @throws {"index must be greater than zero"} Thrown if the index is less than zero.
+     * @throws {"Phrase must be provided"} Thrown if the phrase is not provided.
+     * @throws {"Address not defined"} Thrown if failed to create the address from the phrase.
+     */
+    getAddress(index?: number): Address;
+    /**
+     * @private
+     * Get private key.
+     *
+     * Private function to get keyPair from the this.phrase
+     *
+     * @param {string} phrase The phrase to be used for generating privkey
+     * @returns {ECPairInterface} The privkey generated from the given phrase
+     *
+     * @throws {"Could not get private key from phrase"} Throws an error if failed creating Doge keys from the given phrase
+     * */
+    private getDogeKeys;
+    /**
+     * Get the current address.
+     * Asynchronous version of getAddress method.
+     * Generates a network-specific key-pair by first converting the buffer to a Wallet-Import-Format (WIF)
+     * The address is then decoded into type P2WPKH and returned.
+     * @returns {Address} The current address.
+     *
+     * @throws {"Phrase must be provided"} Thrown if phrase has not been set before.
+     * @throws {"Address not defined"} Thrown if failed creating account from phrase.
+     */
+    getAddressAsync(index?: number): Promise<string>;
+    /**
+     * Asynchronously transfers Dogecoin.
+     *
+     * Builds, signs, and broadcasts a Dogecoin transaction with the specified parameters.
+     * @param {TxParams & { feeRate?: FeeRate }} params The transfer parameters including transaction details and optional fee rate.
+     * @returns {TxHash} A promise that resolves to the transaction hash once the transfer is completed.
+     */
+    transfer(params: TxParams & {
+        feeRate?: FeeRate;
+    }): Promise<TxHash>;
+}
+export { ClientKeystore };

package/lib/clientLedger.d.ts

@@ -0,0 +1,22 @@
+import AppBtc from '@ledgerhq/hw-app-btc';
+import { FeeRate, TxHash, TxParams } from '@xchainjs/xchain-client';
+import { Address } from '@xchainjs/xchain-util';
+import { UtxoClientParams } from '@xchainjs/xchain-utxo';
+import { Client } from './client';
+/**
+ * Custom Ledger Bitcoin client
+ */
+declare class ClientLedger extends Client {
+    private transport;
+    private app;
+    constructor(params: UtxoClientParams & {
+        transport: any;
+    });
+    getApp(): Promise<AppBtc>;
+    getAddress(): string;
+    getAddressAsync(index?: number, verify?: boolean): Promise<Address>;
+    transfer(params: TxParams & {
+        feeRate?: FeeRate;
+    }): Promise<TxHash>;
+}
+export { ClientLedger };

package/lib/index.d.ts

@@ -2,14 +2,13 @@
  * Export all types defined in the 'types.ts' file.
  */
 export * from './types';
-/**
- * Export the Dogecoin client implementation defined in the 'client.ts' file.
- */
-export * from './client';
+export { ClientKeystore as Client } from './clientKeystore';
+export { ClientLedger } from './clientLedger';
 /**
  * Export all constants defined in the 'const.ts' file.
  */
 export * from './const';
+export { defaultDogeParams } from './client';
 /**
  * Export utility functions for validating Dogecoin addresses and getting address prefixes
  * from the 'utils.ts' file.