@subwallet/extension-base 1.1.35-0 → 1.1.35-beta.0

package/types/yield/info/account/reward.d.ts

@@ -0,0 +1,47 @@
+import { APIItemState } from '@subwallet/extension-base/background/KoniTypes';
+import { BasePoolInfo } from '../base';
+/**
+ * @interface EarningRewardItem
+ * @extends BasePoolInfo
+ * @prop {string} address - Account address
+ * @prop {APIItemState} state - State of item
+ * @prop {string} [latestReward] - Latest rewarded claimed
+ * @prop {string} [totalReward] - Total rewarded claimed
+ * @prop {string} [totalSlash] - Total token slashed
+ * @prop {string} [unclaimedReward] - Un-claim reward
+ * */
+export interface EarningRewardItem extends BasePoolInfo {
+    /** Account address */
+    address: string;
+    /** State of item */
+    state: APIItemState;
+    /** Latest rewarded claimed */
+    latestReward?: string;
+    /** Total rewarded claimed */
+    totalReward?: string;
+    /** Total token slashed */
+    totalSlash?: string;
+    /** Un-claim reward */
+    unclaimedReward?: string;
+}
+export interface EarningRewardJson {
+    ready: boolean;
+    data: Record<string, EarningRewardItem>;
+}
+/**
+ * @interface EarningRewardHistoryItem
+ * @extends BasePoolInfo
+ * @prop {string} address - Account address
+ * @prop {number} blockTimestamp - Reward history's block timestamp
+ * @prop {string} amount - Reward history's amount
+ * */
+export interface EarningRewardHistoryItem extends BasePoolInfo {
+    /** Account address */
+    address: string;
+    /** Reward history's block timestamp */
+    blockTimestamp: number;
+    /** Reward history's extrinsic index */
+    eventIndex: string;
+    /** Reward history's amount */
+    amount: string;
+}

package/types/yield/info/account/reward.js

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

package/types/yield/info/account/target.d.ts

@@ -0,0 +1,43 @@
+/**
+ * @enum {string}
+ * @description The earning status of an account in a pool.
+ * */
+export declare enum EarningStatus {
+    /** Earning reward */
+    EARNING_REWARD = "EARNING_REWARD",
+    /** Partially earning */
+    PARTIALLY_EARNING = "PARTIALLY_EARNING",
+    /** Not earning */
+    NOT_EARNING = "NOT_EARNING",
+    /** Waiting (Pool selected not in the reward list) */
+    WAITING = "WAITING",
+    /** Account not staking */
+    NOT_STAKING = "NOT_STAKING"
+}
+/**
+ * @interface NominationInfo
+ * @description Info of the validator account joined
+ * @prop {string} chain - Slug of chain
+ * @prop {string} validatorAddress - Validator's address or nomination pool's id
+ * @prop {string} [validatorIdentity] - Validator's identity
+ * @prop {string} activeStake - Active staked value
+ * @prop {boolean} [hasUnstaking] - Does the account have unstake request with validator?
+ * @prop {string} [validatorMinStake] - Min amount to join with validator
+ * @prop {EarningStatus} status - The staking status of the account
+ * */
+export interface NominationInfo {
+    /** Slug of chain */
+    chain: string;
+    /** Validator's address or nomination pool's id */
+    validatorAddress: string;
+    /** Validator's identity */
+    validatorIdentity?: string;
+    /** Active staked value */
+    activeStake: string;
+    /** Does the account have unstake request with validator? */
+    hasUnstaking?: boolean;
+    /** Min amount to join with validator */
+    validatorMinStake?: string;
+    /** The staking status of the account */
+    status: EarningStatus;
+}

package/types/yield/info/account/target.js

@@ -0,0 +1,27 @@
+// Copyright 2019-2022 @subwallet/extension-base
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * @enum {string}
+ * @description The earning status of an account in a pool.
+ * */
+export let EarningStatus;
+
+/**
+ * @interface NominationInfo
+ * @description Info of the validator account joined
+ * @prop {string} chain - Slug of chain
+ * @prop {string} validatorAddress - Validator's address or nomination pool's id
+ * @prop {string} [validatorIdentity] - Validator's identity
+ * @prop {string} activeStake - Active staked value
+ * @prop {boolean} [hasUnstaking] - Does the account have unstake request with validator?
+ * @prop {string} [validatorMinStake] - Min amount to join with validator
+ * @prop {EarningStatus} status - The staking status of the account
+ * */
+(function (EarningStatus) {
+  EarningStatus["EARNING_REWARD"] = "EARNING_REWARD";
+  EarningStatus["PARTIALLY_EARNING"] = "PARTIALLY_EARNING";
+  EarningStatus["NOT_EARNING"] = "NOT_EARNING";
+  EarningStatus["WAITING"] = "WAITING";
+  EarningStatus["NOT_STAKING"] = "NOT_STAKING";
+})(EarningStatus || (EarningStatus = {}));

package/types/yield/info/account/unstake.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @enum {string}
+ * @description The status of un-staked request.
+ * */
+export declare enum UnstakingStatus {
+    /** Can withdraw unstaked value */
+    CLAIMABLE = "CLAIMABLE",
+    /** Waiting to unlock unstake value */
+    UNLOCKING = "UNLOCKING"
+}
+/**
+ * @interface UnstakingInfo
+ * @description Info of un-stake request
+ * @prop {string} chain - Slug of chain
+ * @prop {UnstakingStatus} status - Status of request
+ * @prop {string} claimable - Amount to be withdrawn
+ * @prop {number} [waitingTime] - Time remains to wait (in hours)
+ * @prop {string} [validatorAddress] - Address of validator
+ * */
+export interface UnstakingInfo {
+    /** Slug of chain */
+    chain: string;
+    /** Status of request */
+    status: UnstakingStatus;
+    /** Amount to be withdrawn */
+    claimable: string;
+    /** Time remains to wait (in hours) */
+    waitingTime?: number;
+    /** Address of validator */
+    validatorAddress?: string;
+}

package/types/yield/info/account/unstake.js

@@ -0,0 +1,22 @@
+// Copyright 2019-2022 @subwallet/extension-base
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * @enum {string}
+ * @description The status of un-staked request.
+ * */
+export let UnstakingStatus;
+
+/**
+ * @interface UnstakingInfo
+ * @description Info of un-stake request
+ * @prop {string} chain - Slug of chain
+ * @prop {UnstakingStatus} status - Status of request
+ * @prop {string} claimable - Amount to be withdrawn
+ * @prop {number} [waitingTime] - Time remains to wait (in hours)
+ * @prop {string} [validatorAddress] - Address of validator
+ * */
+(function (UnstakingStatus) {
+  UnstakingStatus["CLAIMABLE"] = "CLAIMABLE";
+  UnstakingStatus["UNLOCKING"] = "UNLOCKING";
+})(UnstakingStatus || (UnstakingStatus = {}));

package/types/yield/info/base.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @enum {string}
+ * @description The types of yield pool.
+ * */
+export declare enum YieldPoolType {
+    /** Liquid staking */
+    LIQUID_STAKING = "LIQUID_STAKING",
+    /** Lending */
+    LENDING = "LENDING",
+    /** Single farming */
+    SINGLE_FARMING = "SINGLE_FARMING",
+    /** Pool staking */
+    NOMINATION_POOL = "NOMINATION_POOL",
+    /** Native staking */
+    NATIVE_STAKING = "NATIVE_STAKING",
+    /** Parachain staking */
+    PARACHAIN_STAKING = "PARACHAIN_STAKING"
+}
+/**
+ * @enum {number}
+ * @description Time to calculate profit
+ * */
+export declare enum YieldCompoundingPeriod {
+    DAILY = 1,
+    WEEKLY = 7,
+    MONTHLY = 30,
+    YEARLY = 365
+}
+/**
+ * @interface BasePoolInfo
+ * @prop {string} slug - Pool's slug
+ * @prop {string} chain - Pool's chain
+ * @prop {string} type - Pool's type
+ * @prop {string} group - Pool's group (by token)
+ * */
+export interface BasePoolInfo {
+    /** Pool's slug */
+    slug: string;
+    /** Pool's chain */
+    chain: string;
+    /** Pool's type */
+    type: YieldPoolType;
+    /** Pool's group (by token) */
+    group: string;
+}

package/types/yield/info/base.js

@@ -0,0 +1,36 @@
+// Copyright 2019-2022 @subwallet/extension-base
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * @enum {string}
+ * @description The types of yield pool.
+ * */
+export let YieldPoolType;
+
+/**
+ * @enum {number}
+ * @description Time to calculate profit
+ * */
+(function (YieldPoolType) {
+  YieldPoolType["LIQUID_STAKING"] = "LIQUID_STAKING";
+  YieldPoolType["LENDING"] = "LENDING";
+  YieldPoolType["SINGLE_FARMING"] = "SINGLE_FARMING";
+  YieldPoolType["NOMINATION_POOL"] = "NOMINATION_POOL";
+  YieldPoolType["NATIVE_STAKING"] = "NATIVE_STAKING";
+  YieldPoolType["PARACHAIN_STAKING"] = "PARACHAIN_STAKING";
+})(YieldPoolType || (YieldPoolType = {}));
+export let YieldCompoundingPeriod;
+
+/**
+ * @interface BasePoolInfo
+ * @prop {string} slug - Pool's slug
+ * @prop {string} chain - Pool's chain
+ * @prop {string} type - Pool's type
+ * @prop {string} group - Pool's group (by token)
+ * */
+(function (YieldCompoundingPeriod) {
+  YieldCompoundingPeriod[YieldCompoundingPeriod["DAILY"] = 1] = "DAILY";
+  YieldCompoundingPeriod[YieldCompoundingPeriod["WEEKLY"] = 7] = "WEEKLY";
+  YieldCompoundingPeriod[YieldCompoundingPeriod["MONTHLY"] = 30] = "MONTHLY";
+  YieldCompoundingPeriod[YieldCompoundingPeriod["YEARLY"] = 365] = "YEARLY";
+})(YieldCompoundingPeriod || (YieldCompoundingPeriod = {}));

package/types/yield/info/chain/index.d.ts

@@ -0,0 +1,2 @@
+export * from './info';
+export * from './target';

package/types/yield/info/chain/index.js

@@ -0,0 +1,5 @@
+// Copyright 2019-2022 @subwallet/extension-base
+// SPDX-License-Identifier: Apache-2.0
+
+export * from "./info.js";
+export * from "./target.js";

package/types/yield/info/chain/info.d.ts

@@ -0,0 +1,252 @@
+import { BasePoolInfo, YieldPoolType } from '../base';
+/**
+ * @interface YieldAssetEarningStats
+ * @prop {string} slug - Token's slug
+ * @prop {number} [apr] - Token's apr
+ * @prop {number} [apy] - Token's apy
+ * @prop {number} [exchangeRate] - Token's exchangeRate
+ * */
+export interface YieldAssetEarningStats {
+    /** Token's slug */
+    slug: string;
+    /** Token's apr */
+    apr?: number;
+    /** Token's apy */
+    apy?: number;
+    /**
+     * @description Token's exchangeRate
+     * @example input token amount = reward token amount * exchange rate
+     * */
+    exchangeRate?: number;
+}
+/**
+ * @interface YieldPoolMethodInfo
+ * @prop {boolean} join - Pool can join
+ * @prop {boolean} defaultUnstake - Pool can default unstake
+ * @prop {boolean} fastUnstake - Pool can fast unstake
+ * @prop {boolean} cancelUnstake - Pool can cancel unstake
+ * @prop {boolean} withdraw - Pool can withdraw
+ * @prop {boolean} claimReward - Pool can claim reward
+ * */
+export interface YieldPoolMethodInfo {
+    /** Pool can join */
+    join: boolean;
+    /** Pool can default unstake */
+    defaultUnstake: boolean;
+    /** Pool can fast unstake */
+    fastUnstake: boolean;
+    /** Pool can cancel unstake */
+    cancelUnstake: boolean;
+    /** Pool can withdraw */
+    withdraw: boolean;
+    /** Pool can claim reward */
+    claimReward: boolean;
+}
+/**
+ * @interface YieldThresholdInfo
+ * @prop {string} join - Min amount to join pool
+ * @prop {string} defaultUnstake - Min amount to unstake from pool
+ * @prop {string} fastUnstake - Min amount to fast unstake
+ * */
+export interface YieldThresholdInfo {
+    join: string;
+    defaultUnstake: string;
+    fastUnstake: string;
+}
+/**
+ * @interface BaseYieldPoolMetadata
+ * @prop {string} description - Pool's description
+ * @prop {string} name - Pool's name
+ * @prop {string} shortName - Pool's short name
+ * @prop {string} logo - Pool's logo
+ * @prop {boolean} isAvailable - Is the pool available?
+ * @prop {string} inputAsset - Input token (slug)
+ * @prop {string} maintainAsset - Asset to maintain account's pool
+ * @prop {string} maintainBalance - Balance to maintain account's pool
+ * @prop {YieldPoolMethodInfo} availableMethod - Pool's available method
+ * */
+export interface BaseYieldPoolMetadata {
+    /** Pool's description */
+    description: string;
+    /** Pool's name */
+    name: string;
+    /** Pool's short name */
+    shortName: string;
+    /** Pool's logo */
+    logo: string;
+    /** Input token (slug) */
+    inputAsset: string;
+    /** Is the pool available? */
+    isAvailable: boolean;
+    /** Asset to maintain account's pool */
+    maintainAsset: string;
+    /** Balance to maintain account's pool */
+    maintainBalance: string;
+    /** Pool's available method */
+    availableMethod: YieldPoolMethodInfo;
+}
+/**
+ * @interface NormalYieldPoolMetadata
+ * @extends BaseYieldPoolMetadata
+ * */
+export declare type NormalYieldPoolMetadata = BaseYieldPoolMetadata;
+/**
+ * @interface SpecialYieldPoolMetadata
+ * @extends BaseYieldPoolMetadata
+ * @prop {string[]} derivativeAssets - Array of derivative tokens (slug)
+ * @prop {string[]} rewardAssets - Array of reward tokens (slug)
+ * @prop {string[]} feeAssets - Array of fee tokens (slug)
+ * @prop {string} [altInputAssets] - Alt input token (slug) - optional
+ * */
+export interface SpecialYieldPoolMetadata extends BaseYieldPoolMetadata {
+    /** Array of derivative tokens (slug) */
+    derivativeAssets: string[];
+    /** Array of reward tokens (slug) */
+    rewardAssets: string[];
+    /** Alt input token (slug) - optional */
+    altInputAssets?: string;
+    /**
+     * Array of fee tokens (slug)
+     * <p>
+     * If the pool has more than one token, the mint step can use input token for fee instead native token
+     * </p>
+     *  */
+    feeAssets: string[];
+}
+/**
+ * @description Required data
+ * */
+export declare type YieldPoolMetadata = NormalYieldPoolMetadata | SpecialYieldPoolMetadata;
+/**
+ * @interface BaseYieldPoolStatistic
+ * @description Statistic data of pool
+ * @prop {YieldAssetEarningStats[]} assetEarning - Info for asset earning
+ * @prop {number} maxCandidatePerFarmer - Max candidates per farmer
+ * @prop {number} maxWithdrawalRequestPerFarmer - Max withdrawal request per farmer
+ * @prop {string} earningThreshold - Min amount to join pool
+ * @prop {number} [farmerCount] - Total farmer
+ * @prop {string} [tvl] - Total value staked in pool
+ * @prop {number} [totalApy] - Total apy of earning assets
+ * @prop {number} [totalApr] - Total apr of earning assets
+ * */
+export interface BaseYieldPoolStatistic {
+    /** Info for asset earning */
+    assetEarning: YieldAssetEarningStats[];
+    /** Max candidate per farmer  */
+    maxCandidatePerFarmer: number;
+    /** Max withdrawal request per farmer  */
+    maxWithdrawalRequestPerFarmer: number;
+    /** Min amount to join pool */
+    earningThreshold: YieldThresholdInfo;
+    /** Total farmer */
+    farmerCount?: number;
+    /** Total value staked in pool */
+    tvl?: string;
+    /** Total apy of earning assets */
+    totalApy?: number;
+    /** Total apr of earning assets */
+    totalApr?: number;
+}
+/**
+ * @interface NormalYieldPoolStatistic
+ * @extends BaseYieldPoolStatistic
+ * @prop {number} era - Current era of network
+ * @prop {number} eraTime - Time of an era - in hour
+ * @prop {number} unstakingPeriod - Time to wait withdraw un-stake, in hour
+ * @prop {number} [inflation] - Inflation rate
+ * */
+export interface NormalYieldPoolStatistic extends BaseYieldPoolStatistic {
+    /** Current era of network */
+    era: number;
+    /** Time of an era - in hour */
+    eraTime: number;
+    /** Time to wait withdraw un-stake, in hour */
+    unstakingPeriod: number;
+    /** Inflation rate */
+    inflation?: number;
+}
+/**
+ * @interface SpecialYieldPoolStatistic
+ * @extends BaseYieldPoolStatistic
+ * @prop {number} [unstakingPeriod] - Time to wait withdraw un-stake, in hour
+ * */
+export interface SpecialYieldPoolStatistic extends BaseYieldPoolStatistic {
+    /** Time to wait withdraw un-stake, in hour */
+    unstakingPeriod?: number;
+}
+export declare type YieldPoolStatistic = NormalYieldPoolStatistic | SpecialYieldPoolStatistic;
+/**
+ * @interface AbstractYieldPoolInfo
+ * @extends BasePoolInfo
+ * @prop {string} description - Pool's description
+ * @prop {string} name - Pool's name
+ * @prop {string} shortName - Pool's short name
+ * @prop {string} logo - Pool's logo
+ * @prop {YieldPoolStatistic} [statistic] - Pool's metadata
+ * */
+export interface AbstractYieldPoolInfo extends BasePoolInfo {
+    metadata: YieldPoolMetadata;
+    /** Pool's metadata */
+    statistic?: YieldPoolStatistic;
+    lastUpdated?: number;
+}
+/**
+ * @interface SpecialYieldPoolInfo
+ * @extends AbstractYieldPoolInfo
+ * @prop {SpecialYieldPoolStatistic} [statistic] - Pool's metadata
+ * */
+export interface SpecialYieldPoolInfo extends AbstractYieldPoolInfo {
+    type: YieldPoolType.LIQUID_STAKING | YieldPoolType.LENDING;
+    metadata: SpecialYieldPoolMetadata;
+    statistic?: SpecialYieldPoolStatistic;
+}
+/**
+ * @interface LiquidYieldPoolInfo
+ * @extends SpecialYieldPoolInfo
+ * @prop {YieldPoolType.LIQUID_STAKING} type - Pool's type
+ * */
+export interface LiquidYieldPoolInfo extends SpecialYieldPoolInfo {
+    type: YieldPoolType.LIQUID_STAKING;
+}
+/**
+ * @interface LendingYieldPoolInfo
+ * @extends SpecialYieldPoolInfo
+ * @prop {YieldPoolType.LENDING} type - Pool's type
+ * */
+export interface LendingYieldPoolInfo extends SpecialYieldPoolInfo {
+    type: YieldPoolType.LENDING;
+}
+/**
+ * @interface NominationYieldPoolInfo
+ * @extends AbstractYieldPoolInfo
+ * @prop {YieldPoolType.NOMINATION_POOL} type - Pool's type
+ * @prop {NormalYieldPoolStatistic} [statistic] - Pool's metadata
+ * */
+export interface NominationYieldPoolInfo extends AbstractYieldPoolInfo {
+    type: YieldPoolType.NOMINATION_POOL;
+    metadata: NormalYieldPoolMetadata;
+    statistic?: NormalYieldPoolStatistic;
+}
+/**
+ * @interface NativeYieldPoolInfo
+ * @extends AbstractYieldPoolInfo
+ * @prop {YieldPoolType.NATIVE_STAKING} type - Pool's type
+ * @prop {NormalYieldPoolStatistic} [statistic] - Pool's metadata
+ * */
+export interface NativeYieldPoolInfo extends AbstractYieldPoolInfo {
+    type: YieldPoolType.NATIVE_STAKING;
+    metadata: NormalYieldPoolMetadata;
+    statistic?: NormalYieldPoolStatistic;
+}
+/**
+ * Info of yield pool
+ * */
+export declare type YieldPoolInfo = NativeYieldPoolInfo | NominationYieldPoolInfo | LiquidYieldPoolInfo | LendingYieldPoolInfo;
+/**
+ * @interface YieldAssetExpectedEarning
+ * Pool expected return
+ * */
+export interface YieldAssetExpectedEarning {
+    apy?: number;
+    rewardInToken?: number;
+}

package/types/yield/info/chain/info.js

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

package/types/yield/info/chain/target.d.ts

@@ -0,0 +1,37 @@
+import { PalletNominationPoolsBondedPoolInner } from '../pallet';
+export interface NominationPoolInfo extends Pick<PalletNominationPoolsBondedPoolInner, 'roles' | 'memberCounter' | 'state'> {
+    id: number;
+    address: string;
+    name?: string;
+    bondedAmount: string;
+    isProfitable: boolean;
+}
+export interface ValidatorInfo {
+    address: string;
+    chain: string;
+    totalStake: string;
+    ownStake: string;
+    otherStake: string;
+    minBond: string;
+    nominatorCount: number;
+    commission: number;
+    expectedReturn?: number;
+    blocked: boolean;
+    identity?: string;
+    isVerified: boolean;
+    icon?: string;
+    isCrowded: boolean;
+}
+export declare type YieldPoolTarget = NominationPoolInfo | ValidatorInfo;
+export interface RequestGetYieldPoolTargets {
+    slug: string;
+}
+export interface ResponseGetYieldPoolTargets {
+    slug: string;
+    targets: YieldPoolTarget[];
+}
+export interface CollatorExtraInfo {
+    active: boolean;
+    identity?: string;
+    isVerified: boolean;
+}

package/types/yield/info/chain/target.js

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

package/types/yield/info/index.d.ts

@@ -0,0 +1,4 @@
+export * from './account';
+export * from './base';
+export * from './chain';
+export * from './pallet';

package/types/yield/info/index.js

@@ -0,0 +1,7 @@
+// Copyright 2019-2022 @subwallet/extension-base
+// SPDX-License-Identifier: Apache-2.0
+
+export * from "./account/index.js";
+export * from "./base.js";
+export * from "./chain/index.js";
+export * from "./pallet.js";