@bitgo/sdk-coin-stx 1.1.0-rc.0

package/dist/src/lib/utils.d.ts

@@ -0,0 +1,207 @@
+/// <reference types="node" />
+import { AddressHashMode, AddressVersion, ClarityValue, StacksTransaction } from '@stacks/transactions';
+import { AddressDetails, SendParams } from './iface';
+import { KeyPair } from '.';
+import { StacksNetwork as BitgoStacksNetwork } from '@bitgo/statics';
+/**
+ * Encodes a buffer as a "0x" prefixed lower-case hex string.
+ *
+ * @param {Buffer} buff - a buffer with a hexadecimal string
+ * @returns {string} - the hexadecimal string prefixed with "0x"
+ */
+export declare function bufferToHexPrefixString(buff: Buffer): string;
+/**
+ * Remove the "0x" prefix from the given string, if present.
+ *
+ * @param {string} hex - a hexadecimal string
+ * @returns {string} - the hexadecimal string without a leading "0x"
+ */
+export declare function removeHexPrefix(hex: string): string;
+/**
+ * @param tx
+ */
+export declare function getTxSenderAddress(tx: StacksTransaction): string;
+/**
+ * Returns whether or not the string is a valid amount number
+ *
+ * @param {string} amount - the string to validate
+ * @returns {boolean} - the validation result
+ */
+export declare function isValidAmount(amount: string): boolean;
+/**
+ * Returns whether or not the string is a valid protocol address
+ *
+ * @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 protocol transaction id or not.
+ *
+ * A valid transaction id is a SHA-512/256 hash of a serialized transaction; see
+ * the txidFromData function in @stacks/transaction:
+ * https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/utils.ts#L97
+ *
+ * @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 protocol public key or
+ * extended public key.
+ *
+ * The key format is documented at
+ * https://github.com/stacksgov/sips/blob/main/sips/sip-005/sip-005-blocks-and-transactions.md#transaction-authorization
+ *
+ * @param {string} pub - the  public key to be validated
+ * @returns {boolean} - the validation result
+ */
+export declare function isValidPublicKey(pub: string): boolean;
+/**
+ * Returns whether or not the string is a valid protocol private key, or extended
+ * private key.
+ *
+ * The protocol key format is described in the @stacks/transactions npm package, in the
+ * createStacksPrivateKey function:
+ * https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/keys.ts#L125
+ *
+ * @param {string} prv - the private key (or extended private key) to be validated
+ * @returns {boolean} - the validation result
+ */
+export declare function isValidPrivateKey(prv: string): boolean;
+/**
+ * Checks if raw transaction can be deserialized
+ *
+ * @param {unknown} rawTransaction - transaction in raw hex format
+ * @returns {boolean} - the validation result
+ */
+export declare function isValidRawTransaction(rawTransaction: unknown): boolean;
+/**
+ * Returns whether or not the memo string is valid
+ *
+ * @param {string} memo - the string to be validated
+ * @returns {boolean} - the validation result
+ */
+export declare function isValidMemo(memo: string): boolean;
+/**
+ * Checks for valid contract address
+ *
+ * @param {string} addr - contract deployer address
+ * @param {BitgoStacksNetwork} network - network object
+ * @returns {boolean} - the validation result
+ */
+export declare function isValidContractAddress(addr: string, network: BitgoStacksNetwork): boolean;
+/**
+ * Check if the name is one of valid contract names
+ *
+ * @param {string} name - function name
+ * @returns {boolean} - validation result
+ */
+export declare function isValidContractFunctionName(name: string): boolean;
+/**
+ * Unpads a memo string, so it removes nulls.
+ *
+ * Useful when memo is fill up the length. Result is becomes readable.
+ *
+ * @param {string} memo - the string to be validated
+ * @returns {boolean} - the validation result
+ */
+export declare function unpadMemo(memo: string): string;
+/**
+ * Generate a multisig address from multiple STX public keys
+ *
+ * @param {string[]} pubKeys - list of public keys as strings
+ * @param {AddressVersion} addressVersion - MainnetMultiSig, TestnetMultiSig
+ * @param {AddressHashMode} addressHashMode - SerializeP2SH
+ * @param {number} [signaturesRequired] - number of signatures required, default value its 2
+ * @returns {address: string, hash160: string} - a multisig address
+ */
+export declare function getSTXAddressFromPubKeys(pubKeys: string[], addressVersion?: AddressVersion, addressHashMode?: AddressHashMode, signaturesRequired?: number): {
+    address: string;
+    hash160: string;
+};
+/**
+ * signs a string message
+ *
+ * @param keyPair
+ * @param data  - message to be signed
+ * @returns signed message string
+ */
+export declare function signMessage(keyPair: KeyPair, data: string): string;
+/**
+ * Verifies a signed message
+ *
+ * The signature must be 130 bytes long -- see RECOVERABLE_ECDSA_SIG_LENGTH_BYTES
+ * in @stacks/transactions/src/constants.ts
+ *
+ * @param {string} message - message to verify the signature
+ * @param {string} signature - signature to verify
+ * @param {string} publicKey - public key as hex string used to verify the signature
+ * @returns {boolean} - verification result
+ */
+export declare function verifySignature(message: string, signature: string, publicKey: string): boolean;
+/**
+ * Process address into address and memo id
+ *
+ * @param {string} address the address to process
+ * @returns {Object} object containing address and memo id
+ */
+export declare function getAddressDetails(address: string): AddressDetails;
+/**
+ * Validate and return address with appended memo id
+ *
+ * @param {AddressDetails} addressDetails
+ * @returns {string} address with 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
+ */
+export declare function isValidAddressWithPaymentId(address: string): boolean;
+/**
+ * Return string representation of clarity value input
+ *
+ * @param {ClarityValue} cv clarity value function argument
+ * @returns {String} stringified clarity value
+ */
+export declare function stringifyCv(cv: ClarityValue): any;
+/**
+ * Parse functionArgs into send params for send-many-memo contract calls
+ *
+ * @param {ClarityValue[]} args functionArgs from a contract call payload
+ * @returns {SendParams[]} An array of sendParams
+ */
+export declare function functionArgsToSendParams(args: ClarityValue[]): SendParams[];
+/**
+ * Gets the version of an address
+ *
+ * @param {String} address the address with or without the memoId
+ * @returns {AddressVersion} A number that represent the Address Version
+ */
+export declare function getAddressVersion(address: string): AddressVersion;
+/**
+ * Returns a STX pub key from an xpub
+ *
+ * @param {String} xpub an xpub
+ * @returns {String} a compressed STX pub key
+ */
+export declare function xpubToSTXPubkey(xpub: string, compressed?: boolean): string;
+/**
+ * Returns the base address portion of an address
+ *
+ * @param {String} address - an address
+ * @returns {String} - the base address
+ */
+export declare function getBaseAddress(address: string): string;
+/**
+ * Compares an address to the base address to check if matchs.
+ *
+ * @param {String} address - an address
+ * @param {String} baseAddress - a base address
+ * @returns {boolean}
+ */
+export declare function isSameBaseAddress(address: string, baseAddress: string): boolean;
+//# sourceMappingURL=utils.d.ts.map

package/dist/src/lib/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/lib/utils.ts"],"names":[],"mappings":";AAGA,OAAO,EAGL,eAAe,EAGf,cAAc,EAGd,YAAY,EAYZ,iBAAiB,EAGlB,MAAM,sBAAsB,CAAC;AAI9B,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,CAAC;AAC5B,OAAO,EAAE,aAAa,IAAI,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAGrE;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE5D;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEnD;AAyBD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,iBAAiB,GAAG,MAAM,CAUhE;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAGrD;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAEvD;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAM1D;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAwBrD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAQtD;AAYD;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,cAAc,EAAE,OAAO,GAAG,OAAO,CAYtE;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAQjD;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAEzF;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEjE;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAI9C;AAED;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,MAAM,EAAE,EACjB,cAAc,GAAE,cAA+C,EAC/D,eAAe,GAAE,eAA+C,EAChE,kBAAkB,SAAI,GACrB;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAetC;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAOlE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAc9F;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,cAAc,CA6BjE;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,cAAc,GAAG,MAAM,CAY5E;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAOpE;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,EAAE,EAAE,YAAY,GAAG,GAAG,CAoBjD;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,YAAY,EAAE,GAAG,UAAU,EAAE,CAmB3E;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,cAAc,CAGjE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,UAAO,GAAG,MAAM,CAEvE;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAGtD;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAK/E"}