@pezkuwi/api-derive 16.5.5 → 16.5.8

package/balances/account.js

@@ -0,0 +1,149 @@
+import { combineLatest, map, of, switchMap } from 'rxjs';
+import { isFunction, objectSpread } from '@pezkuwi/util';
+import { memo } from '../util/index.js';
+function zeroBalance(api) {
+    return api.registry.createType('Balance');
+}
+function getBalance(api, [freeBalance, reservedBalance, frozenFeeOrFrozen, frozenMiscOrFlags], accType) {
+    const votingBalance = api.registry.createType('Balance', freeBalance.toBn());
+    if (accType.isFrameAccountData) {
+        return {
+            frameSystemAccountInfo: {
+                flags: frozenMiscOrFlags,
+                frozen: frozenFeeOrFrozen
+            },
+            freeBalance,
+            frozenFee: api.registry.createType('Balance', 0),
+            frozenMisc: api.registry.createType('Balance', 0),
+            reservedBalance,
+            votingBalance
+        };
+    }
+    return {
+        freeBalance,
+        frozenFee: frozenFeeOrFrozen,
+        frozenMisc: frozenMiscOrFlags,
+        reservedBalance,
+        votingBalance
+    };
+}
+function calcBalances(api, [accountId, [accountNonce, [primary, ...additional], accType]]) {
+    return objectSpread({
+        accountId,
+        accountNonce,
+        additional: additional.map((b) => getBalance(api, b, accType))
+    }, getBalance(api, primary, accType));
+}
+function queryBalancesFree(api, accountId) {
+    return combineLatest([
+        api.query.balances['freeBalance'](accountId),
+        api.query.balances['reservedBalance'](accountId),
+        api.query.system['accountNonce'](accountId)
+    ]).pipe(map(([freeBalance, reservedBalance, accountNonce]) => [
+        accountNonce,
+        [[freeBalance, reservedBalance, zeroBalance(api), zeroBalance(api)]],
+        { isFrameAccountData: false }
+    ]));
+}
+function queryNonceOnly(api, accountId) {
+    const fill = (nonce) => [
+        nonce,
+        [[zeroBalance(api), zeroBalance(api), zeroBalance(api), zeroBalance(api)]],
+        { isFrameAccountData: false }
+    ];
+    return isFunction(api.query.system.account)
+        ? api.query.system.account(accountId).pipe(map(({ nonce }) => fill(nonce)))
+        : isFunction(api.query.system['accountNonce'])
+            ? api.query.system['accountNonce'](accountId).pipe(map((nonce) => fill(nonce)))
+            : of(fill(api.registry.createType('Index')));
+}
+function queryBalancesAccount(api, accountId, modules = ['balances']) {
+    const balances = modules
+        .map((m) => api.derive[m]?.customAccount || api.query[m]?.account)
+        .filter((q) => isFunction(q));
+    const extract = (nonce, data) => [
+        nonce,
+        data.map(({ feeFrozen, free, miscFrozen, reserved }) => [free, reserved, feeFrozen, miscFrozen]),
+        { isFrameAccountData: false }
+    ];
+    // NOTE this is for the first case where we do have instances specified
+    return balances.length
+        ? isFunction(api.query.system.account)
+            ? combineLatest([
+                api.query.system.account(accountId),
+                ...balances.map((c) => c(accountId))
+            ]).pipe(map(([{ nonce }, ...balances]) => extract(nonce, balances)))
+            : combineLatest([
+                api.query.system['accountNonce'](accountId),
+                ...balances.map((c) => c(accountId))
+            ]).pipe(map(([nonce, ...balances]) => extract(nonce, balances)))
+        : queryNonceOnly(api, accountId);
+}
+function querySystemAccount(api, accountId) {
+    // AccountInfo is current, support old, eg. Edgeware
+    return api.query.system.account(accountId).pipe(map((infoOrTuple) => {
+        const data = infoOrTuple.nonce
+            ? infoOrTuple.data
+            : infoOrTuple[1];
+        const nonce = infoOrTuple.nonce || infoOrTuple[0];
+        if (!data || data.isEmpty) {
+            return [
+                nonce,
+                [[zeroBalance(api), zeroBalance(api), zeroBalance(api), zeroBalance(api)]],
+                { isFrameAccountData: false }
+            ];
+        }
+        const isFrameType = !!infoOrTuple.data.frozen;
+        if (isFrameType) {
+            const { flags, free, frozen, reserved } = data;
+            return [
+                nonce,
+                [[free, reserved, frozen, flags]],
+                { isFrameAccountData: true }
+            ];
+        }
+        else {
+            const { feeFrozen, free, miscFrozen, reserved } = data;
+            return [
+                nonce,
+                [[free, reserved, feeFrozen, miscFrozen]],
+                { isFrameAccountData: false }
+            ];
+        }
+    }));
+}
+/**
+ * @name account
+ * @description Retrieves the essential balance details for an account, such as free balance and account nonce.
+ * @param {( AccountIndex | AccountId | Address | string )} address An accountsId in different formats.
+ * @example
+ * ```javascript
+ * const ALICE = 'F7Hs';
+ *
+ * api.derive.balances.all(ALICE, ({ accountId, lockedBalance }) => {
+ *   console.log(`The account ${accountId} has a locked balance ${lockedBalance} units.`);
+ * });
+ * ```
+ */
+export function account(instanceId, api) {
+    const balanceInstances = api.registry.getModuleInstances(api.runtimeVersion.specName, 'balances');
+    const nonDefaultBalances = balanceInstances && balanceInstances[0] !== 'balances';
+    return memo(instanceId, (address) => api.derive.accounts.accountId(address).pipe(switchMap((accountId) => (accountId
+        ? combineLatest([
+            of(accountId),
+            nonDefaultBalances
+                ? queryBalancesAccount(api, accountId, balanceInstances)
+                : isFunction(api.query.system?.account)
+                    ? querySystemAccount(api, accountId)
+                    : isFunction(api.query.balances?.account)
+                        ? queryBalancesAccount(api, accountId)
+                        : isFunction(api.query.balances?.['freeBalance'])
+                            ? queryBalancesFree(api, accountId)
+                            : queryNonceOnly(api, accountId)
+        ])
+        : of([api.registry.createType('AccountId'), [
+                api.registry.createType('Index'),
+                [[zeroBalance(api), zeroBalance(api), zeroBalance(api), zeroBalance(api)]],
+                { isFrameAccountData: false }
+            ]]))), map((result) => calcBalances(api, result))));
+}

package/balances/all.d.ts

@@ -0,0 +1,20 @@
+import type { Observable } from 'rxjs';
+import type { AccountId } from '@pezkuwi/types/interfaces';
+import type { DeriveApi, DeriveBalancesAll } from '../types.js';
+/**
+ * @name all
+ * @description Retrieves the complete balance information for an account, including free balance, locked balance, reserved balance, and more.
+ * @param {( AccountId | string )} address An accountsId in different formats.
+ * @example
+ * ```javascript
+ * const ALICE = 'F7Hs';
+ *
+ * api.derive.balances.account(ALICE, (accountInfo) => {
+ *   console.log(
+ *     `${accountInfo.accountId} info:`,
+ *     Object.keys(accountInfo).map((key) => `${key}: ${accountInfo[key]}`)
+ *   );
+ * });
+ * ```
+ */
+export declare function all(instanceId: string, api: DeriveApi): (address: AccountId | string) => Observable<DeriveBalancesAll>;

package/balances/all.js

@@ -0,0 +1,167 @@
+import { combineLatest, map, of, switchMap } from 'rxjs';
+import { BN, BN_ZERO, bnMax, bnMin, isFunction, objectSpread } from '@pezkuwi/util';
+import { memo } from '../util/index.js';
+const VESTING_ID = '0x76657374696e6720';
+function calcLocked(api, bestNumber, locks) {
+    let lockedBalance = api.registry.createType('Balance');
+    let lockedBreakdown = [];
+    let vestingLocked = api.registry.createType('Balance');
+    let allLocked = false;
+    if (Array.isArray(locks)) {
+        // only get the locks that are valid until passed the current block
+        lockedBreakdown = locks.filter(({ until }) => !until || (bestNumber && until.gt(bestNumber)));
+        allLocked = lockedBreakdown.some(({ amount }) => amount && amount.isMax());
+        vestingLocked = api.registry.createType('Balance', lockedBreakdown.filter(({ id }) => id.eq(VESTING_ID)).reduce((result, { amount }) => result.iadd(amount), new BN(0)));
+        // get the maximum of the locks according to https://github.com/pezkuwichain/bizinikiwi/blob/master/srml/balances/src/lib.rs#L699
+        const notAll = lockedBreakdown.filter(({ amount }) => amount && !amount.isMax());
+        if (notAll.length) {
+            lockedBalance = api.registry.createType('Balance', bnMax(...notAll.map(({ amount }) => amount)));
+        }
+    }
+    return { allLocked, lockedBalance, lockedBreakdown, vestingLocked };
+}
+function calcShared(api, bestNumber, data, locks) {
+    const { allLocked, lockedBalance, lockedBreakdown, vestingLocked } = calcLocked(api, bestNumber, locks);
+    let transferable = null;
+    if (data?.frameSystemAccountInfo?.frozen) {
+        const { frameSystemAccountInfo, freeBalance, reservedBalance } = data;
+        const noFrozenReserved = frameSystemAccountInfo.frozen.isZero() && reservedBalance.isZero();
+        const ED = api.consts.balances.existentialDeposit;
+        const maybeED = noFrozenReserved ? new BN(0) : ED;
+        const frozenReserveDif = frameSystemAccountInfo.frozen.sub(reservedBalance);
+        transferable = api.registry.createType('Balance', allLocked
+            ? 0
+            : bnMax(new BN(0), freeBalance.sub(bnMax(maybeED, frozenReserveDif))));
+    }
+    return objectSpread({}, data, {
+        availableBalance: api.registry.createType('Balance', allLocked ? 0 : bnMax(new BN(0), data?.freeBalance ? data.freeBalance.sub(lockedBalance) : new BN(0))),
+        lockedBalance,
+        lockedBreakdown,
+        transferable,
+        vestingLocked
+    });
+}
+function calcVesting(bestNumber, shared, _vesting) {
+    // Calculate the vesting balances,
+    //  - offset = balance locked at startingBlock
+    //  - perBlock is the unlock amount
+    const vesting = _vesting || [];
+    const isVesting = !shared.vestingLocked.isZero();
+    const vestedBalances = vesting.map(({ locked, perBlock, startingBlock }) => bestNumber.gt(startingBlock)
+        ? bnMin(locked, perBlock.mul(bestNumber.sub(startingBlock)))
+        : BN_ZERO);
+    const vestedBalance = vestedBalances.reduce((all, value) => all.iadd(value), new BN(0));
+    const vestingTotal = vesting.reduce((all, { locked }) => all.iadd(locked), new BN(0));
+    return {
+        isVesting,
+        vestedBalance,
+        vestedClaimable: isVesting
+            ? shared.vestingLocked.sub(vestingTotal.sub(vestedBalance))
+            : BN_ZERO,
+        vesting: vesting
+            .map(({ locked, perBlock, startingBlock }, index) => ({
+            endBlock: locked.div(perBlock).iadd(startingBlock),
+            locked,
+            perBlock,
+            startingBlock,
+            vested: vestedBalances[index]
+        }))
+            .filter(({ locked }) => !locked.isZero()),
+        vestingTotal
+    };
+}
+function calcBalances(api, result) {
+    const [data, [vesting, allLocks, namedReserves], bestNumber] = result;
+    const shared = calcShared(api, bestNumber, data, allLocks[0]);
+    return objectSpread(shared, calcVesting(bestNumber, shared, vesting), {
+        accountId: data.accountId,
+        accountNonce: data.accountNonce,
+        additional: allLocks
+            .slice(1)
+            .map((l, index) => calcShared(api, bestNumber, data.additional[index], l)),
+        namedReserves
+    });
+}
+function queryOld(api, accountId) {
+    return combineLatest([
+        api.query.balances.locks(accountId),
+        api.query.balances['vesting'](accountId)
+    ]).pipe(map(([locks, optVesting]) => {
+        let vestingNew = null;
+        if (optVesting.isSome) {
+            const { offset: locked, perBlock, startingBlock } = optVesting.unwrap();
+            vestingNew = api.registry.createType('VestingInfo', { locked, perBlock, startingBlock });
+        }
+        return [
+            vestingNew
+                ? [vestingNew]
+                : null,
+            [locks],
+            []
+        ];
+    }));
+}
+const isNonNullable = (nullable) => !!nullable;
+function createCalls(calls) {
+    return [
+        calls.map((c) => !c),
+        calls.filter(isNonNullable)
+    ];
+}
+function queryCurrent(api, accountId, balanceInstances = ['balances']) {
+    const [lockEmpty, lockQueries] = createCalls(balanceInstances.map((m) => api.derive[m]?.customLocks || api.query[m]?.locks));
+    const [reserveEmpty, reserveQueries] = createCalls(balanceInstances.map((m) => api.query[m]?.reserves));
+    return combineLatest([
+        api.query.vesting?.vesting
+            ? api.query.vesting.vesting(accountId)
+            : of(api.registry.createType('Option<VestingInfo>')),
+        lockQueries.length
+            ? combineLatest(lockQueries.map((c) => c(accountId)))
+            : of([]),
+        reserveQueries.length
+            ? combineLatest(reserveQueries.map((c) => c(accountId)))
+            : of([])
+    ]).pipe(map(([opt, locks, reserves]) => {
+        let offsetLock = -1;
+        let offsetReserve = -1;
+        const vesting = opt.unwrapOr(null);
+        return [
+            vesting
+                ? Array.isArray(vesting)
+                    ? vesting
+                    : [vesting]
+                : null,
+            lockEmpty.map((e) => e ? api.registry.createType('Vec<BalanceLock>') : locks[++offsetLock]),
+            reserveEmpty.map((e) => e ? api.registry.createType('Vec<PezpalletBalancesReserveData>') : reserves[++offsetReserve])
+        ];
+    }));
+}
+/**
+ * @name all
+ * @description Retrieves the complete balance information for an account, including free balance, locked balance, reserved balance, and more.
+ * @param {( AccountId | string )} address An accountsId in different formats.
+ * @example
+ * ```javascript
+ * const ALICE = 'F7Hs';
+ *
+ * api.derive.balances.account(ALICE, (accountInfo) => {
+ *   console.log(
+ *     `${accountInfo.accountId} info:`,
+ *     Object.keys(accountInfo).map((key) => `${key}: ${accountInfo[key]}`)
+ *   );
+ * });
+ * ```
+ */
+export function all(instanceId, api) {
+    const balanceInstances = api.registry.getModuleInstances(api.runtimeVersion.specName, 'balances');
+    return memo(instanceId, (address) => combineLatest([
+        api.derive.balances.account(address),
+        isFunction(api.query.system?.account) || isFunction(api.query.balances?.account)
+            ? queryCurrent(api, address, balanceInstances)
+            : queryOld(api, address)
+    ]).pipe(switchMap(([account, locks]) => combineLatest([
+        of(account),
+        of(locks),
+        api.derive.chain.bestNumber()
+    ])), map((result) => calcBalances(api, result))));
+}

package/balances/index.d.ts

@@ -0,0 +1,20 @@
+import { all } from './all.js';
+export * from './account.js';
+export * from './votingBalances.js';
+/**
+ * @name votingBalance
+ * @param {( AccountId | string )} address An accounts Id in different formats.
+ * @returns An object containing the results of various balance queries
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * const ALICE = 'F7Hs';
+ *
+ * api.derive.balances.votingBalance(ALICE, ({ accountId, lockedBalance }) => {
+ *   console.log(`The account ${accountId} has a locked balance ${lockedBalance} units.`);
+ * });
+ * ```
+ */
+declare const votingBalance: typeof all;
+export { all, votingBalance };

package/balances/index.js

@@ -0,0 +1,20 @@
+import { all } from './all.js';
+export * from './account.js';
+export * from './votingBalances.js';
+/**
+ * @name votingBalance
+ * @param {( AccountId | string )} address An accounts Id in different formats.
+ * @returns An object containing the results of various balance queries
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * const ALICE = 'F7Hs';
+ *
+ * api.derive.balances.votingBalance(ALICE, ({ accountId, lockedBalance }) => {
+ *   console.log(`The account ${accountId} has a locked balance ${lockedBalance} units.`);
+ * });
+ * ```
+ */
+const votingBalance = all;
+export { all, votingBalance };

package/balances/types.d.ts

@@ -0,0 +1,69 @@
+import type { AccountId, Balance, BalanceLockTo212, Index } from '@pezkuwi/types/interfaces';
+import type { PezpalletBalancesBalanceLock, PezpalletBalancesReserveData } from '@pezkuwi/types/lookup';
+import type { BN } from '@pezkuwi/util';
+export interface DeriveBalancesAccountData {
+    frameSystemAccountInfo?: {
+        frozen: Balance;
+        flags: Balance;
+    };
+    freeBalance: Balance;
+    frozenFee: Balance;
+    frozenMisc: Balance;
+    reservedBalance: Balance;
+    votingBalance: Balance;
+}
+export interface DeriveBalancesAccount extends DeriveBalancesAccountData {
+    accountId: AccountId;
+    accountNonce: Index;
+    additional: DeriveBalancesAccountData[];
+}
+export interface DeriveBalancesAllAccountData extends DeriveBalancesAccountData {
+    /**
+     * Calculated available balance. This uses the formula: max(0, free - locked)
+     * This is only correct when the return type of `api.query.system.account` is `AccountInfo` which was replaced by `PezframeSystemAccountInfo`.
+     * See `transferable` for the correct balance calculation.
+     *
+     * ref: https://github.com/pezkuwichain/bizinikiwi/pull/12951
+     */
+    availableBalance: Balance;
+    /**
+     * The amount of balance locked away.
+     */
+    lockedBalance: Balance;
+    /**
+     * The breakdown of locked balances.
+     */
+    lockedBreakdown: (PezpalletBalancesBalanceLock | BalanceLockTo212)[];
+    /**
+     * Calculated transferable balance. This uses the formula: free - max(maybeEd, frozen - reserve)
+     * Where `maybeEd` means if there is no frozen and reserves it will be zero, else it will be the existential deposit.
+     * This is only correct when the return type of `api.query.system.account` is `PezframeSystemAccountInfo`.
+     * Which is the most up to date calulcation for transferrable balances.
+     *
+     * ref: https://github.com/pezkuwichain/pezkuwi-sdk/issues/1833
+     */
+    transferable: Balance | null;
+    /**
+     * Amount locked in vesting.
+     */
+    vestingLocked: Balance;
+}
+export interface DeriveBalancesVesting {
+    startingBlock: BN;
+    endBlock: BN;
+    perBlock: BN;
+    locked: BN;
+    vested: BN;
+}
+export interface DeriveBalancesAllVesting {
+    isVesting: boolean;
+    vestedBalance: BN;
+    vestedClaimable: BN;
+    vesting: DeriveBalancesVesting[];
+    vestingTotal: BN;
+}
+export interface DeriveBalancesAll extends DeriveBalancesAccount, DeriveBalancesAllAccountData, DeriveBalancesAllVesting {
+    additional: DeriveBalancesAllAccountData[];
+    namedReserves: PezpalletBalancesReserveData[][];
+}
+export type DeriveBalancesMap = Record<string, DeriveBalancesAll>;

package/balances/types.js

@@ -0,0 +1 @@
+export {};

package/balances/votingBalances.d.ts

@@ -0,0 +1,15 @@
+import type { Observable } from 'rxjs';
+import type { AccountId, AccountIndex, Address } from '@pezkuwi/types/interfaces';
+import type { DeriveApi, DeriveBalancesAccount } from '../types.js';
+/**
+ * @name votingBalances
+ * @description Retrieves the balance information for multiple accounts, typically used in governance-related contexts to check voting power.
+ * @param {(AccountId | AccountIndex | Address | string)[]} addresses An array of account identifiers.
+ * @example
+ * ```javascript
+ * const addresses = ["5D4b...Zf1", "5HGj...yrV"];
+ * const balances = await api.derive.balances.votingBalances(addresses);
+ * console.log("Voting Balances:", balances);
+ * ```
+ */
+export declare function votingBalances(instanceId: string, api: DeriveApi): (addresses?: (AccountId | AccountIndex | Address | string)[]) => Observable<DeriveBalancesAccount[]>;

package/balances/votingBalances.js

@@ -0,0 +1,18 @@
+import { combineLatest, of } from 'rxjs';
+import { memo } from '../util/index.js';
+/**
+ * @name votingBalances
+ * @description Retrieves the balance information for multiple accounts, typically used in governance-related contexts to check voting power.
+ * @param {(AccountId | AccountIndex | Address | string)[]} addresses An array of account identifiers.
+ * @example
+ * ```javascript
+ * const addresses = ["5D4b...Zf1", "5HGj...yrV"];
+ * const balances = await api.derive.balances.votingBalances(addresses);
+ * console.log("Voting Balances:", balances);
+ * ```
+ */
+export function votingBalances(instanceId, api) {
+    return memo(instanceId, (addresses) => !addresses?.length
+        ? of([])
+        : combineLatest(addresses.map((accountId) => api.derive.balances.account(accountId))));
+}

package/bounties/bounties.d.ts

@@ -0,0 +1,12 @@
+import type { Observable } from 'rxjs';
+import type { DeriveApi, DeriveBounties } from '../types.js';
+/**
+ * @name bounties
+ * @descrive Retrieves all active bounties, their descriptions, and associated proposals.
+ * @example
+ * ```javascript
+ * const bounties = await api.derive.bounties();
+ * console.log("Active bounties:", bounties);
+ * ```
+ */
+export declare function bounties(instanceId: string, api: DeriveApi): () => Observable<DeriveBounties>;

package/bounties/bounties.js

@@ -0,0 +1,50 @@
+import { combineLatest, map, of, switchMap } from 'rxjs';
+import { memo } from '../util/index.js';
+import { filterBountiesProposals } from './helpers/filterBountyProposals.js';
+function parseResult([maybeBounties, maybeDescriptions, ids, bountyProposals]) {
+    const bounties = [];
+    maybeBounties.forEach((bounty, index) => {
+        if (bounty.isSome) {
+            bounties.push({
+                bounty: bounty.unwrap(),
+                description: maybeDescriptions[index].unwrapOrDefault().toUtf8(),
+                index: ids[index],
+                proposals: bountyProposals.filter((bountyProposal) => bountyProposal.proposal && ids[index].eq(bountyProposal.proposal.args[0]))
+            });
+        }
+    });
+    return bounties;
+}
+/**
+ * @name bounties
+ * @descrive Retrieves all active bounties, their descriptions, and associated proposals.
+ * @example
+ * ```javascript
+ * const bounties = await api.derive.bounties();
+ * console.log("Active bounties:", bounties);
+ * ```
+ */
+export function bounties(instanceId, api) {
+    const bountyBase = api.query.bounties || api.query.treasury;
+    return memo(instanceId, () => bountyBase.bounties
+        ? combineLatest([
+            bountyBase.bountyCount(),
+            api.query.council
+                ? api.query.council.proposalCount()
+                : of(0)
+        ]).pipe(switchMap(() => combineLatest([
+            bountyBase.bounties.keys(),
+            api.derive.council
+                ? api.derive.council.proposals()
+                : of([])
+        ])), switchMap(([keys, proposals]) => {
+            const ids = keys.map(({ args: [id] }) => id);
+            return combineLatest([
+                bountyBase.bounties.multi(ids),
+                bountyBase.bountyDescriptions.multi(ids),
+                of(ids),
+                of(filterBountiesProposals(api, proposals))
+            ]);
+        }), map(parseResult))
+        : of(parseResult([[], [], [], []])));
+}

package/bounties/helpers/filterBountyProposals.d.ts

@@ -0,0 +1,2 @@
+import type { DeriveApi, DeriveCollectiveProposal } from '../../types.js';
+export declare function filterBountiesProposals(api: DeriveApi, allProposals: DeriveCollectiveProposal[]): DeriveCollectiveProposal[];

package/bounties/helpers/filterBountyProposals.js

@@ -0,0 +1,5 @@
+export function filterBountiesProposals(api, allProposals) {
+    const bountyTxBase = api.tx.bounties ? api.tx.bounties : api.tx.treasury;
+    const bountyProposalCalls = [bountyTxBase.approveBounty, bountyTxBase.closeBounty, bountyTxBase.proposeCurator, bountyTxBase.unassignCurator];
+    return allProposals.filter((proposal) => bountyProposalCalls.find((bountyCall) => proposal.proposal && bountyCall.is(proposal.proposal)));
+}

package/bounties/index.d.ts

@@ -0,0 +1 @@
+export * from './bounties.js';

package/bounties/index.js

@@ -0,0 +1 @@
+export * from './bounties.js';