@xchainjs/xchain-thorchain 0.27.11 → 0.28.0

package/lib/utils.d.ts

@@ -1,197 +1,197 @@
-import cosmosclient from '@cosmos-client/core';
-import { Balance, Fees, Network, TxHash } from '@xchainjs/xchain-client';
-import { CosmosSDKClient, TxLog } from '@xchainjs/xchain-cosmos';
-import { Address, Asset, BaseAmount } from '@xchainjs/xchain-util';
-import Long from 'long';
-import { ChainId, ExplorerUrls, TxData } from './types';
-import { MsgNativeTx } from './types/messages';
-/**
- * Checks whether an asset is `AssetRuneNative`
- *
- * @param {Asset} asset
- * @returns {boolean} `true` or `false`
- */
-export declare const isAssetRuneNative: (asset: Asset) => boolean;
-/**
+import cosmosclient from '@cosmos-client/core';
+import { Balance, Fees, Network, TxHash } from '@xchainjs/xchain-client';
+import { CosmosSDKClient, TxLog } from '@xchainjs/xchain-cosmos';
+import { Address, Asset, BaseAmount } from '@xchainjs/xchain-util';
+import Long from 'long';
+import { ChainId, ExplorerUrls, TxData } from './types';
+import { MsgNativeTx } from './types/messages';
+/**
+ * Checks whether an asset is `AssetRuneNative`
+ *
+ * @param {Asset} asset
+ * @returns {boolean} `true` or `false`
+ */
+export declare const isAssetRuneNative: (asset: Asset) => boolean;
+/**
 
- * Get denomination from Asset
- *
- * @param {Asset} asset
- * @returns {string} The denomination of the given asset.
- */
-export declare const getDenom: (asset: Asset) => string;
-/**
- * Get Asset from denomination
- *
- * @param {string} denom
- * @returns {Asset|null} The asset of the given denomination.
- */
-export declare const assetFromDenom: (denom: string) => Asset | null;
-/**
- * Response guard for transaction broadcast
- *
- * @param {any} response The response from the node.
- * @returns {boolean} `true` or `false`.
- */
-export declare const isBroadcastSuccess: (response: unknown) => boolean;
-/**
- * Get address prefix based on the network.
- *
- * @param {Network} network
- * @returns {string} The address prefix based on the network.
- *
- **/
-export declare const getPrefix: (network: Network) => "thor" | "sthor" | "tthor";
-/**
- * Register type for encoding `MsgDeposit` messages
- */
-export declare const registerDepositCodecs: () => void;
-/**
- * Register type for encoding `MsgSend` messages
- */
-export declare const registerSendCodecs: () => void;
-/**
- * Parse transaction data from event logs
- *
- * @param {TxLog[]} logs List of tx logs
- * @param {Address} address - Address to get transaction data for
- * @returns {TxData} Parsed transaction data
- */
-export declare const getDepositTxDataFromLogs: (logs: TxLog[], address: Address, senderAsset?: Asset | undefined, receiverAsset?: Asset | undefined) => TxData;
-/**
- * Get the default fee.
- *
- * @returns {Fees} The default fee.
- */
-export declare const getDefaultFees: () => Fees;
-/**
- * Get transaction type.
- *
- * @param {string} txData the transaction input data
- * @param {string} encoding `base64` or `hex`
- * @returns {string} the transaction type.
- */
-export declare const getTxType: (txData: string, encoding: 'base64' | 'hex') => string;
-/**
- * Helper to get THORChain's chain id
- * @param {string} nodeUrl THORNode url
- */
-export declare const getChainId: (nodeUrl: string) => Promise<ChainId>;
-/**
- * Builds final unsigned TX
- *
- * @param cosmosSdk - CosmosSDK
- * @param txBody - txBody with encoded Msgs
- * @param signerPubkey - signerPubkey string
- * @param sequence - account sequence
- * @param gasLimit - transaction gas limit
- * @returns
- */
-export declare const buildUnsignedTx: ({ cosmosSdk, txBody, signerPubkey, sequence, gasLimit, }: {
-    cosmosSdk: cosmosclient.CosmosSDK;
-    txBody: cosmosclient.proto.cosmos.tx.v1beta1.TxBody;
-    signerPubkey: cosmosclient.proto.google.protobuf.Any;
-    sequence: Long;
-    gasLimit?: Long.Long | undefined;
-}) => cosmosclient.TxBuilder;
-/**
- * Estimates usage of gas
- *
- * Note: Be careful by using this helper function,
- * it's still experimental and result might be incorrect.
- * Change `multiplier` to get a valid estimation of gas.
- */
-export declare const getEstimatedGas: ({ cosmosSDKClient, txBody, privKey, accountNumber, accountSequence, multiplier, }: {
-    cosmosSDKClient: CosmosSDKClient;
-    txBody: cosmosclient.proto.cosmos.tx.v1beta1.TxBody;
-    privKey: cosmosclient.proto.cosmos.crypto.secp256k1.PrivKey;
-    accountNumber: Long;
-    accountSequence: Long;
-    multiplier?: number | undefined;
-}) => Promise<Long | undefined>;
-/**
- * Structure a MsgDeposit
- *
- * @param {MsgNativeTx} msgNativeTx Msg of type `MsgNativeTx`.
- * @param {string} nodeUrl Node url
- * @param {chainId} ChainId Chain id of the network
- *
- * @returns {Tx} The transaction details of the given transaction id.
- *
- * @throws {"Invalid client url"} Thrown if the client url is an invalid one.
- */
-export declare const buildDepositTx: ({ msgNativeTx, nodeUrl, chainId, }: {
-    msgNativeTx: MsgNativeTx;
-    nodeUrl: string;
-    chainId: ChainId;
-}) => Promise<cosmosclient.proto.cosmos.tx.v1beta1.TxBody>;
-/**
- * Structure a MsgSend
- *
- * @param fromAddress - required, from address string
- * @param toAddress - required, to address string
- * @param assetAmount - required, asset amount string (e.g. "10000")
- * @param assetDenom - required, asset denom string (e.g. "rune")
- * @param memo - optional, memo string
- *
- * @returns
- */
-export declare const buildTransferTx: ({ fromAddress, toAddress, assetAmount, assetDenom, memo, nodeUrl, chainId, }: {
-    fromAddress: Address;
-    toAddress: Address;
-    assetAmount: BaseAmount;
-    assetDenom: string;
-    memo?: string | undefined;
-    nodeUrl: string;
-    chainId: ChainId;
-}) => Promise<cosmosclient.proto.cosmos.tx.v1beta1.TxBody>;
-/**
- * Get the balance of a given address.
- *
- * @param {Address} address By default, it will return the balance of the current wallet. (optional)
- * @param {Asset} asset If not set, it will return all assets available. (optional)
- * @param {cosmosClient} CosmosSDKClient
- *
- * @returns {Balance[]} The balance of the address.
- */
-export declare const getBalance: ({ address, assets, cosmosClient, }: {
-    address: Address;
-    assets?: Asset[] | undefined;
-    cosmosClient: CosmosSDKClient;
-}) => Promise<Balance[]>;
-/**
- * Get the explorer url.
- *
- * @param {Network} network
- * @param {ExplorerUrls} Explorer urls
- * @returns {string} The explorer url for thorchain based on the given network.
- */
-export declare const getExplorerUrl: ({ root }: ExplorerUrls, network: Network) => string;
-/**
- * Get explorer address url.
- *
- * @param {ExplorerUrls} Explorer urls
- * @param {Network} network
- * @param {Address} address
- * @returns {string} The explorer url for the given address.
- */
-export declare const getExplorerAddressUrl: ({ urls, network, address, }: {
-    urls: ExplorerUrls;
-    network: Network;
-    address: Address;
-}) => string;
-/**
- * Get transaction url.
- *
- * @param {ExplorerUrls} Explorer urls
- * @param {Network} network
- * @param {TxHash} txID
- * @returns {string} The explorer url for the given transaction id.
- */
-export declare const getExplorerTxUrl: ({ urls, network, txID, }: {
-    urls: ExplorerUrls;
-    network: Network;
-    txID: TxHash;
-}) => string;
-export declare const getAccount: (address: string, client: CosmosSDKClient) => Promise<cosmosclient.proto.cosmos.auth.v1beta1.IBaseAccount>;
-export declare const getSequence: (address: string, client: CosmosSDKClient) => Promise<number | null>;
+ * Get denomination from Asset
+ *
+ * @param {Asset} asset
+ * @returns {string} The denomination of the given asset.
+ */
+export declare const getDenom: (asset: Asset) => string;
+/**
+ * Get Asset from denomination
+ *
+ * @param {string} denom
+ * @returns {Asset|null} The asset of the given denomination.
+ */
+export declare const assetFromDenom: (denom: string) => Asset | null;
+/**
+ * Response guard for transaction broadcast
+ *
+ * @param {any} response The response from the node.
+ * @returns {boolean} `true` or `false`.
+ */
+export declare const isBroadcastSuccess: (response: unknown) => boolean;
+/**
+ * Get address prefix based on the network.
+ *
+ * @param {Network} network
+ * @returns {string} The address prefix based on the network.
+ *
+ **/
+export declare const getPrefix: (network: Network) => "thor" | "sthor" | "tthor";
+/**
+ * Register type for encoding `MsgDeposit` messages
+ */
+export declare const registerDepositCodecs: () => void;
+/**
+ * Register type for encoding `MsgSend` messages
+ */
+export declare const registerSendCodecs: () => void;
+/**
+ * Parse transaction data from event logs
+ *
+ * @param {TxLog[]} logs List of tx logs
+ * @param {Address} address - Address to get transaction data for
+ * @returns {TxData} Parsed transaction data
+ */
+export declare const getDepositTxDataFromLogs: (logs: TxLog[], address: Address, senderAsset?: Asset, receiverAsset?: Asset) => TxData;
+/**
+ * Get the default fee.
+ *
+ * @returns {Fees} The default fee.
+ */
+export declare const getDefaultFees: () => Fees;
+/**
+ * Get transaction type.
+ *
+ * @param {string} txData the transaction input data
+ * @param {string} encoding `base64` or `hex`
+ * @returns {string} the transaction type.
+ */
+export declare const getTxType: (txData: string, encoding: 'base64' | 'hex') => string;
+/**
+ * Helper to get THORChain's chain id
+ * @param {string} nodeUrl THORNode url
+ */
+export declare const getChainId: (nodeUrl: string) => Promise<ChainId>;
+/**
+ * Builds final unsigned TX
+ *
+ * @param cosmosSdk - CosmosSDK
+ * @param txBody - txBody with encoded Msgs
+ * @param signerPubkey - signerPubkey string
+ * @param sequence - account sequence
+ * @param gasLimit - transaction gas limit
+ * @returns
+ */
+export declare const buildUnsignedTx: ({ cosmosSdk, txBody, signerPubkey, sequence, gasLimit, }: {
+    cosmosSdk: cosmosclient.CosmosSDK;
+    txBody: cosmosclient.proto.cosmos.tx.v1beta1.TxBody;
+    signerPubkey: cosmosclient.proto.google.protobuf.Any;
+    sequence: Long;
+    gasLimit?: Long.Long | undefined;
+}) => cosmosclient.TxBuilder;
+/**
+ * Estimates usage of gas
+ *
+ * Note: Be careful by using this helper function,
+ * it's still experimental and result might be incorrect.
+ * Change `multiplier` to get a valid estimation of gas.
+ */
+export declare const getEstimatedGas: ({ cosmosSDKClient, txBody, privKey, accountNumber, accountSequence, multiplier, }: {
+    cosmosSDKClient: CosmosSDKClient;
+    txBody: cosmosclient.proto.cosmos.tx.v1beta1.TxBody;
+    privKey: cosmosclient.proto.cosmos.crypto.secp256k1.PrivKey;
+    accountNumber: Long;
+    accountSequence: Long;
+    multiplier?: number | undefined;
+}) => Promise<Long | undefined>;
+/**
+ * Structure a MsgDeposit
+ *
+ * @param {MsgNativeTx} msgNativeTx Msg of type `MsgNativeTx`.
+ * @param {string} nodeUrl Node url
+ * @param {chainId} ChainId Chain id of the network
+ *
+ * @returns {Tx} The transaction details of the given transaction id.
+ *
+ * @throws {"Invalid client url"} Thrown if the client url is an invalid one.
+ */
+export declare const buildDepositTx: ({ msgNativeTx, nodeUrl, chainId, }: {
+    msgNativeTx: MsgNativeTx;
+    nodeUrl: string;
+    chainId: ChainId;
+}) => Promise<cosmosclient.proto.cosmos.tx.v1beta1.TxBody>;
+/**
+ * Structure a MsgSend
+ *
+ * @param fromAddress - required, from address string
+ * @param toAddress - required, to address string
+ * @param assetAmount - required, asset amount string (e.g. "10000")
+ * @param assetDenom - required, asset denom string (e.g. "rune")
+ * @param memo - optional, memo string
+ *
+ * @returns
+ */
+export declare const buildTransferTx: ({ fromAddress, toAddress, assetAmount, assetDenom, memo, nodeUrl, chainId, }: {
+    fromAddress: Address;
+    toAddress: Address;
+    assetAmount: BaseAmount;
+    assetDenom: string;
+    memo?: string | undefined;
+    nodeUrl: string;
+    chainId: ChainId;
+}) => Promise<cosmosclient.proto.cosmos.tx.v1beta1.TxBody>;
+/**
+ * Get the balance of a given address.
+ *
+ * @param {Address} address By default, it will return the balance of the current wallet. (optional)
+ * @param {Asset} asset If not set, it will return all assets available. (optional)
+ * @param {cosmosClient} CosmosSDKClient
+ *
+ * @returns {Balance[]} The balance of the address.
+ */
+export declare const getBalance: ({ address, assets, cosmosClient, }: {
+    address: Address;
+    assets?: Asset[] | undefined;
+    cosmosClient: CosmosSDKClient;
+}) => Promise<Balance[]>;
+/**
+ * Get the explorer url.
+ *
+ * @param {Network} network
+ * @param {ExplorerUrls} Explorer urls
+ * @returns {string} The explorer url for thorchain based on the given network.
+ */
+export declare const getExplorerUrl: ({ root }: ExplorerUrls, network: Network) => string;
+/**
+ * Get explorer address url.
+ *
+ * @param {ExplorerUrls} Explorer urls
+ * @param {Network} network
+ * @param {Address} address
+ * @returns {string} The explorer url for the given address.
+ */
+export declare const getExplorerAddressUrl: ({ urls, network, address, }: {
+    urls: ExplorerUrls;
+    network: Network;
+    address: Address;
+}) => string;
+/**
+ * Get transaction url.
+ *
+ * @param {ExplorerUrls} Explorer urls
+ * @param {Network} network
+ * @param {TxHash} txID
+ * @returns {string} The explorer url for the given transaction id.
+ */
+export declare const getExplorerTxUrl: ({ urls, network, txID, }: {
+    urls: ExplorerUrls;
+    network: Network;
+    txID: TxHash;
+}) => string;
+export declare const getAccount: (address: string, client: CosmosSDKClient) => Promise<cosmosclient.proto.cosmos.auth.v1beta1.IBaseAccount>;
+export declare const getSequence: (address: string, client: CosmosSDKClient) => Promise<number | null>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain",
-  "version": "0.27.11",
+  "version": "0.28.0",
   "description": "Custom Thorchain client and utilities used by XChainJS clients",
   "keywords": [
     "THORChain",
@@ -35,12 +35,12 @@
   },
   "devDependencies": {
     "@cosmos-client/core": "0.46.1",
-    "@types/big.js": "^6.0.0",
-    "@xchainjs/xchain-client": "^0.13.7",
-    "@xchainjs/xchain-cosmos": "^0.20.9",
-    "@xchainjs/xchain-crypto": "^0.2.6",
-    "@xchainjs/xchain-util": "^0.12.0",
-    "axios": "^0.25.0",
+    "@types/big.js": "^6.1.6",
+    "@xchainjs/xchain-client": "^0.14.0",
+    "@xchainjs/xchain-cosmos": "^0.21.0",
+    "@xchainjs/xchain-crypto": "^0.3.0",
+    "@xchainjs/xchain-util": "^0.13.0",
+    "axios": "^1.3.6",
     "bech32-buffer": "^0.2.0",
     "nock": "^13.0.5"
   },
@@ -49,11 +49,11 @@
   },
   "peerDependencies": {
     "@cosmos-client/core": "0.46.1",
-    "@xchainjs/xchain-client": "^0.13.7",
-    "@xchainjs/xchain-cosmos": "^0.20.9",
-    "@xchainjs/xchain-crypto": "^0.2.6",
-    "@xchainjs/xchain-util": "^0.12.0",
-    "axios": "^0.25.0",
+    "@xchainjs/xchain-client": "^0.14.0",
+    "@xchainjs/xchain-cosmos": "^0.21.0",
+    "@xchainjs/xchain-crypto": "^0.3.0",
+    "@xchainjs/xchain-util": "^0.13.0",
+    "axios": "^1.3.6",
     "bech32-buffer": "^0.2.0"
   }
 }