@talismn/balances 0.3.0 → 0.3.2

package/dist/types/balances.js

@@ -1,471 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SumBalancesFormatter = exports.FiatSumBalancesFormatter = exports.BalanceFormatter = exports.Balance = exports.Balances = void 0;
-const util_1 = require("@talismn/util");
-const memoize_1 = __importDefault(require("lodash/memoize"));
-const typescript_memoize_1 = require("typescript-memoize");
-const helpers_1 = require("../helpers");
-const log_1 = __importDefault(require("../log"));
-const balancetypes_1 = require("./balancetypes");
-/**
- * A collection of balances.
- */
-class Balances {
-    //
-    // Properties
-    //
-    #balances = {};
-    //
-    // Methods
-    //
-    constructor(balances, hydrate) {
-        // handle Balances (convert to Balance[])
-        if (balances instanceof Balances)
-            return new Balances([...balances], hydrate);
-        // handle Balance (convert to Balance[])
-        if (balances instanceof Balance)
-            return new Balances([balances], hydrate);
-        // handle BalanceJsonList (the only remaining non-array type of balances) (convert to BalanceJson[])
-        if (!Array.isArray(balances))
-            return new Balances(Object.values(balances), hydrate);
-        // handle no balances
-        if (balances.length === 0)
-            return this;
-        // handle BalanceJson[]
-        if (!(0, util_1.isArrayOf)(balances, Balance))
-            return new Balances(balances.map((storage) => new Balance(storage)), hydrate);
-        // handle Balance[]
-        this.#balances = Object.fromEntries(balances.map((balance) => [balance.id, balance]));
-        if (hydrate !== undefined)
-            this.hydrate(hydrate);
-    }
-    /**
-     * Calling toJSON on a collection of balances will return the underlying BalanceJsonList.
-     */
-    toJSON = () => Object.fromEntries(Object.entries(this.#balances)
-        .map(([id, balance]) => {
-        try {
-            return [id, balance.toJSON()];
-        }
-        catch (error) {
-            log_1.default.error("Failed to convert balance to JSON", error, { id, balance });
-            return null;
-        }
-    })
-        .filter(Array.isArray));
-    /**
-     * Allows the collection to be iterated over.
-     *
-     * @example
-     * [...balances].forEach(balance => { // do something // })
-     *
-     * @example
-     * for (const balance of balances) {
-     *   // do something
-     * }
-     */
-    [Symbol.iterator] = () => 
-    // Create an array of the balances in this collection and return the result of its iterator.
-    Object.values(this.#balances)[Symbol.iterator]();
-    /**
-     * Hydrates all balances in this collection.
-     *
-     * @param sources - The sources to hydrate from.
-     */
-    hydrate = (sources) => {
-        Object.values(this.#balances).map((balance) => balance.hydrate(sources));
-    };
-    /**
-     * Retrieve a balance from this collection by id.
-     *
-     * @param id - The id of the balance to fetch.
-     * @returns The balance if one exists, or none.
-     */
-    get = (id) => this.#balances[id] || null;
-    /**
-     * Retrieve balances from this collection by search query.
-     *
-     * @param query - The search query.
-     * @returns All balances which match the query.
-     */
-    find = (query) => {
-        // construct filter
-        const orQueries = (Array.isArray(query) ? query : [query]).map((query) => typeof query === "function" ? query : Object.entries(query));
-        // filter balances
-        const filter = (balance) => orQueries.some((query) => typeof query === "function"
-            ? query(balance)
-            : query.every(([key, value]) => balance[key] === value));
-        // return filter matches
-        return new Balances([...this].filter(filter));
-    };
-    /**
-     * Add some balances to this collection.
-     * Added balances take priority over existing balances.
-     * The aggregation of the two collections is returned.
-     * The original collection is not mutated.
-     *
-     * @param balances - Either a balance or collection of balances to add.
-     * @returns The new collection of balances.
-     */
-    add = (balances) => {
-        // handle single balance
-        if (balances instanceof Balance)
-            return this.add(new Balances(balances));
-        // merge balances
-        const mergedBalances = { ...this.#balances };
-        [...balances].forEach((balance) => (mergedBalances[balance.id] = balance));
-        // return new balances
-        return new Balances(Object.values(mergedBalances));
-    };
-    /**
-     * Remove balances from this collection by id.
-     * A new collection without these balances is returned.
-     * The original collection is not mutated.
-     *
-     * @param ids - The id(s) of the balances to remove.
-     * @returns The new collection of balances.
-     */
-    remove = (ids) => {
-        // handle single id
-        if (!Array.isArray(ids))
-            return this.remove([ids]);
-        // merge balances
-        const removedBalances = { ...this.#balances };
-        ids.forEach((id) => delete removedBalances[id]);
-        // return new balances
-        return new Balances(Object.values(removedBalances));
-    };
-    // TODO: Add some more useful aggregator methods
-    /**
-     * Get an array of balances in this collection, sorted by chain sortIndex.
-     *
-     * @returns A sorted array of the balances in this collection.
-     */
-    get sorted() {
-        return [...this].sort((a, b) => ((a.chain || a.evmNetwork)?.sortIndex || Number.MAX_SAFE_INTEGER) -
-            ((b.chain || b.evmNetwork)?.sortIndex || Number.MAX_SAFE_INTEGER));
-    }
-    /**
-     * Get the number of balances in this collection.
-     *
-     * @returns The number of balances in this collection.
-     */
-    get count() {
-        return [...this].length;
-    }
-    /**
-     * Get the summed value of balances in this collection.
-     * TODO: Sum up token amounts AND fiat amounts
-     *
-     * @example
-     * // Get the sum of all transferable balances in usd.
-     * balances.sum.fiat('usd').transferable
-     */
-    get sum() {
-        return new SumBalancesFormatter(this);
-    }
-}
-__decorate([
-    (0, typescript_memoize_1.Memoize)()
-], Balances.prototype, "sorted", null);
-__decorate([
-    (0, typescript_memoize_1.Memoize)()
-], Balances.prototype, "count", null);
-__decorate([
-    (0, typescript_memoize_1.Memoize)()
-], Balances.prototype, "sum", null);
-exports.Balances = Balances;
-/**
- * An individual balance.
- */
-class Balance {
-    //
-    // Properties
-    //
-    /** The underlying data for this balance */
-    #storage;
-    #db = null;
-    //
-    // Methods
-    //
-    constructor(storage, hydrate) {
-        this.#format = (0, memoize_1.default)(this.#format);
-        this.#storage = storage;
-        if (hydrate !== undefined)
-            this.hydrate(hydrate);
-    }
-    toJSON = () => this.#storage;
-    isSource = (source) => this.#storage.source === source;
-    // // TODO: Fix this method, the types don't work with our plugin architecture.
-    // // Specifically, the `BalanceJson` type is compiled down to `IBalance` in the following way:
-    // //
-    // //     toJSON: () => BalanceJson // works
-    // //     isSource: (source: BalanceSource) => boolean // works
-    // //     asSource: <P extends string>(source: P) => NarrowBalanceType<IBalance, P> | null // Doesn't work! IBalance should just be BalanceJson!
-    // //
-    // // `IBalance` won't match the type of `BalanceSource` after `PluginBalanceTypes` has been extended by balance plugins.
-    // // As a result, typescript will think that the returned #storage is not a BalanceJson.
-    // asSource = <P extends BalanceSource>(source: P): NarrowBalanceType<BalanceJson, P> | null => {
-    //   if (this.#storage.source === source) return this.#storage as NarrowBalanceType<BalanceJson, P>
-    //   return null
-    // }
-    hydrate = (hydrate) => {
-        if (hydrate !== undefined)
-            this.#db = hydrate;
-    };
-    #format = (balance) => new BalanceFormatter(typeof balance === "bigint" ? balance.toString() : balance, this.decimals || undefined, this.#db?.tokenRates && this.#db.tokenRates[this.tokenId]);
-    //
-    // Accessors
-    //
-    get id() {
-        const { source, address, chainId, evmNetworkId, tokenId } = this.#storage;
-        const locationId = chainId !== undefined ? chainId : evmNetworkId;
-        return `${source}-${address}-${locationId}-${tokenId}`;
-    }
-    get source() {
-        return this.#storage.source;
-    }
-    get status() {
-        return this.#storage.status;
-    }
-    get address() {
-        return this.#storage.address;
-    }
-    get chainId() {
-        return this.#storage.chainId;
-    }
-    get chain() {
-        return (this.#db?.chains && this.chainId && this.#db?.chains[this.chainId]) || null;
-    }
-    get evmNetworkId() {
-        return this.#storage.evmNetworkId;
-    }
-    get evmNetwork() {
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        return (this.#db?.evmNetworks && this.#db?.evmNetworks[this.evmNetworkId]) || null;
-    }
-    get tokenId() {
-        return this.#storage.tokenId;
-    }
-    get token() {
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        return (this.#db?.tokens && this.#db?.tokens[this.tokenId]) || null;
-    }
-    get decimals() {
-        return this.token?.decimals || null;
-    }
-    get rates() {
-        return (this.#db?.tokenRates && this.#db.tokenRates[this.tokenId]) || null;
-    }
-    /**
-     * The total balance of this token.
-     * Includes the free and the reserved amount.
-     * The balance will be reaped if this goes below the existential deposit.
-     */
-    get total() {
-        const extra = (0, balancetypes_1.includeInTotalExtraAmount)(this.#storage.extra);
-        return this.#format(this.free.planck + this.reserved.planck + extra);
-    }
-    /** The non-reserved balance of this token. Includes the frozen amount. Is included in the total. */
-    get free() {
-        return this.#format(typeof this.#storage.free === "string"
-            ? BigInt(this.#storage.free)
-            : Array.isArray(this.#storage.free)
-                ? this.#storage.free
-                    .map((reserve) => BigInt(reserve.amount))
-                    .reduce((a, b) => a + b, BigInt("0"))
-                : BigInt(this.#storage.free?.amount || "0"));
-    }
-    /** The reserved balance of this token. Is included in the total. */
-    get reserved() {
-        return this.#format(typeof this.#storage.reserves === "string"
-            ? BigInt(this.#storage.reserves)
-            : Array.isArray(this.#storage.reserves)
-                ? this.#storage.reserves
-                    .map((reserve) => BigInt(reserve.amount))
-                    .reduce((a, b) => a + b, BigInt("0"))
-                : BigInt(this.#storage.reserves?.amount || "0"));
-    }
-    /** The frozen balance of this token. Is included in the free amount. */
-    get locked() {
-        return this.#format(typeof this.#storage.locks === "string"
-            ? BigInt(this.#storage.locks)
-            : Array.isArray(this.#storage.locks)
-                ? this.#storage.locks
-                    .map((lock) => BigInt(lock.amount))
-                    .reduce((a, b) => util_1.BigMath.max(a, b), BigInt("0"))
-                : BigInt(this.#storage.locks?.amount || "0"));
-    }
-    /** @depreacted - use balance.locked */
-    get frozen() {
-        return this.locked;
-    }
-    /** The transferable balance of this token. Is generally the free amount - the miscFrozen amount. */
-    get transferable() {
-        // if no locks exist, transferable is equal to the free amount
-        if (!this.#storage.locks)
-            return this.free;
-        // find the largest lock (but ignore any locks which are marked as `includeInTransferable`)
-        const excludeAmount = (0, balancetypes_1.excludeFromTransferableAmount)(this.#storage.locks);
-        // subtract the lock from the free amount (but don't go below 0)
-        return this.#format(util_1.BigMath.max(this.free.planck - excludeAmount, BigInt("0")));
-    }
-    /** The feePayable balance of this token. Is generally the free amount - the feeFrozen amount. */
-    get feePayable() {
-        // if no locks exist, feePayable is equal to the free amount
-        if (!this.#storage.locks)
-            return this.free;
-        // find the largest lock which can't be used to pay tx fees
-        const excludeAmount = (0, balancetypes_1.excludeFromFeePayableLocks)(this.#storage.locks)
-            .map((lock) => BigInt(lock.amount))
-            .reduce((max, lock) => util_1.BigMath.max(max, lock), BigInt("0"));
-        // subtract the lock from the free amount (but don't go below 0)
-        return this.#format(util_1.BigMath.max(this.free.planck - excludeAmount, BigInt("0")));
-    }
-}
-__decorate([
-    (0, typescript_memoize_1.Memoize)()
-], Balance.prototype, "total", null);
-__decorate([
-    (0, typescript_memoize_1.Memoize)()
-], Balance.prototype, "free", null);
-__decorate([
-    (0, typescript_memoize_1.Memoize)()
-], Balance.prototype, "reserved", null);
-__decorate([
-    (0, typescript_memoize_1.Memoize)()
-], Balance.prototype, "locked", null);
-__decorate([
-    (0, typescript_memoize_1.Memoize)()
-], Balance.prototype, "frozen", null);
-__decorate([
-    (0, typescript_memoize_1.Memoize)()
-], Balance.prototype, "transferable", null);
-__decorate([
-    (0, typescript_memoize_1.Memoize)()
-], Balance.prototype, "feePayable", null);
-exports.Balance = Balance;
-class BalanceFormatter {
-    #planck;
-    #decimals;
-    #fiatRatios;
-    constructor(planck, decimals, fiatRatios) {
-        this.#planck = typeof planck === "bigint" ? planck.toString() : planck ?? "0";
-        this.#decimals = decimals || 0;
-        this.#fiatRatios = fiatRatios || null;
-        this.fiat = (0, memoize_1.default)(this.fiat);
-    }
-    toJSON = () => this.#planck;
-    get planck() {
-        return BigInt(this.#planck);
-    }
-    get tokens() {
-        return (0, util_1.planckToTokens)(this.#planck, this.#decimals);
-    }
-    fiat(currency) {
-        if (!this.#fiatRatios)
-            return null;
-        const ratio = this.#fiatRatios[currency];
-        if (!ratio)
-            return null;
-        return parseFloat(this.tokens) * ratio;
-    }
-}
-__decorate([
-    (0, typescript_memoize_1.Memoize)()
-], BalanceFormatter.prototype, "tokens", null);
-exports.BalanceFormatter = BalanceFormatter;
-class FiatSumBalancesFormatter {
-    #balances;
-    #currency;
-    constructor(balances, currency) {
-        this.#balances = balances;
-        this.#currency = currency;
-        this.#sum = (0, memoize_1.default)(this.#sum);
-    }
-    #sum = (balanceField) => {
-        // a function to get a fiat amount from a balance
-        const fiat = (balance) => balance[balanceField].fiat(this.#currency) || 0;
-        // a function to add two amounts
-        const sum = (a, b) => a + b;
-        return [...this.#balances].filter(helpers_1.filterMirrorTokens).reduce((total, balance) => sum(
-        // add the total amount...
-        total, 
-        // ...to the fiat amount of each balance
-        fiat(balance)), 
-        // start with a total of 0
-        0);
-    };
-    /**
-     * The total balance of these tokens. Includes the free and the reserved amount.
-     */
-    get total() {
-        return this.#sum("total");
-    }
-    /** The non-reserved balance of these tokens. Includes the frozen amount. Is included in the total. */
-    get free() {
-        return this.#sum("free");
-    }
-    /** The reserved balance of these tokens. Is included in the total. */
-    get reserved() {
-        return this.#sum("reserved");
-    }
-    /** The frozen balance of these tokens. Is included in the free amount. */
-    get locked() {
-        return this.#sum("locked");
-    }
-    /** @deprecated - use balances.locked */
-    get frozen() {
-        return this.locked;
-    }
-    /** The transferable balance of these tokens. Is generally the free amount - the miscFrozen amount. */
-    get transferable() {
-        return this.#sum("transferable");
-    }
-    /** The feePayable balance of these tokens. Is generally the free amount - the feeFrozen amount. */
-    get feePayable() {
-        return this.#sum("feePayable");
-    }
-}
-__decorate([
-    (0, typescript_memoize_1.Memoize)()
-], FiatSumBalancesFormatter.prototype, "total", null);
-__decorate([
-    (0, typescript_memoize_1.Memoize)()
-], FiatSumBalancesFormatter.prototype, "free", null);
-__decorate([
-    (0, typescript_memoize_1.Memoize)()
-], FiatSumBalancesFormatter.prototype, "reserved", null);
-__decorate([
-    (0, typescript_memoize_1.Memoize)()
-], FiatSumBalancesFormatter.prototype, "locked", null);
-__decorate([
-    (0, typescript_memoize_1.Memoize)()
-], FiatSumBalancesFormatter.prototype, "frozen", null);
-__decorate([
-    (0, typescript_memoize_1.Memoize)()
-], FiatSumBalancesFormatter.prototype, "transferable", null);
-__decorate([
-    (0, typescript_memoize_1.Memoize)()
-], FiatSumBalancesFormatter.prototype, "feePayable", null);
-exports.FiatSumBalancesFormatter = FiatSumBalancesFormatter;
-class SumBalancesFormatter {
-    #balances;
-    constructor(balances) {
-        this.#balances = balances;
-        this.fiat = (0, memoize_1.default)(this.fiat);
-    }
-    fiat(currency) {
-        return new FiatSumBalancesFormatter(this.#balances, currency);
-    }
-}
-exports.SumBalancesFormatter = SumBalancesFormatter;

package/dist/types/balancetypes.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.includeInTotalExtraAmount = exports.excludeFromFeePayableLocks = exports.excludeFromTransferableAmount = void 0;
-const util_1 = require("@talismn/util");
-function excludeFromTransferableAmount(locks) {
-    if (typeof locks === "string")
-        return BigInt(locks);
-    if (!Array.isArray(locks))
-        locks = [locks];
-    return locks
-        .filter((lock) => lock.includeInTransferable !== true)
-        .map((lock) => BigInt(lock.amount))
-        .reduce((max, lock) => util_1.BigMath.max(max, lock), BigInt("0"));
-}
-exports.excludeFromTransferableAmount = excludeFromTransferableAmount;
-function excludeFromFeePayableLocks(locks) {
-    if (typeof locks === "string")
-        return [];
-    if (!Array.isArray(locks))
-        locks = [locks];
-    return locks.filter((lock) => lock.excludeFromFeePayable);
-}
-exports.excludeFromFeePayableLocks = excludeFromFeePayableLocks;
-function includeInTotalExtraAmount(extra) {
-    if (!extra)
-        return BigInt("0");
-    if (!Array.isArray(extra))
-        extra = [extra];
-    return extra
-        .filter((extra) => extra.includeInTotal)
-        .map((extra) => BigInt(extra.amount))
-        .reduce((a, b) => a + b, BigInt("0"));
-}
-exports.includeInTotalExtraAmount = includeInTotalExtraAmount;

package/dist/types/index.js

@@ -1,20 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./addresses"), exports);
-__exportStar(require("./balances"), exports);
-__exportStar(require("./balancetypes"), exports);
-__exportStar(require("./subscriptions"), exports);

package/dist/types/subscriptions.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });