mainnet-js 0.5.9 → 1.0.0-rc.1

package/dist/main/wallet/Wif.js

@@ -1,1067 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RegTestWatchWallet = exports.TestNetWatchWallet = exports.WatchWallet = exports.RegTestWifWallet = exports.TestNetWifWallet = exports.WifWallet = exports.RegTestWallet = exports.TestNetWallet = exports.Wallet = void 0;
-//#region Imports
-// Stable
-const libauth_1 = require("@bitauth/libauth");
-// Unstable?
-const libauth_2 = require("@bitauth/libauth");
-const bip39_1 = require("bip39");
-const enum_1 = require("../enum");
-const interface_1 = require("../interface");
-const enum_2 = require("../enum");
-const Base_1 = require("./Base");
-const enum_3 = require("./enum");
-const model_1 = require("./model");
-const Wif_1 = require("../transaction/Wif");
-const asSendRequestObject_1 = require("../util/asSendRequestObject");
-const balanceObjectFromSatoshi_1 = require("../util/balanceObjectFromSatoshi");
-const checkWifNetwork_1 = require("../util/checkWifNetwork");
-const deriveCashaddr_1 = require("../util/deriveCashaddr");
-const derivePublicKeyHash_1 = require("../util/derivePublicKeyHash");
-const checkForEmptySeed_1 = require("../util/checkForEmptySeed");
-const sanitizeUnit_1 = require("../util/sanitizeUnit");
-const sumUtxoValue_1 = require("../util/sumUtxoValue");
-const sumSendRequestAmounts_1 = require("../util/sumSendRequestAmounts");
-const getRelayFeeCache_1 = require("../network/getRelayFeeCache");
-const Slp_1 = require("./Slp");
-const axios_1 = __importDefault(require("axios"));
-const bchaddr_1 = require("../util/bchaddr");
-const Util_1 = require("./Util");
-const index_1 = require("../network/index");
-const randomBytes_1 = require("../util/randomBytes");
-const message_1 = require("../message");
-const amountInSatoshi_1 = require("../util/amountInSatoshi");
-const getXPubKey_1 = require("../util/getXPubKey");
-const constant_1 = require("../constant");
-const electrumTransformer_1 = require("../history/electrumTransformer");
-//#endregion Imports
-const secp256k1Promise = (0, libauth_1.instantiateSecp256k1)();
-const sha256Promise = (0, libauth_1.instantiateSha256)();
-/**
- * Class to manage a bitcoin cash wallet.
- */
-class Wallet extends Base_1.BaseWallet {
-    //#endregion
-    //#region Constructors and Statics
-    constructor(name = "", network = enum_1.NetworkType.Mainnet, walletType = enum_3.WalletTypeEnum.Seed) {
-        super(name, network, walletType);
-        this.derivationPath = "m/44'/0'/0'/0/0";
-        this.parentDerivationPath = "m/44'/0'/0'";
-        this._slpAware = false; // a flag which activates utxo checking against an external slp indexer
-        this._slpSemiAware = false; // a flag which requires an utxo to have more than 546 sats to be spendable and counted in the balance
-        this.fromId = async (walletId) => {
-            let [walletType, networkGiven, arg1] = walletId.split(":");
-            if (this.network != networkGiven) {
-                throw Error(`Network prefix ${networkGiven} to a ${this.network} wallet`);
-            }
-            // "wif:regtest:cNfsPtqN2bMRS7vH5qd8tR8GMvgXyL5BjnGAKgZ8DYEiCrCCQcP6"
-            if (walletType === "wif") {
-                return this.fromWIF(arg1);
-            }
-            return super.fromId(walletId);
-        };
-        this.networkPrefix = enum_1.prefixFromNetworkMap[this.network];
-    }
-    //#region Accessors
-    // interface to slp functions. see Slp.ts
-    get slp() {
-        if (!this._slp) {
-            this._slp = new Slp_1.Slp(this);
-            this._slpAware = true;
-        }
-        return this._slp;
-    }
-    // interface to slp functions. see Slp.ts
-    static get slp() {
-        return Slp_1.Slp;
-    }
-    // interface to util functions. see Util.ts
-    get util() {
-        if (!this._util) {
-            this._util = new Util_1.Util(this);
-        }
-        return this._util;
-    }
-    // interface to util util. see Util.Util
-    static get util() {
-        return Util_1.Util;
-    }
-    slpAware(value = true) {
-        this._slpAware = value;
-        return this;
-    }
-    slpSemiAware(value = true) {
-        this._slpSemiAware = value;
-        return this;
-    }
-    getNetworkProvider(network = interface_1.Network.MAINNET) {
-        return (0, index_1.getNetworkProvider)(network);
-    }
-    /**
-     *  explorerUrl   Web url to a transaction on a block explorer
-     *
-     * @param txId   transaction Id
-     * @returns   Url string
-     */
-    explorerUrl(txId) {
-        const explorerUrlMap = {
-            mainnet: "https://blockchair.com/bitcoin-cash/transaction/",
-            testnet: "https://www.blockchain.com/bch-testnet/tx/",
-            regtest: "",
-        };
-        return explorerUrlMap[this.network] + txId;
-    }
-    // Return wallet info
-    getInfo() {
-        return {
-            cashaddr: this.cashaddr,
-            isTestnet: this.isTestnet,
-            name: this.name,
-            network: this.network,
-            seed: this.mnemonic ? this.getSeed().seed : undefined,
-            derivationPath: this.mnemonic ? this.getSeed().derivationPath : undefined,
-            parentDerivationPath: this.mnemonic
-                ? this.getSeed().parentDerivationPath
-                : undefined,
-            parentXPubKey: this.parentXPubKey ? this.parentXPubKey : undefined,
-            publicKey: this.publicKey ? (0, libauth_2.binToHex)(this.publicKey) : undefined,
-            publicKeyHash: (0, libauth_2.binToHex)(this.publicKeyHash),
-            privateKey: this.privateKey ? (0, libauth_2.binToHex)(this.privateKey) : undefined,
-            privateKeyWif: this.privateKeyWif,
-            walletId: this.toString(),
-            walletDbEntry: this.toDbString(),
-        };
-    }
-    // returns the public key hash for an address
-    getPublicKey(hex = false) {
-        if (this.publicKey) {
-            return hex ? (0, libauth_2.binToHex)(this.publicKey) : this.publicKey;
-        }
-        else {
-            throw Error("The public key for this wallet is not known, perhaps the wallet was created to watch the *hash* of a public key? i.e. a cashaddress.");
-        }
-    }
-    // returns the public key hash for an address
-    getPublicKeyCompressed(hex = false) {
-        if (this.publicKeyCompressed) {
-            return hex
-                ? (0, libauth_2.binToHex)(this.publicKeyCompressed)
-                : this.publicKeyCompressed;
-        }
-        else {
-            throw Error("The compressed public key for this wallet is not known, perhaps the wallet was created to watch the *hash* of a public key? i.e. a cashaddress.");
-        }
-    }
-    // returns the public key hash for an address
-    getPublicKeyHash(hex = false) {
-        if (this.publicKeyHash) {
-            return hex ? (0, libauth_2.binToHex)(this.publicKeyHash) : this.publicKeyHash;
-        }
-        else {
-            throw Error("The public key hash for this wallet is not known. If this wallet was created from the constructor directly, calling the deriveInfo() function may help. ");
-        }
-    }
-    /**
-     * fromWIF - create a wallet using the private key supplied in `Wallet Import Format`
-     *
-     * @param wif   WIF encoded private key string
-     *
-     * @returns instantiated wallet
-     */
-    static async fromWIF(wif) {
-        return new this().fromWIF(wif);
-    }
-    /**
-     * fromCashaddr - create a watch-only wallet in the network derived from the address
-     *
-     * such kind of wallet does not have a private key and is unable to spend any funds
-     * however it still allows to use many utility functions such as getting and watching balance, etc.
-     *
-     * @param address   cashaddress of a wallet
-     *
-     * @returns instantiated wallet
-     */
-    static async fromCashaddr(address) {
-        const prefix = (0, derivePublicKeyHash_1.derivePrefix)(address);
-        const networkType = enum_2.networkPrefixMap[prefix];
-        return new this("", networkType, enum_3.WalletTypeEnum.Watch).watchOnly(address);
-    }
-    /**
-     * fromSlpaddr - create an SLP aware watch-only wallet in the network derived from the address
-     *
-     * such kind of wallet does not have a private key and is unable to spend any funds
-     * however it still allows to use many utility functions such as getting and watching balance, etc.
-     *
-     * @param address   slpaddress of a wallet
-     *
-     * @returns instantiated wallet
-     */
-    static async fromSlpaddr(address) {
-        return this.fromCashaddr((0, bchaddr_1.toCashAddress)(address));
-    }
-    //#endregion Constructors and Statics
-    //#region Protected implementations
-    async generate() {
-        if (this.walletType === enum_3.WalletTypeEnum.Wif) {
-            return await this._generateWif();
-        }
-        else if (this.walletType === enum_3.WalletTypeEnum.Watch) {
-            return this;
-        }
-        else if (this.walletType === enum_3.WalletTypeEnum.Hd) {
-            throw Error("Not implemented");
-        }
-        else if (this.walletType === enum_3.WalletTypeEnum.Seed) {
-            return await this._generateMnemonic();
-        }
-        else {
-            console.log(this.walletType);
-            throw Error(`Could not determine walletType: ${this.walletType}`);
-        }
-    }
-    async _generateWif() {
-        if (!this.privateKey) {
-            this.privateKey = (0, libauth_2.generatePrivateKey)(() => (0, randomBytes_1.generateRandomBytes)(32));
-        }
-        return this.deriveInfo();
-    }
-    async _generateMnemonic() {
-        this.mnemonic = (0, bip39_1.generateMnemonic)();
-        if (this.mnemonic.length == 0)
-            throw Error("refusing to create wallet from empty mnemonic");
-        let seed = (0, bip39_1.mnemonicToSeedSync)(this.mnemonic);
-        (0, checkForEmptySeed_1.checkForEmptySeed)(seed);
-        let network = this.isTestnet ? "testnet" : "mainnet";
-        this.parentXPubKey = await (0, getXPubKey_1.getXPubKey)(seed, this.parentDerivationPath, network);
-        const crypto = await (0, libauth_2.instantiateBIP32Crypto)();
-        let hdNode = (0, libauth_2.deriveHdPrivateNodeFromSeed)(crypto, seed);
-        if (!hdNode.valid) {
-            throw Error("Invalid private key derived from mnemonic seed");
-        }
-        let zerothChild = (0, libauth_2.deriveHdPath)(crypto, hdNode, this.derivationPath);
-        if (typeof zerothChild === "string") {
-            throw Error(zerothChild);
-        }
-        this.privateKey = zerothChild.privateKey;
-        this.walletType = enum_3.WalletTypeEnum.Seed;
-        return await this.deriveInfo();
-    }
-    async getXPubKeys(paths) {
-        if (this.mnemonic) {
-            if (paths) {
-                let xPubKeys = await this.deriveHdPaths(paths);
-                return [xPubKeys];
-            }
-            else {
-                return await this.deriveHdPaths(constant_1.DERIVATION_PATHS);
-            }
-        }
-        else {
-            throw Error("xpubkeys can only be derived from seed type wallets.");
-        }
-    }
-    // Initialize wallet from a mnemonic phrase
-    async fromSeed(mnemonic, derivationPath) {
-        this.mnemonic = mnemonic;
-        const crypto = await (0, libauth_2.instantiateBIP32Crypto)();
-        if (this.mnemonic.length == 0)
-            throw Error("refusing to create wallet from empty mnemonic");
-        let seed = (0, bip39_1.mnemonicToSeedSync)(this.mnemonic);
-        (0, checkForEmptySeed_1.checkForEmptySeed)(seed);
-        let hdNode = (0, libauth_2.deriveHdPrivateNodeFromSeed)(crypto, seed);
-        if (!hdNode.valid) {
-            throw Error("Invalid private key derived from mnemonic seed");
-        }
-        if (derivationPath) {
-            this.derivationPath = derivationPath;
-            // If the derivation path is for the first account child, set the parent derivation path
-            let path = derivationPath.split("/");
-            if (path.slice(-2).join("/") == "0/0") {
-                this.parentDerivationPath = path.slice(0, -2).join("/");
-            }
-        }
-        let zerothChild = (0, libauth_2.deriveHdPath)(crypto, hdNode, this.derivationPath);
-        if (typeof zerothChild === "string") {
-            throw Error(zerothChild);
-        }
-        this.privateKey = zerothChild.privateKey;
-        let network = this.isTestnet ? "testnet" : "mainnet";
-        this.parentXPubKey = await (0, getXPubKey_1.getXPubKey)(seed, this.parentDerivationPath, network);
-        this.walletType = enum_3.WalletTypeEnum.Seed;
-        await this.deriveInfo();
-        return this;
-    }
-    // Get common xpub paths from zerothChild privateKey
-    async deriveHdPaths(hdPaths) {
-        const crypto = await (0, libauth_2.instantiateBIP32Crypto)();
-        if (!this.mnemonic)
-            throw Error("refusing to create wallet from empty mnemonic");
-        let seed = (0, bip39_1.mnemonicToSeedSync)(this.mnemonic);
-        (0, checkForEmptySeed_1.checkForEmptySeed)(seed);
-        let hdNode = (0, libauth_2.deriveHdPrivateNodeFromSeed)(crypto, seed);
-        if (!hdNode.valid) {
-            throw Error("Invalid private key derived from mnemonic seed");
-        }
-        let result = [];
-        for (const path of hdPaths) {
-            if (path === "m") {
-                throw Error("Storing or sharing of parent public key may lead to loss of funds. Storing or sharing *root* parent public keys is strongly discouraged, although all parent keys have risk. See: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#implications");
-            }
-            let childNode = (0, libauth_2.deriveHdPath)(crypto, hdNode, path);
-            if (typeof childNode === "string") {
-                throw Error(childNode);
-            }
-            let node = (0, libauth_2.deriveHdPublicNode)(crypto, childNode);
-            if (typeof node === "string") {
-                throw Error(node);
-            }
-            let xPubKey = (0, libauth_1.encodeHdPublicKey)(crypto, {
-                network: this.network,
-                node: node,
-            });
-            let key = new model_1.XPubKey({
-                path: path,
-                xPubKey: xPubKey,
-            });
-            result.push(await key.ready());
-        }
-        return await Promise.all(result).then((result) => {
-            return result;
-        });
-    }
-    // Initialize a watch only wallet from a cash addr
-    async watchOnly(address) {
-        this.walletType = enum_3.WalletTypeEnum.Watch;
-        let addressComponents = address.split(":");
-        let addressPrefix, addressBase;
-        if (addressComponents.length === 1) {
-            addressBase = addressComponents.shift();
-            addressPrefix = (0, derivePublicKeyHash_1.derivePrefix)(addressBase);
-        }
-        else {
-            addressPrefix = addressComponents.shift();
-            addressBase = addressComponents.shift();
-            if (addressPrefix in enum_2.networkPrefixMap) {
-                if (enum_2.networkPrefixMap[addressPrefix] != this.network) {
-                    throw Error(`a ${addressPrefix} address cannot be watched from a ${this.network} Wallet`);
-                }
-            }
-        }
-        this.cashaddr = `${addressPrefix}:${addressBase}`;
-        this.address = this.cashaddr;
-        this.publicKeyHash = (0, derivePublicKeyHash_1.derivePublicKeyHash)(this.cashaddr);
-        return this;
-    }
-    // Initialize wallet from Wallet Import Format
-    async fromWIF(secret) {
-        (0, checkWifNetwork_1.checkWifNetwork)(secret, this.network);
-        const sha256 = await sha256Promise;
-        let wifResult = (0, libauth_2.decodePrivateKeyWif)(sha256, secret);
-        if (typeof wifResult === "string") {
-            throw Error(wifResult);
-        }
-        let resultData = wifResult;
-        this.privateKey = resultData.privateKey;
-        this.privateKeyWif = secret;
-        this.walletType = enum_3.WalletTypeEnum.Wif;
-        await this.deriveInfo();
-        return this;
-    }
-    async newRandom(name, dbName) {
-        dbName = dbName ? dbName : this.networkPrefix;
-        return super.newRandom(name, dbName);
-    }
-    async named(name, dbName, forceNew = false) {
-        dbName = dbName ? dbName : this.networkPrefix;
-        return super.named(name, dbName, forceNew);
-    }
-    async replaceNamed(name, walletId, dbName) {
-        dbName = dbName ? dbName : this.networkPrefix;
-        return super.replaceNamed(name, walletId, dbName);
-    }
-    async namedExists(name, dbName) {
-        dbName = dbName ? dbName : this.networkPrefix;
-        return super.namedExists(name, dbName);
-    }
-    //#endregion Protected Implementations
-    //#region Serialization
-    // Returns the serialized wallet as a string
-    // If storing in a database, set asNamed to false to store secrets
-    // In all other cases, the a named wallet is deserialized from the database
-    //  by the name key
-    toString() {
-        const result = super.toString();
-        if (result)
-            return result;
-        if (this.walletType === enum_3.WalletTypeEnum.Wif) {
-            return `${this.walletType}:${this.network}:${this.privateKeyWif}`;
-        }
-        throw Error("toString unsupported wallet type");
-    }
-    //
-    toDbString() {
-        const result = super.toDbString();
-        if (result)
-            return result;
-        if (this.walletType === enum_3.WalletTypeEnum.Wif) {
-            return `${this.walletType}:${this.network}:${this.privateKeyWif}`;
-        }
-        throw Error("toDbString unsupported wallet type");
-    }
-    //#endregion Serialization
-    //#region Funds
-    //
-    async getAddressUtxos(address) {
-        if (!this.provider) {
-            throw Error("Attempting to get utxos from wallet without a client");
-        }
-        if (this._slpAware) {
-            const [bchUtxos, slpOutpoints] = await Promise.all([
-                this.provider.getUtxos(address),
-                this.slp.getSlpOutpoints(),
-            ]);
-            return bchUtxos.filter((bchutxo) => slpOutpoints.findIndex((slpOutpoint) => `${bchutxo.txid}:${bchutxo.vout}` === slpOutpoint) === -1);
-        }
-        else if (this._slpSemiAware) {
-            const bchUtxos = await this.provider.getUtxos(address);
-            return bchUtxos.filter((bchutxo) => bchutxo.satoshis > constant_1.DUST_UTXO_THRESHOLD);
-        }
-        else {
-            return await this.provider.getUtxos(address);
-        }
-    }
-    /**
-     * utxos Get unspent outputs for the wallet
-     *
-     */
-    async getUtxos() {
-        if (!this.cashaddr) {
-            throw Error("Attempted to get utxos without an address");
-        }
-        let utxos = await this.getAddressUtxos(this.cashaddr);
-        let resp = new model_1.UtxoResponse();
-        resp.utxos = await Promise.all(utxos.map(async (o) => {
-            return model_1.UtxoItem.fromElectrum(o);
-        }));
-        return resp;
-    }
-    // gets wallet balance in sats, bch and usd
-    async getBalance(rawUnit, usdPriceCache = true) {
-        if (rawUnit) {
-            const unit = (0, sanitizeUnit_1.sanitizeUnit)(rawUnit);
-            return await (0, balanceObjectFromSatoshi_1.balanceFromSatoshi)(await this.getBalanceFromProvider(), unit, usdPriceCache);
-        }
-        else {
-            return await (0, balanceObjectFromSatoshi_1.balanceResponseFromSatoshi)(await this.getBalanceFromProvider(), usdPriceCache);
-        }
-    }
-    // Gets balance by summing value in all utxos in stats
-    async getBalanceFromUtxos() {
-        const utxos = await this.getAddressUtxos(this.cashaddr);
-        return await (0, sumUtxoValue_1.sumUtxoValue)(utxos);
-    }
-    // Gets balance from fulcrum
-    async getBalanceFromProvider() {
-        // TODO not sure why getting the balance from a provider doesn't work
-        if (this._slpAware || this._slpSemiAware) {
-            return await this.getBalanceFromUtxos();
-        }
-        else {
-            return await this.provider.getBalance(this.cashaddr);
-        }
-    }
-    // // waiting for any transaction hash of this wallet
-    // // commented out until fulcrum supports new method https://github.com/cculianu/Fulcrum/pull/89
-    // public watchAddress(callback: (txHash: string) => void): CancelWatchFn {
-    //   return (this.provider! as ElectrumNetworkProvider).watchAddress(
-    //     this.getDepositAddress(),
-    //     callback
-    //   );
-    // }
-    // // waiting for any transaction of this wallet
-    // // commented out until fulcrum supports new method https://github.com/cculianu/Fulcrum/pull/89
-    // public watchAddressTransactions(
-    //   callback: (tx: ElectrumRawTransaction) => void
-    // ): CancelWatchFn {
-    //   return (this.provider! as ElectrumNetworkProvider).watchAddressTransactions(
-    //     this.getDepositAddress(),
-    //     callback
-    //   );
-    // }
-    // sets up a callback to be called upon wallet's balance change
-    // can be cancelled by calling the function returned from this one
-    watchBalance(callback) {
-        return this.provider.watchAddressStatus(this.getDepositAddress(), async (_status) => {
-            const balance = (await this.getBalance());
-            callback(balance);
-        });
-    }
-    // sets up a callback to be called upon wallet's BCH or USD balance change
-    // if BCH balance does not change, the callback will be triggered every
-    // @param `usdPriceRefreshInterval` milliseconds by polling for new BCH USD price
-    // Since we want to be most sensitive to usd value change, we do not use the cached exchange rates
-    // can be cancelled by calling the function returned from this one
-    watchBalanceUsd(callback, usdPriceRefreshInterval = 30000) {
-        let usdPrice = -1;
-        const _callback = async () => {
-            const balance = (await this.getBalance(undefined, false));
-            if (usdPrice !== balance.usd) {
-                usdPrice = balance.usd;
-                callback(balance);
-            }
-        };
-        const watchCancel = this.provider.watchAddressStatus(this.getDepositAddress(), _callback);
-        const interval = setInterval(_callback, usdPriceRefreshInterval);
-        return async () => {
-            await watchCancel();
-            clearInterval(interval);
-        };
-    }
-    // waits for address balance to be greater than or equal to the target value
-    // this call halts the execution
-    async waitForBalance(value, rawUnit = enum_1.UnitEnum.BCH) {
-        return new Promise(async (resolve) => {
-            const watchCancel = this.watchBalance(async (balance) => {
-                const satoshiBalance = await (0, amountInSatoshi_1.amountInSatoshi)(value, rawUnit);
-                if (balance.sat >= satoshiBalance) {
-                    await watchCancel();
-                    resolve(balance);
-                }
-            });
-        });
-    }
-    async getMaxAmountToSend(params = {
-        outputCount: 1,
-        options: {},
-    }) {
-        if (!this.privateKey) {
-            throw Error("Couldn't get network or private key for wallet.");
-        }
-        if (!this.cashaddr) {
-            throw Error("attempted to send without a cashaddr");
-        }
-        if (params.options && params.options.slpAware) {
-            this._slpAware = true;
-        }
-        if (params.options && params.options.slpSemiAware) {
-            this._slpSemiAware = true;
-        }
-        let feePaidBy;
-        if (params.options && params.options.feePaidBy) {
-            feePaidBy = params.options.feePaidBy;
-        }
-        else {
-            feePaidBy = enum_3.FeePaidByEnum.change;
-        }
-        // get inputs
-        let utxos;
-        if (params.options && params.options.utxoIds) {
-            utxos = params.options.utxoIds.map((utxoId) => model_1.UtxoItem.fromId(utxoId).asElectrum());
-        }
-        else {
-            utxos = await this.getAddressUtxos(this.cashaddr);
-        }
-        // Get current height to assure recently mined coins are not spent.
-        const bestHeight = await this.provider.getBlockHeight();
-        // simulate outputs using the sender's address
-        const sendRequest = new model_1.SendRequest({
-            cashaddr: this.cashaddr,
-            value: 100,
-            unit: "sat",
-        });
-        const sendRequests = Array(params.outputCount)
-            .fill(0)
-            .map(() => sendRequest);
-        const fundingUtxos = await (0, Wif_1.getSuitableUtxos)(utxos, undefined, bestHeight, feePaidBy);
-        const relayFeePerByteInSatoshi = await (0, getRelayFeeCache_1.getRelayFeeCache)(this.provider);
-        const fee = await (0, Wif_1.getFeeAmount)({
-            utxos: fundingUtxos,
-            sendRequests: sendRequests,
-            privateKey: this.privateKey,
-            relayFeePerByteInSatoshi: relayFeePerByteInSatoshi,
-            slpOutputs: [],
-            feePaidBy: feePaidBy,
-        });
-        const spendableAmount = await (0, sumUtxoValue_1.sumUtxoValue)(fundingUtxos);
-        let result = spendableAmount - fee;
-        if (result < 0) {
-            result = 0;
-        }
-        return await (0, balanceObjectFromSatoshi_1.balanceResponseFromSatoshi)(result);
-    }
-    /**
-     * send Send some amount to an address
-     * this function processes the send requests, encodes the transaction, sends it to the network
-     * @returns (depending on the options parameter) the transaction id, new address balance and a link to the transaction on the blockchain explorer
-     *
-     * This is a first class function with REST analog, maintainers should strive to keep backward-compatibility
-     *
-     */
-    async send(requests, options) {
-        let encodedTransaction = await this.encodeTransaction(requests, undefined, options);
-        const awaitTransactionPropagation = !options ||
-            options.awaitTransactionPropagation === undefined ||
-            options.awaitTransactionPropagation;
-        const txId = await this.submitTransaction(encodedTransaction, awaitTransactionPropagation);
-        let resp = new model_1.SendResponse({});
-        resp.txId = txId;
-        const queryBalance = !options || options.queryBalance === undefined || options.queryBalance;
-        if (queryBalance) {
-            resp.balance = (await this.getBalance());
-        }
-        resp.explorerUrl = this.explorerUrl(resp.txId);
-        return resp;
-    }
-    /**
-     * sendMax Send all available funds to a destination cash address
-     *
-     * @param  {string} cashaddr destination cash address
-     * @param  {SendRequestOptionsI} options Options of the send requests
-     *
-     * @returns (depending on the options parameter) the transaction id, new address balance and a link to the transaction on the blockchain explorer
-     */
-    async sendMax(cashaddr, options) {
-        const txId = await this.sendMaxRaw(cashaddr, options);
-        const queryBalance = !options || options.queryBalance === undefined || options.queryBalance;
-        return {
-            txId: txId,
-            balance: queryBalance
-                ? (await this.getBalance())
-                : undefined,
-            explorerUrl: this.explorerUrl(txId),
-        };
-    }
-    /**
-     * sendMaxRaw (internal) Send all available funds to a destination cash address
-     *
-     * @param  {string} cashaddr destination cash address
-     * @param  {SendRequestOptionsI} options Options of the send requests
-     *
-     * @returns the transaction id sent to the network
-     */
-    async sendMaxRaw(cashaddr, options) {
-        let maxSpendableAmount = await this.getMaxAmountToSend({
-            outputCount: 1,
-            options: options,
-        });
-        if (maxSpendableAmount.sat === undefined) {
-            throw Error("no Max amount to send");
-        }
-        let sendRequest = new model_1.SendRequest({
-            cashaddr: cashaddr,
-            value: maxSpendableAmount.sat,
-            unit: "sat",
-        });
-        const encodedTransaction = await this.encodeTransaction([sendRequest], true, options);
-        const awaitTransactionPropagation = !options ||
-            options.awaitTransactionPropagation === undefined ||
-            options.awaitTransactionPropagation;
-        const txId = await this.submitTransaction(encodedTransaction, awaitTransactionPropagation);
-        return txId;
-    }
-    /**
-     * encodeTransaction Encode and sign a transaction given a list of sendRequests, options and estimate fees.
-     * @param  {SendRequest[]} sendRequests SendRequests
-     * @param  {boolean} discardChange=false
-     * @param  {SendRequestOptionsI} options Options of the send requests
-     */
-    async encodeTransaction(requests, discardChange = false, options) {
-        let sendRequests = (0, asSendRequestObject_1.asSendRequestObject)(requests);
-        if (!this.privateKey) {
-            throw new Error(`Wallet ${this.name} is missing either a network or private key`);
-        }
-        if (!this.cashaddr) {
-            throw Error("attempted to send without a cashaddr");
-        }
-        if (options && options.slpAware) {
-            this._slpAware = true;
-        }
-        if (options && options.slpSemiAware) {
-            this._slpSemiAware = true;
-        }
-        let feePaidBy;
-        if (options && options.feePaidBy) {
-            feePaidBy = options.feePaidBy;
-        }
-        else {
-            feePaidBy = enum_3.FeePaidByEnum.change;
-        }
-        let changeAddress;
-        if (options && options.changeAddress) {
-            changeAddress = options.changeAddress;
-        }
-        else {
-            changeAddress = "";
-        }
-        // get inputs from options or query all inputs
-        let utxos;
-        if (options && options.utxoIds) {
-            utxos = options.utxoIds.map((utxoId) => model_1.UtxoItem.fromId(utxoId).asElectrum());
-        }
-        else {
-            utxos = await this.getAddressUtxos(this.cashaddr);
-        }
-        const bestHeight = await this.provider.getBlockHeight();
-        const spendAmount = await (0, sumSendRequestAmounts_1.sumSendRequestAmounts)(sendRequests);
-        if (utxos.length === 0) {
-            throw Error("There were no Unspent Outputs");
-        }
-        if (typeof spendAmount !== "bigint") {
-            throw Error("Couldn't get spend amount when building transaction");
-        }
-        const relayFeePerByteInSatoshi = await (0, getRelayFeeCache_1.getRelayFeeCache)(this.provider);
-        const feeEstimate = await (0, Wif_1.getFeeAmount)({
-            utxos: utxos,
-            sendRequests: sendRequests,
-            privateKey: this.privateKey,
-            relayFeePerByteInSatoshi: relayFeePerByteInSatoshi,
-            slpOutputs: [],
-            feePaidBy: feePaidBy,
-        });
-        const fundingUtxos = await (0, Wif_1.getSuitableUtxos)(utxos, BigInt(spendAmount) + BigInt(feeEstimate), bestHeight, feePaidBy);
-        if (fundingUtxos.length === 0) {
-            throw Error("The available inputs couldn't satisfy the request with fees");
-        }
-        const fee = await (0, Wif_1.getFeeAmount)({
-            utxos: fundingUtxos,
-            sendRequests: sendRequests,
-            privateKey: this.privateKey,
-            relayFeePerByteInSatoshi: relayFeePerByteInSatoshi,
-            slpOutputs: [],
-            feePaidBy: feePaidBy,
-        });
-        const encodedTransaction = await (0, Wif_1.buildEncodedTransaction)(fundingUtxos, sendRequests, this.privateKey, fee, discardChange, [], feePaidBy, changeAddress);
-        return encodedTransaction;
-    }
-    // Submit a raw transaction
-    async submitTransaction(transaction, awaitPropagation = true) {
-        if (!this.provider) {
-            throw Error("Wallet network provider was not initialized");
-        }
-        let rawTransaction = (0, libauth_2.binToHex)(transaction);
-        return await this.provider.sendRawTransaction(rawTransaction, awaitPropagation);
-    }
-    // gets transaction history of this wallet
-    async getRawHistory() {
-        return await this.provider.getHistory(this.cashaddr);
-    }
-    // gets transaction history of this wallet
-    async getHistory(unit, start, count, collapseChange) {
-        return (0, electrumTransformer_1.getAddressHistory)(this.cashaddr, this.provider, unit, start, count, collapseChange);
-    }
-    // gets last transaction of this wallet
-    async getLastTransaction(confirmedOnly = false) {
-        let history = await this.getRawHistory();
-        if (confirmedOnly) {
-            history = history.filter((val) => val.height > 0);
-        }
-        if (!history.length) {
-            return null;
-        }
-        const [lastTx] = history.slice(-1);
-        return this.provider.getRawTransactionObject(lastTx.tx_hash);
-    }
-    // waits for next transaction, program execution is halted
-    async waitForTransaction(options = {
-        getTransactionInfo: true,
-        getBalance: false,
-        txHash: undefined,
-    }) {
-        if (options.getTransactionInfo === undefined) {
-            options.getTransactionInfo = true;
-        }
-        return new Promise(async (resolve) => {
-            let txHashSeen = false;
-            const makeResponse = async (txHash) => {
-                const response = {};
-                const promises = [undefined, undefined];
-                if (options.getBalance === true) {
-                    promises[0] = this.getBalance();
-                }
-                if (options.getTransactionInfo === true) {
-                    if (!txHash) {
-                        promises[1] = this.getLastTransaction();
-                    }
-                    else {
-                        promises[1] = this.provider.getRawTransactionObject(txHash);
-                    }
-                }
-                const result = await Promise.all(promises);
-                response.balance = result[0];
-                response.transactionInfo = result[1];
-                return response;
-            };
-            // waiting for a specific transaction to propagate
-            if (options.txHash) {
-                const waitForTransactionCallback = async (data) => {
-                    if (data && data[0] === options.txHash) {
-                        txHashSeen = true;
-                        this.provider.unsubscribeFromTransaction(options.txHash, waitForTransactionCallback);
-                        resolve(makeResponse(options.txHash));
-                    }
-                };
-                this.provider.subscribeToTransaction(options.txHash, waitForTransactionCallback);
-                return;
-            }
-            // waiting for any address transaction
-            const watchCancel = this.provider.watchAddressStatus(this.getDepositAddress(), async (_status) => {
-                watchCancel();
-                resolve(makeResponse());
-            });
-        });
-    }
-    /**
-     * watchBlocks Watch network blocks
-     *
-     * @param callback callback with a block header object
-     *
-     * @returns a function which will cancel watching upon evaluation
-     */
-    watchBlocks(callback) {
-        return this.provider.watchBlocks(callback);
-    }
-    /**
-     * waitForBlock Wait for a network block
-     *
-     * @param height if specified waits for this exact blockchain height, otherwise resolves with the next block
-     *
-     */
-    async waitForBlock(height) {
-        return this.provider.waitForBlock(height);
-    }
-    //#endregion Funds
-    //#region Private implementation details
-    async deriveInfo() {
-        const sha256 = await sha256Promise;
-        const secp256k1 = await secp256k1Promise;
-        this.publicKey = secp256k1.derivePublicKeyUncompressed(this.privateKey);
-        this.publicKeyCompressed = secp256k1.derivePublicKeyCompressed(this.privateKey);
-        const networkType = this.network === enum_1.NetworkType.Regtest ? enum_1.NetworkType.Testnet : this.network;
-        this.privateKeyWif = (0, libauth_2.encodePrivateKeyWif)(sha256, this.privateKey, networkType);
-        (0, checkWifNetwork_1.checkWifNetwork)(this.privateKeyWif, this.network);
-        this.cashaddr = (await (0, deriveCashaddr_1.deriveCashaddr)(this.privateKey, this.networkPrefix));
-        this.address = this.cashaddr;
-        this.publicKeyHash = (0, derivePublicKeyHash_1.derivePublicKeyHash)(this.cashaddr);
-        return this;
-    }
-    //#endregion Private implementation details
-    //#region Signing
-    // Convenience wrapper to sign interface
-    async sign(message) {
-        return await Wallet.signedMessage.sign(message, this.privateKey);
-    }
-    // Convenience wrapper to verify interface
-    async verify(message, sig, publicKey) {
-        return await Wallet.signedMessage.verify(message, sig, this.cashaddr, publicKey);
-    }
-}
-exports.Wallet = Wallet;
-Wallet.signedMessage = new message_1.SignedMessage();
-/**
- * Class to manage a testnet wallet.
- */
-class TestNetWallet extends Wallet {
-    constructor(name = "") {
-        super(name, enum_1.NetworkType.Testnet);
-    }
-    // will receive 10000 testnet satoshi, rate limits apply
-    async getTestnetSatoshis() {
-        try {
-            const response = await axios_1.default.post(`${TestNetWallet.faucetServer}/faucet/get_testnet_bch`, { cashaddr: this.cashaddr });
-            const data = response.data;
-            return data.txId;
-        }
-        catch (e) {
-            // console.log(e);
-            // console.log(e.response ? e.response.data : "");
-            throw e;
-        }
-    }
-    // be nice and return them back
-    async returnTestnetSatoshis() {
-        try {
-            const response = await axios_1.default.post(`${TestNetWallet.faucetServer}/faucet/get_addresses`);
-            const data = response.data;
-            return await this.slpAware().sendMax(data.bchtest);
-        }
-        catch (e) {
-            console.log(e);
-            console.log(e.response ? e.response.data : "");
-            throw e;
-        }
-    }
-    // will receive 10 testnet tokens, rate limits apply
-    async getTestnetSlp(tokenId) {
-        try {
-            const response = await axios_1.default.post(`${TestNetWallet.faucetServer}/faucet/get_testnet_slp`, { slpaddr: this.slp.slpaddr, tokenId: tokenId });
-            const data = response.data;
-            return data.txId;
-        }
-        catch (e) {
-            //console.log(e);
-            //console.log(e.response ? e.response.data : "");
-            throw e;
-        }
-    }
-    // be nice and return them back
-    async returnTestnetSlp(tokenId) {
-        try {
-            const response = await axios_1.default.post(`${TestNetWallet.faucetServer}/faucet/get_addresses`);
-            const data = response.data;
-            return await this.slp.sendMax(data.slptest, tokenId);
-        }
-        catch (e) {
-            console.log(e);
-            console.log(e.response ? e.response.data : "");
-            throw e;
-        }
-    }
-    // interface to static slp functions. see Slp.ts
-    static get slp() {
-        return Slp_1.TestNetSlp;
-    }
-    // interface to static util functions. see Util.ts
-    static get util() {
-        return Util_1.TestNetUtil;
-    }
-}
-exports.TestNetWallet = TestNetWallet;
-TestNetWallet.networkPrefix = libauth_2.CashAddressNetworkPrefix.testnet;
-TestNetWallet.faucetServer = "https://rest-unstable.mainnet.cash";
-/**
- * Class to manage a regtest wallet.
- */
-class RegTestWallet extends Wallet {
-    constructor(name = "") {
-        super(name, enum_1.NetworkType.Regtest);
-    }
-    // interface to static slp functions. see Slp.ts
-    static get slp() {
-        return Slp_1.RegTestSlp;
-    }
-    // interface to static util functions. see Util.ts
-    static get util() {
-        return Util_1.RegTestUtil;
-    }
-}
-exports.RegTestWallet = RegTestWallet;
-RegTestWallet.networkPrefix = libauth_2.CashAddressNetworkPrefix.regtest;
-/**
- * Class to manage a bitcoin cash wif wallet.
- */
-class WifWallet extends Wallet {
-    constructor(name = "") {
-        super(name, enum_1.NetworkType.Mainnet, enum_3.WalletTypeEnum.Wif);
-    }
-    // interface to static slp functions. see Slp.ts
-    static get slp() {
-        return Slp_1.WifSlp;
-    }
-    // interface to static util functions. see Util.ts
-    static get util() {
-        return Util_1.WifUtil;
-    }
-}
-exports.WifWallet = WifWallet;
-WifWallet.networkPrefix = libauth_2.CashAddressNetworkPrefix.mainnet;
-WifWallet.walletType = enum_3.WalletTypeEnum.Wif;
-/**
- * Class to manage a testnet wif wallet.
- */
-class TestNetWifWallet extends Wallet {
-    constructor(name = "") {
-        super(name, enum_1.NetworkType.Testnet, enum_3.WalletTypeEnum.Wif);
-    }
-    // interface to static slp functions. see Slp.ts
-    static get slp() {
-        return Slp_1.TestNetWifSlp;
-    }
-    // interface to static util functions. see Util.ts
-    static get util() {
-        return Util_1.TestNetWifUtil;
-    }
-}
-exports.TestNetWifWallet = TestNetWifWallet;
-TestNetWifWallet.networkPrefix = libauth_2.CashAddressNetworkPrefix.testnet;
-TestNetWifWallet.walletType = enum_3.WalletTypeEnum.Wif;
-/**
- * Class to manage a regtest wif wallet.
- */
-class RegTestWifWallet extends Wallet {
-    constructor(name = "") {
-        super(name, enum_1.NetworkType.Regtest, enum_3.WalletTypeEnum.Wif);
-    }
-    // interface to static slp functions. see Slp.ts
-    static get slp() {
-        return Slp_1.RegTestWifSlp;
-    }
-    // interface to static util functions. see Util.ts
-    static get util() {
-        return Util_1.RegTestWifUtil;
-    }
-}
-exports.RegTestWifWallet = RegTestWifWallet;
-RegTestWifWallet.networkPrefix = libauth_2.CashAddressNetworkPrefix.regtest;
-RegTestWifWallet.walletType = enum_3.WalletTypeEnum.Wif;
-/**
- * Class to manage a bitcoin cash watch wallet.
- */
-class WatchWallet extends Wallet {
-    constructor(name = "") {
-        super(name, enum_1.NetworkType.Mainnet, enum_3.WalletTypeEnum.Watch);
-    }
-    // interface to static slp functions. see Slp.ts
-    static get slp() {
-        return Slp_1.WatchSlp;
-    }
-    // interface to static util functions. see Util.ts
-    static get util() {
-        return Util_1.WatchUtil;
-    }
-}
-exports.WatchWallet = WatchWallet;
-WatchWallet.networkPrefix = libauth_2.CashAddressNetworkPrefix.mainnet;
-WatchWallet.walletType = enum_3.WalletTypeEnum.Watch;
-/**
- * Class to manage a testnet watch wallet.
- */
-class TestNetWatchWallet extends Wallet {
-    constructor(name = "") {
-        super(name, enum_1.NetworkType.Testnet, enum_3.WalletTypeEnum.Watch);
-    }
-    // interface to static slp functions. see Slp.ts
-    static get slp() {
-        return Slp_1.TestNetWatchSlp;
-    }
-    // interface to static util functions. see Util.ts
-    static get util() {
-        return Util_1.TestNetWatchUtil;
-    }
-}
-exports.TestNetWatchWallet = TestNetWatchWallet;
-TestNetWatchWallet.networkPrefix = libauth_2.CashAddressNetworkPrefix.testnet;
-TestNetWatchWallet.walletType = enum_3.WalletTypeEnum.Watch;
-/**
- * Class to manage a regtest watch wallet.
- */
-class RegTestWatchWallet extends Wallet {
-    constructor(name = "") {
-        super(name, enum_1.NetworkType.Regtest, enum_3.WalletTypeEnum.Watch);
-    }
-    // interface to static slp functions. see Slp.ts
-    static get slp() {
-        return Slp_1.RegTestWatchSlp;
-    }
-    // interface to static util functions. see Util.ts
-    static get util() {
-        return Util_1.RegTestWatchUtil;
-    }
-}
-exports.RegTestWatchWallet = RegTestWatchWallet;
-RegTestWatchWallet.networkPrefix = libauth_2.CashAddressNetworkPrefix.regtest;
-RegTestWatchWallet.walletType = enum_3.WalletTypeEnum.Watch;
-//# sourceMappingURL=Wif.js.map