mainnet-js 0.5.8 → 1.0.0-rc.1

package/dist/main/wallet/Slp.js

@@ -1,775 +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.RegTestWatchSlp = exports.TestNetWatchSlp = exports.WatchSlp = exports.RegTestWifSlp = exports.TestNetWifSlp = exports.WifSlp = exports.RegTestSlp = exports.TestNetSlp = exports.Slp = void 0;
-const Wif_1 = require("../wallet/Wif");
-const interface_1 = require("../slp/interface");
-const SlpDbProvider_1 = require("../slp/SlpDbProvider");
-const Qr_1 = require("../qr/Qr");
-const bignumber_js_1 = __importDefault(require("bignumber.js"));
-const getRelayFeeCache_1 = require("../network/getRelayFeeCache");
-const Wif_2 = require("../transaction/Wif");
-const SlpLibAuth_1 = require("../slp/SlpLibAuth");
-const libauth_1 = require("@bitauth/libauth");
-const bchaddr_1 = require("../util/bchaddr");
-const GsppProvider_1 = require("../slp/GsppProvider");
-const delay_1 = require("../util/delay");
-const Util_1 = require("./Util");
-const index_1 = require("../index");
-const enum_1 = require("./enum");
-/**
- * Class to manage an slp enabled wallet.
- */
-class Slp {
-    /**
-     * Initializes an Slp Wallet.
-     *
-     * @param wallet     A non-slp wallet object
-     */
-    constructor(wallet) {
-        // a loookup table of spent inputs to keep track of NFT parent token consumption. related to a bug in SLPDB
-        this.spentParentUtxos = [];
-        this.slpaddr = (0, bchaddr_1.toSlpAddress)(wallet.cashaddr);
-        this.wallet = wallet;
-        let provider = Slp.defaultProvider;
-        if (index_1.Mainnet.getRuntimePlatform() === index_1.Mainnet.RuntimePlatform.node &&
-            process.env.SLP_PROVIDER)
-            provider = process.env.SLP_PROVIDER;
-        if (provider === "gspp") {
-            this.provider = new GsppProvider_1.GsppProvider(this.wallet.network);
-        }
-        else {
-            // provider === "slpdb"
-            this.provider = new SlpDbProvider_1.SlpDbProvider(this.wallet.network);
-        }
-    }
-    static get walletType() {
-        return Wif_1.Wallet;
-    }
-    /**
-     * setProvider - sets the provider to fetch slp data from
-     */
-    setProvider(provider) {
-        return (this.provider = provider);
-    }
-    /**
-     * getDepositAddress - get the slp deposit address
-     *
-     * a high-level function,
-     *
-     * @see {@link https://rest-unstable.mainnet.cash/api-docs/#/wallet%2Fslp/slpDepositAddress|/wallet/slp/deposit_address} for REST endpoint
-     *
-     * @returns The the slp address as a string
-     */
-    getDepositAddress() {
-        return this.slpaddr;
-    }
-    /**
-     * getDepositQr - get an slp address qrcode, encoded for display on the web
-     *
-     * a high-level function
-     *
-     * @see {@link https://rest-unstable.mainnet.cash/api-docs/#/wallet%2Fslp/slpDepositQr|/wallet/slp/deposit_qr} for REST endpoint
-     *
-     * @returns The qrcode for the slp address
-     */
-    getDepositQr() {
-        const result = (0, Qr_1.qrAddress)(this.slpaddr);
-        result.alt = "A Bitcoin Cash Simple Ledger Protocol QR Code";
-        return result;
-    }
-    /**
-     * getTokenInfo - get data associated with a token
-     *
-     * a high-level function
-     *
-     * @see {@link https://rest-unstable.mainnet.cash/api-docs/#/wallet%2Fslp/slpTokenInfo|/wallet/slp/token_info} for REST endpoint
-     *
-     * @param tokenId  The tokenId to request information about
-     *
-     * @returns Promise to the slp token info or undefined.
-     */
-    getTokenInfo(tokenId) {
-        return this.provider.SlpTokenInfo(tokenId);
-    }
-    /**
-     * getSlpOutpoints - get a list of SLP unspent outpoints
-     *
-     * an intermediate function contributing to the output of wallet.getUtxos() and /wallet/utxos for slp enabled wallets
-     *
-     * @param slpaddr  The slpaddr to request slp unspent outpoints for
-     *
-     * @returns Promise to a list of slp unspent outpoints
-     */
-    async getSlpOutpoints() {
-        return this.provider.SlpOutpoints(this.slpaddr);
-    }
-    /**
-     * getSlpUtxos - get a list of SLP unspent outputs
-     *
-     * @returns Promise to a list of slp unspent outputs
-     */
-    async getSlpUtxos() {
-        return this.provider.SlpUtxos(this.slpaddr);
-    }
-    /**
-     * getFormattedSlpUtxos - get a list of unspent outputs
-     *
-     * an intermediate function
-     *
-     * @returns Promise to a list of slp formatted unspent outputs
-     */
-    async getFormattedSlpUtxos() {
-        const utxos = await this.getSlpUtxos();
-        return utxos.map((val) => {
-            let utxo = {};
-            utxo.ticker = val.ticker;
-            utxo.tokenId = val.tokenId;
-            utxo.value = val.value.toString();
-            utxo.satoshis = val.satoshis;
-            utxo.decimals = val.decimals;
-            utxo.txId = val.txid;
-            utxo.index = val.vout;
-            utxo.utxoId = utxo.txId + ":" + utxo.index;
-            utxo.type = val.type;
-            return utxo;
-        });
-    }
-    /**
-     * getBatonUtxos - get a list of baton unspent outputs
-     *
-     * an intermediate function
-     *
-     * @param tokenId   The id of the slp token
-     *
-     * @returns Promise to a list of slp unspent outputs
-     */
-    async getBatonUtxos(tokenId) {
-        return this.provider.SlpBatonUtxos(this.slpaddr, tokenId);
-    }
-    /**
-     * getHistory - get a transaction history for a particular address
-     *
-     * an intermediate function
-     *
-     * @param tokenId   The id of the slp token
-     *
-     * @returns Promise to a list of transactions
-     */
-    async getHistory(tokenId) {
-        return this.provider.SlpAddressTransactionHistory(this.slpaddr, tokenId);
-    }
-    /**
-     * getLastTransaction - get a last SLP token transaction of a particular address
-     *
-     * @param {boolean} [confirmedOnly=false]  When confirmedOnly is true, results will be limited to only transactions included in a block.
-     *
-     * @returns Promise to the transaction hex or error
-     */
-    async getLastTransaction(confirmedOnly = false) {
-        let history = await this.getHistory();
-        if (confirmedOnly) {
-            history = history.filter((val) => val.height > 0);
-        }
-        const [lastTx] = history.slice(-1);
-        return this.wallet.provider.getRawTransactionObject(lastTx.tx_hash);
-    }
-    /**
-     * getBalance - get a token balance for a particular address
-     *
-     * a high-level function, see also /wallet/slp/balance REST endpoint
-     *
-     * @param tokenId   The id of the slp token
-     *
-     * @returns Promise to an SlpTokenBalance
-     */
-    async getBalance(tokenId) {
-        if (!tokenId) {
-            throw new Error(`Invalid tokenId ${tokenId}`);
-        }
-        return this.provider.SlpTokenBalance(this.slpaddr, tokenId);
-    }
-    /**
-     * getAllBalances - get all token balances for a particular address
-     *
-     * a high-level function, see also /wallet/slp/all_balances REST endpoint
-     *
-     * @returns Promise to an array of SlpTokenBalance
-     */
-    async getAllBalances() {
-        return this.provider.SlpAllTokenBalances(this.slpaddr);
-    }
-    /**
-     * watchBalance - set up a callback to be called upon wallet's slp balance change
-     *
-     * can be cancelled by calling the function returned from this one
-     *
-     * @param callback   The callback function to be called each time the balance changes
-     * @param tokenId    Specific token id to watch
-     *
-     * @returns A function to cancel the watching
-     */
-    watchBalance(callback, tokenId) {
-        return this.provider.SlpWatchBalance(callback, this.slpaddr, tokenId);
-    }
-    /**
-     * waitForBalance - wait for address balance to be greater than or equal to the target value
-     *
-     * This call halts the program execution
-     *
-     * @param value      Target balance value
-     * @param tokenId    Specific token id to watch
-     *
-     * @returns Actual token balance after reaching or surpassing the target value
-     */
-    async waitForBalance(value, tokenId) {
-        return this.provider.SlpWaitForBalance(value, this.slpaddr, tokenId);
-    }
-    /**
-     * watchBalance - set up a callback to be called upon wallet's slp transactions occurring
-     *
-     * can be cancelled by calling the function returned from this one
-     *
-     * @param callback   The callback function to be called each time the balance changes
-     * @param tokenId    Specific token id to watch, optional
-     *
-     * @returns A function to cancel the watching
-     */
-    watchTransactions(callback, tokenId) {
-        return this.provider.SlpWatchTransactions(callback, this.slpaddr, tokenId);
-    }
-    /**
-     * waitForBalance - wait for the next SLP transaction to occur
-     *
-     * This call halts the program execution
-     *
-     * @param tokenId    Specific token id to watch, optional
-     *
-     * @returns Transaction object
-     */
-    async waitForTransaction(tokenId) {
-        return this.provider.SlpWaitForTransaction(this.slpaddr, tokenId);
-    }
-    /**
-     * genesis - create a new Type1 SLP token
-     *
-     * @param options    Token creation options @see SlpGenesisOptions
-     *
-     * @returns Token Id and new token balance
-     */
-    async genesis(options) {
-        let result = await this._processGenesis(options);
-        return {
-            tokenId: result,
-            balance: await this.getBalance(result),
-        };
-    }
-    /**
-     * nftParentGenesis - create a new NFT Parent token
-     *
-     * @param options    Token creation options @see SlpGenesisOptions
-     *
-     * @returns Token Id and new token balance
-     */
-    async nftParentGenesis(options) {
-        options.type = interface_1.SlpTokenType.NftParent;
-        let result = await this._processGenesis(options);
-        return {
-            tokenId: result,
-            balance: await this.getBalance(result),
-        };
-    }
-    /**
-     * nftParentGenesis - create a new NFT Child token
-     *
-     * @param parentTokenId    Parent token id, at least one is required and will be spent in the child genesis process
-     * @param options    Token creation options @see SlpGenesisOptions
-     *
-     * @returns Token Id and new token balance
-     */
-    async nftChildGenesis(options) {
-        if (!options.parentTokenId) {
-            throw new Error(`The 'parentTokenId' was not set or invalid ${options.parentTokenId}`);
-        }
-        let parentUtxos = await this.provider.SlpSpendableUtxos(this.slpaddr, options.parentTokenId);
-        parentUtxos = parentUtxos.filter((val) => this.spentParentUtxos.indexOf(`${val.txid}:${val.vout}`) === -1);
-        parentUtxos = parentUtxos.sort((a, b) => a.value.comparedTo(b.value));
-        if (!parentUtxos.length) {
-            throw new Error(`You do not own any NFT parent tokens with id ${options.parentTokenId}`);
-        }
-        if (parentUtxos[0].type !== interface_1.SlpTokenType.NftParent) {
-            throw new Error(`The 'parentTokenId' is not of type ${interface_1.SlpTokenType.NftParent}`);
-        }
-        // we are about to spend exactly 1 NFT parent
-        // if we do not have it, we have to make one by splitting
-        if (parentUtxos[0].value.isGreaterThan(new bignumber_js_1.default(1))) {
-            await this.send([
-                {
-                    slpaddr: this.slpaddr,
-                    tokenId: options.parentTokenId,
-                    value: new bignumber_js_1.default(1),
-                },
-            ]);
-            return await this.nftChildGenesis(options);
-        }
-        options.type = interface_1.SlpTokenType.NftChild;
-        options.endBaton = true;
-        options.initialAmount = 1;
-        options.decimals = 0;
-        let result = await this._processGenesis(options, [parentUtxos[0]]);
-        const tx = (await this.wallet.provider.getRawTransactionObject(result));
-        tx.vin.forEach((val) => this.spentParentUtxos.push(`${val.txid}:${val.vout}`));
-        return {
-            tokenId: result,
-            balance: await this.getBalance(result),
-        };
-    }
-    /**
-     * _processGenesis - prepare the genesis transaction with given parameters
-     *
-     * a private utility wrapper to pre-process transactions
-     *
-     * @param options   genesis options to controll the process
-     *
-     * @returns the created tokenId (which is genesis transaction id) and token balance
-     */
-    async _processGenesis(options, ensureInputs = []) {
-        options = this.substituteOptionals(options);
-        let slpOutputsResult = await (0, SlpLibAuth_1.SlpGetGenesisOutputs)(options);
-        let fundingBchUtxos = await this.wallet
-            .slpAware(true)
-            .getAddressUtxos(this.wallet.cashaddr);
-        fundingBchUtxos = [...ensureInputs, ...fundingBchUtxos];
-        return this.processSlpTransaction(fundingBchUtxos, slpOutputsResult);
-    }
-    /**
-     * sendMax - send the maximum spendable amount for a token to an slpaddr.
-     *
-     * a high-level function, see also /wallet/slp/send_max REST endpoint
-     *
-     * @param slpaddr   destination SLP address
-     * @param tokenId   the id of the token to be spent
-     *
-     * @returns transaction id and token balance
-     */
-    async sendMax(slpaddr, tokenId) {
-        const balance = await this.getBalance(tokenId);
-        const requests = [balance].map((val) => ({
-            slpaddr: slpaddr,
-            value: val.value,
-            ticker: val.ticker,
-            tokenId: val.tokenId,
-        }));
-        return this.send(requests);
-    }
-    /**
-     *  explorerUrl   Web url to a transaction on a block explorer
-     *
-     * @param txId   transaction Id
-     * @returns   Url string
-     */
-    explorerUrl(txId) {
-        const explorerUrlMap = {
-            mainnet: "https://simpleledger.info/#tx/",
-            testnet: "https://testnet.simpleledger.info/#tx/",
-            regtest: "",
-        };
-        return explorerUrlMap[this.wallet.network] + txId;
-    }
-    /**
-     * send - attempt to process a list of slp send requests.
-     *
-     * a high-level function, see also /wallet/slp/send REST endpoint
-     *
-     * @param [requests]   list of send requests
-     *
-     * @returns transaction id and token balance
-     */
-    async send(requests) {
-        let [actualTokenId, result] = await this._processSendRequests(requests);
-        return {
-            txId: result,
-            balance: await this.getBalance(actualTokenId),
-            explorerUrl: this.explorerUrl(result),
-        };
-    }
-    /**
-     * _processSendRequests - given a list of sendRequests, estimate fees, build the transaction and submit it.
-     *
-     * A private utility wrapper to pre-process transactions
-     *
-     * Unstable - behavior may change without notice.
-     *
-     * @param  {SlpSendRequest[]} sendRequests
-     */
-    async _processSendRequests(sendRequests) {
-        if (!sendRequests.length) {
-            throw Error("Empty send requests");
-        }
-        if (sendRequests.length > 19) {
-            throw Error("Too many send requests in one transaction");
-        }
-        const uniqueTokenIds = new Set(sendRequests.map((val) => val.tokenId));
-        if (uniqueTokenIds.size > 1) {
-            throw Error("You have two different token types with the same ticker. Pass tokenId parameter");
-        }
-        const tokenId = sendRequests[0].tokenId;
-        if (!tokenId.match(/^[0-9a-fA-F]{64}$/)) {
-            throw new Error("Invalid tokenId, must be 64 character long hexadecimal string");
-        }
-        const slpUtxos = await this.provider.SlpSpendableUtxos(this.slpaddr, tokenId);
-        let slpOutputsResult = await (0, SlpLibAuth_1.SlpGetSendOutputs)(this.slpaddr, slpUtxos, sendRequests);
-        let fundingBchUtxos = await this.wallet
-            .slpAware(true)
-            .getAddressUtxos(this.wallet.cashaddr);
-        let slpToBchUtxos = slpOutputsResult.FundingSlpUtxos.map((val) => val);
-        fundingBchUtxos = [...slpToBchUtxos, ...fundingBchUtxos];
-        const actualTokenId = slpUtxos[0].tokenId;
-        return [
-            actualTokenId,
-            await this.processSlpTransaction(fundingBchUtxos, slpOutputsResult, actualTokenId),
-        ];
-    }
-    /**
-     * mint - create new tokens to increase the circulation supply.
-     *
-     * a high-level function, see also /wallet/slp/mint endpoint
-     *
-     * @param value   amount to mint
-     * @param tokenId   the tokenId of the slp being minted
-     * @param endBaton   boolean indicating whether the token should continue to be "mintable"
-     *
-     * @returns transaction id and token balance
-     */
-    async mint(options) {
-        let [actualTokenId, result] = await this._processMint(options);
-        return {
-            txId: result,
-            balance: await this.getBalance(actualTokenId),
-        };
-    }
-    /**
-     * _processMint - given mint parameters, prepare the transaction
-     *
-     * a private utility wrapper to pre-process transactions
-     *
-     * @param value   amount to mint
-     * @param tokenId   the tokenId of the slp being minted
-     * @param endBaton   boolean indicating whether the token should continue to be "mintable"
-     *
-     * @returns the tokenId and minting transaction id
-     */
-    async _processMint(options) {
-        options = this.substituteOptionals(options);
-        options.value = new bignumber_js_1.default(options.value);
-        if (options.value.isLessThanOrEqualTo(0) &&
-            options.batonReceiverSlpAddr === this.slpaddr) {
-            throw Error("Mint amount should be greater than zero");
-        }
-        const slpBatonUtxos = await this.getBatonUtxos(options.tokenId);
-        if (!slpBatonUtxos.length) {
-            throw Error(`You do not possess the minting baton for ${options.tokenId}`);
-        }
-        let slpOutputsResult = await (0, SlpLibAuth_1.SlpGetMintOutputs)(options, slpBatonUtxos);
-        let bchUtxos = await this.wallet
-            .slpAware(true)
-            .getAddressUtxos(this.wallet.cashaddr);
-        let fundingBchUtxos = bchUtxos;
-        let slpToBchUtxos = slpOutputsResult.FundingSlpUtxos.map((val) => val);
-        fundingBchUtxos = [...slpToBchUtxos, ...fundingBchUtxos];
-        return [
-            options.tokenId,
-            await this.processSlpTransaction(fundingBchUtxos, slpOutputsResult, options.tokenId),
-        ];
-    }
-    /**
-     * processSlpTransaction - process the prepared SLP transaction and submit it to the network
-     *
-     * @param fundingBchUtxos   ensure these BCH utxos to be spent in the process
-     * @param slpOutputsResult  prepared SLP outputs to be added to transaction
-     *
-     * @returns the tokenId and minting transaction id
-     */
-    async processSlpTransaction(fundingBchUtxos, slpOutputsResult, tokenId) {
-        if (!this.wallet.privateKey) {
-            throw new Error(`Wallet ${this.wallet.name} is missing either a network or private key`);
-        }
-        if (!fundingBchUtxos.length) {
-            throw new Error("No bch available to fund this transaction");
-        }
-        const bestHeight = await this.wallet.provider.getBlockHeight();
-        const relayFeePerByteInSatoshi = await (0, getRelayFeeCache_1.getRelayFeeCache)(this.wallet.provider);
-        const feeEstimate = await (0, Wif_2.getFeeAmount)({
-            utxos: fundingBchUtxos,
-            sendRequests: slpOutputsResult.BchSendRequests,
-            privateKey: this.wallet.privateKey,
-            relayFeePerByteInSatoshi: relayFeePerByteInSatoshi,
-            slpOutputs: slpOutputsResult.SlpOutputs,
-            feePaidBy: enum_1.FeePaidByEnum.change,
-        });
-        const bchSpendAmount = slpOutputsResult.BchSendRequests.map((val) => val.value).reduce((a, b) => a + b, 0);
-        let fundingUtxos = await (0, Wif_2.getSuitableUtxos)(fundingBchUtxos, BigInt(bchSpendAmount) + BigInt(feeEstimate), bestHeight, enum_1.FeePaidByEnum.change);
-        if (fundingUtxos.length === 0) {
-            throw Error("The available inputs couldn't satisfy the request with fees");
-        }
-        const fee = await (0, Wif_2.getFeeAmount)({
-            utxos: fundingUtxos,
-            sendRequests: slpOutputsResult.BchSendRequests,
-            privateKey: this.wallet.privateKey,
-            relayFeePerByteInSatoshi: relayFeePerByteInSatoshi,
-            slpOutputs: slpOutputsResult.SlpOutputs,
-            feePaidBy: enum_1.FeePaidByEnum.change,
-        });
-        const encodedTransaction = await (0, Wif_2.buildEncodedTransaction)(fundingUtxos, slpOutputsResult.BchSendRequests, this.wallet.privateKey, fee, false, slpOutputsResult.SlpOutputs);
-        return this._submitTransaction(encodedTransaction, tokenId);
-    }
-    /**
-     * _submitTransaction - transform binary transaction to hex and submit it to the network provider
-     *
-     * a private utility wrapper submit raw transactions
-     *
-     * @param transaction   raw transaction
-     *
-     * @returns the transaction id of the broadcasted transaction
-     */
-    async _submitTransaction(transaction, tokenId) {
-        let rawTransaction = (0, libauth_1.binToHex)(transaction);
-        const slpPromise = new Promise(async (resolve) => {
-            const txHash = await Util_1.Util.getTransactionHash(rawTransaction);
-            const cancelWatchFn = this.provider.SlpWatchTransactions(async (tx) => {
-                if (tx.tx_hash === txHash) {
-                    cancelWatchFn();
-                    resolve(txHash);
-                }
-            }, undefined, tokenId || txHash);
-        });
-        const bchPromise = this.wallet.provider.sendRawTransaction(rawTransaction, true);
-        const [_, txHash] = await Promise.all([slpPromise, bchPromise]);
-        // allow for indexer processing, delay value is a bit arbitrary
-        await (0, delay_1.delay)(100);
-        return txHash;
-    }
-    /**
-     * substituteOptionals - substitute optional fields with default values
-     *
-     * will ensure that baton and token receiver are intialized as SLP address of this wallet if absent
-     * will ensure that baton will not be ended if endBaton is undefined
-     * a private utility wrapper substitute optionals
-     *
-     * @param options   genesis or mint options to substitute values int
-     *
-     * @returns options with relevant values substituted/initialized
-     */
-    substituteOptionals(options) {
-        if (!options.batonReceiverSlpAddr) {
-            options.batonReceiverSlpAddr = this.slpaddr;
-        }
-        if (!options.tokenReceiverSlpAddr) {
-            options.tokenReceiverSlpAddr = this.slpaddr;
-        }
-        if (options.endBaton === undefined) {
-            options.endBaton = false;
-        }
-        return options;
-    }
-    //#region Convenience methods to initialize Slp aware BCH wallet.
-    /**
-     * fromId - create an SLP aware wallet from encoded walletId string
-     *
-     * @param walletId   walletId options to steer the creation process
-     *
-     * @returns wallet instantiated accordingly to the walletId rules
-     */
-    static async fromId(walletId) {
-        const wallet = await this.walletType.fromId(walletId);
-        wallet._slpAware = true;
-        return wallet;
-    }
-    /**
-     * named - create an SLP aware named wallet
-     *
-     * @param name   user friendly wallet alias
-     * @param dbName name under which the wallet will be stored in the database
-     * @param force  force recreate wallet in the database if a record already exist
-     *
-     * @returns instantiated wallet
-     */
-    static async named(name, dbName, force) {
-        const wallet = await this.walletType.named(name, dbName, force);
-        wallet.derivationPath = "m/44'/245'/0'/0/0";
-        wallet._slpAware = true;
-        return wallet;
-    }
-    /**
-     * fromSeed - create an SLP aware wallet using the seed phrase and derivation path
-     *
-     * unless specified the derivation path m/44'/245'/0'/0/0 will be userd
-     * this derivation path is standard for Electron Cash SLP and other SLP enabled wallets
-     *
-     * @param seed   BIP39 12 word seed phrase
-     * @param derivationPath BIP44 HD wallet derivation path to get a single the private key from hierarchy
-     *
-     * @returns instantiated wallet
-     */
-    static async fromSeed(seed, derivationPath = "m/44'/245'/0'/0/0") {
-        const wallet = await this.walletType.fromSeed(seed, derivationPath);
-        wallet._slpAware = true;
-        return wallet;
-    }
-    /**
-     * newRandom - create an SLP aware random wallet
-     *
-     * if `name` parameter is specified, the wallet will also be persisted to DB
-     *
-     * @param name   user friendly wallet alias
-     * @param dbName name under which the wallet will be stored in the database
-     *
-     * @returns instantiated wallet
-     */
-    static async newRandom(name = "", dbName) {
-        const wallet = await this.walletType.newRandom(name, dbName);
-        wallet.derivationPath = "m/44'/245'/0'/0/0";
-        wallet._slpAware = true;
-        return wallet;
-    }
-    /**
-     * fromWIF - create an SLP aware wallet using the private key supplied in `Wallet Import Format`
-     *
-     * @param wif   WIF encoded private key string
-     *
-     * @returns instantiated wallet
-     */
-    static async fromWIF(wif) {
-        const wallet = await this.walletType.fromWIF(wif);
-        wallet.derivationPath = "m/44'/245'/0'/0/0";
-        wallet._slpAware = true;
-        return wallet;
-    }
-    /**
-     * watchOnly - create an SLP aware watch-only wallet
-     *
-     * 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 or slpaddress of a wallet
-     *
-     * @returns instantiated wallet
-     */
-    static async watchOnly(address) {
-        const wallet = await this.walletType.watchOnly((0, bchaddr_1.toCashAddress)(address));
-        wallet.derivationPath = "m/44'/245'/0'/0/0";
-        wallet._slpAware = true;
-        return wallet;
-    }
-    /**
-     * fromCashaddr - 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   cashaddress of a wallet
-     *
-     * @returns instantiated wallet
-     */
-    static async fromCashaddr(address) {
-        const wallet = await this.walletType.fromCashaddr(address);
-        wallet.derivationPath = "m/44'/245'/0'/0/0";
-        wallet._slpAware = true;
-        return wallet;
-    }
-    /**
-     * 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) {
-        const wallet = await this.walletType.fromSlpaddr(address);
-        wallet.derivationPath = "m/44'/245'/0'/0/0";
-        wallet._slpAware = true;
-        return wallet;
-    }
-}
-exports.Slp = Slp;
-Slp.defaultProvider = "slpdb";
-//#region Specific wallet classes
-/**
- * Class to manage an slp enabled testnet wallet.
- */
-class TestNetSlp extends Slp {
-    static get walletType() {
-        return Wif_1.TestNetWallet;
-    }
-}
-exports.TestNetSlp = TestNetSlp;
-/**
- * Class to manage an slp enabled regtest wallet.
- */
-class RegTestSlp extends Slp {
-    static get walletType() {
-        return Wif_1.RegTestWallet;
-    }
-}
-exports.RegTestSlp = RegTestSlp;
-/**
- * Class to manage a bitcoin cash wif wallet.
- */
-class WifSlp extends Slp {
-    static get walletType() {
-        return Wif_1.WifWallet;
-    }
-}
-exports.WifSlp = WifSlp;
-/**
- * Class to manage a testnet wif wallet.
- */
-class TestNetWifSlp extends Slp {
-    static get walletType() {
-        return Wif_1.TestNetWifWallet;
-    }
-}
-exports.TestNetWifSlp = TestNetWifSlp;
-/**
- * Class to manage a regtest wif wallet.
- */
-class RegTestWifSlp extends Slp {
-    static get walletType() {
-        return Wif_1.RegTestWifWallet;
-    }
-}
-exports.RegTestWifSlp = RegTestWifSlp;
-/**
- * Class to manage a bitcoin cash watch wallet.
- */
-class WatchSlp extends Slp {
-    static get walletType() {
-        return Wif_1.WatchWallet;
-    }
-}
-exports.WatchSlp = WatchSlp;
-/**
- * Class to manage a testnet watch wallet.
- */
-class TestNetWatchSlp extends Slp {
-    static get walletType() {
-        return Wif_1.TestNetWatchWallet;
-    }
-}
-exports.TestNetWatchSlp = TestNetWatchSlp;
-/**
- * Class to manage a regtest watch wallet.
- */
-class RegTestWatchSlp extends Slp {
-    static get walletType() {
-        return Wif_1.RegTestWatchWallet;
-    }
-}
-exports.RegTestWatchSlp = RegTestWatchSlp;
-//#endregion
-//# sourceMappingURL=Slp.js.map