@xchainjs/xchain-doge 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,3 @@
+# v.0.1.0 (2022-01-15)
+
+First release

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 THORChain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,73 @@
+# `@xchainjs/xchain-doge`
+
+## Modules
+
+- `client` - Custom client for communicating with Doge using [BIP39](https://github.com/bitcoinjs/bip39) [bitcoinjs-lib](https://github.com/bitcoinjs/bitcoinjs-lib) and [WIF](https://github.com/bitcoinjs/wif)
+
+## Installation
+
+```
+yarn add @xchainjs/xchain-doge
+```
+
+Following peer dependencies have to be installed into your project. These are not included in `@xchainjs/xchain-doge`.
+
+```
+yarn add @xchainjs/xchain-client @xchainjs/xchain-crypto @xchainjs/xchain-util axios bitcoinjs-lib coininfo wif
+```
+
+## Service Providers
+
+This package uses the following service providers:
+
+| Function                    | Service     | Notes                                                                            |
+| --------------------------- | ----------- | -------------------------------------------------------------------------------- |
+| Balances                    | Sochain     | https://sochain.com/api#get-balance                                              |
+| Transaction history         | Sochain     | https://sochain.com/api#get-display-data-address, https://sochain.com/api#get-tx |
+| Transaction details by hash | Sochain     | https://sochain.com/api#get-tx                                                   |
+| Transaction fees            | BlockCypher | https://api.blockcypher.com/v1/doge/main                                         |
+| Transaction broadcast       | BlockCypher | https://api.blockcypher.com/v1/doge/main/txs/push                                |
+| Explorer                    | Blockchair  | https://blockchair.com/dogecoin                                                  |
+
+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

@@ -0,0 +1,13 @@
+import { Network } from '@xchainjs/xchain-client/lib';
+/**
+ * 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

@@ -0,0 +1,121 @@
+import { Address, Balance, Fee, FeeRate, Tx, TxHash, TxHistoryParams, TxParams, TxsPage, UTXOClient, XChainClientParams } from '@xchainjs/xchain-client';
+export declare type DogecoinClientParams = XChainClientParams & {
+    sochainUrl?: string;
+    nodeUrl?: string;
+    blockcypherUrl?: string;
+};
+/**
+ * Custom Dogecoin client
+ */
+declare class Client extends UTXOClient {
+    private sochainUrl;
+    private blockcypherUrl;
+    nodeUrl: string | undefined;
+    /**
+     * Constructor
+     * Client is initialised with network type
+     * Pass strict null as nodeAuth to disable auth for node json rpc
+     *
+     * @param {DogecoinClientParams} params
+     */
+    constructor({ network, sochainUrl, blockcypherUrl, phrase, nodeUrl, 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;
+    /**
+     * 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;
+    /**
+     * 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[]>;
+    /**
+     * 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>;
+    /**
+     * Transfer Doge.
+     *
+     * @param {TxParams&FeeRate} params The transfer options.
+     * @returns {TxHash} The transaction hash.
+     */
+    transfer(params: TxParams & {
+        feeRate?: FeeRate;
+    }): Promise<TxHash>;
+}
+export { Client };

package/lib/const.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 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;

package/lib/index.d.ts

@@ -0,0 +1,5 @@
+export * from './types';
+export * from './client';
+export * from './const';
+export { broadcastTx, getDefaultFees, getDefaultFeesWithRates, validateAddress, calcFee, scanUTXOs } from './utils';
+export { createTxInfo } from './ledger';