stable-layer-sdk 1.0.6 → 2.0.0

package/README.md

@@ -0,0 +1,147 @@
+# Stable Layer SDK
+
+TypeScript SDK for the [Stable Layer](https://github.com/StableLayer/stable-layer-sdk) protocol on Sui blockchain. Mint and burn stablecoins, and claim yield farming rewards.
+
+## Installation
+
+```bash
+npm install stable-layer-sdk @mysten/sui @mysten/bcs
+```
+
+## Quick Start
+
+```typescript
+import { StableLayerClient } from "stable-layer-sdk";
+
+const client = new StableLayerClient({
+  network: "mainnet",
+  sender: "0xYOUR_ADDRESS",
+});
+```
+
+## Examples
+
+### Mint Stablecoins
+
+Deposit USDC to mint stablecoins. The SDK builds a transaction that mints via Stable Layer and deposits into the vault farm.
+
+```typescript
+import { Transaction, coinWithBalance } from "@mysten/sui/transactions";
+
+const tx = new Transaction();
+
+// Mint with auto-transfer (coin sent to sender automatically)
+await client.buildMintTx({
+  tx,
+  stableCoinType: "0x6d9fc...::btc_usdc::BtcUSDC",
+  usdcCoin: coinWithBalance({
+    balance: BigInt(1_000_000),
+    type: "0xdba34...::usdc::USDC",
+  })(tx),
+  amount: BigInt(1_000_000),
+});
+
+// Or get the coin back for further composition
+const coin = await client.buildMintTx({
+  tx,
+  stableCoinType: "0x6d9fc...::btc_usdc::BtcUSDC",
+  usdcCoin: coinWithBalance({
+    balance: BigInt(1_000_000),
+    type: "0xdba34...::usdc::USDC",
+  })(tx),
+  amount: BigInt(1_000_000),
+  autoTransfer: false,
+});
+```
+
+### Burn Stablecoins
+
+Burn stablecoins to redeem USDC.
+
+```typescript
+const tx = new Transaction();
+
+// Burn a specific amount
+await client.buildBurnTx({
+  tx,
+  stableCoinType: "0x6d9fc...::btc_usdc::BtcUSDC",
+  amount: BigInt(1_000_000),
+});
+
+// Or burn entire balance
+await client.buildBurnTx({
+  tx,
+  stableCoinType: "0x6d9fc...::btc_usdc::BtcUSDC",
+  all: true,
+});
+```
+
+### Claim Rewards
+
+Claim accumulated yield farming rewards.
+
+```typescript
+const tx = new Transaction();
+
+await client.buildClaimTx({
+  tx,
+  stableCoinType: "0x6d9fc...::btc_usdc::BtcUSDC",
+});
+```
+
+### Query Total Supply
+
+```typescript
+// Total supply across all coin types
+const totalSupply = await client.getTotalSupply();
+
+// Total supply for a specific coin type
+const btcUsdcSupply = await client.getTotalSupplyByCoinType(
+  "0x6d9fc...::btc_usdc::BtcUSDC",
+);
+```
+
+### Signing and Executing
+
+All `build*` methods return a `Transaction` that you sign and execute with the Sui SDK:
+
+```typescript
+import { SuiClient, getFullnodeUrl } from "@mysten/sui/client";
+import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519";
+
+const suiClient = new SuiClient({ url: getFullnodeUrl("mainnet") });
+const keypair = Ed25519Keypair.fromSecretKey(YOUR_PRIVATE_KEY);
+
+const tx = new Transaction();
+await client.buildMintTx({ tx, /* ... */ });
+
+const result = await suiClient.signAndExecuteTransaction({
+  transaction: tx,
+  signer: keypair,
+});
+```
+
+## API
+
+### `new StableLayerClient(config)`
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `config.network` | `"mainnet" \| "testnet"` | Sui network |
+| `config.sender` | `string` | Default sender address |
+
+### Transaction Methods
+
+All methods accept a `tx` (Transaction) and optional `sender` to override the default. Set `autoTransfer: false` to get the resulting coin back instead of auto-transferring.
+
+| Method | Description |
+|--------|-------------|
+| `buildMintTx(params)` | Mint stablecoins from USDC |
+| `buildBurnTx(params)` | Burn stablecoins to redeem USDC |
+| `buildClaimTx(params)` | Claim yield farming rewards |
+| `getTotalSupply()` | Get total supply from registry |
+| `getTotalSupplyByCoinType(type)` | Get total supply for a specific coin type |
+
+## License
+
+MIT

package/dist/cjs/index.cjs

@@ -30,18 +30,14 @@ var STABLE_VAULT = "0x65f38160110cd6859d05f338ff54b4f462883bb6f87c667a65c0fb0e53
 var USDC_TYPE = "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC";
 var STABLE_LP_TYPE = "0xb75744fadcbfc174627567ca29645d0af8f6e6fd01b6f57c75a08cd3fb97c567::lake_usdc::LakeUSDC";
 var YUSDB_TYPE = "0xac718b4b672d7f461fe7e86847166ff9c23cadba217397f0848a95bdea1f1051::yesusdb::YesUSDB";
-var STABLE_LAYER_PACKAGE_ID = "0x41e25d09e20cf3bc43fe321e51ef178fac419ae47b783a7161982158fc9f17d6";
-var STABLE_VAULT_FARM_PACKAGE_ID = "0xd5b9fb5a964fa9c274e07a788d7b6d36d8df1c73e2e6f795f8db852621470b70";
+var STABLE_LAYER_PACKAGE_ID = "0xa4a78d8d3d1df62fb81d10068142e79b0d30ad4e3f578060487e36ed9ea764da";
+var STABLE_VAULT_FARM_PACKAGE_ID = "0x00d31ddaa73a56abcc3e2d885ac1e1d90f9ae0e38bbef2ba2923550c8250de4d";
 var SAVING_TYPE = "0x38f61c75fa8407140294c84167dd57684580b55c3066883b48dedc344b1cde1e::susdb::SUSDB";
 var YIELD_VAULT = "0x0a7f6325253157cd437812fea0ceee9a6b96f2ec5eac410da6df39558ff3a4d1";
 var STABLE_REGISTRY = "0x213f4d584c0770f455bb98c94a4ee5ea9ddbc3d4ebb98a0ad6d093eb6da41642";
 var STABLE_VAULT_FARM_ENTITY_TYPE = `0xc1025fe014b03d33b207b5afb0ba04293be87fab438c1418a26a75c2fe05c223::stable_vault_farm::StableVaultFarmEntity<${STABLE_LP_TYPE}, ${USDC_TYPE}>`;
 var STABLE_VAULT_FARM = "0xe958b7d102b33bf3c09addb0e2cdff102ff2c93afe407ec5c2a541e8959a650c";
-var YIELD_USDB_PACKAGE_ID = "0x203eebc39442014a1b8180f3b8ed70143dac2c5d28ba5703fe34c21052728705";
-var BTC_USD_TYPE = "0x6d9fc33611f4881a3f5c0cd4899d95a862236ce52b3a38fef039077b0c5b5834::btc_usdc::BtcUSDC";
-var STABLE_COIN_TYPES = {
-  btcUSDC: BTC_USD_TYPE
-};
+var YIELD_USDB_PACKAGE_ID = "0x3dcbf82f7e3b80ed65cee596612602a6c7e78c71fd40f6455b40ad033ed04786";
 
 // src/index.ts
 var import_client = require("@mysten/sui/client");
@@ -642,7 +638,7 @@ var StableLayerClient = class {
   }
   async buildMintTx({
     tx,
-    lpToken,
+    stableCoinType,
     usdcCoin,
     sender,
     autoTransfer = true
@@ -655,7 +651,7 @@ var StableLayerClient = class {
         uCoin: usdcCoin
       },
       typeArguments: [
-        STABLE_COIN_TYPES[lpToken],
+        stableCoinType,
         USDC_TYPE,
         STABLE_VAULT_FARM_ENTITY_TYPE
       ]
@@ -668,7 +664,7 @@ var StableLayerClient = class {
       typeArguments: [
         STABLE_LP_TYPE,
         USDC_TYPE,
-        STABLE_COIN_TYPES[lpToken],
+        stableCoinType,
         YUSDB_TYPE,
         SAVING_TYPE
       ],
@@ -693,7 +689,7 @@ var StableLayerClient = class {
   }
   async buildBurnTx({
     tx,
-    lpToken,
+    stableCoinType,
     amount,
     all,
     sender,
@@ -707,10 +703,10 @@ var StableLayerClient = class {
       balance: all ? BigInt(
         (await this.suiClient.getBalance({
           owner: sender ?? this.sender,
-          coinType: STABLE_COIN_TYPES[lpToken]
+          coinType: stableCoinType
         })).totalBalance
       ) : amount,
-      type: STABLE_COIN_TYPES[lpToken]
+      type: stableCoinType
     });
     this.releaseRewards(tx);
     const burnRequest = requestBurn({
@@ -719,10 +715,7 @@ var StableLayerClient = class {
         registry: STABLE_REGISTRY,
         stableCoin: btcUsdCoin
       },
-      typeArguments: [
-        STABLE_COIN_TYPES[lpToken],
-        USDC_TYPE
-      ]
+      typeArguments: [stableCoinType, USDC_TYPE]
     })(tx);
     const [uPrice] = await this.bucketClient.aggregatePrices(tx, {
       coinTypes: [USDC_TYPE]
@@ -742,7 +735,7 @@ var StableLayerClient = class {
       typeArguments: [
         STABLE_LP_TYPE,
         USDC_TYPE,
-        STABLE_COIN_TYPES[lpToken],
+        stableCoinType,
         YUSDB_TYPE,
         SAVING_TYPE
       ]
@@ -754,10 +747,7 @@ var StableLayerClient = class {
         registry: STABLE_REGISTRY,
         burnRequest
       },
-      typeArguments: [
-        STABLE_COIN_TYPES[lpToken],
-        USDC_TYPE
-      ]
+      typeArguments: [stableCoinType, USDC_TYPE]
     })(tx);
     if (autoTransfer) {
       tx.transferObjects([usdcCoin], sender ?? this.sender);
@@ -768,7 +758,7 @@ var StableLayerClient = class {
   }
   async buildClaimTx({
     tx,
-    lpToken,
+    stableCoinType,
     sender,
     autoTransfer = true
   }) {
@@ -787,7 +777,7 @@ var StableLayerClient = class {
       typeArguments: [
         STABLE_LP_TYPE,
         USDC_TYPE,
-        STABLE_COIN_TYPES[lpToken],
+        stableCoinType,
         YUSDB_TYPE,
         SAVING_TYPE
       ]
@@ -810,12 +800,14 @@ var StableLayerClient = class {
     const content = result.data?.content;
     return content?.fields?.total_supply;
   }
-  async getTotalSupplyByCoinName(coinName) {
+  async getTotalSupplyByCoinType(stableCoinType) {
     const result = await this.suiClient.getDynamicFieldObject({
       parentId: STABLE_REGISTRY,
       name: {
         type: "0x1::type_name::TypeName",
-        value: STABLE_COIN_TYPES[coinName]
+        value: {
+          name: stableCoinType.slice(2)
+        }
       }
     });
     const content = result.data?.content;