@aspan/sdk 0.4.9 → 0.5.0

package/dist/index.d.mts

@@ -97,14 +97,11 @@ interface RedeemXBNBParams {
 }
 /** Parameters for depositing to stability pool */
 interface DepositParams {
-    assets: bigint;
-    receiver: Address;
+    apUSDAmount: bigint;
 }
-/** Parameters for redeeming from stability pool */
-interface RedeemParams {
+/** Parameters for withdrawing from stability pool */
+interface WithdrawParams {
     shares: bigint;
-    receiver: Address;
-    owner: Address;
 }
 /** Overall protocol statistics */
 interface ProtocolStats {
@@ -580,11 +577,11 @@ declare class AspanClient extends AspanReadClient {
      */
     deposit(params: DepositParams): Promise<Hash>;
     /**
-     * Redeem from stability pool by shares
-     * @param params Redeem parameters
+     * Withdraw from stability pool by shares
+     * @param params Withdraw parameters
      * @returns Transaction hash
      */
-    redeem(params: RedeemParams): Promise<Hash>;
+    withdraw(params: WithdrawParams): Promise<Hash>;
     /**
      * Harvest yield from LSTs
      * @returns Transaction hash
@@ -1334,13 +1331,9 @@ declare const DiamondABI: readonly [{
     readonly type: "function";
     readonly name: "deposit";
     readonly inputs: readonly [{
-        readonly name: "assets";
+        readonly name: "_amount";
         readonly type: "uint256";
         readonly internalType: "uint256";
-    }, {
-        readonly name: "receiver";
-        readonly type: "address";
-        readonly internalType: "address";
     }];
     readonly outputs: readonly [{
         readonly name: "shares";
@@ -1350,26 +1343,14 @@ declare const DiamondABI: readonly [{
     readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
-    readonly name: "redeem";
+    readonly name: "withdraw";
     readonly inputs: readonly [{
-        readonly name: "shares";
+        readonly name: "_shares";
         readonly type: "uint256";
         readonly internalType: "uint256";
-    }, {
-        readonly name: "receiver";
-        readonly type: "address";
-        readonly internalType: "address";
-    }, {
-        readonly name: "owner";
-        readonly type: "address";
-        readonly internalType: "address";
     }];
     readonly outputs: readonly [{
-        readonly name: "apUSDOut";
-        readonly type: "uint256";
-        readonly internalType: "uint256";
-    }, {
-        readonly name: "xBNBOut";
+        readonly name: "assets";
         readonly type: "uint256";
         readonly internalType: "uint256";
     }];
@@ -2888,4 +2869,4 @@ declare function formatPriceUSD(price: bigint): string;
  */
 declare function calculateAPY(previousRate: bigint, currentRate: bigint, periodDays: number): number;
 
-export { type ApUSDMintedEvent, type ApUSDRedeemedEvent, AspanClient, type AspanClientConfig, AspanReadClient, AspanRouterClient, type AspanRouterClientConfig, AspanRouterReadClient, type AspanRouterWriteClientConfig, type AspanWriteClientConfig, BPS_PRECISION, BSC_ADDRESSES, type BigIntString, CHAIN_IDS, type CurrentFeeTier, type CurrentFees, type DepositParams, type DepositedEvent, DiamondABI, type ExpectedOutput, type FeeTier, type LSTInfo, type LSTYieldInfo, type MintApUSDParams, type MintXBNBParams, type OracleBounds, PHAROS_ADDRESSES, PRECISION, PRICE_PRECISION, type ProtocolStats, type RedeemAndSwapEvent, type RedeemApUSDParams, type RedeemParams, type RedeemXBNBParams, RouterABI, type RouterMintEvent, type RouterMintParams, type RouterMintParams2, type RouterRedeemAndSwapParams, type RouterRedeemAndUnstakeParams, type RouterRedeemEvent, type RouterRedeemParams, type RouterSwapParams, type StabilityMode2Info, type StabilityModeInfo, type StabilityPoolStats, type StakeAndMintEvent, type StakeAndMintParams, type SwapAndMintDefaultParams, type SwapAndMintEvent, type SwapAndMintParams, type TokenAddresses, type TransactionReceipt, type TransactionResult, type UnstakeClaimedEvent, type UnstakeRequestedEvent, type UserStabilityPoolPosition, type WithdrawalRequestInfo, type WithdrawnEvent, type XBNBMintedEvent, type XBNBRedeemedEvent, type YieldHarvestedEvent, type YieldStats, calculateAPY, createAspanClient, createAspanPharosClient, createAspanPharosReadClient, createAspanReadClient, createAspanReadClientForChain, createAspanTestnetClient, createAspanTestnetReadClient, createAspanWriteClientForChain, createRouterClient, createRouterPharosClient, createRouterPharosReadClient, createRouterReadClient, createRouterReadClientForChain, createRouterTestnetClient, createRouterTestnetReadClient, createRouterWriteClientForChain, encodeV3Path, formatAmount, formatCR, formatFeeBPS, formatPriceUSD, getChainById, parseAmount, pharosTestnet };
+export { type ApUSDMintedEvent, type ApUSDRedeemedEvent, AspanClient, type AspanClientConfig, AspanReadClient, AspanRouterClient, type AspanRouterClientConfig, AspanRouterReadClient, type AspanRouterWriteClientConfig, type AspanWriteClientConfig, BPS_PRECISION, BSC_ADDRESSES, type BigIntString, CHAIN_IDS, type CurrentFeeTier, type CurrentFees, type DepositParams, type DepositedEvent, DiamondABI, type ExpectedOutput, type FeeTier, type LSTInfo, type LSTYieldInfo, type MintApUSDParams, type MintXBNBParams, type OracleBounds, PHAROS_ADDRESSES, PRECISION, PRICE_PRECISION, type ProtocolStats, type RedeemAndSwapEvent, type RedeemApUSDParams, type RedeemXBNBParams, RouterABI, type RouterMintEvent, type RouterMintParams, type RouterMintParams2, type RouterRedeemAndSwapParams, type RouterRedeemAndUnstakeParams, type RouterRedeemEvent, type RouterRedeemParams, type RouterSwapParams, type StabilityMode2Info, type StabilityModeInfo, type StabilityPoolStats, type StakeAndMintEvent, type StakeAndMintParams, type SwapAndMintDefaultParams, type SwapAndMintEvent, type SwapAndMintParams, type TokenAddresses, type TransactionReceipt, type TransactionResult, type UnstakeClaimedEvent, type UnstakeRequestedEvent, type UserStabilityPoolPosition, type WithdrawParams, type WithdrawalRequestInfo, type WithdrawnEvent, type XBNBMintedEvent, type XBNBRedeemedEvent, type YieldHarvestedEvent, type YieldStats, calculateAPY, createAspanClient, createAspanPharosClient, createAspanPharosReadClient, createAspanReadClient, createAspanReadClientForChain, createAspanTestnetClient, createAspanTestnetReadClient, createAspanWriteClientForChain, createRouterClient, createRouterPharosClient, createRouterPharosReadClient, createRouterReadClient, createRouterReadClientForChain, createRouterTestnetClient, createRouterTestnetReadClient, createRouterWriteClientForChain, encodeV3Path, formatAmount, formatCR, formatFeeBPS, formatPriceUSD, getChainById, parseAmount, pharosTestnet };

package/dist/index.d.ts

@@ -97,14 +97,11 @@ interface RedeemXBNBParams {
 }
 /** Parameters for depositing to stability pool */
 interface DepositParams {
-    assets: bigint;
-    receiver: Address;
+    apUSDAmount: bigint;
 }
-/** Parameters for redeeming from stability pool */
-interface RedeemParams {
+/** Parameters for withdrawing from stability pool */
+interface WithdrawParams {
     shares: bigint;
-    receiver: Address;
-    owner: Address;
 }
 /** Overall protocol statistics */
 interface ProtocolStats {
@@ -580,11 +577,11 @@ declare class AspanClient extends AspanReadClient {
      */
     deposit(params: DepositParams): Promise<Hash>;
     /**
-     * Redeem from stability pool by shares
-     * @param params Redeem parameters
+     * Withdraw from stability pool by shares
+     * @param params Withdraw parameters
      * @returns Transaction hash
      */
-    redeem(params: RedeemParams): Promise<Hash>;
+    withdraw(params: WithdrawParams): Promise<Hash>;
     /**
      * Harvest yield from LSTs
      * @returns Transaction hash
@@ -1334,13 +1331,9 @@ declare const DiamondABI: readonly [{
     readonly type: "function";
     readonly name: "deposit";
     readonly inputs: readonly [{
-        readonly name: "assets";
+        readonly name: "_amount";
         readonly type: "uint256";
         readonly internalType: "uint256";
-    }, {
-        readonly name: "receiver";
-        readonly type: "address";
-        readonly internalType: "address";
     }];
     readonly outputs: readonly [{
         readonly name: "shares";
@@ -1350,26 +1343,14 @@ declare const DiamondABI: readonly [{
     readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
-    readonly name: "redeem";
+    readonly name: "withdraw";
     readonly inputs: readonly [{
-        readonly name: "shares";
+        readonly name: "_shares";
         readonly type: "uint256";
         readonly internalType: "uint256";
-    }, {
-        readonly name: "receiver";
-        readonly type: "address";
-        readonly internalType: "address";
-    }, {
-        readonly name: "owner";
-        readonly type: "address";
-        readonly internalType: "address";
     }];
     readonly outputs: readonly [{
-        readonly name: "apUSDOut";
-        readonly type: "uint256";
-        readonly internalType: "uint256";
-    }, {
-        readonly name: "xBNBOut";
+        readonly name: "assets";
         readonly type: "uint256";
         readonly internalType: "uint256";
     }];
@@ -2888,4 +2869,4 @@ declare function formatPriceUSD(price: bigint): string;
  */
 declare function calculateAPY(previousRate: bigint, currentRate: bigint, periodDays: number): number;
 
-export { type ApUSDMintedEvent, type ApUSDRedeemedEvent, AspanClient, type AspanClientConfig, AspanReadClient, AspanRouterClient, type AspanRouterClientConfig, AspanRouterReadClient, type AspanRouterWriteClientConfig, type AspanWriteClientConfig, BPS_PRECISION, BSC_ADDRESSES, type BigIntString, CHAIN_IDS, type CurrentFeeTier, type CurrentFees, type DepositParams, type DepositedEvent, DiamondABI, type ExpectedOutput, type FeeTier, type LSTInfo, type LSTYieldInfo, type MintApUSDParams, type MintXBNBParams, type OracleBounds, PHAROS_ADDRESSES, PRECISION, PRICE_PRECISION, type ProtocolStats, type RedeemAndSwapEvent, type RedeemApUSDParams, type RedeemParams, type RedeemXBNBParams, RouterABI, type RouterMintEvent, type RouterMintParams, type RouterMintParams2, type RouterRedeemAndSwapParams, type RouterRedeemAndUnstakeParams, type RouterRedeemEvent, type RouterRedeemParams, type RouterSwapParams, type StabilityMode2Info, type StabilityModeInfo, type StabilityPoolStats, type StakeAndMintEvent, type StakeAndMintParams, type SwapAndMintDefaultParams, type SwapAndMintEvent, type SwapAndMintParams, type TokenAddresses, type TransactionReceipt, type TransactionResult, type UnstakeClaimedEvent, type UnstakeRequestedEvent, type UserStabilityPoolPosition, type WithdrawalRequestInfo, type WithdrawnEvent, type XBNBMintedEvent, type XBNBRedeemedEvent, type YieldHarvestedEvent, type YieldStats, calculateAPY, createAspanClient, createAspanPharosClient, createAspanPharosReadClient, createAspanReadClient, createAspanReadClientForChain, createAspanTestnetClient, createAspanTestnetReadClient, createAspanWriteClientForChain, createRouterClient, createRouterPharosClient, createRouterPharosReadClient, createRouterReadClient, createRouterReadClientForChain, createRouterTestnetClient, createRouterTestnetReadClient, createRouterWriteClientForChain, encodeV3Path, formatAmount, formatCR, formatFeeBPS, formatPriceUSD, getChainById, parseAmount, pharosTestnet };
+export { type ApUSDMintedEvent, type ApUSDRedeemedEvent, AspanClient, type AspanClientConfig, AspanReadClient, AspanRouterClient, type AspanRouterClientConfig, AspanRouterReadClient, type AspanRouterWriteClientConfig, type AspanWriteClientConfig, BPS_PRECISION, BSC_ADDRESSES, type BigIntString, CHAIN_IDS, type CurrentFeeTier, type CurrentFees, type DepositParams, type DepositedEvent, DiamondABI, type ExpectedOutput, type FeeTier, type LSTInfo, type LSTYieldInfo, type MintApUSDParams, type MintXBNBParams, type OracleBounds, PHAROS_ADDRESSES, PRECISION, PRICE_PRECISION, type ProtocolStats, type RedeemAndSwapEvent, type RedeemApUSDParams, type RedeemXBNBParams, RouterABI, type RouterMintEvent, type RouterMintParams, type RouterMintParams2, type RouterRedeemAndSwapParams, type RouterRedeemAndUnstakeParams, type RouterRedeemEvent, type RouterRedeemParams, type RouterSwapParams, type StabilityMode2Info, type StabilityModeInfo, type StabilityPoolStats, type StakeAndMintEvent, type StakeAndMintParams, type SwapAndMintDefaultParams, type SwapAndMintEvent, type SwapAndMintParams, type TokenAddresses, type TransactionReceipt, type TransactionResult, type UnstakeClaimedEvent, type UnstakeRequestedEvent, type UserStabilityPoolPosition, type WithdrawParams, type WithdrawalRequestInfo, type WithdrawnEvent, type XBNBMintedEvent, type XBNBRedeemedEvent, type YieldHarvestedEvent, type YieldStats, calculateAPY, createAspanClient, createAspanPharosClient, createAspanPharosReadClient, createAspanReadClient, createAspanReadClientForChain, createAspanTestnetClient, createAspanTestnetReadClient, createAspanWriteClientForChain, createRouterClient, createRouterPharosClient, createRouterPharosReadClient, createRouterReadClient, createRouterReadClientForChain, createRouterTestnetClient, createRouterTestnetReadClient, createRouterWriteClientForChain, encodeV3Path, formatAmount, formatCR, formatFeeBPS, formatPriceUSD, getChainById, parseAmount, pharosTestnet };

package/dist/index.js

@@ -303,24 +303,18 @@ var DiamondABI = [
   {
     type: "function",
     name: "deposit",
-    inputs: [
-      { name: "assets", type: "uint256", internalType: "uint256" },
-      { name: "receiver", type: "address", internalType: "address" }
-    ],
+    inputs: [{ name: "_amount", type: "uint256", internalType: "uint256" }],
     outputs: [{ name: "shares", type: "uint256", internalType: "uint256" }],
     stateMutability: "nonpayable"
   },
   {
     type: "function",
-    name: "redeem",
+    name: "withdraw",
     inputs: [
-      { name: "shares", type: "uint256", internalType: "uint256" },
-      { name: "receiver", type: "address", internalType: "address" },
-      { name: "owner", type: "address", internalType: "address" }
+      { name: "_shares", type: "uint256", internalType: "uint256" }
     ],
     outputs: [
-      { name: "apUSDOut", type: "uint256", internalType: "uint256" },
-      { name: "xBNBOut", type: "uint256", internalType: "uint256" }
+      { name: "assets", type: "uint256", internalType: "uint256" }
     ],
     stateMutability: "nonpayable"
   },
@@ -1812,22 +1806,22 @@ var AspanClient = class extends AspanReadClient {
       address: this.diamondAddress,
       abi: DiamondABI,
       functionName: "deposit",
-      args: [params.assets, params.receiver]
+      args: [params.apUSDAmount]
     });
   }
   /**
-   * Redeem from stability pool by shares
-   * @param params Redeem parameters
+   * Withdraw from stability pool by shares
+   * @param params Withdraw parameters
    * @returns Transaction hash
    */
-  async redeem(params) {
+  async withdraw(params) {
     return this.walletClient.writeContract({
       chain: this.chain,
       account: this.walletClient.account,
       address: this.diamondAddress,
       abi: DiamondABI,
-      functionName: "redeem",
-      args: [params.shares, params.receiver, params.owner]
+      functionName: "withdraw",
+      args: [params.shares]
     });
   }
   /**

package/dist/index.mjs

@@ -245,24 +245,18 @@ var DiamondABI = [
   {
     type: "function",
     name: "deposit",
-    inputs: [
-      { name: "assets", type: "uint256", internalType: "uint256" },
-      { name: "receiver", type: "address", internalType: "address" }
-    ],
+    inputs: [{ name: "_amount", type: "uint256", internalType: "uint256" }],
     outputs: [{ name: "shares", type: "uint256", internalType: "uint256" }],
     stateMutability: "nonpayable"
   },
   {
     type: "function",
-    name: "redeem",
+    name: "withdraw",
     inputs: [
-      { name: "shares", type: "uint256", internalType: "uint256" },
-      { name: "receiver", type: "address", internalType: "address" },
-      { name: "owner", type: "address", internalType: "address" }
+      { name: "_shares", type: "uint256", internalType: "uint256" }
     ],
     outputs: [
-      { name: "apUSDOut", type: "uint256", internalType: "uint256" },
-      { name: "xBNBOut", type: "uint256", internalType: "uint256" }
+      { name: "assets", type: "uint256", internalType: "uint256" }
     ],
     stateMutability: "nonpayable"
   },
@@ -1754,22 +1748,22 @@ var AspanClient = class extends AspanReadClient {
       address: this.diamondAddress,
       abi: DiamondABI,
       functionName: "deposit",
-      args: [params.assets, params.receiver]
+      args: [params.apUSDAmount]
     });
   }
   /**
-   * Redeem from stability pool by shares
-   * @param params Redeem parameters
+   * Withdraw from stability pool by shares
+   * @param params Withdraw parameters
    * @returns Transaction hash
    */
-  async redeem(params) {
+  async withdraw(params) {
     return this.walletClient.writeContract({
       chain: this.chain,
       account: this.walletClient.account,
       address: this.diamondAddress,
       abi: DiamondABI,
-      functionName: "redeem",
-      args: [params.shares, params.receiver, params.owner]
+      functionName: "withdraw",
+      args: [params.shares]
     });
   }
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aspan/sdk",
-  "version": "0.4.9",
+  "version": "0.5.0",
   "description": "TypeScript SDK for Aspan Protocol - LST-backed stablecoin on BNB Chain",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/__tests__/risk.test.ts

@@ -1224,7 +1224,7 @@ describe.skipIf(!IS_FORK && !IS_LIVE)("Risk Control Tests", () => {
 
       await approve(TOKENS.apUSD, DIAMOND, depositedApUSD);
       try {
-        await waitTx(await diamondWrite.deposit({ assets: depositedApUSD, receiver: account.address }));
+        await waitTx(await diamondWrite.deposit({ apUSDAmount: depositedApUSD }));
       } catch (err: any) {
         console.log(`  ⚠️ Deposit failed (AccessControl or not configured): ${err.shortMessage || err.message?.slice(0, 100)}`);
         console.log(`  Skipping remaining FC-02 tests`);
@@ -1351,7 +1351,7 @@ describe.skipIf(!IS_FORK && !IS_LIVE)("Risk Control Tests", () => {
 
       console.log(`  Withdrawing ${formatAmount(currentShares)} shares...`);
       try {
-        await waitTx(await diamondWrite.redeem({ shares: currentShares, receiver: account.address, owner: account.address }));
+        await waitTx(await diamondWrite.withdraw({ shares: currentShares }));
       } catch (err: any) {
         console.log(`  ⚠️ Withdraw failed: ${err.shortMessage || err.message?.slice(0, 100)}`);
         return;

package/src/abi/diamond.ts

@@ -243,24 +243,18 @@ export const DiamondABI = [
   {
     type: "function",
     name: "deposit",
-    inputs: [
-      { name: "assets", type: "uint256", internalType: "uint256" },
-      { name: "receiver", type: "address", internalType: "address" }
-    ],
+    inputs: [{ name: "_amount", type: "uint256", internalType: "uint256" }],
     outputs: [{ name: "shares", type: "uint256", internalType: "uint256" }],
     stateMutability: "nonpayable"
   },
   {
     type: "function",
-    name: "redeem",
+    name: "withdraw",
     inputs: [
-      { name: "shares", type: "uint256", internalType: "uint256" },
-      { name: "receiver", type: "address", internalType: "address" },
-      { name: "owner", type: "address", internalType: "address" }
+      { name: "_shares", type: "uint256", internalType: "uint256" }
     ],
     outputs: [
-      { name: "apUSDOut", type: "uint256", internalType: "uint256" },
-      { name: "xBNBOut", type: "uint256", internalType: "uint256" }
+      { name: "assets", type: "uint256", internalType: "uint256" }
     ],
     stateMutability: "nonpayable"
   },

package/src/client.ts

@@ -74,7 +74,7 @@ import type {
   MintXBNBParams,
   RedeemXBNBParams,
   DepositParams,
-  RedeemParams,
+  WithdrawParams,
 } from "./types";
 
 // ============ Configuration ============
@@ -1190,23 +1190,23 @@ export class AspanClient extends AspanReadClient {
       address: this.diamondAddress,
       abi: DiamondABI,
       functionName: "deposit",
-      args: [params.assets, params.receiver],
+      args: [params.apUSDAmount],
     });
   }
 
   /**
-   * Redeem from stability pool by shares
-   * @param params Redeem parameters
+   * Withdraw from stability pool by shares
+   * @param params Withdraw parameters
    * @returns Transaction hash
    */
-  async redeem(params: RedeemParams): Promise<Hash> {
+  async withdraw(params: WithdrawParams): Promise<Hash> {
     return this.walletClient.writeContract({
       chain: this.chain,
       account: this.walletClient.account!,
       address: this.diamondAddress,
       abi: DiamondABI,
-      functionName: "redeem",
-      args: [params.shares, params.receiver, params.owner],
+      functionName: "withdraw",
+      args: [params.shares],
     });
   }
 

package/src/index.ts

@@ -67,7 +67,7 @@ export type {
   MintXBNBParams,
   RedeemXBNBParams,
   DepositParams,
-  RedeemParams,
+  WithdrawParams,
   // Events
   ApUSDMintedEvent,
   ApUSDRedeemedEvent,

package/src/types.ts

@@ -120,15 +120,12 @@ export interface RedeemXBNBParams {
 
 /** Parameters for depositing to stability pool */
 export interface DepositParams {
-  assets: bigint;
-  receiver: Address;
+  apUSDAmount: bigint;
 }
 
-/** Parameters for redeeming from stability pool */
-export interface RedeemParams {
+/** Parameters for withdrawing from stability pool */
+export interface WithdrawParams {
   shares: bigint;
-  receiver: Address;
-  owner: Address;
 }
 
 // ============ Protocol Stats ============