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

package/types/index.js

@@ -1,6 +1,10 @@
-// Copyright 2019-2022 @polkadot/extension authors & contributors
+// Copyright 2019-2022 @subwallet/extension-base authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
 export * from "./balance.js";
 export * from "./buy.js";
+export * from "./campaigns/index.js";
+export * from "./ordinal.js";
+export * from "./transaction.js";
+export * from "./yield/index.js";
 export {};

package/types/ordinal.d.ts

@@ -0,0 +1,69 @@
+export interface OrdinalItem {
+    chain: string;
+    address: string;
+    data: Record<string, any>;
+}
+export interface SubscanEventBaseItemData {
+    id: number;
+    block_timestamp: number;
+    extrinsic_index: string;
+    extrinsic_hash: string;
+    finalized: boolean;
+    event_index: string;
+    phase: number;
+    module_id: string;
+    event_id: string;
+}
+export interface SubscanEventListResponse {
+    code: number;
+    message: string;
+    generated_at: number;
+    data: {
+        count: number;
+        events: SubscanEventBaseItemData[];
+    };
+}
+export interface SubscanBatchChildParam {
+    name: string;
+    type: string;
+    value: string;
+}
+export interface SubscanBatchChild {
+    call_index: string;
+    call_module: string;
+    call_name: string;
+    params: SubscanBatchChildParam[];
+}
+export interface SubscanExtrinsicParamDetail {
+    name: string;
+    type: string;
+    type_name: string;
+    value: string | SubscanBatchChild[];
+}
+export interface SubscanExtrinsicParam {
+    extrinsic_index: string;
+    params: SubscanExtrinsicParamDetail[];
+}
+export interface SubscanExtrinsicParamResponse {
+    code: number;
+    message: string;
+    generated_at: number;
+    data: SubscanExtrinsicParam[];
+}
+export interface OrdinalRemarkData {
+    p: string;
+    op: string;
+    tick: string;
+    amt: string;
+}
+export interface OrdinalNftProperties {
+    P: {
+        value: string;
+    };
+    Op: {
+        value: string;
+    };
+    Tick: {
+        value: string;
+    };
+}

package/types/ordinal.js

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

package/types/transaction.d.ts

@@ -0,0 +1,3 @@
+import { TransactionConfig } from 'web3-core';
+import { SubmittableExtrinsic } from '@polkadot/api/types';
+export declare type TransactionData = SubmittableExtrinsic<'promise'> | TransactionConfig;

package/types/transaction.js

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

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

@@ -0,0 +1,2 @@
+export * from './join';
+export * from './others';

package/types/yield/actions/index.js

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

package/types/yield/actions/join/index.d.ts

@@ -0,0 +1,3 @@
+export * from './step';
+export * from './submit';
+export * from './validate';

package/types/yield/actions/join/index.js

@@ -0,0 +1,6 @@
+// Copyright 2019-2022 @subwallet/extension-base
+// SPDX-License-Identifier: Apache-2.0
+
+export * from "./step.js";
+export * from "./submit.js";
+export * from "./validate.js";

package/types/yield/actions/join/step.d.ts

@@ -0,0 +1,94 @@
+import { YieldPoolTarget } from '@subwallet/extension-base/types';
+/**
+ * @interface RequestEarlyValidateYield
+ * @description Params to early validate join pool
+ * @prop {string} slug - Pool's slug
+ * @prop {string} address - Account's address
+ * */
+export interface RequestEarlyValidateYield {
+    /** Pool's slug */
+    slug: string;
+    /** Account's address */
+    address: string;
+}
+/**
+ * @interface ResponseEarlyValidateYield
+ * @prop {boolean} passed - Passed validate
+ * */
+export interface ResponseEarlyValidateYield {
+    passed: boolean;
+}
+/**
+ * @interface OptimalYieldPathParams
+ * @description Params to generate steps
+ * */
+export interface OptimalYieldPathParams {
+    slug: string;
+    address: string;
+    amount: string;
+    targets?: YieldPoolTarget[];
+}
+/**
+ * @enum {string}
+ * @description Type of join yield step
+ * */
+export declare enum YieldStepType {
+    DEFAULT = "DEFAULT",
+    XCM = "XCM",
+    NOMINATE = "NOMINATE",
+    JOIN_NOMINATION_POOL = "JOIN_NOMINATION_POOL",
+    MINT_VDOT = "MINT_VDOT",
+    MINT_LDOT = "MINT_LDOT",
+    MINT_QDOT = "MINT_QDOT",
+    MINT_SDOT = "MINT_SDOT",
+    MINT_STDOT = "MINT_STDOT",
+    TOKEN_APPROVAL = "TOKEN_APPROVAL"
+}
+/**
+ * @interface BaseYieldStepDetail
+ * @description Base info of a step
+ * @prop {string} name - Step's name
+ * @prop {YieldStepType} type - Step's type
+ * @prop {Record<string,unknown>} [metadata] - Metadata for generating extrinsic
+ * */
+export interface BaseYieldStepDetail {
+    /** Step's name */
+    name: string;
+    /** Step's type */
+    type: YieldStepType;
+    /** Metadata for generating extrinsic */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * @interface YieldStepDetail
+ * @extends BaseYieldStepDetail
+ * @description Detail of a step
+ * @prop {number} id - Step's id
+ * */
+export interface YieldStepDetail extends BaseYieldStepDetail {
+    /** Step's id */
+    id: number;
+}
+/**
+ * @interface YieldTokenBaseInfo
+ * @prop {string} slug - Token's slug
+ * @prop {string} [amount] - Token's amount
+ * */
+export interface YieldTokenBaseInfo {
+    /** Token's slug */
+    slug: string;
+    /** Token's amount */
+    amount?: string;
+}
+/** Base info and fee of a step */
+export declare type YieldStepBaseInfo = [BaseYieldStepDetail, YieldTokenBaseInfo];
+/**
+ * @interface OptimalYieldPath
+ * @description Result after generate steps
+ * */
+export interface OptimalYieldPath {
+    totalFee: YieldTokenBaseInfo[];
+    steps: YieldStepDetail[];
+    connectionError?: string;
+}
+export declare type GenStepFunction = (params: OptimalYieldPathParams) => Promise<YieldStepBaseInfo | undefined>;

package/types/yield/actions/join/step.js

@@ -0,0 +1,46 @@
+// Copyright 2019-2022 @subwallet/extension-base
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * @interface RequestEarlyValidateYield
+ * @description Params to early validate join pool
+ * @prop {string} slug - Pool's slug
+ * @prop {string} address - Account's address
+ * */
+
+/**
+ * @interface ResponseEarlyValidateYield
+ * @prop {boolean} passed - Passed validate
+ * */
+
+/**
+ * @interface OptimalYieldPathParams
+ * @description Params to generate steps
+ * */
+
+/**
+ * @enum {string}
+ * @description Type of join yield step
+ * */
+
+export let YieldStepType;
+
+/**
+ * @interface BaseYieldStepDetail
+ * @description Base info of a step
+ * @prop {string} name - Step's name
+ * @prop {YieldStepType} type - Step's type
+ * @prop {Record<string,unknown>} [metadata] - Metadata for generating extrinsic
+ * */
+(function (YieldStepType) {
+  YieldStepType["DEFAULT"] = "DEFAULT";
+  YieldStepType["XCM"] = "XCM";
+  YieldStepType["NOMINATE"] = "NOMINATE";
+  YieldStepType["JOIN_NOMINATION_POOL"] = "JOIN_NOMINATION_POOL";
+  YieldStepType["MINT_VDOT"] = "MINT_VDOT";
+  YieldStepType["MINT_LDOT"] = "MINT_LDOT";
+  YieldStepType["MINT_QDOT"] = "MINT_QDOT";
+  YieldStepType["MINT_SDOT"] = "MINT_SDOT";
+  YieldStepType["MINT_STDOT"] = "MINT_STDOT";
+  YieldStepType["TOKEN_APPROVAL"] = "TOKEN_APPROVAL";
+})(YieldStepType || (YieldStepType = {}));

package/types/yield/actions/join/submit.d.ts

@@ -0,0 +1,53 @@
+import { BaseRequestSign, ExtrinsicType, InternalRequestSign } from '@subwallet/extension-base/background/KoniTypes';
+import { TransactionData } from '../../../transaction';
+import { NominationPoolInfo, ValidatorInfo, YieldPositionInfo } from '../../info';
+import { OptimalYieldPath } from './step';
+export interface HandleYieldStepData {
+    txChain: string;
+    extrinsicType: ExtrinsicType;
+    extrinsic: TransactionData;
+    txData: any;
+    transferNativeAmount: string;
+}
+export interface AbstractSubmitYieldJoinData {
+    slug: string;
+    amount: string;
+    address: string;
+}
+export interface SubmitJoinNativeStaking extends AbstractSubmitYieldJoinData {
+    selectedValidators: ValidatorInfo[];
+}
+export interface SubmitJoinNominationPool extends AbstractSubmitYieldJoinData {
+    selectedPool: NominationPoolInfo;
+}
+export interface SubmitYieldStepData extends AbstractSubmitYieldJoinData {
+    exchangeRate: number;
+    inputTokenSlug: string;
+    derivativeTokenSlug?: string;
+    rewardTokenSlug: string;
+    feeTokenSlug: string;
+}
+export declare type SubmitYieldJoinData = SubmitYieldStepData | SubmitJoinNativeStaking | SubmitJoinNominationPool;
+export interface HandleYieldStepParams extends BaseRequestSign {
+    path: OptimalYieldPath;
+    data: SubmitYieldJoinData;
+    currentStep: number;
+}
+export declare type RequestYieldStepSubmit = InternalRequestSign<HandleYieldStepParams>;
+export interface StakePoolingBondingParams extends BaseRequestSign {
+    poolPosition?: YieldPositionInfo;
+    slug: string;
+    selectedPool: NominationPoolInfo;
+    amount: string;
+    address: string;
+}
+export declare type RequestStakePoolingBonding = InternalRequestSign<StakePoolingBondingParams>;
+export interface BondingSubmitParams extends BaseRequestSign {
+    slug: string;
+    poolPosition?: YieldPositionInfo;
+    amount: string;
+    address: string;
+    selectedValidators: ValidatorInfo[];
+    lockPeriod?: number;
+}
+export declare type RequestBondingSubmit = InternalRequestSign<BondingSubmitParams>;

package/types/yield/actions/join/submit.js

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

package/types/yield/actions/join/validate.d.ts

@@ -0,0 +1,18 @@
+import { OptimalYieldPath, YieldStepDetail } from './step';
+import { SubmitYieldJoinData } from './submit';
+export declare enum YieldValidationStatus {
+    NOT_ENOUGH_FEE = "NOT_ENOUGH_FEE",
+    NOT_ENOUGH_BALANCE = "NOT_ENOUGH_BALANCE",
+    NOT_ENOUGH_MIN_JOIN_POOL = "NOT_ENOUGH_MIN_JOIN_POOL",
+    OK = "OK"
+}
+export interface YieldProcessValidation {
+    ok: boolean;
+    status: YieldValidationStatus;
+    failedStep?: YieldStepDetail;
+    message?: string;
+}
+export interface ValidateYieldProcessParams {
+    path: OptimalYieldPath;
+    data: SubmitYieldJoinData;
+}

package/types/yield/actions/join/validate.js

@@ -0,0 +1,10 @@
+// Copyright 2019-2022 @subwallet/extension-base
+// SPDX-License-Identifier: Apache-2.0
+
+export let YieldValidationStatus;
+(function (YieldValidationStatus) {
+  YieldValidationStatus["NOT_ENOUGH_FEE"] = "NOT_ENOUGH_FEE";
+  YieldValidationStatus["NOT_ENOUGH_BALANCE"] = "NOT_ENOUGH_BALANCE";
+  YieldValidationStatus["NOT_ENOUGH_MIN_JOIN_POOL"] = "NOT_ENOUGH_MIN_JOIN_POOL";
+  YieldValidationStatus["OK"] = "OK";
+})(YieldValidationStatus || (YieldValidationStatus = {}));

package/types/yield/actions/others.d.ts

@@ -0,0 +1,63 @@
+import { BaseRequestSign, InternalRequestSign } from '@subwallet/extension-base/background/KoniTypes';
+import { UnstakingInfo, YieldPoolInfo } from '../info';
+/**
+ * @interface YieldLeaveParams
+ * @description Request params to leave pool
+ * @prop {string} address - Request account
+ * @prop {string} amount - Amount token want to leave
+ * @prop {string} slug - Pool's slug
+ * @prop {string} [selectedTarget] - Pool target want to leave (nomination pool and native staking need)
+ * @prop {boolean} fastLeave - Fast leave pool (swap token)
+ * @prop {YieldPoolInfo} poolInfo - Pool's info - use for create history
+ * */
+export interface YieldLeaveParams extends BaseRequestSign {
+    /** Request account */
+    address: string;
+    /** Amount token want to leave */
+    amount: string;
+    /** Pool's slug */
+    slug: string;
+    /** Pool target want to leave (nomination pool and native staking need) */
+    selectedTarget?: string;
+    /** Fast leave pool (swap token) */
+    fastLeave: boolean;
+    /** Pool's info - use for create history */
+    poolInfo: YieldPoolInfo;
+}
+export declare type RequestYieldLeave = InternalRequestSign<YieldLeaveParams>;
+/**
+ * @interface RequestYieldWithdrawal
+ * @description Request params to withdraw
+ * @prop {string} address - Request account
+ * @prop {string} slug - Pool's slug
+ * @prop {UnstakingInfo} unstakingInfo - Info of unstaking request wants to withdraw
+ * */
+export interface YieldWithdrawalParams extends BaseRequestSign {
+    /** Request account */
+    address: string;
+    /** Pool's slug */
+    slug: string;
+    /**
+     * <p>
+     *  Info of unstaking request wants to withdraw
+     * </p>
+     * <p>
+     *  Need to create amount on history
+     * </p>
+     * */
+    unstakingInfo: UnstakingInfo;
+}
+export declare type RequestYieldWithdrawal = InternalRequestSign<YieldWithdrawalParams>;
+export interface StakeCancelWithdrawalParams extends BaseRequestSign {
+    address: string;
+    slug: string;
+    selectedUnstaking: UnstakingInfo;
+}
+export declare type RequestStakeCancelWithdrawal = InternalRequestSign<StakeCancelWithdrawalParams>;
+export interface StakeClaimRewardParams extends BaseRequestSign {
+    address: string;
+    slug: string;
+    unclaimedReward?: string;
+    bondReward?: boolean;
+}
+export declare type RequestStakeClaimReward = InternalRequestSign<StakeClaimRewardParams>;

package/types/yield/actions/others.js

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

package/types/yield/index.d.ts

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

package/types/yield/index.js

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

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

@@ -0,0 +1,4 @@
+export * from './info';
+export * from './reward';
+export * from './target';
+export * from './unstake';

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

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

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

@@ -0,0 +1,101 @@
+import { BasePoolInfo, YieldPoolType } from '../base';
+import { EarningStatus, NominationInfo } from './target';
+import { UnstakingInfo } from './unstake';
+export interface YieldAssetBalance {
+    slug: string;
+    activeBalance: string;
+    exchangeRate?: number;
+}
+/**
+ * @interface BaseYieldPositionInfo
+ * @extends BasePoolInfo
+ * @prop {string} address - Account address
+ * */
+export interface BaseYieldPositionInfo extends BasePoolInfo {
+    /** Account address */
+    address: string;
+}
+/**
+ * @interface AbstractYieldPositionInfo
+ * @prop {string} address - Account address
+ * @prop {string} chain - Chain's slug
+ * @prop {YieldPoolGroup} group - Pool's group
+ * @prop {string} slug - Pool's slug
+ * @prop {YieldPoolType} type - Pool's type
+ * @prop {string} totalStake - Total stake of the account
+ * @prop {string} activeStake - Active stake of the account
+ * @prop {string} unstakeBalance - Unstaking balance of the account
+ * @prop {YieldAssetBalance[]} balance - List balance related with stake
+ * @prop {boolean} isBondedBefore - Is the account bonded in pool before?
+ * @prop {NominationInfo[]} nominations - List nominations account joined - use for nomination pool and native staking
+ * @prop {EarningStatus} status - Earning status of the account
+ * @prop {UnstakingInfo[]} unstakings - List unstake request of the account - use for nomination pool and native staking
+ * */
+export interface AbstractYieldPositionInfo extends BaseYieldPositionInfo {
+    /** Token to show */
+    balanceToken: string;
+    /** Total stake of the account */
+    totalStake: string;
+    /** Active stake of the account */
+    activeStake: string;
+    /** Unstaking balance of the account */
+    unstakeBalance: string;
+    /** Is the account bonded in pool before? */
+    isBondedBefore: boolean;
+    /** List nominations account joined - use for nomination pool and native staking */
+    nominations: NominationInfo[];
+    /** Earning status of the account */
+    status: EarningStatus;
+    /** List unstake request of the account - use for nomination pool and native staking */
+    unstakings: UnstakingInfo[];
+}
+/**
+ * @interface SpecialYieldPositionInfo
+ * @extends AbstractYieldPositionInfo
+ * @prop {string} rootAsset - Input token - Root token before stake and after unstake (slug)
+ * */
+export interface SpecialYieldPositionInfo extends AbstractYieldPositionInfo {
+    type: YieldPoolType.LIQUID_STAKING | YieldPoolType.LENDING;
+    /** @description
+     * <p>Derivative token - Token got after stake (slug)</p>
+     * <p>To detect exchange rate</p>
+     * <p>Exchange rate = root token amount / balance token amount</p>
+     * */
+    derivativeToken: string;
+}
+/**
+ * @interface LiquidYieldPositionInfo
+ * @extends SpecialYieldPositionInfo
+ * @prop {YieldPoolType.LIQUID_STAKING} type - Pool's type
+ * */
+export interface LiquidYieldPositionInfo extends SpecialYieldPositionInfo {
+    type: YieldPoolType.LIQUID_STAKING;
+}
+/**
+ * @interface LendingYieldPositionInfo
+ * @extends SpecialYieldPositionInfo
+ * @prop {YieldPoolType.LENDING} type - Pool's type
+ * */
+export interface LendingYieldPositionInfo extends SpecialYieldPositionInfo {
+    type: YieldPoolType.LENDING;
+}
+/**
+ * @interface NominationYieldPositionInfo
+ * @extends AbstractYieldPositionInfo
+ * @prop {YieldPoolType.NOMINATION_POOL} type - Pool's type
+ * */
+export interface NominationYieldPositionInfo extends AbstractYieldPositionInfo {
+    type: YieldPoolType.NOMINATION_POOL;
+}
+/**
+ * @interface NativeYieldPositionInfo
+ * @extends AbstractYieldPositionInfo
+ * @prop {YieldPoolType.NATIVE_STAKING} type - Pool's type
+ * */
+export interface NativeYieldPositionInfo extends AbstractYieldPositionInfo {
+    type: YieldPoolType.NATIVE_STAKING;
+}
+/**
+ * Info of yield pool
+ * */
+export declare type YieldPositionInfo = NativeYieldPositionInfo | NominationYieldPositionInfo | LiquidYieldPositionInfo | LendingYieldPositionInfo;

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

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

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

@@ -0,0 +1,30 @@
+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>;
+}

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 = {}));