@xchainjs/xchain-doge 0.5.8 → 0.5.10

package/README.md

@@ -39,3 +39,53 @@ This package uses the following service providers:
 Sochain API rate limits: https://sochain.com/api#rate-limits (300 requests/minute)
 
 BlockCypher API rate limits: https://api.blockcypher.com/v1/doge/main (5 requests/second)
+
+### UtxoOnlineDataProviders
+
+## default providers
+
+Creating a no-arg DOGE Client will default to the following settings:
+
+```typescript
+const defaultDogeParams: UtxoClientParams = {
+  network: Network.Mainnet,
+  phrase: '',
+  explorerProviders: blockstreamExplorerProviders,
+  dataProviders: [blockcypherDataProviders],
+  rootDerivationPaths: {
+    [Network.Mainnet]: `m/44'/3'/0'/0/`,
+    [Network.Stagenet]: `m/44'/3'/0'/0/`,
+    [Network.Testnet]: `m/44'/1'/0'/0/`,
+  },
+  feeBounds: {
+    lower: LOWER_FEE_BOUND,
+    upper: UPPER_FEE_BOUND,
+  },
+}
+```
+
+Note: BlockCypher is the default online data provider (to fetch realtime utxos, balances, etc)
+
+## Overriding providers
+
+You can specify own array of providers, whoch will be executed in array-order, to provide automated failover to the subsequent providers if calls to the first providers fail
+
+### example sochain v3, blockcypher backup
+
+```typescript
+import { Client, defaultDogeParams, AssetDOGE, SochainDataProviders, BlockcypherDataProviders } from '@xchainjs/xchain-doge'
+import { SochainNetwork,  SochainProvider } from '@xchainjs/xchain-utxo-providers'
+import { Network, UtxoClientParams } from '@xchainjs/xchain-client'
+
+// override with your API key
+SochainDataProviders[Network.Mainnet].apiKey = 'YOU_SOCHAIN_API_KEY'
+
+//overridde the default init params with your onfig
+const initParams: UtxoClientParams = {
+  ...defaultDogeParams,
+  dataProviders: [SochainDataProviders, BlockcypherDataProviders]// use sochain first and blockcypher as fallback
+  phrase: process.env.YOURPHRASE,
+}
+const DOGEClient = new Client(sochainParams)
+
+```

package/lib/client.d.ts

@@ -1,17 +1,12 @@
-import { Balance, Fee, FeeRate, Tx, TxHash, TxHistoryParams, TxParams, TxsPage, UTXOClient, XChainClientParams } from '@xchainjs/xchain-client';
+import { Fee, FeeRate, TxHash, TxParams, UTXO, UTXOClient, UtxoClientParams } from '@xchainjs/xchain-client';
 import { Address } from '@xchainjs/xchain-util';
-export declare type DogecoinClientParams = XChainClientParams & {
-    sochainUrl?: string;
-    blockcypherUrl?: string;
-    sochainApiKey: string;
-};
+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 {
-    private sochainUrl;
-    private blockcypherUrl;
-    private sochainApiKey;
     /**
      * Constructor
      * Client is initialised with network type
@@ -19,41 +14,7 @@ declare class Client extends UTXOClient {
      *
      * @param {DogecoinClientParams} params
      */
-    constructor({ network, feeBounds, sochainApiKey, sochainUrl, blockcypherUrl, phrase, rootDerivationPaths, }: DogecoinClientParams);
-    /**
-     * Set/Update the sochain url.
-     *
-     * @param {string} url The new sochain url.
-     * @returns {void}
-     */
-    setSochainUrl(url: string): void;
-    /**
-     * Set/Update the blockcypher url.
-     *
-     * @param {string} url The new blockcypher url.
-     * @returns {void}
-     */
-    setBlockcypherUrl(url: string): void;
-    /**
-     * Get the explorer url.
-     *
-     * @returns {string} The explorer url based on the network.
-     */
-    getExplorerUrl(): string;
-    /**
-     * Get the explorer url for the given address.
-     *
-     * @param {Address} address
-     * @returns {string} The explorer url for the given address based on the network.
-     */
-    getExplorerAddressUrl(address: Address): string;
-    /**
-     * Get the explorer url for the given transaction id.
-     *
-     * @param {string} txID The transaction id
-     * @returns {string} The explorer url for the given transaction id based on the network.
-     */
-    getExplorerTxUrl(txID: string): string;
+    constructor(params?: UtxoClientParams);
     /**
      * Get the current address.
      *
@@ -85,36 +46,6 @@ declare class Client extends UTXOClient {
      * @returns {boolean} `true` or `false`
      */
     validateAddress(address: string): boolean;
-    /**
-     * Get the Doge balance of a given address.
-     *
-     * @param {Address} address By default, it will return the balance of the current wallet. (optional)
-     * @returns {Balance[]} The Doge balance of the address.
-     */
-    getBalance(address: Address): Promise<Balance[]>;
-    /**
-     * helper function tto limit adding to an array
-     *
-     * @param arr array to be added to
-     * @param toAdd elements to add
-     * @param limit do not add more than this limit
-     */
-    private addArrayUpToLimit;
-    /**
-     * Get transaction history of a given address with pagination options.
-     * By default it will return the transaction history of the current wallet.
-     *
-     * @param {TxHistoryParams} params The options to get transaction history. (optional)
-     * @returns {TxsPage} The transaction history.
-     */
-    getTransactions(params?: TxHistoryParams): Promise<TxsPage>;
-    /**
-     * Get the transaction details of a given transaction id.
-     *
-     * @param {string} txId The transaction id.
-     * @returns {Tx} The transaction details of the given transaction id.
-     */
-    getTransactionData(txId: string): Promise<Tx>;
     protected getSuggestedFeeRate(): Promise<FeeRate>;
     protected calcFee(feeRate: FeeRate, memo?: string): Promise<Fee>;
     /**
@@ -126,5 +57,25 @@ declare class Client extends UTXOClient {
     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,4 +1,6 @@
+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`)
@@ -20,3 +22,18 @@ export declare const DOGEChain: "DOGE";
  * @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,6 +1,5 @@
 export * from './types';
 export * from './client';
 export * from './const';
-export { broadcastTx, buildTx, getDefaultFees, getDefaultFeesWithRates, validateAddress, calcFee, scanUTXOs, getPrefix, } from './utils';
+export { getDefaultFees, getDefaultFeesWithRates, validateAddress, calcFee, getPrefix } from './utils';
 export { getSendTxUrl } from './blockcypher-api';
-export { createTxInfo } from './ledger';