@myx-trade/sdk 0.1.244 → 0.1.245-beta.0

package/dist/index.d.mts

@@ -30,6 +30,8 @@ interface ContractAddress {
     readonly DATA_PROVIDER: Address$1;
     readonly ORACLE_RESERVE: Address$1;
     readonly FORWARDER: Address$1;
+    readonly REIMBURSEMENT: Address$1;
+    readonly DISPUTE_COURT: Address$1;
     readonly TRADING_ROUTER: Address$1;
 }
 
@@ -1359,7 +1361,7 @@ declare class Utils {
     constructor(configManager: ConfigManager, logger: Logger);
     getOrderIdFromTransaction(receipt: any): string | null;
     private getApproveQuoteAmount;
-    needsApproval(address: string, chainId: number, quoteAddress: string, requiredAmount: string, spenderAddress?: string): Promise<boolean>;
+    needsApproval(account: string, chainId: number, tokenAddress: string, requiredAmount: string, spenderAddress?: string): Promise<boolean>;
     approveAuthorization({ chainId, quoteAddress, amount, spenderAddress, signer, }: {
         chainId: number;
         quoteAddress: string;
@@ -1392,13 +1394,16 @@ declare class Utils {
         publishTime: number;
         oracleType: OracleType;
         vaa: string;
-    } | {
-        price: string;
-        vaa: string;
-        publishTime: number;
-        poolId: string;
-        value: number;
     }>;
+    buildUpdatePriceParams(poolId: string, chainId: number): Promise<{
+        poolId: string;
+        referencePrice: bigint;
+        oracleUpdateData: string;
+        publishTime: number;
+        oracleType: OracleType;
+        value: bigint;
+        price: string;
+    }[]>;
     transferKlineResolutionToInterval(resolution: KlineResolution): HttpKlineIntervalEnum;
     getErrorMessage(error: any, fallbackErrorMessage?: string): Promise<any>;
     checkSeamlessGas(userAddress: string, chainId: number): Promise<boolean>;
@@ -1477,8 +1482,8 @@ declare class Utils {
         data?: undefined;
     }>;
     formatErrorMessage(error: any): any;
-    getGasPriceByRatio(chainId: number): Promise<bigint>;
-    getGasLimitByRatio(chainId: number, gasLimit: bigint): Promise<bigint>;
+    getGasPriceByRatio(): Promise<bigint>;
+    getGasLimitByRatio(gasLimit: bigint): Promise<bigint>;
 }
 
 declare class Api {
@@ -3366,6 +3371,65 @@ declare class BaseMyxClient {
     protected get config(): MyxClientConfig;
 }
 
+interface AppealVoteParams {
+    caseId: number;
+    validator: Address$2;
+    isFor: boolean;
+    deadline: number;
+    v: number;
+    r: string;
+    s: string;
+}
+
+declare class Appeal extends BaseMyxClient {
+    constructor(client: MyxClient);
+    private getDisputeCourtContract;
+    private getReimbursementContract;
+    /**
+     * submit appeal
+     * @param poolId - the pool id
+     * @param poolToken - the pool token
+     * @returns the transaction receipt
+     */
+    submitAppeal(poolId: string, lpToken: Address$2, lpAmount: string): Promise<ethers.ContractTransactionReceipt | null>;
+    /**
+     * vote for appeal
+     * @param caseId - the case id
+     * @param isFor - true if for the appeal, false if against the appeal
+     * @returns the transaction receipt
+     */
+    voteForAppeal({ caseId, validator, isFor, deadline, v, r, s, }: AppealVoteParams): Promise<ethers.ContractTransactionReceipt | null>;
+    /**
+     * claim appeal margin
+     * @param caseId - the case id
+     * @returns the transaction receipt
+     */
+    claimAppealMargin(caseId: number): Promise<ethers.ContractTransactionReceipt | null>;
+    /**
+     * claim reimbursement
+     * @param caseId - the case id
+     * @param baseAmount - the base amount
+     * @param quoteAmount - the quote amount
+     * @param merkleProof - the merkle proof
+     * @returns the transaction receipt
+     */
+    claimReimbursement(caseId: number, baseAmount: number, quoteAmount: number, merkleProof: BytesLike[]): Promise<ethers.ContractTransactionReceipt | null>;
+    /**
+     * get dispute configuration
+     */
+    getDisputeConfiguration(): Promise<[string, bigint, bigint, bigint, bigint, bigint, bigint, bigint, bigint] & {
+        appealToken: string;
+        disputeBondUsd: bigint;
+        appealBondUsd: bigint;
+        disputeThresholdUsd: bigint;
+        caseDuration: bigint;
+        voteDuration: bigint;
+        resolveDuration: bigint;
+        voteCountRate: bigint;
+        effectiveVoteRate: bigint;
+    }>;
+}
+
 declare class Referrals extends BaseMyxClient {
     constructor(client: MyxClient);
     claimRebate(tokenAddress: Address$2): Promise<ethers.ContractTransactionReceipt | null>;
@@ -3376,7 +3440,7 @@ declare class MyxClient {
      * private properties
      */
     private configManager;
-    private logger;
+    logger: Logger;
     /**
      * public properties
      */
@@ -3388,6 +3452,7 @@ declare class MyxClient {
     account: Account;
     seamless: Seamless;
     api: Api;
+    appeal: Appeal;
     referrals: Referrals;
     /**
      * 获取配置管理器（用于访问 accessToken 相关方法）

package/dist/index.d.ts

@@ -30,6 +30,8 @@ interface ContractAddress {
     readonly DATA_PROVIDER: Address$1;
     readonly ORACLE_RESERVE: Address$1;
     readonly FORWARDER: Address$1;
+    readonly REIMBURSEMENT: Address$1;
+    readonly DISPUTE_COURT: Address$1;
     readonly TRADING_ROUTER: Address$1;
 }
 
@@ -1359,7 +1361,7 @@ declare class Utils {
     constructor(configManager: ConfigManager, logger: Logger);
     getOrderIdFromTransaction(receipt: any): string | null;
     private getApproveQuoteAmount;
-    needsApproval(address: string, chainId: number, quoteAddress: string, requiredAmount: string, spenderAddress?: string): Promise<boolean>;
+    needsApproval(account: string, chainId: number, tokenAddress: string, requiredAmount: string, spenderAddress?: string): Promise<boolean>;
     approveAuthorization({ chainId, quoteAddress, amount, spenderAddress, signer, }: {
         chainId: number;
         quoteAddress: string;
@@ -1392,13 +1394,16 @@ declare class Utils {
         publishTime: number;
         oracleType: OracleType;
         vaa: string;
-    } | {
-        price: string;
-        vaa: string;
-        publishTime: number;
-        poolId: string;
-        value: number;
     }>;
+    buildUpdatePriceParams(poolId: string, chainId: number): Promise<{
+        poolId: string;
+        referencePrice: bigint;
+        oracleUpdateData: string;
+        publishTime: number;
+        oracleType: OracleType;
+        value: bigint;
+        price: string;
+    }[]>;
     transferKlineResolutionToInterval(resolution: KlineResolution): HttpKlineIntervalEnum;
     getErrorMessage(error: any, fallbackErrorMessage?: string): Promise<any>;
     checkSeamlessGas(userAddress: string, chainId: number): Promise<boolean>;
@@ -1477,8 +1482,8 @@ declare class Utils {
         data?: undefined;
     }>;
     formatErrorMessage(error: any): any;
-    getGasPriceByRatio(chainId: number): Promise<bigint>;
-    getGasLimitByRatio(chainId: number, gasLimit: bigint): Promise<bigint>;
+    getGasPriceByRatio(): Promise<bigint>;
+    getGasLimitByRatio(gasLimit: bigint): Promise<bigint>;
 }
 
 declare class Api {
@@ -3366,6 +3371,65 @@ declare class BaseMyxClient {
     protected get config(): MyxClientConfig;
 }
 
+interface AppealVoteParams {
+    caseId: number;
+    validator: Address$2;
+    isFor: boolean;
+    deadline: number;
+    v: number;
+    r: string;
+    s: string;
+}
+
+declare class Appeal extends BaseMyxClient {
+    constructor(client: MyxClient);
+    private getDisputeCourtContract;
+    private getReimbursementContract;
+    /**
+     * submit appeal
+     * @param poolId - the pool id
+     * @param poolToken - the pool token
+     * @returns the transaction receipt
+     */
+    submitAppeal(poolId: string, lpToken: Address$2, lpAmount: string): Promise<ethers.ContractTransactionReceipt | null>;
+    /**
+     * vote for appeal
+     * @param caseId - the case id
+     * @param isFor - true if for the appeal, false if against the appeal
+     * @returns the transaction receipt
+     */
+    voteForAppeal({ caseId, validator, isFor, deadline, v, r, s, }: AppealVoteParams): Promise<ethers.ContractTransactionReceipt | null>;
+    /**
+     * claim appeal margin
+     * @param caseId - the case id
+     * @returns the transaction receipt
+     */
+    claimAppealMargin(caseId: number): Promise<ethers.ContractTransactionReceipt | null>;
+    /**
+     * claim reimbursement
+     * @param caseId - the case id
+     * @param baseAmount - the base amount
+     * @param quoteAmount - the quote amount
+     * @param merkleProof - the merkle proof
+     * @returns the transaction receipt
+     */
+    claimReimbursement(caseId: number, baseAmount: number, quoteAmount: number, merkleProof: BytesLike[]): Promise<ethers.ContractTransactionReceipt | null>;
+    /**
+     * get dispute configuration
+     */
+    getDisputeConfiguration(): Promise<[string, bigint, bigint, bigint, bigint, bigint, bigint, bigint, bigint] & {
+        appealToken: string;
+        disputeBondUsd: bigint;
+        appealBondUsd: bigint;
+        disputeThresholdUsd: bigint;
+        caseDuration: bigint;
+        voteDuration: bigint;
+        resolveDuration: bigint;
+        voteCountRate: bigint;
+        effectiveVoteRate: bigint;
+    }>;
+}
+
 declare class Referrals extends BaseMyxClient {
     constructor(client: MyxClient);
     claimRebate(tokenAddress: Address$2): Promise<ethers.ContractTransactionReceipt | null>;
@@ -3376,7 +3440,7 @@ declare class MyxClient {
      * private properties
      */
     private configManager;
-    private logger;
+    logger: Logger;
     /**
      * public properties
      */
@@ -3388,6 +3452,7 @@ declare class MyxClient {
     account: Account;
     seamless: Seamless;
     api: Api;
+    appeal: Appeal;
     referrals: Referrals;
     /**
      * 获取配置管理器（用于访问 accessToken 相关方法）