@subwallet/extension-base 1.1.28-beta.1 → 1.1.28-beta.2

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

@@ -1,4 +1,4 @@
-import { YieldPoolType } from '../base';
+import { BasePoolInfo, YieldPoolType } from '../base';
 /**
  * @interface YieldAssetEarningStats
  * @prop {string} slug - Token's slug
@@ -21,8 +21,65 @@ export interface YieldAssetEarningStats {
 }
 /**
  * @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 {boolean} allowCancelUnstaking - Allow canceling un-stake
+ * */
+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;
+    /** Allow to cancel un-stake */
+    allowCancelUnstaking: boolean;
+}
+/**
+ * @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 {number} maxCandidatePerFarmer - Max candidates per farmer
  * @prop {number} maxWithdrawalRequestPerFarmer - Max withdrawal request per farmer
  * @prop {string} minJoinPool - Min amount to join pool
@@ -30,13 +87,8 @@ export interface YieldAssetEarningStats {
  * @prop {string} [tvl] - Total value staked in pool
  * @prop {number} [totalApy] - Total apy of earning assets
  * @prop {number} [totalApr] - Total apr of earning assets
- * @prop {boolean} allowCancelUnstaking - Allow canceling un-stake
  * */
-export interface BaseYieldPoolMetadata {
-    /** Input token (slug) */
-    inputAsset: string;
-    /** Is the pool available? */
-    isAvailable: boolean;
+export interface BaseYieldPoolStatistic {
     /** Max candidate per farmer  */
     maxCandidatePerFarmer: number;
     /** Max withdrawal request per farmer  */
@@ -51,17 +103,15 @@ export interface BaseYieldPoolMetadata {
     totalApy?: number;
     /** Total apr of earning assets */
     totalApr?: number;
-    /** Allow to cancel un-stake */
-    allowCancelUnstaking: boolean;
 }
 /**
- * @interface NormalYieldPoolMetadata
- * @extends BaseYieldPoolMetadata
+ * @interface NormalYieldPoolStatistic
+ * @extends BaseYieldPoolStatistic
  * @prop {number} era - Current era of network
  * @prop {number} unstakingPeriod - Time to wait withdraw un-stake, in hour
  * @prop {number} [inflation] - Inflation rate
  * */
-export interface NormalYieldPoolMetadata extends BaseYieldPoolMetadata {
+export interface NormalYieldPoolStatistic extends BaseYieldPoolStatistic {
     /** Current era of network */
     era: number;
     /** Time to wait withdraw un-stake, in hour */
@@ -70,75 +120,41 @@ export interface NormalYieldPoolMetadata extends BaseYieldPoolMetadata {
     inflation?: number;
 }
 /**
- * @interface SpecialYieldPoolMetadata
- * @extends BaseYieldPoolMetadata
- * @prop {number} [era] - Current era of network
- * @prop {number} [unstakingPeriod] - Time to wait withdraw un-stake, in hour
- * @prop {number} [inflation] - Inflation rate
- * @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
+ * @interface SpecialYieldPoolStatistic
+ * @extends BaseYieldPoolStatistic
+ * @prop {YieldAssetEarningStats[]} assetEarning - Info for asset earning
+ * @prop {string} minWithdrawal - Min amount for withdrawal request
  * */
-export interface SpecialYieldPoolMetadata extends BaseYieldPoolMetadata {
+export interface SpecialYieldPoolStatistic extends BaseYieldPoolStatistic {
     /** Info for asset earning */
     assetEarning: YieldAssetEarningStats[];
     /** Min amount for withdrawal request */
     minWithdrawal: string;
-    /** 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[];
 }
-export declare type YieldPoolMetadata = NormalYieldPoolMetadata | SpecialYieldPoolMetadata;
+export declare type YieldPoolStatistic = NormalYieldPoolStatistic | SpecialYieldPoolStatistic;
 /**
  * @interface AbstractYieldPoolInfo
- * @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)
+ * @extends BasePoolInfo
  * @prop {string} description - Pool's description
  * @prop {string} name - Pool's name
- * @prop {string} [logo] - Pool's logo
- * @prop {YieldPoolMetadata} metadata - Pool's metadata
+ * @prop {string} shortName - Pool's short name
+ * @prop {string} logo - Pool's logo
+ * @prop {YieldPoolStatistic} [statistic] - Pool's metadata
  * */
-export interface AbstractYieldPoolInfo {
-    /** Pool's slug */
-    slug: string;
-    /** Pool's chain */
-    chain: string;
-    /** Pool's type */
-    type: YieldPoolType;
-    /** Pool's group (by token) */
-    group: string;
-    /** Pool's description */
-    description: string;
-    /** Pool's name */
-    name: string;
-    /** Pool's short name */
-    shortName: string;
-    /** Pool's logo - optional */
-    logo?: string;
-    /** Pool's metadata */
+export interface AbstractYieldPoolInfo extends BasePoolInfo {
     metadata: YieldPoolMetadata;
+    /** Pool's metadata */
+    statistic?: YieldPoolStatistic;
 }
 /**
  * @interface SpecialYieldPoolInfo
  * @extends AbstractYieldPoolInfo
- * @prop {SpecialYieldPoolMetadata} metadata - Pool's metadata
+ * @prop {SpecialYieldPoolStatistic} [statistic] - Pool's metadata
  * */
 export interface SpecialYieldPoolInfo extends AbstractYieldPoolInfo {
     type: YieldPoolType.LIQUID_STAKING | YieldPoolType.LENDING;
     metadata: SpecialYieldPoolMetadata;
+    statistic?: SpecialYieldPoolStatistic;
 }
 /**
  * @interface LiquidYieldPoolInfo
@@ -160,21 +176,23 @@ export interface LendingYieldPoolInfo extends SpecialYieldPoolInfo {
  * @interface NominationYieldPoolInfo
  * @extends AbstractYieldPoolInfo
  * @prop {YieldPoolType.NOMINATION_POOL} type - Pool's type
- * @prop {NormalYieldPoolMetadata} metadata - Pool's metadata
+ * @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 {NormalYieldPoolMetadata} metadata - Pool's metadata
+ * @prop {NormalYieldPoolStatistic} [statistic] - Pool's metadata
  * */
 export interface NativeYieldPoolInfo extends AbstractYieldPoolInfo {
     type: YieldPoolType.NATIVE_STAKING;
     metadata: NormalYieldPoolMetadata;
+    statistic?: NormalYieldPoolStatistic;
 }
 /**
  * Info of yield pool

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

@@ -26,6 +26,10 @@ 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;