@xchainjs/xchain-thorchain 1.0.11 → 1.1.0

package/lib/client.d.ts

@@ -5,7 +5,6 @@ import { StdFee } from '@cosmjs/amino';
 import { AssetInfo, Network, PreparedTx, TxHash, TxParams } from '@xchainjs/xchain-client';
 import { Client as CosmosSDKClient, CosmosSdkClientParams, MsgTypes } from '@xchainjs/xchain-cosmos-sdk';
 import { Address, Asset } from '@xchainjs/xchain-util';
-import { BigNumber } from 'bignumber.js';
 import { DepositParam, DepositTx, TxOfflineParams } from './types';
 /**
  * Interface for custom Thorchain client
@@ -20,28 +19,15 @@ export interface ThorchainClient {
  */
 export type ThorchainClientParams = Partial<CosmosSdkClientParams>;
 /**
- * Thorchain client
+ * Thorchain base client
  */
-export declare class Client extends CosmosSDKClient implements ThorchainClient {
+export declare abstract class Client extends CosmosSDKClient implements ThorchainClient {
     /**
      * Thorchain client constructor
      *
      * @param {ThorchainClientParams} config Optional - Client configuration. If it is not set, default values will be used
      */
     constructor(config?: ThorchainClientParams);
-    /**
-     * Asynchronous version of getAddress method.
-     * @param {number} index Derivation path index of the address to be generated.
-     * @returns {string} A promise that resolves to the generated address.
-     */
-    getAddressAsync(index?: number): Promise<string>;
-    /**
-     * Get the address derived from the provided phrase.
-     * @param {number | undefined} walletIndex The index of the address derivation path. Default is 0.
-     * @returns {string} The user address at the specified walletIndex.
-     */
-    getAddress(walletIndex?: number | undefined): string;
-    transfer(params: TxParams): Promise<string>;
     /**
      * Get address prefix by network
      * @param {Network} network The network of which return the prefix
@@ -104,44 +90,6 @@ export declare class Client extends CosmosSDKClient implements ThorchainClient {
     prepareTx({ sender, recipient, asset, amount, memo, }: TxParams & {
         sender: Address;
     }): Promise<PreparedTx>;
-    /**
-     * Make a deposit
-     *
-     * @param {number} param.walletIndex Optional - The index to use to generate the address from the transaction will be done.
-     * If it is not set, address associated with index 0 will be used
-     * @param {Asset} param.asset Optional - The asset that will be deposit. If it is not set, Thorchain native asset will be
-     * used
-     * @param {BaseAmount} param.amount The amount that will be deposit
-     * @param {string} param.memo Optional - The memo associated with the deposit
-     * @param {BigNumber} param.gasLimit Optional - The limit amount of gas allowed to spend in the deposit. If not set, default
-     * value of 600000000 will be used
-     * @returns {string} The deposit hash
-     */
-    deposit({ walletIndex, asset, amount, memo, gasLimit, }: DepositParam): Promise<string>;
-    /**
-     * Create and sign transaction without broadcasting it
-     *
-     * @deprecated Use prepare Tx instead
-     */
-    transferOffline({ walletIndex, recipient, asset, amount, memo, gasLimit, }: TxOfflineParams & {
-        gasLimit?: BigNumber;
-    }): Promise<string>;
-    /**
-     * Returns the private key associated with an index
-     *
-     * @param {number} index Optional - The index to use to generate the private key. If it is not set, address associated with
-     * index 0 will be used
-     * @returns {Uint8Array} The private key
-     */
-    getPrivateKey(index?: number): Promise<Uint8Array>;
-    /**
-     * Returns the compressed public key associated with an index
-     *
-     * @param {number} index Optional - The index to use to generate the private key. If it is not set, address associated with
-     * index 0 will be used
-     * @returns {Uint8Array} The public key
-     */
-    getPubKey(index?: number): Promise<Uint8Array>;
     /**
      * Get deposit transaction
      *
@@ -162,41 +110,6 @@ export declare class Client extends CosmosSDKClient implements ThorchainClient {
      * @returns {StdFee} the standard fee
      */
     protected getStandardFee(): StdFee;
-    /**
-     * Hashes a buffer using SHA256 followed by RIPEMD160 or RMD160.
-     * @param {Uint8Array} buffer The buffer to hash
-     * @returns {Uint8Array} The hashed buffer
-     */
-    private hash160;
-    /**
-     * Sign a transaction making a round robin over the clients urls provided to the client
-     *
-     * @param {string} sender Sender address
-     * @param {DecodedTxRaw} unsignedTx Unsigned transaction
-     * @param {DirectSecp256k1HdWallet} signer Signer
-     * @param {BigNumber} gasLimit Transaction gas limit
-     * @returns {TxRaw} The raw signed transaction
-     */
-    private roundRobinSign;
-    /**
-     * Sign and broadcast a transaction making a round robin over the clients urls provided to the client
-     *
-     * @param {string} sender Sender address
-     * @param {DecodedTxRaw} unsignedTx Unsigned transaction
-     * @param {DirectSecp256k1HdWallet} signer Signer
-     * @returns {DeliverTxResponse} The transaction broadcasted
-     */
-    private roundRobinSignAndBroadcastTx;
-    /**
-     * Sign and broadcast a transaction making a round robin over the clients urls provided to the client
-     *
-     * @param {string} sender Sender address
-     * @param {DirectSecp256k1HdWallet} signer Signer
-     * @param {BigNumber} gasLimit Gas limit for the transaction
-     * @param {BaseAmount} amount Amount to deposit
-     * @param {string} memo Deposit memo
-     * @param {Asset} asset Asset to deposit
-     * @returns {DeliverTxResponse} The transaction broadcasted
-     */
-    private roundRobinSignAndBroadcastDeposit;
+    abstract deposit(params: DepositParam): Promise<string>;
+    abstract transferOffline(params: TxOfflineParams): Promise<string>;
 }

package/lib/clientKeystore.d.ts

@@ -0,0 +1,97 @@
+import { TxParams } from '@xchainjs/xchain-client';
+import { BigNumber } from 'bignumber.js';
+import { Client } from './client';
+import { DepositParam, TxOfflineParams } from './types';
+/**
+ * Thorchain Keystore client
+ */
+export declare class ClientKeystore extends Client {
+    /**
+     * Asynchronous version of getAddress method.
+     * @param {number} index Derivation path index of the address to be generated.
+     * @returns {string} A promise that resolves to the generated address.
+     */
+    getAddressAsync(index?: number): Promise<string>;
+    /**
+     * Get the address derived from the provided phrase.
+     * @param {number | undefined} walletIndex The index of the address derivation path. Default is 0.
+     * @returns {string} The user address at the specified walletIndex.
+     */
+    getAddress(walletIndex?: number): string;
+    /**
+     * Returns the private key associated with an index
+     *
+     * @param {number} index Optional - The index to use to generate the private key. If it is not set, address associated with
+     * index 0 will be used
+     * @returns {Uint8Array} The private key
+     */
+    getPrivateKey(index?: number): Promise<Uint8Array>;
+    /**
+     * Returns the compressed public key associated with an index
+     *
+     * @param {number} index Optional - The index to use to generate the private key. If it is not set, address associated with
+     * index 0 will be used
+     * @returns {Uint8Array} The public key
+     */
+    getPubKey(index?: number): Promise<Uint8Array>;
+    transfer(params: TxParams): Promise<string>;
+    /**
+     * Make a deposit
+     *
+     * @param {number} param.walletIndex Optional - The index to use to generate the address from the transaction will be done.
+     * If it is not set, address associated with index 0 will be used
+     * @param {Asset} param.asset Optional - The asset that will be deposit. If it is not set, Thorchain native asset will be
+     * used
+     * @param {BaseAmount} param.amount The amount that will be deposit
+     * @param {string} param.memo Optional - The memo associated with the deposit
+     * @param {BigNumber} param.gasLimit Optional - The limit amount of gas allowed to spend in the deposit. If not set, default
+     * value of 600000000 will be used
+     * @returns {string} The deposit hash
+     */
+    deposit({ walletIndex, asset, amount, memo, gasLimit, }: DepositParam): Promise<string>;
+    /**
+     * Create and sign transaction without broadcasting it
+     *
+     * @deprecated Use prepare Tx instead
+     */
+    transferOffline({ walletIndex, recipient, asset, amount, memo, gasLimit, }: TxOfflineParams & {
+        gasLimit?: BigNumber;
+    }): Promise<string>;
+    /**
+     * Hashes a buffer using SHA256 followed by RIPEMD160 or RMD160.
+     * @param {Uint8Array} buffer The buffer to hash
+     * @returns {Uint8Array} The hashed buffer
+     */
+    private hash160;
+    /**
+     * Sign a transaction making a round robin over the clients urls provided to the client
+     *
+     * @param {string} sender Sender address
+     * @param {DecodedTxRaw} unsignedTx Unsigned transaction
+     * @param {DirectSecp256k1HdWallet} signer Signer
+     * @param {BigNumber} gasLimit Transaction gas limit
+     * @returns {TxRaw} The raw signed transaction
+     */
+    private roundRobinSign;
+    /**
+     * Sign and broadcast a transaction making a round robin over the clients urls provided to the client
+     *
+     * @param {string} sender Sender address
+     * @param {DecodedTxRaw} unsignedTx Unsigned transaction
+     * @param {DirectSecp256k1HdWallet} signer Signer
+     * @returns {DeliverTxResponse} The transaction broadcasted
+     */
+    private roundRobinSignAndBroadcastTx;
+    /**
+     * Sign and broadcast a transaction making a round robin over the clients urls provided to the client
+     *
+     * @param {string} sender Sender address
+     * @param {DirectSecp256k1HdWallet} signer Signer
+     * @param {BigNumber} gasLimit Gas limit for the transaction
+     * @param {BaseAmount} amount Amount to deposit
+     * @param {string} memo Deposit memo
+     * @param {Asset} asset Asset to deposit
+     * @returns {DeliverTxResponse} The transaction broadcasted
+     */
+    private roundRobinSignAndBroadcastDeposit;
+}

package/lib/clientLedger.d.ts

@@ -0,0 +1,70 @@
+import Transport from '@ledgerhq/hw-transport';
+import { TxParams } from '@xchainjs/xchain-client';
+import { Client, ThorchainClientParams } from './client';
+import { DepositParam } from './types';
+/**
+ * Thorchain Ledger client
+ */
+export declare class ClientLedger extends Client {
+    private app;
+    constructor(params: ThorchainClientParams & {
+        transport: Transport;
+    });
+    /**
+     * Asynchronous version of getAddress method.
+     * @param {number} index Derivation path index of the address to be generated.
+     * @param {boolean} verify True to check the address against the Ledger device, otherwise false
+     * @returns {string} A promise that resolves to the generated address.
+     */
+    getAddressAsync(index?: number, verify?: boolean): Promise<string>;
+    /**
+     * @deprecated
+     * Asynchronous version of getAddress method. Not supported for ledger client
+     * @throws {Error} Not supported method
+     */
+    getAddress(): string;
+    /**
+     * Transfers RUNE or synth token
+     *
+     * @param {TxParams} params The transfer options.
+     * @param {number} params.walletIndex Optional - The index to use to generate the address from the transaction will be done.
+     * If it is not set, address associated with index 0 will be used
+     * @param {asset} params.asset Optional - The asset that will be deposit. If it is not set, Thorchain native asset will be
+     * used
+     * @param {BaseAmount} params.amount The amount that will be transfer
+     * @param {string} params.recipient Recipient of the transfer
+     * @param {string} params.memo Optional - The memo associated with the transfer
+     * @returns {TxHash} The transaction hash.
+     */
+    transfer(params: TxParams): Promise<string>;
+    /**
+     * Make a deposit
+     *
+     * @param {number} param.walletIndex Optional - The index to use to generate the address from the transaction will be done.
+     * If it is not set, address associated with index 0 will be used
+     * @param {Asset} param.asset Optional - The asset that will be deposit. If it is not set, Thorchain native asset will be
+     * used
+     * @param {BaseAmount} param.amount The amount that will be deposit
+     * @param {string} param.memo Optional - The memo associated with the deposit
+     * @param {BigNumber} param.gasLimit Optional - The limit amount of gas allowed to spend in the deposit. If not set, default
+     * value of 600000000 will be used
+     * @returns {string} The deposit hash
+     */
+    deposit({ walletIndex, asset, amount, memo, gasLimit, }: DepositParam): Promise<string>;
+    /**
+     * @deprecated
+     * Create a transaction and sign it without broadcasting it
+     *
+     * @param {TxParams} params The transfer options.
+     * @param {number} params.walletIndex Optional - The index to use to generate the address from the transaction will be done.
+     * If it is not set, address associated with index 0 will be used
+     * @param {asset} params.asset Optional - The asset that will be deposit. If it is not set, Thorchain native asset will be
+     * used
+     * @param {BaseAmount} params.amount The amount that will be transfer
+     * @param {string} params.recipient Recipient of the transfer
+     * @param {string} params.memo Optional - The memo associated with the transfer
+     * @returns {TxHash} The transaction hash.
+     */
+    transferOffline(params: TxParams): Promise<string>;
+    private getProtocolAminoMessages;
+}

package/lib/index.d.ts

@@ -1,4 +1,5 @@
-export * from './client';
+export { ClientKeystore, ClientKeystore as Client } from './clientKeystore';
+export { ClientLedger } from './clientLedger';
 export * from './types';
 export * from './utils';
 export * from './const';