@xchainjs/xchain-doge 0.5.13 → 0.6.0

package/lib/blockcypher-api.d.ts

@@ -1,13 +1,13 @@
-import { Network } from '@xchainjs/xchain-client';
-/**
- * Get Dogecoin suggested transaction fee.
- *
- * @returns {number} The Dogecoin suggested transaction fee per bytes in sat.
- */
-export declare const getSuggestedTxFee: ({ blockcypherUrl }: {
-    blockcypherUrl: string;
-}) => Promise<number>;
-export declare const getSendTxUrl: ({ blockcypherUrl, network }: {
-    blockcypherUrl: string;
-    network: Network;
-}) => string;
+import { Network } from '@xchainjs/xchain-client';
+/**
+ * Get Dogecoin suggested transaction fee.
+ *
+ * @returns {number} The Dogecoin suggested transaction fee per bytes in sat.
+ */
+export declare const getSuggestedTxFee: ({ blockcypherUrl }: {
+    blockcypherUrl: string;
+}) => Promise<number>;
+export declare const getSendTxUrl: ({ blockcypherUrl, network }: {
+    blockcypherUrl: string;
+    network: Network;
+}) => string;

package/lib/client.d.ts

@@ -1,81 +1,81 @@
-import { Fee, FeeRate, TxHash, TxParams, UTXO, UTXOClient, UtxoClientParams } from '@xchainjs/xchain-client';
-import { Address } from '@xchainjs/xchain-util';
-import * as Dogecoin from 'bitcoinjs-lib';
-import { LedgerTxInfo, LedgerTxInfoParams } from './types/ledger';
-export declare const defaultDogeParams: UtxoClientParams;
-/**
- * Custom Dogecoin client
- */
-declare class Client extends UTXOClient {
-    /**
-     * Constructor
-     * Client is initialised with network type
-     * Pass strict null as nodeAuth to disable auth for node json rpc
-     *
-     * @param {DogecoinClientParams} params
-     */
-    constructor(params?: UtxoClientParams);
-    /**
-     * Get the current address.
-     *
-     * 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.
-     */
-    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;
-    /**
-     * Validate the given address.
-     *
-     * @param {Address} address
-     * @returns {boolean} `true` or `false`
-     */
-    validateAddress(address: string): boolean;
-    protected getSuggestedFeeRate(): Promise<FeeRate>;
-    protected calcFee(feeRate: FeeRate, memo?: string): Promise<Fee>;
-    /**
-     * Transfer Doge.
-     *
-     * @param {TxParams&FeeRate} params The transfer options.
-     * @returns {TxHash} The transaction hash.
-     */
-    transfer(params: TxParams & {
-        feeRate?: FeeRate;
-    }): Promise<TxHash>;
-    /**
-     * Build transcation.
-     *
-     * @param {BuildParams} params The transaction build options.
-     * @returns {Transaction}
-     */
-    buildTx: ({ amount, recipient, memo, feeRate, sender, }: TxParams & {
-        feeRate: FeeRate;
-        sender: Address;
-    }) => Promise<{
-        psbt: Dogecoin.Psbt;
-        utxos: UTXO[];
-    }>;
-    /**
-     * Create transaction info.
-     *
-     * @param {LedgerTxInfoParams} params The transaction build options.
-     * @returns {LedgerTxInfo} The transaction info used for ledger sign.
-     */
-    createTxInfo(params: LedgerTxInfoParams): Promise<LedgerTxInfo>;
-}
-export { Client };
+import { Fee, FeeRate, TxHash, TxParams, UTXO, UTXOClient, UtxoClientParams } from '@xchainjs/xchain-client';
+import { Address } from '@xchainjs/xchain-util';
+import * as Dogecoin from 'bitcoinjs-lib';
+import { LedgerTxInfo, LedgerTxInfoParams } from './types/ledger';
+export declare const defaultDogeParams: UtxoClientParams;
+/**
+ * Custom Dogecoin client
+ */
+declare class Client extends UTXOClient {
+    /**
+     * Constructor
+     * Client is initialised with network type
+     * Pass strict null as nodeAuth to disable auth for node json rpc
+     *
+     * @param {DogecoinClientParams} params
+     */
+    constructor(params?: UtxoClientParams);
+    /**
+     * Get the current address.
+     *
+     * 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.
+     */
+    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;
+    /**
+     * Validate the given address.
+     *
+     * @param {Address} address
+     * @returns {boolean} `true` or `false`
+     */
+    validateAddress(address: string): boolean;
+    protected getSuggestedFeeRate(): Promise<FeeRate>;
+    protected calcFee(feeRate: FeeRate, memo?: string): Promise<Fee>;
+    /**
+     * Transfer Doge.
+     *
+     * @param {TxParams&FeeRate} params The transfer options.
+     * @returns {TxHash} The transaction hash.
+     */
+    transfer(params: TxParams & {
+        feeRate?: FeeRate;
+    }): Promise<TxHash>;
+    /**
+     * Build transcation.
+     *
+     * @param {BuildParams} params The transaction build options.
+     * @returns {Transaction}
+     */
+    buildTx: ({ amount, recipient, memo, feeRate, sender, }: TxParams & {
+        feeRate: FeeRate;
+        sender: Address;
+    }) => Promise<{
+        psbt: Dogecoin.Psbt;
+        utxos: UTXO[];
+    }>;
+    /**
+     * Create transaction info.
+     *
+     * @param {LedgerTxInfoParams} params The transaction build options.
+     * @returns {LedgerTxInfo} The transaction info used for ledger sign.
+     */
+    createTxInfo(params: LedgerTxInfoParams): Promise<LedgerTxInfo>;
+}
+export { Client };

package/lib/const.d.ts

@@ -1,39 +1,39 @@
-import { ExplorerProvider } from '@xchainjs/xchain-client';
-import { Asset } from '@xchainjs/xchain-util';
-import { BlockcypherProvider, SochainProvider } from '@xchainjs/xchain-utxo-providers';
-/**
- * Minimum transaction fee
- * 100000 satoshi/kB (similar to current `minrelaytxfee`)
- * @see https://github.com/dogecoin/dogecoin/blob/master/src/validation.h#L58
- */
-export declare const MIN_TX_FEE = 100000;
-export declare const DOGE_DECIMAL = 8;
-export declare const LOWER_FEE_BOUND = 40000;
-export declare const UPPER_FEE_BOUND = 20000000;
-/**
- * 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
- */
-export declare const AssetDOGE: Asset;
-export declare const blockstreamExplorerProviders: {
-    testnet: ExplorerProvider;
-    stagenet: ExplorerProvider;
-    mainnet: ExplorerProvider;
-};
-export declare const sochainDataProviders: {
-    testnet: SochainProvider;
-    stagenet: SochainProvider;
-    mainnet: SochainProvider;
-};
-export declare const blockcypherDataProviders: {
-    testnet: undefined;
-    stagenet: BlockcypherProvider;
-    mainnet: BlockcypherProvider;
-};
+import { ExplorerProvider } from '@xchainjs/xchain-client';
+import { Asset } from '@xchainjs/xchain-util';
+import { BlockcypherProvider, SochainProvider } from '@xchainjs/xchain-utxo-providers';
+/**
+ * Minimum transaction fee
+ * 100000 satoshi/kB (similar to current `minrelaytxfee`)
+ * @see https://github.com/dogecoin/dogecoin/blob/master/src/validation.h#L58
+ */
+export declare const MIN_TX_FEE = 100000;
+export declare const DOGE_DECIMAL = 8;
+export declare const LOWER_FEE_BOUND = 40000;
+export declare const UPPER_FEE_BOUND = 20000000;
+/**
+ * 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
+ */
+export declare const AssetDOGE: Asset;
+export declare const blockstreamExplorerProviders: {
+    testnet: ExplorerProvider;
+    stagenet: ExplorerProvider;
+    mainnet: ExplorerProvider;
+};
+export declare const sochainDataProviders: {
+    testnet: SochainProvider;
+    stagenet: SochainProvider;
+    mainnet: SochainProvider;
+};
+export declare const blockcypherDataProviders: {
+    testnet: undefined;
+    stagenet: BlockcypherProvider;
+    mainnet: BlockcypherProvider;
+};

package/lib/index.d.ts

@@ -1,5 +1,5 @@
-export * from './types';
-export * from './client';
-export * from './const';
-export { getDefaultFees, getDefaultFeesWithRates, validateAddress, calcFee, getPrefix } from './utils';
-export { getSendTxUrl } from './blockcypher-api';
+export * from './types';
+export * from './client';
+export * from './const';
+export { getDefaultFees, getDefaultFeesWithRates, validateAddress, calcFee, getPrefix } from './utils';
+export { getSendTxUrl } from './blockcypher-api';