@bitgo/account-lib 2.20.0-rc.3 → 2.20.0-rc.32

package/dist/src/coin/hbar/utils.d.ts

@@ -1,152 +1,193 @@
-/// <reference types="node" />
 import { PrivateKey } from '@hashgraph/sdk';
-import { proto } from '../../../resources/hbar/protobuf/hedera';
-import { AddressDetails } from './ifaces';
+import * as proto from '@hashgraph/proto';
+import { AddressDetails } from './iface';
+import { toHex, toUint8Array } from '@bitgo/sdk-core';
+import { BaseCoin } from '@bitgo/statics';
+export { toHex, toUint8Array };
 /**
- * Returns whether or not the string is a valid Hedera account.
+ * Returns whether the string is a valid Hedera account address
  *
  * In any form, `shard` and `realm` are assumed to be 0 if not provided.
  *
- * @param {string} address - the address to be validated
- * @returns {boolean} - the validation result
+ * @param {string} address - The address to be validated
+ * @returns {boolean} - The validation result
  */
 export declare function isValidAddress(address: string): boolean;
 /**
- * Returns whether or not the string is a valid Hedera transaction id or not.
+ * Returns whether the string is a valid Hedera transaction id
  *
- * @param {string} txId - the transaction id to be validated
- * @returns {boolean} - the validation result
+ * @param {string} txId - The transaction id to be validated
+ * @returns {boolean} - The validation result
  */
 export declare function isValidTransactionId(txId: string): boolean;
 /**
- * Returns whether or not the string is a valid Hedera public key
+ Returns whether the string is a valid Hedera public key
  *
- * @param {string} key - the  public key to be validated
- * @returns {boolean} - the validation result
+ * @param {string} key - The public key to be validated
+ * @returns {boolean} - The validation result
  */
 export declare function isValidPublicKey(key: string): boolean;
-/**
- * Returns an hex string of the given buffer
- *
- * @param {Buffer | Uint8Array} buffer - the buffer to be converted to hex
- * @returns {string} - the hex value
- */
-export declare function toHex(buffer: Buffer | Uint8Array): string;
-/**
- * Returns a Uint8Array of the given hex string
- *
- * @param {string} str - the hex string to be converted
- * @returns {string} - the Uint8Array value
- */
-export declare function toUint8Array(str: string): Uint8Array;
 /**
  * Checks whether nodeJS.process exist and if a node version is defined to determine if this is an nodeJS environment
  *
- * @returns {boolean} - the validation result
+ * @returns {boolean} - The validation result
  */
 export declare function isNodeEnvironment(): boolean;
 /**
  * Calculate the current time with nanoseconds precision
  *
- * @returns {string} the current time in seconds
+ * @returns {string} - The current time in seconds
  */
 export declare function getCurrentTime(): string;
 /**
- * Returns whether or not the string is a valid timestamp. Nanoseconds are optional and can be passed after a dot, for
- * example: 1595374723.356981689
+ * Returns whether the string is a valid timestamp
  *
- * @param {string} time - the timestamp to be validated
- * @returns {boolean} the validation result
+ * Nanoseconds are optional and can be passed after a dot, for example: 1595374723.356981689
+ *
+ * @param {string} time - The timestamp to be validated
+ * @returns {boolean} - The validation result
  */
 export declare function isValidTimeString(time: string): boolean;
 /**
- * Returns whether or not the string is a valid amount number
+ * Returns whether the string is a valid amount number
  *
- * @param {string} amount - the string to validate
- * @returns {boolean} - the validation result
+ * @param {string} amount - The string to validate
+ * @returns {boolean} - The validation result
  */
 export declare function isValidAmount(amount: string): boolean;
 /**
  * Returns whether the provided raw transaction accommodates to bitgo's preferred format
  *
  * @param {any} rawTransaction - The raw transaction to be checked
- * @returns {boolean} the validation result
+ * @returns {boolean} - The validation result
  */
 export declare function isValidRawTransactionFormat(rawTransaction: any): boolean;
 /**
  * Returns a string representation of an {proto.IAccountID} object
  *
- * @param {proto.IAccountID} - account id to be cast to string
- * @returns {string} - the string representation of the {proto.IAccountID}
+ * @param {proto.IAccountID} accountId - Account id to be cast to string
+ * @returns {string} - The string representation of the {proto.IAccountID}
  */
 export declare function stringifyAccountId({ shardNum, realmNum, accountNum }: proto.IAccountID): string;
+/**
+ * Returns a string representation of an {proto.ITokenID} object
+ *
+ * @param {proto.ITokenID} - token id to be cast to string
+ * @returns {string} - the string representation of the {proto.ITokenID}
+ */
+export declare function stringifyTokenId({ shardNum, realmNum, tokenNum }: proto.ITokenID): string;
 /**
  * Returns a string representation of an {proto.ITimestamp} object
  *
- * @param {proto.ITimestamp} - timestamp to be cast to string
- * @returns {string} - the string representation of the {proto.ITimestamp}
+ * @param {proto.ITimestamp} timestamp - Timestamp to be cast to string
+ * @returns {string} - The string representation of the {proto.ITimestamp}
  */
 export declare function stringifyTxTime({ seconds, nanos }: proto.ITimestamp): string;
 /**
  * Remove the specified prefix from a string only if it starts with that prefix
  *
- * @param {string} prefix The prefix to be removed
- * @param {string} key The original string, usually a private or public key
- * @returns {string} The string without prefix
+ * @param {string} prefix - The prefix to be removed
+ * @param {string} key - The original string, usually a private or public key
+ * @returns {string} - The string without prefix
  */
 export declare function removePrefix(prefix: string, key: string): string;
 /**
- * Check if this is a valid memo or not.
+ * Check if this is a valid memo
  *
- * @param memo
+ * @param {string} memo
+ * @returns {boolean}
  */
 export declare function isValidMemo(memo: string): boolean;
 /**
  * Uses the native hashgraph SDK function to get a raw key.
  *
- * @param prv
+ * @param {string} prv - Private key
+ * @returns {PrivateKey}
  */
 export declare function createRawKey(prv: string): PrivateKey;
 /**
- * Converts an stellar public key to a ed25519 hex format.
+ * Converts a stellar public key to ed25519 hex format
  *
- * @param stellarPub
- * @param prv
+ * @param {string} stellarPub
+ * @returns {string}
  */
 export declare function convertFromStellarPub(stellarPub: string): string;
 /**
- * Compares an address to the base address to check if matchs.
+ * Checks if two addresses have the same base address
  *
- * @param {String} address - an address
- * @param {String} baseAddress - a base address
+ * @param {String} address
+ * @param {String} baseAddress
  * @returns {boolean}
  */
 export declare function isSameBaseAddress(address: string, baseAddress: string): boolean;
 /**
  * Returns the base address portion of an address
  *
- * @param {String} address - an address
+ * @param {String} address
  * @returns {String} - the base address
  */
 export declare function getBaseAddress(address: string): string;
 /**
  * Process address into address and memo id
  *
- * @param rawAddress the address
- * @returns object containing address and memo id
+ * @param {string} rawAddress
+ * @returns {AddressDetails} - object containing address and memo id
  */
 export declare function getAddressDetails(rawAddress: string): AddressDetails;
 /**
  * Validate and return address with appended memo id
  *
- * @param {AddressDetails} addressDetails
+ * @param {AddressDetails} addressDetails - Address which to append memo id
+ * @returns {string} - Address with appended memo id
  */
 export declare function normalizeAddress({ address, memoId }: AddressDetails): string;
 /**
  * Return boolean indicating whether input is a valid address with memo id
  *
- * @param {string} address address in the form <address>?memoId=<memoId>
- * @returns {boolean} true is input is a valid address
+ * @param {string} address - Address in the form <address>?memoId=<memoId>
+ * @returns {boolean} - True if input is a valid address
  */
 export declare function isValidAddressWithPaymentId(address: string): boolean;
+/**
+ * Build hedera {proto.TokenID} object from token ID string
+ *
+ * @param {string} tokenID - The token ID to build
+ * @returns {proto.TokenID} - The resulting proto TokenID object
+ */
+export declare function buildHederaTokenID(tokenID: string): proto.TokenID;
+/**
+ * Build hedera {proto.AccountID} object from account ID string
+ *
+ * @param {string} accountID - The account ID to build
+ * @returns {proto} - The resulting proto AccountID object
+ */
+export declare function buildHederaAccountID(accountID: string): proto.AccountID;
+/**
+ * Check if Hedera token ID is valid and supported
+ *
+ * @param {string} tokenId - The token ID to validate
+ * @returns {boolean} - True if tokenId is valid and supported
+ */
+export declare function isValidHederaTokenID(tokenId: string): boolean;
+/**
+ * Get the associated hedera token ID from token name, if supported
+ *
+ * @param {string} tokenName - The hedera token name
+ * @returns {boolean} - The associated token ID or undefined if not supported
+ */
+export declare function getHederaTokenIdFromName(tokenName: string): string | undefined;
+/**
+ * Get the associated hedera token from token ID, if supported
+ *
+ * @param tokenId - The token address
+ * @returns {BaseCoin} - BaseCoin object for the matching token
+ */
+export declare function getHederaTokenNameFromId(tokenId: string): Readonly<BaseCoin> | undefined;
+/**
+ * Return boolean indicating whether input is a valid token transfer transaction
+ *
+ * @param {proto.ICryptoTransferTransactionBody | null} transferTxBody is a transfer transaction body
+ * @returns {boolean} true is input is a valid token transfer transaction
+ */
+export declare function isTokenTransfer(transferTxBody: proto.ICryptoTransferTransactionBody | null): boolean;
 //# sourceMappingURL=utils.d.ts.map

package/dist/src/coin/hbar/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/coin/hbar/utils.ts"],"names":[],"mappings":";AACA,OAAO,EAAuC,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAIjF,OAAO,EAAE,KAAK,EAAE,MAAM,yCAAyC,CAAC;AAEhE,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAM1C;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAUvD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAa1D;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAUrD;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,CAEzD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAEpD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAE3C;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,MAAM,CAQvC;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,WAE7C;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAOrD;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,cAAc,EAAE,GAAG,GAAG,OAAO,CAQxE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,KAAK,CAAC,UAAU,GAAG,MAAM,CAE/F;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,KAAK,CAAC,UAAU,UAEnE;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAKhE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEjD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAEpD;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAOhE;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAK/E;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAGtD;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,cAAc,CAwBpE;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,cAAc,GAAG,MAAM,CAK5E;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAOpE"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/coin/hbar/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAa,UAAU,EAAqC,MAAM,gBAAgB,CAAC;AAC1F,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAG1C,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC,OAAO,EAAE,KAAK,EAAE,YAAY,EAAc,MAAM,iBAAiB,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAsB,MAAM,gBAAgB,CAAC;AAC9D,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;AAI/B;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAUvD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAa1D;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAUrD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAE3C;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,MAAM,CAQvC;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEvD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAOrD;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,cAAc,EAAE,GAAG,GAAG,OAAO,CAKxE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,KAAK,CAAC,UAAU,GAAG,MAAM,CAE/F;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,KAAK,CAAC,QAAQ,GAAG,MAAM,CAEzF;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,KAAK,CAAC,UAAU,GAAG,MAAM,CAE5E;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAKhE;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAEpD;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAOhE;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAK/E;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAGtD;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,cAAc,CA6BpE;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,cAAc,GAAG,MAAM,CAK5E;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAOpE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,OAAO,CAOjE;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK,CAAC,SAAS,CAOvE;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAK7D;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAS9E;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,SAAS,CAQxF;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,cAAc,EAAE,KAAK,CAAC,8BAA8B,GAAG,IAAI,GAAG,OAAO,CAEpG"}