@bitgo/account-lib 2.20.1-rc.2 → 2.21.0-hotfix.0

package/dist/src/coin/stx/transferBuilder.js

@@ -0,0 +1,99 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransferBuilder = void 0;
+const bn_js_1 = __importDefault(require("bn.js"));
+const transactions_1 = require("@stacks/transactions");
+const sdk_core_1 = require("@bitgo/sdk-core");
+const transactionBuilder_1 = require("./transactionBuilder");
+const utils_1 = require("./utils");
+class TransferBuilder extends transactionBuilder_1.TransactionBuilder {
+    constructor(_coinConfig) {
+        super(_coinConfig);
+    }
+    initBuilder(tx) {
+        const txData = tx.toJson();
+        if (txData.payload === undefined) {
+            throw new sdk_core_1.InvalidTransactionError('payload must not be undefined');
+        }
+        if (txData.payload.payloadType === transactions_1.PayloadType.TokenTransfer) {
+            this.to(txData.payload.to);
+            this.amount(txData.payload.amount);
+            if (txData.payload.memo) {
+                this.memo(txData.payload.memo);
+            }
+            super.initBuilder(tx);
+        }
+        else {
+            throw new sdk_core_1.BuildTransactionError('Transaction should be transfer');
+        }
+    }
+    /** @inheritdoc */
+    async buildImplementation() {
+        this._options = this.buildTokenTransferOptions();
+        this.transaction.setTransactionType(sdk_core_1.TransactionType.Send);
+        this.transaction.stxTransaction = await transactions_1.makeUnsignedSTXTokenTransfer(this._options);
+        return await super.buildImplementation();
+    }
+    buildTokenTransferOptions() {
+        const defaultOpts = {
+            recipient: this._toAddress,
+            amount: this._amount,
+            memo: this._memo,
+            anchorMode: this._anchorMode,
+            network: this._network,
+            fee: new bn_js_1.default(this._fee.fee),
+            nonce: new bn_js_1.default(this._nonce),
+        };
+        if (this._fromPubKeys.length > 0) {
+            if (this._fromPubKeys.length === 1) {
+                return {
+                    ...defaultOpts,
+                    publicKey: this._fromPubKeys[0],
+                };
+            }
+            else {
+                return {
+                    ...defaultOpts,
+                    publicKeys: this._fromPubKeys,
+                    numSignatures: this._numberSignatures,
+                };
+            }
+        }
+        else {
+            throw new sdk_core_1.InvalidParameterValueError('supply at least 1 public key');
+        }
+    }
+    // region Transfer fields
+    /**
+     * Set the destination address where the funds will be sent,
+     * it may take the format `'<shard>.<realm>.<account>'` or `'<account>'`
+     *
+     * @param {string} address the address to transfer funds to
+     * @returns {TransferBuilder} the builder with the new parameter set
+     */
+    to(address) {
+        if (!utils_1.isValidAddress(address)) {
+            throw new sdk_core_1.InvalidParameterValueError('Invalid address');
+        }
+        this._toAddress = address;
+        return this;
+    }
+    /**
+     * Set the amount to be transferred
+     *
+     * @param {string} amount amount to transfer in tinyBars (there are 100,000,000 tinyBars in one Hbar)
+     * @returns {TransferBuilder} the builder with the new parameter set
+     */
+    amount(amount) {
+        if (!utils_1.isValidAmount(amount)) {
+            throw new sdk_core_1.InvalidParameterValueError('Invalid amount');
+        }
+        this._amount = new bn_js_1.default(amount);
+        return this;
+    }
+}
+exports.TransferBuilder = TransferBuilder;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHJhbnNmZXJCdWlsZGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2NvaW4vc3R4L3RyYW5zZmVyQnVpbGRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7QUFDQSxrREFBMkI7QUFDM0IsdURBTThCO0FBQzlCLDhDQUt5QjtBQUV6Qiw2REFBMEQ7QUFDMUQsbUNBQXdEO0FBRXhELE1BQWEsZUFBZ0IsU0FBUSx1Q0FBa0I7SUFLckQsWUFBWSxXQUFpQztRQUMzQyxLQUFLLENBQUMsV0FBVyxDQUFDLENBQUM7SUFDckIsQ0FBQztJQUVELFdBQVcsQ0FBQyxFQUFlO1FBQ3pCLE1BQU0sTUFBTSxHQUFHLEVBQUUsQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUMzQixJQUFJLE1BQU0sQ0FBQyxPQUFPLEtBQUssU0FBUyxFQUFFO1lBQ2hDLE1BQU0sSUFBSSxrQ0FBdUIsQ0FBQywrQkFBK0IsQ0FBQyxDQUFDO1NBQ3BFO1FBQ0QsSUFBSSxNQUFNLENBQUMsT0FBTyxDQUFDLFdBQVcsS0FBSywwQkFBVyxDQUFDLGFBQWEsRUFBRTtZQUM1RCxJQUFJLENBQUMsRUFBRSxDQUFDLE1BQU0sQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLENBQUM7WUFDM0IsSUFBSSxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1lBQ25DLElBQUksTUFBTSxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUU7Z0JBQ3ZCLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQzthQUNoQztZQUNELEtBQUssQ0FBQyxXQUFXLENBQUMsRUFBRSxDQUFDLENBQUM7U0FDdkI7YUFBTTtZQUNMLE1BQU0sSUFBSSxnQ0FBcUIsQ0FBQyxnQ0FBZ0MsQ0FBQyxDQUFDO1NBQ25FO0lBQ0gsQ0FBQztJQUVELGtCQUFrQjtJQUNSLEtBQUssQ0FBQyxtQkFBbUI7UUFDakMsSUFBSSxDQUFDLFFBQVEsR0FBRyxJQUFJLENBQUMseUJBQXlCLEVBQUUsQ0FBQztRQUNqRCxJQUFJLENBQUMsV0FBVyxDQUFDLGtCQUFrQixDQUFDLDBCQUFlLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDMUQsSUFBSSxDQUFDLFdBQVcsQ0FBQyxjQUFjLEdBQUcsTUFBTSwyQ0FBNEIsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDcEYsT0FBTyxNQUFNLEtBQUssQ0FBQyxtQkFBbUIsRUFBRSxDQUFDO0lBQzNDLENBQUM7SUFFTyx5QkFBeUI7UUFDL0IsTUFBTSxXQUFXLEdBQXlCO1lBQ3hDLFNBQVMsRUFBRSxJQUFJLENBQUMsVUFBVTtZQUMxQixNQUFNLEVBQUUsSUFBSSxDQUFDLE9BQU87WUFDcEIsSUFBSSxFQUFFLElBQUksQ0FBQyxLQUFLO1lBQ2hCLFVBQVUsRUFBRSxJQUFJLENBQUMsV0FBVztZQUM1QixPQUFPLEVBQUUsSUFBSSxDQUFDLFFBQVE7WUFDdEIsR0FBRyxFQUFFLElBQUksZUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDO1lBQzlCLEtBQUssRUFBRSxJQUFJLGVBQU0sQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDO1NBQy9CLENBQUM7UUFDRixJQUFJLElBQUksQ0FBQyxZQUFZLENBQUMsTUFBTSxHQUFHLENBQUMsRUFBRTtZQUNoQyxJQUFJLElBQUksQ0FBQyxZQUFZLENBQUMsTUFBTSxLQUFLLENBQUMsRUFBRTtnQkFDbEMsT0FBTztvQkFDTCxHQUFHLFdBQVc7b0JBQ2QsU0FBUyxFQUFFLElBQUksQ0FBQyxZQUFZLENBQUMsQ0FBQyxDQUFDO2lCQUNoQyxDQUFDO2FBQ0g7aUJBQU07Z0JBQ0wsT0FBTztvQkFDTCxHQUFHLFdBQVc7b0JBQ2QsVUFBVSxFQUFFLElBQUksQ0FBQyxZQUFZO29CQUM3QixhQUFhLEVBQUUsSUFBSSxDQUFDLGlCQUFpQjtpQkFDdEMsQ0FBQzthQUNIO1NBQ0Y7YUFBTTtZQUNMLE1BQU0sSUFBSSxxQ0FBMEIsQ0FBQyw4QkFBOEIsQ0FBQyxDQUFDO1NBQ3RFO0lBQ0gsQ0FBQztJQUVELHlCQUF5QjtJQUN6Qjs7Ozs7O09BTUc7SUFDSCxFQUFFLENBQUMsT0FBZTtRQUNoQixJQUFJLENBQUMsc0JBQWMsQ0FBQyxPQUFPLENBQUMsRUFBRTtZQUM1QixNQUFNLElBQUkscUNBQTBCLENBQUMsaUJBQWlCLENBQUMsQ0FBQztTQUN6RDtRQUNELElBQUksQ0FBQyxVQUFVLEdBQUcsT0FBTyxDQUFDO1FBQzFCLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsTUFBTSxDQUFDLE1BQWM7UUFDbkIsSUFBSSxDQUFDLHFCQUFhLENBQUMsTUFBTSxDQUFDLEVBQUU7WUFDMUIsTUFBTSxJQUFJLHFDQUEwQixDQUFDLGdCQUFnQixDQUFDLENBQUM7U0FDeEQ7UUFDRCxJQUFJLENBQUMsT0FBTyxHQUFHLElBQUksZUFBTSxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBQ2xDLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztDQUNGO0FBM0ZELDBDQTJGQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEJhc2VDb2luIGFzIENvaW5Db25maWcgfSBmcm9tICdAYml0Z28vc3RhdGljcyc7XG5pbXBvcnQgQmlnTnVtIGZyb20gJ2JuLmpzJztcbmltcG9ydCB7XG4gIG1ha2VVbnNpZ25lZFNUWFRva2VuVHJhbnNmZXIsXG4gIFBheWxvYWRUeXBlLFxuICBVbnNpZ25lZFRva2VuVHJhbnNmZXJPcHRpb25zLFxuICBUb2tlblRyYW5zZmVyT3B0aW9ucyxcbiAgVW5zaWduZWRNdWx0aVNpZ1Rva2VuVHJhbnNmZXJPcHRpb25zLFxufSBmcm9tICdAc3RhY2tzL3RyYW5zYWN0aW9ucyc7XG5pbXBvcnQge1xuICBCdWlsZFRyYW5zYWN0aW9uRXJyb3IsXG4gIEludmFsaWRQYXJhbWV0ZXJWYWx1ZUVycm9yLFxuICBJbnZhbGlkVHJhbnNhY3Rpb25FcnJvcixcbiAgVHJhbnNhY3Rpb25UeXBlLFxufSBmcm9tICdAYml0Z28vc2RrLWNvcmUnO1xuaW1wb3J0IHsgVHJhbnNhY3Rpb24gfSBmcm9tICcuL3RyYW5zYWN0aW9uJztcbmltcG9ydCB7IFRyYW5zYWN0aW9uQnVpbGRlciB9IGZyb20gJy4vdHJhbnNhY3Rpb25CdWlsZGVyJztcbmltcG9ydCB7IGlzVmFsaWRBZGRyZXNzLCBpc1ZhbGlkQW1vdW50IH0gZnJvbSAnLi91dGlscyc7XG5cbmV4cG9ydCBjbGFzcyBUcmFuc2ZlckJ1aWxkZXIgZXh0ZW5kcyBUcmFuc2FjdGlvbkJ1aWxkZXIge1xuICBwcml2YXRlIF9vcHRpb25zOiBVbnNpZ25lZFRva2VuVHJhbnNmZXJPcHRpb25zIHwgVW5zaWduZWRNdWx0aVNpZ1Rva2VuVHJhbnNmZXJPcHRpb25zO1xuICBwcm90ZWN0ZWQgX3RvQWRkcmVzczogc3RyaW5nO1xuICBwcm90ZWN0ZWQgX2Ftb3VudDogQmlnTnVtO1xuXG4gIGNvbnN0cnVjdG9yKF9jb2luQ29uZmlnOiBSZWFkb25seTxDb2luQ29uZmlnPikge1xuICAgIHN1cGVyKF9jb2luQ29uZmlnKTtcbiAgfVxuXG4gIGluaXRCdWlsZGVyKHR4OiBUcmFuc2FjdGlvbik6IHZvaWQge1xuICAgIGNvbnN0IHR4RGF0YSA9IHR4LnRvSnNvbigpO1xuICAgIGlmICh0eERhdGEucGF5bG9hZCA9PT0gdW5kZWZpbmVkKSB7XG4gICAgICB0aHJvdyBuZXcgSW52YWxpZFRyYW5zYWN0aW9uRXJyb3IoJ3BheWxvYWQgbXVzdCBub3QgYmUgdW5kZWZpbmVkJyk7XG4gICAgfVxuICAgIGlmICh0eERhdGEucGF5bG9hZC5wYXlsb2FkVHlwZSA9PT0gUGF5bG9hZFR5cGUuVG9rZW5UcmFuc2Zlcikge1xuICAgICAgdGhpcy50byh0eERhdGEucGF5bG9hZC50byk7XG4gICAgICB0aGlzLmFtb3VudCh0eERhdGEucGF5bG9hZC5hbW91bnQpO1xuICAgICAgaWYgKHR4RGF0YS5wYXlsb2FkLm1lbW8pIHtcbiAgICAgICAgdGhpcy5tZW1vKHR4RGF0YS5wYXlsb2FkLm1lbW8pO1xuICAgICAgfVxuICAgICAgc3VwZXIuaW5pdEJ1aWxkZXIodHgpO1xuICAgIH0gZWxzZSB7XG4gICAgICB0aHJvdyBuZXcgQnVpbGRUcmFuc2FjdGlvbkVycm9yKCdUcmFuc2FjdGlvbiBzaG91bGQgYmUgdHJhbnNmZXInKTtcbiAgICB9XG4gIH1cblxuICAvKiogQGluaGVyaXRkb2MgKi9cbiAgcHJvdGVjdGVkIGFzeW5jIGJ1aWxkSW1wbGVtZW50YXRpb24oKTogUHJvbWlzZTxUcmFuc2FjdGlvbj4ge1xuICAgIHRoaXMuX29wdGlvbnMgPSB0aGlzLmJ1aWxkVG9rZW5UcmFuc2Zlck9wdGlvbnMoKTtcbiAgICB0aGlzLnRyYW5zYWN0aW9uLnNldFRyYW5zYWN0aW9uVHlwZShUcmFuc2FjdGlvblR5cGUuU2VuZCk7XG4gICAgdGhpcy50cmFuc2FjdGlvbi5zdHhUcmFuc2FjdGlvbiA9IGF3YWl0IG1ha2VVbnNpZ25lZFNUWFRva2VuVHJhbnNmZXIodGhpcy5fb3B0aW9ucyk7XG4gICAgcmV0dXJuIGF3YWl0IHN1cGVyLmJ1aWxkSW1wbGVtZW50YXRpb24oKTtcbiAgfVxuXG4gIHByaXZhdGUgYnVpbGRUb2tlblRyYW5zZmVyT3B0aW9ucygpOiBVbnNpZ25lZFRva2VuVHJhbnNmZXJPcHRpb25zIHwgVW5zaWduZWRNdWx0aVNpZ1Rva2VuVHJhbnNmZXJPcHRpb25zIHtcbiAgICBjb25zdCBkZWZhdWx0T3B0czogVG9rZW5UcmFuc2Zlck9wdGlvbnMgPSB7XG4gICAgICByZWNpcGllbnQ6IHRoaXMuX3RvQWRkcmVzcyxcbiAgICAgIGFtb3VudDogdGhpcy5fYW1vdW50LFxuICAgICAgbWVtbzogdGhpcy5fbWVtbyxcbiAgICAgIGFuY2hvck1vZGU6IHRoaXMuX2FuY2hvck1vZGUsXG4gICAgICBuZXR3b3JrOiB0aGlzLl9uZXR3b3JrLFxuICAgICAgZmVlOiBuZXcgQmlnTnVtKHRoaXMuX2ZlZS5mZWUpLFxuICAgICAgbm9uY2U6IG5ldyBCaWdOdW0odGhpcy5fbm9uY2UpLFxuICAgIH07XG4gICAgaWYgKHRoaXMuX2Zyb21QdWJLZXlzLmxlbmd0aCA+IDApIHtcbiAgICAgIGlmICh0aGlzLl9mcm9tUHViS2V5cy5sZW5ndGggPT09IDEpIHtcbiAgICAgICAgcmV0dXJuIHtcbiAgICAgICAgICAuLi5kZWZhdWx0T3B0cyxcbiAgICAgICAgICBwdWJsaWNLZXk6IHRoaXMuX2Zyb21QdWJLZXlzWzBdLFxuICAgICAgICB9O1xuICAgICAgfSBlbHNlIHtcbiAgICAgICAgcmV0dXJuIHtcbiAgICAgICAgICAuLi5kZWZhdWx0T3B0cyxcbiAgICAgICAgICBwdWJsaWNLZXlzOiB0aGlzLl9mcm9tUHViS2V5cyxcbiAgICAgICAgICBudW1TaWduYXR1cmVzOiB0aGlzLl9udW1iZXJTaWduYXR1cmVzLFxuICAgICAgICB9O1xuICAgICAgfVxuICAgIH0gZWxzZSB7XG4gICAgICB0aHJvdyBuZXcgSW52YWxpZFBhcmFtZXRlclZhbHVlRXJyb3IoJ3N1cHBseSBhdCBsZWFzdCAxIHB1YmxpYyBrZXknKTtcbiAgICB9XG4gIH1cblxuICAvLyByZWdpb24gVHJhbnNmZXIgZmllbGRzXG4gIC8qKlxuICAgKiBTZXQgdGhlIGRlc3RpbmF0aW9uIGFkZHJlc3Mgd2hlcmUgdGhlIGZ1bmRzIHdpbGwgYmUgc2VudCxcbiAgICogaXQgbWF5IHRha2UgdGhlIGZvcm1hdCBgJzxzaGFyZD4uPHJlYWxtPi48YWNjb3VudD4nYCBvciBgJzxhY2NvdW50PidgXG4gICAqXG4gICAqIEBwYXJhbSB7c3RyaW5nfSBhZGRyZXNzIHRoZSBhZGRyZXNzIHRvIHRyYW5zZmVyIGZ1bmRzIHRvXG4gICAqIEByZXR1cm5zIHtUcmFuc2ZlckJ1aWxkZXJ9IHRoZSBidWlsZGVyIHdpdGggdGhlIG5ldyBwYXJhbWV0ZXIgc2V0XG4gICAqL1xuICB0byhhZGRyZXNzOiBzdHJpbmcpOiB0aGlzIHtcbiAgICBpZiAoIWlzVmFsaWRBZGRyZXNzKGFkZHJlc3MpKSB7XG4gICAgICB0aHJvdyBuZXcgSW52YWxpZFBhcmFtZXRlclZhbHVlRXJyb3IoJ0ludmFsaWQgYWRkcmVzcycpO1xuICAgIH1cbiAgICB0aGlzLl90b0FkZHJlc3MgPSBhZGRyZXNzO1xuICAgIHJldHVybiB0aGlzO1xuICB9XG5cbiAgLyoqXG4gICAqIFNldCB0aGUgYW1vdW50IHRvIGJlIHRyYW5zZmVycmVkXG4gICAqXG4gICAqIEBwYXJhbSB7c3RyaW5nfSBhbW91bnQgYW1vdW50IHRvIHRyYW5zZmVyIGluIHRpbnlCYXJzICh0aGVyZSBhcmUgMTAwLDAwMCwwMDAgdGlueUJhcnMgaW4gb25lIEhiYXIpXG4gICAqIEByZXR1cm5zIHtUcmFuc2ZlckJ1aWxkZXJ9IHRoZSBidWlsZGVyIHdpdGggdGhlIG5ldyBwYXJhbWV0ZXIgc2V0XG4gICAqL1xuICBhbW91bnQoYW1vdW50OiBzdHJpbmcpOiB0aGlzIHtcbiAgICBpZiAoIWlzVmFsaWRBbW91bnQoYW1vdW50KSkge1xuICAgICAgdGhyb3cgbmV3IEludmFsaWRQYXJhbWV0ZXJWYWx1ZUVycm9yKCdJbnZhbGlkIGFtb3VudCcpO1xuICAgIH1cbiAgICB0aGlzLl9hbW91bnQgPSBuZXcgQmlnTnVtKGFtb3VudCk7XG4gICAgcmV0dXJuIHRoaXM7XG4gIH1cbn1cbiJdfQ==

package/dist/src/coin/stx/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/coin/stx/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/coin/stx/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"}