stable-layer-sdk 0.0.3 → 1.0.1

package/dist/index.js

@@ -1,33 +1,238 @@
-"use strict";
-/**
- * Stable Layer SDK
- * A simple hello world SDK for testing
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Greeter = void 0;
-exports.hello = hello;
-exports.getVersion = getVersion;
-/**
- * Returns a hello world message
- */
-function hello(name) {
-    return `Hello, ${name || 'World'}!`;
-}
-/**
- * A simple greeting class
- */
-class Greeter {
-    constructor(name) {
-        this.name = name;
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { coinWithBalance, } from "@mysten/sui/transactions";
+import * as constants from "./libs/constants";
+import { BucketClient } from "@bucket-protocol/sdk";
+import { getFullnodeUrl, SuiClient } from "@mysten/sui/client";
+import { release } from "./generated/yield_usdb/yield_usdb";
+import { fulfillBurn, mint, requestBurn, } from "./generated/stable_layer/stable_layer";
+import { claim, pay, receive, } from "./generated/stable_vault_farm/stable_vault_farm";
+import { STABLE_REGISTRY } from "./libs/constants";
+export class StableLayerSDK {
+    constructor(config) {
+        this.bucketClient = new BucketClient({ network: config.network });
+        this.suiClient = new SuiClient({ url: getFullnodeUrl(config.network) });
+        this.sender = config.sender;
     }
-    greet() {
-        return `Hello from ${this.name}!`;
+    buildMintTx(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ tx, coinName, amount, sender, }) {
+            tx.setSender(sender !== null && sender !== void 0 ? sender : this.sender);
+            const usdcCoin = coinWithBalance({
+                balance: amount,
+                type: constants.USDC_TYPE,
+            });
+            if (!usdcCoin) {
+                throw new Error("No USDC found");
+            }
+            const [stableCoin, loan] = mint({
+                package: constants.STABLE_LAYER_PACKAGE_ID,
+                arguments: {
+                    registry: constants.STABLE_REGISTRY,
+                    uCoin: usdcCoin,
+                },
+                typeArguments: [
+                    constants.STABLE_COIN_TYPES[coinName],
+                    constants.USDC_TYPE,
+                    constants.STABLE_VAULT_FARM_ENTITY_TYPE,
+                ],
+            })(tx);
+            const [uPrice] = yield this.bucketClient.aggregatePrices(tx, {
+                coinTypes: [constants.USDC_TYPE],
+            });
+            const depositResponse = receive({
+                package: constants.STABLE_VAULT_FARM_PACKAGE_ID,
+                typeArguments: [
+                    constants.STABLE_LP_TYPE,
+                    constants.USDC_TYPE,
+                    constants.STABLE_COIN_TYPES[coinName],
+                    constants.YUSDB_TYPE,
+                    constants.SAVING_TYPE,
+                ],
+                arguments: {
+                    farm: constants.STABLE_VAULT_FARM,
+                    loan,
+                    stableVault: constants.STABLE_VAULT,
+                    usdbTreasury: this.bucketClient.treasury(tx),
+                    psmPool: this.getBucketPSMPool(tx),
+                    savingPool: this.getBucketSavingPool(tx),
+                    yieldVault: constants.YIELD_VAULT,
+                    uPrice,
+                },
+            })(tx);
+            this.checkResponse({ tx, response: depositResponse, type: "deposit" });
+            tx.transferObjects([stableCoin], sender !== null && sender !== void 0 ? sender : this.sender);
+            return tx;
+        });
+    }
+    buildBurnTx(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ tx, coinName, amount, all, sender, }) {
+            tx.setSender(sender !== null && sender !== void 0 ? sender : this.sender);
+            if (!all && !amount) {
+                throw new Error("Amount or all must be provided");
+            }
+            const btcUsdCoin = coinWithBalance({
+                balance: all
+                    ? BigInt((yield this.suiClient.getBalance({
+                        owner: sender !== null && sender !== void 0 ? sender : this.sender,
+                        coinType: constants.STABLE_COIN_TYPES[coinName],
+                    })).totalBalance)
+                    : amount,
+                type: constants.STABLE_COIN_TYPES[coinName],
+            })(tx);
+            if (!btcUsdCoin) {
+                throw new Error("No BTCUSD coin found");
+            }
+            this.releaseRewards(tx);
+            const burnRequest = requestBurn({
+                package: constants.STABLE_LAYER_PACKAGE_ID,
+                arguments: {
+                    registry: constants.STABLE_REGISTRY,
+                    stableCoin: btcUsdCoin,
+                },
+                typeArguments: [
+                    constants.STABLE_COIN_TYPES[coinName],
+                    constants.USDC_TYPE,
+                ],
+            })(tx);
+            const [uPrice] = yield this.bucketClient.aggregatePrices(tx, {
+                coinTypes: [constants.USDC_TYPE],
+            });
+            const withdrawResponse = pay({
+                package: constants.STABLE_VAULT_FARM_PACKAGE_ID,
+                arguments: {
+                    farm: constants.STABLE_VAULT_FARM,
+                    request: burnRequest,
+                    stableVault: constants.STABLE_VAULT,
+                    usdbTreasury: this.bucketClient.treasury(tx),
+                    psmPool: this.getBucketPSMPool(tx),
+                    savingPool: this.getBucketSavingPool(tx),
+                    yieldVault: constants.YIELD_VAULT,
+                    uPrice,
+                },
+                typeArguments: [
+                    constants.STABLE_LP_TYPE,
+                    constants.USDC_TYPE,
+                    constants.STABLE_COIN_TYPES[coinName],
+                    constants.YUSDB_TYPE,
+                    constants.SAVING_TYPE,
+                ],
+            })(tx);
+            this.checkResponse({ tx, response: withdrawResponse, type: "withdraw" });
+            const usdcCoin = fulfillBurn({
+                package: constants.STABLE_LAYER_PACKAGE_ID,
+                arguments: {
+                    registry: constants.STABLE_REGISTRY,
+                    burnRequest,
+                },
+                typeArguments: [
+                    constants.STABLE_COIN_TYPES[coinName],
+                    constants.USDC_TYPE,
+                ],
+            })(tx);
+            tx.transferObjects([usdcCoin], sender !== null && sender !== void 0 ? sender : this.sender);
+            return tx;
+        });
+    }
+    buildClaimTx(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ tx, coinName, sender, }) {
+            tx.setSender(sender !== null && sender !== void 0 ? sender : this.sender);
+            this.releaseRewards(tx);
+            const [rewardCoin, withdrawResponse] = claim({
+                package: constants.STABLE_VAULT_FARM_PACKAGE_ID,
+                arguments: {
+                    stableRegistry: constants.STABLE_REGISTRY,
+                    farm: constants.STABLE_VAULT_FARM,
+                    stableVault: constants.STABLE_VAULT,
+                    usdbTreasury: this.bucketClient.treasury(tx),
+                    savingPool: this.getBucketSavingPool(tx),
+                    yieldVault: constants.YIELD_VAULT,
+                },
+                typeArguments: [
+                    constants.STABLE_LP_TYPE,
+                    constants.USDC_TYPE,
+                    constants.STABLE_COIN_TYPES[coinName],
+                    constants.YUSDB_TYPE,
+                    constants.SAVING_TYPE,
+                ],
+            })(tx);
+            this.checkResponse({ tx, response: withdrawResponse, type: "withdraw" });
+            tx.transferObjects([rewardCoin], sender !== null && sender !== void 0 ? sender : this.sender);
+            return tx;
+        });
+    }
+    getTotalSupply() {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            const result = yield this.suiClient.getObject({
+                id: constants.STABLE_REGISTRY,
+                options: {
+                    showContent: true,
+                },
+            });
+            const content = (_a = result.data) === null || _a === void 0 ? void 0 : _a.content;
+            return BigInt((_c = (_b = content === null || content === void 0 ? void 0 : content.fields) === null || _b === void 0 ? void 0 : _b.total_supply) !== null && _c !== void 0 ? _c : "0");
+        });
+    }
+    getTotalSupplyByCoinName(coinName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g;
+            const result = yield this.suiClient.getDynamicFieldObject({
+                parentId: STABLE_REGISTRY,
+                name: {
+                    type: "0x1::type_name::TypeName",
+                    value: constants.STABLE_COIN_TYPES[coinName],
+                },
+            });
+            const content = (_a = result.data) === null || _a === void 0 ? void 0 : _a.content;
+            return BigInt((_g = (_f = (_e = (_d = (_c = (_b = content === null || content === void 0 ? void 0 : content.fields) === null || _b === void 0 ? void 0 : _b.treasury_cap) === null || _c === void 0 ? void 0 : _c.fields) === null || _d === void 0 ? void 0 : _d.total_supply) === null || _e === void 0 ? void 0 : _e.fields) === null || _f === void 0 ? void 0 : _f.value) !== null && _g !== void 0 ? _g : BigInt(0));
+        });
+    }
+    getBucketSavingPool(tx) {
+        return this.bucketClient.savingPoolObj(tx, {
+            lpType: constants.SAVING_TYPE,
+        });
+    }
+    getBucketPSMPool(tx) {
+        return this.bucketClient.psmPoolObj(tx, {
+            coinType: constants.USDC_TYPE,
+        });
+    }
+    checkResponse({ tx, response, type, }) {
+        if (type === "deposit") {
+            return this.bucketClient.checkDepositResponse(tx, {
+                lpType: constants.SAVING_TYPE,
+                depositResponse: response,
+            });
+        }
+        else {
+            return this.bucketClient.checkWithdrawResponse(tx, {
+                lpType: constants.SAVING_TYPE,
+                withdrawResponse: response,
+            });
+        }
+    }
+    releaseRewards(tx) {
+        const depositResponse = release({
+            package: constants.YIELD_USDB_PACKAGE_ID,
+            arguments: {
+                vault: constants.YIELD_VAULT,
+                treasury: this.bucketClient.treasury(tx),
+                savingPool: this.bucketClient.savingPoolObj(tx, {
+                    lpType: constants.SAVING_TYPE,
+                }),
+            },
+            typeArguments: [constants.YUSDB_TYPE, constants.SAVING_TYPE],
+        })(tx);
+        this.bucketClient.checkDepositResponse(tx, {
+            depositResponse,
+            lpType: constants.SAVING_TYPE,
+        });
     }
-}
-exports.Greeter = Greeter;
-/**
- * Get the SDK version
- */
-function getVersion() {
-    return '1.0.0';
 }

package/dist/interface.d.ts

@@ -0,0 +1,25 @@
+import { Transaction } from "@mysten/sui/transactions";
+import { Network } from "@bucket-protocol/sdk";
+export interface StableLayerConfig {
+    network: Network;
+    sender: string;
+}
+export interface MintTransactionParams {
+    tx: Transaction;
+    coinName: StableCoinType;
+    amount: bigint;
+    sender?: string;
+}
+export interface BurnTransactionParams {
+    tx: Transaction;
+    coinName: StableCoinType;
+    amount?: bigint;
+    all?: boolean;
+    sender?: string;
+}
+export interface ClaimTransactionParams {
+    tx: Transaction;
+    coinName: StableCoinType;
+    sender?: string;
+}
+export type StableCoinType = "BTC_USD";

package/dist/interface.js

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

package/dist/libs/constants.d.ts

@@ -0,0 +1,15 @@
+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 = "0x41e25d09e20cf3bc43fe321e51ef178fac419ae47b783a7161982158fc9f17d6";
+export declare const STABLE_VAULT_FARM_PACKAGE_ID = "0xd5b9fb5a964fa9c274e07a788d7b6d36d8df1c73e2e6f795f8db852621470b70";
+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 = "0x203eebc39442014a1b8180f3b8ed70143dac2c5d28ba5703fe34c21052728705";
+export declare const BTC_USD_TYPE = "0x6d9fc33611f4881a3f5c0cd4899d95a862236ce52b3a38fef039077b0c5b5834::btc_usdc::BtcUSDC";
+export type StableCoinType = "BTC_USD";
+export declare const STABLE_COIN_TYPES: Record<StableCoinType, string>;

package/dist/libs/constants.js

@@ -0,0 +1,18 @@
+export const STABLE_VAULT = "0x65f38160110cd6859d05f338ff54b4f462883bb6f87c667a65c0fb0e537410a7";
+export const USDC_TYPE = "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC";
+export const STABLE_LP_TYPE = "0xb75744fadcbfc174627567ca29645d0af8f6e6fd01b6f57c75a08cd3fb97c567::lake_usdc::LakeUSDC";
+export const YUSDB_TYPE = "0xac718b4b672d7f461fe7e86847166ff9c23cadba217397f0848a95bdea1f1051::yesusdb::YesUSDB";
+export const STABLE_LAYER_PACKAGE_ID = "0x41e25d09e20cf3bc43fe321e51ef178fac419ae47b783a7161982158fc9f17d6";
+export const STABLE_VAULT_FARM_PACKAGE_ID = "0xd5b9fb5a964fa9c274e07a788d7b6d36d8df1c73e2e6f795f8db852621470b70";
+// Bucket Protocol dependencies
+export const SAVING_TYPE = "0x38f61c75fa8407140294c84167dd57684580b55c3066883b48dedc344b1cde1e::susdb::SUSDB";
+export const YIELD_VAULT = "0x0a7f6325253157cd437812fea0ceee9a6b96f2ec5eac410da6df39558ff3a4d1";
+export const STABLE_REGISTRY = "0x213f4d584c0770f455bb98c94a4ee5ea9ddbc3d4ebb98a0ad6d093eb6da41642";
+export const STABLE_VAULT_FARM_ENTITY_TYPE = `0xc1025fe014b03d33b207b5afb0ba04293be87fab438c1418a26a75c2fe05c223::stable_vault_farm::StableVaultFarmEntity<${STABLE_LP_TYPE}, ${USDC_TYPE}>`;
+export const STABLE_VAULT_FARM = "0xe958b7d102b33bf3c09addb0e2cdff102ff2c93afe407ec5c2a541e8959a650c";
+export const YIELD_USDB_PACKAGE_ID = "0x203eebc39442014a1b8180f3b8ed70143dac2c5d28ba5703fe34c21052728705";
+// Stable Coins
+export const BTC_USD_TYPE = "0x6d9fc33611f4881a3f5c0cd4899d95a862236ce52b3a38fef039077b0c5b5834::btc_usdc::BtcUSDC";
+export const STABLE_COIN_TYPES = {
+    BTC_USD: BTC_USD_TYPE,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stable-layer-sdk",
-  "version": "0.0.3",
+  "version": "1.0.1",
   "description": "A TypeScript SDK for Stable Layer",
   "repository": {
     "type": "git",
@@ -15,7 +15,7 @@
   "scripts": {
     "build": "tsc",
     "dev": "tsc --watch",
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "vitest",
     "prepublishOnly": "npm run build"
   },
   "keywords": [
@@ -28,7 +28,22 @@
   "devDependencies": {
     "@tsconfig/recommended": "^1.0.3",
     "@types/node": "^20.0.0",
-    "typescript": "^5.0.0"
+    "typescript": "^5.0.0",
+    "vitest": "^4.0.7"
   },
-  "dependencies": {}
+  "dependencies": {
+    "@bucket-protocol/sdk": "1.0.7",
+    "@mysten/bcs": "^1.9.2",
+    "@mysten/sui": "^1.44.0"
+  },
+  "peerDependencies": {
+    "@mysten/sui": "^1.44.0"
+  },
+  "resolutions": {
+    "@mysten/sui": "^1.44.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
 }