@xchainjs/xchain-doge 0.7.9 → 0.7.11

package/lib/blockcypher-api.d.ts

@@ -1,4 +1,12 @@
 import { Network } from '@xchainjs/xchain-client';
+/**
+ * Function to get the URL for sending a transaction based on the network and Blockcypher URL.
+ * Throws an error if the network is 'testnet' since the testnet URL is not available for Blockcypher.
+ * @param {object} params Object containing the Blockcypher URL and network type.
+ * @param {string} params.blockcypherUrl The Blockcypher URL.
+ * @param {Network} params.network The network type (Mainnet, Testnet, or Stagenet).
+ * @returns {string} The URL for sending a transaction.
+ */
 export declare const getSendTxUrl: ({ blockcypherUrl, network }: {
     blockcypherUrl: string;
     network: Network;

package/lib/client.d.ts

@@ -4,29 +4,39 @@ import { Address } from '@xchainjs/xchain-util';
 import { Client as UTXOClient, UTXO, UtxoClientParams } from '@xchainjs/xchain-utxo';
 import * as Dogecoin from 'bitcoinjs-lib';
 import { LedgerTxInfo, LedgerTxInfoParams } from './types/ledger';
+/**
+ * Default parameters for Dogecoin UTXO client.
+ * Contains default values for network, phrase, explorer providers, data providers, root derivation paths, and fee bounds.
+ */
 export declare const defaultDogeParams: UtxoClientParams;
 /**
- * Custom Dogecoin client
+ * Custom Dogecoin client extending UTXOClient.
+ * Implements methods for Dogecoin-specific functionality.
  */
 declare class Client extends UTXOClient {
     /**
-     * Constructor
-     * Client is initialised with network type
-     * Pass strict null as nodeAuth to disable auth for node json rpc
+     * Constructor for initializing the Dogecoin client.
+     * Initializes the client with the provided parameters.
      *
-     * @param {DogecoinClientParams} params
+     * @param {DogecoinClientParams} params Parameters for initializing the Dogecoin client.
      */
     constructor(params?: UtxoClientParams);
     /**
-     * @deprecated this function eventually will be removed use getAddressAsync instead
+     * 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.
@@ -34,8 +44,9 @@ declare class Client extends UTXOClient {
      */
     getAddressAsync(index?: number): Promise<string>;
     /**
+     * Get Dogecoin asset information.
      *
-     * @returns Doge asset info
+     * @returns {AssetInfo} Dogecoin asset information.
      */
     getAssetInfo(): AssetInfo;
     /**
@@ -53,25 +64,27 @@ declare class Client extends UTXOClient {
     /**
      * Validate the given address.
      *
-     * @param {Address} address
-     * @returns {boolean} `true` or `false`
+     * @param {Address} address The Dogecoin address to validate.
+     * @returns {boolean} `true` if the address is valid, otherwise `false`.
      */
     validateAddress(address: string): boolean;
     /**
-     * Transfer Doge.
+     * Asynchronously transfers Dogecoin.
      *
-     * @param {TxParams&FeeRate} params The transfer options.
-     * @returns {TxHash} The transaction hash.
+     * 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>;
     /**
-     * Build transcation.
+     * Builds a Dogecoin transaction (PSBT).
      *
-     * @param {BuildParams} params The transaction build options.
-     * @returns {Transaction}
-     * @deprecated
+     * Builds a Partially Signed Bitcoin Transaction (PSBT) with the specified parameters.
+     * @param {BuildParams} params The transaction build options including sender, recipient, amount, memo, and fee rate.
+     * @returns {Transaction} A promise that resolves to the built PSBT and the unspent transaction outputs (UTXOs) used in the transaction.
+     * @deprecated This method is deprecated. Use the `transfer` method instead.
      */
     buildTx: ({ amount, recipient, memo, feeRate, sender, }: TxParams & {
         feeRate: FeeRate;
@@ -81,18 +94,20 @@ declare class Client extends UTXOClient {
         utxos: UTXO[];
     }>;
     /**
-     * Create transaction info.
+     * Asynchronously creates transaction information for ledger sign.
+     *
+     * Builds a transaction (PSBT) and prepares necessary information for ledger signing.
      *
-     * @param {LedgerTxInfoParams} params The transaction build options.
-     * @returns {LedgerTxInfo} The transaction info used for ledger sign.
-     * @deprecated
+     * @param {LedgerTxInfoParams} params The parameters for creating transaction information.
+     * @returns {LedgerTxInfo} A promise that resolves to the transaction information used for ledger sign.
      */
     createTxInfo(params: LedgerTxInfoParams): Promise<LedgerTxInfo>;
     /**
-     * Prepare transfer.
+     * Asynchronously prepares a transaction for transfer.
      *
-     * @param {TxParams&Address&FeeRate&boolean} params The transfer options.
-     * @returns {PreparedTx} The raw unsigned transaction.
+     * Builds a transaction (PSBT) with the specified transfer options.
+     * @param {TxParams & { sender: Address; feeRate: FeeRate; spendPendingUTXO?: boolean }} params The transfer options including sender address, fee rate, and optional flag for spending pending UTXOs.
+     * @returns {Promise<PreparedTx>} A promise that resolves to the raw unsigned transaction (PSBT).
      */
     prepareTx({ sender, memo, amount, recipient, feeRate, }: TxParams & {
         sender: Address;
@@ -100,19 +115,19 @@ declare class Client extends UTXOClient {
         spendPendingUTXO?: boolean;
     }): Promise<PreparedTx>;
     /**
-     * Compile memo.
+     * Compiles the memo into a buffer for inclusion in a Dogecoin transaction.
      *
      * @param {string} memo The memo to be compiled.
-     * @returns {Buffer} The compiled memo.
+     * @returns {Buffer} The compiled memo as a buffer.
      */
     protected compileMemo(memo: string): Buffer;
     /**
-     * Get the transaction fee.
+     * Calculates the transaction fee based on the provided UTXOs, fee rate, and optional data.
      *
-     * @param {UTXO[]} inputs The UTXOs.
-     * @param {FeeRate} feeRate The fee rate.
-     * @param {Buffer} data The compiled memo (Optional).
-     * @returns {number} The fee amount.
+     * @param {UTXO[]} inputs The unspent transaction outputs (UTXOs) used as inputs.
+     * @param {FeeRate} feeRate The fee rate for the transaction.
+     * @param {Buffer | null} data The compiled memo (optional).
+     * @returns {number} The calculated transaction fee.
      */
     protected getFeeFromUtxos(inputs: UTXO[], feeRate: FeeRate, data?: Buffer | null): number;
 }

package/lib/const.d.ts

@@ -2,24 +2,34 @@ import { ExplorerProvider } from '@xchainjs/xchain-client';
 import { Asset } from '@xchainjs/xchain-util';
 import { BlockcypherProvider, SochainProvider, UtxoOnlineDataProviders } from '@xchainjs/xchain-utxo-providers';
 /**
- * Minimum transaction fee
- * 100000 satoshi/kB (similar to current `minrelaytxfee`)
+ * Minimum transaction fee for Dogecoin transactions.
+ * Defined as 100000 satoshi/kB.
  * @see https://github.com/dogecoin/dogecoin/blob/master/src/validation.h#L58
  */
 export declare const MIN_TX_FEE = 100000;
+/**
+ * Decimal places for Dogecoin.
+ */
 export declare const DOGE_DECIMAL = 8;
+/**
+ * Lower fee bound for Dogecoin transactions.
+ * Referenced from Dogecoin fee recommendation documentation.
+ * @see https://github.com/dogecoin/dogecoin/blob/master/doc/fee-recommendation.md
+ */
 export declare const LOWER_FEE_BOUND = 100;
+/**
+ * Upper fee bound for Dogecoin transactions.
+ * Referenced from Dogecoin fee recommendation documentation.
+ * @see https://github.com/dogecoin/dogecoin/blob/master/doc/fee-recommendation.md
+ */
 export declare const UPPER_FEE_BOUND = 20000000;
 /**
- * Chain identifier for Dogecoin
- *
+ * Chain identifier for Dogecoin.
  */
 export declare const DOGEChain: "DOGE";
 /**
- * Base "chain" asset on dogecoin
- *
- * Based on definition in Thorchain `common`
- * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
+ * Base asset object for Dogecoin.
+ * Represents the Dogecoin asset in various contexts.
  */
 export declare const AssetDOGE: Asset;
 export declare const blockstreamExplorerProviders: {

package/lib/index.d.ts

@@ -1,5 +1,22 @@
+/**
+ * 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 all constants defined in the 'const.ts' file.
+ */
 export * from './const';
+/**
+ * Export utility functions for validating Dogecoin addresses and getting address prefixes
+ * from the 'utils.ts' file.
+ */
 export { validateAddress, getPrefix } from './utils';
+/**
+ * Export a function for getting the transaction send URL from the Blockcypher API
+ * from the 'blockcypher-api.ts' file.
+ */
 export { getSendTxUrl } from './blockcypher-api';