@xchainjs/xchain-doge 0.1.2 → 0.2.1

package/CHANGELOG.md

@@ -1,3 +1,27 @@
+# v.0.2.1 (2022-05-05)
+
+## Update
+
+- Add `deposit` function to Doge `Client`
+- Update latest dependencies
+- Add tests for `deposit` 
+
+## Fix
+
+- Fix import of `xchain-client`
+
+# v.0.2.0 (2022-03-23)
+
+## Update
+
+- Fetch `txHex` optionally by scanning UTXOs #489
+- Cache list of `txHex`s in `getTxHexFromCache` to avoid same requests for same data #490
+- Export `buildTx` (from `utils`) and `getSendTxUrl` (from `blockcypher-api`)
+
+## Breaking change
+
+- Remove unspecific `AddressParams` type
+
 # v.0.1.2 (2022-02-04)
 
 - Use latest axios@0.25.0

package/README.md

@@ -16,6 +16,13 @@ Following peer dependencies have to be installed into your project. These are no
 yarn add @xchainjs/xchain-client @xchainjs/xchain-crypto @xchainjs/xchain-util axios bitcoinjs-lib coininfo wif
 ```
 
+## Documentation
+
+### [`xchain doge`](http://docs.xchainjs.org/xchain-client/xchain-doge/)
+[`How xchain-doge works`](http://docs.xchainjs.org/xchain-client/xchain-doge/how-it-works.html)\
+[`How to use xchain-doge`](http://docs.xchainjs.org/xchain-client/xchain-doge/how-to-use.html)
+
+
 ## Service Providers
 
 This package uses the following service providers:
@@ -32,42 +39,3 @@ 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)
-
-## Usage
-
-Initialize client and use class methods:
-
-```
-import { Client, Network } from '../src/client'
-
-// Create a new client interface
-const dogeClient = new Client({ network: Network.Testnet })
-
-// Set phrase
-dogeClient.setPhrase('phrase here')
-
-// Get address
-const address = dogeClient.getAddress()
-
-// Get balance
-const balance = await dogeClient.getBalance()
-
-// Transfer with feeRate
-const txid = await dogeClient.transfer({ asset: AssetDoge, recipient: 'recipient address here', amount: baseAmount(100, DOGE_DECIMAL), feeRate: 1 })
-
-// Transfer with default feeRate (default is `fast`)
-const txid = await dogeClient.transfer({ asset: AssetDoge, recipient: 'recipient address here', amount: baseAmount(100, DOGE_DECIMAL) })
-
-// Get fee estimations
-const { fast, fastest, average } = await dogeClient.getFees()
-
-// Get feeRate estimations
-const { fast, fastest, average } = await dogeClient.getFeeRates()
-
-// Search transactions
-const transactions = await dogeClient.getTransactions({ address: 'address here', limit: 4 })
-
-// Get a transaction with a given txId/hash
-const txData = await dogeClient.getTransactionData('b660ee07167cfa32681e2623f3a29dc64a089cabd9a3a07dd17f9028ac956eb8')
-
-```

package/lib/blockcypher-api.d.ts

@@ -1,4 +1,4 @@
-import { Network } from '@xchainjs/xchain-client/lib';
+import { Network } from '@xchainjs/xchain-client';
 /**
  * Get Dogecoin suggested transaction fee.
  *

package/lib/client.d.ts

@@ -1,4 +1,4 @@
-import { Address, Balance, Fee, FeeRate, Tx, TxHash, TxHistoryParams, TxParams, TxsPage, UTXOClient, XChainClientParams } from '@xchainjs/xchain-client';
+import { Address, Balance, DepositParams, Fee, FeeRate, Tx, TxHash, TxHistoryParams, TxParams, TxsPage, UTXOClient, XChainClientParams } from '@xchainjs/xchain-client';
 export declare type DogecoinClientParams = XChainClientParams & {
     sochainUrl?: string;
     blockcypherUrl?: string;
@@ -115,5 +115,15 @@ declare class Client extends UTXOClient {
     transfer(params: TxParams & {
         feeRate?: FeeRate;
     }): Promise<TxHash>;
+    /**
+     * Transaction to THORChain inbound address.
+     *
+     * @param {DepositParams} params The transaction options.
+     * @returns {TxHash} The transaction hash.
+     *
+     * @throws {"halted chain"} Thrown if chain is halted.
+     * @throws {"halted trading"} Thrown if trading is halted.
+     */
+    deposit({ walletIndex, asset, amount, memo }: DepositParams): Promise<TxHash>;
 }
 export { Client };

package/lib/index.d.ts

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