stable-layer-sdk 3.0.0 → 3.1.0

package/dist/types/index.d.ts

@@ -1,12 +1,23 @@
-import { BurnTransactionParams, ClaimTransactionParams, CoinResult, MintTransactionParams, StableLayerConfig } from "./interface.js";
+import { BurnTransactionParams, ClaimRewardUsdbAmountParams, ClaimTransactionParams, CoinResult, MintTransactionParams, SetMaxSupplyTransactionParams, StableLayerConfig } from "./interface.js";
 export declare class StableLayerClient {
     private bucketClient;
     private suiClient;
     private sender;
-    constructor(config: StableLayerConfig);
+    private network;
+    private mockFarmRegistryId?;
+    private mockFarmPackageId?;
+    private mockUsdbCoinType?;
+    static getConstants(network: import("./interface.js").Network): import("./libs/constants.js").Constants;
+    getConstants(): import("./libs/constants.js").Constants;
+    static initialize(config: StableLayerConfig): Promise<StableLayerClient>;
+    private constructor();
+    private getMockFarmPackageId;
+    private getMockFarmEntityType;
     buildMintTx({ tx, stableCoinType, usdcCoin, sender, autoTransfer, }: MintTransactionParams): Promise<CoinResult | undefined>;
     buildBurnTx({ tx, stableCoinType, amount, all, sender, autoTransfer, }: BurnTransactionParams): Promise<CoinResult | undefined>;
     buildClaimTx({ tx, stableCoinType, sender, autoTransfer, }: ClaimTransactionParams): Promise<CoinResult | undefined>;
+    getClaimRewardUsdbAmount({ stableCoinType, sender, }: ClaimRewardUsdbAmountParams): Promise<bigint>;
+    buildSetMaxSupplyTx({ tx, registry, factoryCapId, maxSupply, stableCoinType, usdCoinType, sender, }: SetMaxSupplyTransactionParams): void;
     getTotalSupply(): Promise<string | undefined>;
     getTotalSupplyByCoinType(stableCoinType: string): Promise<string | undefined>;
     private getBucketSavingPool;
@@ -14,3 +25,6 @@ export declare class StableLayerClient {
     private checkResponse;
     private releaseRewards;
 }
+export * from "./libs/constants.js";
+export { STABLE_REGISTRY_MAINNET_ALT, STABLE_LAYER_PACKAGE_MAINNET_ALT, } from "./libs/constants.mainnet.js";
+export type { ClaimRewardUsdbAmountParams, SetMaxSupplyTransactionParams } from "./interface.js";

package/dist/types/interface.d.ts

@@ -1,7 +1,22 @@
+import type { ConfigType } from "@bucket-protocol/sdk";
+import type { SuiGrpcClient } from "@mysten/sui/grpc";
 import { Transaction, TransactionArgument, TransactionResult } from "@mysten/sui/transactions";
+export type Network = "mainnet" | "testnet";
 export interface StableLayerConfig {
-    network: "mainnet" | "testnet";
+    network: Network;
     sender: string;
+    /** Custom RPC URL. Falls back to SUI_GRPC_URL env or default fullnode URL. */
+    baseUrl?: string;
+    /** Pre-instantiated SuiGrpcClient. When provided, baseUrl is ignored. */
+    suiClient?: SuiGrpcClient;
+    /** Override entry config object ID for BucketClient (e.g. for testing). */
+    configObjectId?: string;
+    /** Config overrides passed to BucketClient.initialize (e.g. PRICE_SERVICE_ENDPOINT). */
+    configOverrides?: Partial<ConfigType>;
+    /** Testnet: optional mock_farm registry, package ID, and mock USDB type for claim preview. */
+    mockFarmRegistryId?: string;
+    mockFarmPackageId?: string;
+    mockUsdbCoinType?: string;
 }
 export interface MintTransactionParams {
     tx: Transaction;
@@ -25,4 +40,17 @@ export interface ClaimTransactionParams {
     sender?: string;
     autoTransfer?: boolean;
 }
+export interface ClaimRewardUsdbAmountParams {
+    stableCoinType: string;
+    sender: string;
+}
+export interface SetMaxSupplyTransactionParams {
+    tx: Transaction;
+    registry: string;
+    factoryCapId: string;
+    maxSupply: bigint;
+    stableCoinType: string;
+    usdCoinType: string;
+    sender?: string;
+}
 export type CoinResult = TransactionResult | TransactionResult[number];

package/dist/types/libs/constants.d.ts

@@ -1,12 +1,31 @@
-export declare const STABLE_VAULT = "0x65f38160110cd6859d05f338ff54b4f462883bb6f87c667a65c0fb0e537410a7";
-export declare const USDC_TYPE = "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC";
-export declare const STABLE_LP_TYPE = "0xb75744fadcbfc174627567ca29645d0af8f6e6fd01b6f57c75a08cd3fb97c567::lake_usdc::LakeUSDC";
-export declare const YUSDB_TYPE = "0xac718b4b672d7f461fe7e86847166ff9c23cadba217397f0848a95bdea1f1051::yesusdb::YesUSDB";
-export declare const STABLE_LAYER_PACKAGE_ID = "0xa4a78d8d3d1df62fb81d10068142e79b0d30ad4e3f578060487e36ed9ea764da";
-export declare const STABLE_VAULT_FARM_PACKAGE_ID = "0x00d31ddaa73a56abcc3e2d885ac1e1d90f9ae0e38bbef2ba2923550c8250de4d";
-export declare const SAVING_TYPE = "0x38f61c75fa8407140294c84167dd57684580b55c3066883b48dedc344b1cde1e::susdb::SUSDB";
-export declare const YIELD_VAULT = "0x0a7f6325253157cd437812fea0ceee9a6b96f2ec5eac410da6df39558ff3a4d1";
-export declare const STABLE_REGISTRY = "0x213f4d584c0770f455bb98c94a4ee5ea9ddbc3d4ebb98a0ad6d093eb6da41642";
-export declare const STABLE_VAULT_FARM_ENTITY_TYPE = "0xc1025fe014b03d33b207b5afb0ba04293be87fab438c1418a26a75c2fe05c223::stable_vault_farm::StableVaultFarmEntity<0xb75744fadcbfc174627567ca29645d0af8f6e6fd01b6f57c75a08cd3fb97c567::lake_usdc::LakeUSDC, 0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC>";
-export declare const STABLE_VAULT_FARM = "0xe958b7d102b33bf3c09addb0e2cdff102ff2c93afe407ec5c2a541e8959a650c";
-export declare const YIELD_USDB_PACKAGE_ID = "0x3dcbf82f7e3b80ed65cee596612602a6c7e78c71fd40f6455b40ad033ed04786";
+import type { Network } from "../interface.js";
+export type Constants = {
+    STABLE_VAULT: string;
+    USDC_TYPE: string;
+    STABLE_LP_TYPE: string;
+    YUSDB_TYPE: string;
+    STABLE_LAYER_PACKAGE_ID: string;
+    STABLE_VAULT_FARM_PACKAGE_ID: string;
+    SAVING_TYPE: string;
+    YIELD_VAULT: string;
+    STABLE_REGISTRY: string;
+    STABLE_VAULT_FARM: string;
+    YIELD_USDB_PACKAGE_ID: string;
+    STABLE_VAULT_FARM_ENTITY_TYPE: string;
+    MOCK_FARM_PACKAGE_ID: string;
+    MOCK_FARM_REGISTRY: string;
+    MOCK_USDB_TYPE: string;
+};
+export declare function getConstants(network: Network): Constants;
+export declare const STABLE_VAULT: "0x65f38160110cd6859d05f338ff54b4f462883bb6f87c667a65c0fb0e537410a7";
+export declare const USDC_TYPE: "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC";
+export declare const STABLE_LP_TYPE: "0xb75744fadcbfc174627567ca29645d0af8f6e6fd01b6f57c75a08cd3fb97c567::lake_usdc::LakeUSDC";
+export declare const YUSDB_TYPE: "0xac718b4b672d7f461fe7e86847166ff9c23cadba217397f0848a95bdea1f1051::yesusdb::YesUSDB";
+export declare const STABLE_LAYER_PACKAGE_ID: "0xa4a78d8d3d1df62fb81d10068142e79b0d30ad4e3f578060487e36ed9ea764da";
+export declare const STABLE_VAULT_FARM_PACKAGE_ID: "0x00d31ddaa73a56abcc3e2d885ac1e1d90f9ae0e38bbef2ba2923550c8250de4d";
+export declare const SAVING_TYPE: "0x38f61c75fa8407140294c84167dd57684580b55c3066883b48dedc344b1cde1e::susdb::SUSDB";
+export declare const YIELD_VAULT: "0x0a7f6325253157cd437812fea0ceee9a6b96f2ec5eac410da6df39558ff3a4d1";
+export declare const STABLE_REGISTRY: "0x213f4d584c0770f455bb98c94a4ee5ea9ddbc3d4ebb98a0ad6d093eb6da41642";
+export declare const STABLE_VAULT_FARM: "0xe958b7d102b33bf3c09addb0e2cdff102ff2c93afe407ec5c2a541e8959a650c";
+export declare const YIELD_USDB_PACKAGE_ID: "0x3dcbf82f7e3b80ed65cee596612602a6c7e78c71fd40f6455b40ad033ed04786";
+export declare const STABLE_VAULT_FARM_ENTITY_TYPE: string;

package/dist/types/libs/constants.mainnet.d.ts

@@ -0,0 +1,20 @@
+/** Alternate mainnet deployment — registry 0x213f4d58... belongs to this package */
+export declare const STABLE_REGISTRY_MAINNET_ALT = "0x213f4d584c0770f455bb98c94a4ee5ea9ddbc3d4ebb98a0ad6d093eb6da41642";
+export declare const STABLE_LAYER_PACKAGE_MAINNET_ALT = "0x41e25d09e20cf3bc43fe321e51ef178fac419ae47b783a7161982158fc9f17d6";
+/** Mainnet object IDs and type strings */
+export declare const MAINNET: {
+    readonly STABLE_VAULT: "0x65f38160110cd6859d05f338ff54b4f462883bb6f87c667a65c0fb0e537410a7";
+    readonly USDC_TYPE: "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC";
+    readonly STABLE_LP_TYPE: "0xb75744fadcbfc174627567ca29645d0af8f6e6fd01b6f57c75a08cd3fb97c567::lake_usdc::LakeUSDC";
+    readonly YUSDB_TYPE: "0xac718b4b672d7f461fe7e86847166ff9c23cadba217397f0848a95bdea1f1051::yesusdb::YesUSDB";
+    readonly STABLE_LAYER_PACKAGE_ID: "0xa4a78d8d3d1df62fb81d10068142e79b0d30ad4e3f578060487e36ed9ea764da";
+    readonly STABLE_REGISTRY_MAINNET_ALT: "0x213f4d584c0770f455bb98c94a4ee5ea9ddbc3d4ebb98a0ad6d093eb6da41642";
+    readonly STABLE_LAYER_PACKAGE_MAINNET_ALT: "0x41e25d09e20cf3bc43fe321e51ef178fac419ae47b783a7161982158fc9f17d6";
+    readonly STABLE_VAULT_FARM_PACKAGE_ID: "0x00d31ddaa73a56abcc3e2d885ac1e1d90f9ae0e38bbef2ba2923550c8250de4d";
+    readonly SAVING_TYPE: "0x38f61c75fa8407140294c84167dd57684580b55c3066883b48dedc344b1cde1e::susdb::SUSDB";
+    readonly YIELD_VAULT: "0x0a7f6325253157cd437812fea0ceee9a6b96f2ec5eac410da6df39558ff3a4d1";
+    readonly STABLE_REGISTRY: "0x213f4d584c0770f455bb98c94a4ee5ea9ddbc3d4ebb98a0ad6d093eb6da41642";
+    readonly STABLE_VAULT_FARM: "0xe958b7d102b33bf3c09addb0e2cdff102ff2c93afe407ec5c2a541e8959a650c";
+    readonly YIELD_USDB_PACKAGE_ID: "0x3dcbf82f7e3b80ed65cee596612602a6c7e78c71fd40f6455b40ad033ed04786";
+};
+export declare const STABLE_VAULT_FARM_ENTITY_TYPE_MAINNET: string;

package/dist/types/libs/constants.testnet.d.ts

@@ -0,0 +1,22 @@
+export declare const MOCK_FARM_PACKAGE_ID_TESTNET: "0x3a55ec8fabe5f3e982908ed3a7c3065f26e83ab226eb8d3450177dbaac25878b";
+export declare const MOCK_FARM_ORIGINAL_PACKAGE_ID_TESTNET: "0x673d4118c17de717b0b90c326f8f52f87b5fff8678f513edd2ae575a55175954";
+export declare const MOCK_FARM_REGISTRY_TESTNET: "0xc3e8d2e33e36f6a4b5c199fe2dde3ba6dc29e7af8dd045c86e62d7c21f374d02";
+export declare const MOCK_USDB_TYPE_TESTNET: "0x673d4118c17de717b0b90c326f8f52f87b5fff8678f513edd2ae575a55175954::usdb::USDB";
+export declare const TESTNET: {
+    readonly STABLE_LAYER_PACKAGE_ID: "0x9c248c80c3a757167780f17e0c00a4d293280be7276f1b81a153f6e47d2567c9";
+    readonly STABLE_REGISTRY: "0xfa0fd96e0fbc07dc6bdc23cc1ac5b4c0056f4b469b9db0a70b6ea01c14a4c7b5";
+    readonly USDC_TYPE: "0xa1ec7fc00a6f40db9693ad1415d0c193ad3906494428cf252621037bd7117e29::usdc::USDC";
+    readonly STABLE_VAULT_FARM_ENTITY_TYPE: "0x673d4118c17de717b0b90c326f8f52f87b5fff8678f513edd2ae575a55175954::farm::MockFarmEntity";
+    readonly MOCK_FARM_PACKAGE_ID: "0x3a55ec8fabe5f3e982908ed3a7c3065f26e83ab226eb8d3450177dbaac25878b";
+    readonly MOCK_FARM_REGISTRY: "0xc3e8d2e33e36f6a4b5c199fe2dde3ba6dc29e7af8dd045c86e62d7c21f374d02";
+    readonly MOCK_USDB_TYPE: "0x673d4118c17de717b0b90c326f8f52f87b5fff8678f513edd2ae575a55175954::usdb::USDB";
+    readonly STABLE_VAULT: "";
+    readonly STABLE_LP_TYPE: "";
+    readonly YUSDB_TYPE: "";
+    readonly STABLE_VAULT_FARM_PACKAGE_ID: "";
+    readonly SAVING_TYPE: "";
+    readonly YIELD_VAULT: "";
+    readonly STABLE_VAULT_FARM: "";
+    readonly YIELD_USDB_PACKAGE_ID: "";
+};
+export declare const STABLE_VAULT_FARM_ENTITY_TYPE_TESTNET: "0x673d4118c17de717b0b90c326f8f52f87b5fff8678f513edd2ae575a55175954::farm::MockFarmEntity";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stable-layer-sdk",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "A TypeScript SDK for Stable Layer",
   "repository": {
     "type": "git",
@@ -38,6 +38,9 @@
     "build:types": "tsc --emitDeclarationOnly --declaration --outDir dist",
     "dev": "tsc --watch",
     "test": "vitest",
+    "test:e2e:testnet": "vitest run --config vitest.e2e-testnet.config.ts",
+    "query-output": "QUERY_OUTPUT=1 vitest run",
+    "sl:mint": "node ./scripts/sl-mint.mjs",
     "format": "prettier --write .",
     "format:check": "prettier --check ."
   },
@@ -62,7 +65,7 @@
     "vitest": "^4.0.7"
   },
   "dependencies": {
-    "@bucket-protocol/sdk": "2.0.0"
+    "@bucket-protocol/sdk": "^2.1.0"
   },
   "peerDependencies": {
     "@mysten/bcs": ">=2.0.0",