stable-layer-sdk 0.0.2 → 1.0.0

package/dist/client.test.d.ts

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

package/dist/client.test.js

@@ -0,0 +1,146 @@
+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 { StableLayerSDK } from "./index";
+import { Transaction } from "@mysten/sui/transactions";
+import { getFullnodeUrl, SuiClient } from "@mysten/sui/client";
+import { describe, it, expect, beforeAll } from "vitest";
+import * as constants from "./libs/constants";
+const testConfig = {
+    network: "mainnet",
+    sender: "0x2b986d2381347d9e1c903167cf9b36da5f8eaba6f0db44e0c60e40ea312150ca",
+};
+describe("StableLayerSDK", () => {
+    let sdk;
+    let suiClient;
+    beforeAll(() => {
+        sdk = new StableLayerSDK(testConfig);
+        suiClient = new SuiClient({ url: getFullnodeUrl("mainnet") });
+    });
+    describe("constructor", () => {
+        it("should initialize with correct config", () => {
+            expect(sdk).toBeInstanceOf(StableLayerSDK);
+        });
+    });
+    describe("buildMintTx", () => {
+        it("should build a valid mint transaction", () => __awaiter(void 0, void 0, void 0, function* () {
+            const tx = new Transaction();
+            const params = {
+                tx,
+                coinName: "BTC_USD",
+                amount: BigInt(10),
+                sender: testConfig.sender,
+            };
+            const builtTx = yield sdk.buildMintTx(params);
+            expect(builtTx).toBeInstanceOf(Transaction);
+            // Dev inspect the transaction to validate it's well-formed
+            const result = yield suiClient.devInspectTransactionBlock({
+                transactionBlock: builtTx,
+                sender: testConfig.sender,
+            });
+            // Should not have execution errors in the transaction structure
+            expect(result.error).toBeUndefined();
+            expect(result.effects.status.status).toBe("success");
+        }));
+        it("should throw error when neither amount nor all is provided for burn", () => __awaiter(void 0, void 0, void 0, function* () {
+            const tx = new Transaction();
+            const params = {
+                tx,
+                coinName: "BTC_USD",
+                sender: testConfig.sender,
+            };
+            yield expect(sdk.buildBurnTx(params)).rejects.toThrow("Amount or all must be provided");
+        }));
+    });
+    describe("buildBurnTx", () => {
+        it("should build a valid burn transaction with amount", () => __awaiter(void 0, void 0, void 0, function* () {
+            const tx = new Transaction();
+            const params = {
+                tx,
+                coinName: "BTC_USD",
+                amount: BigInt(10),
+                sender: testConfig.sender,
+            };
+            const builtTx = yield sdk.buildBurnTx(params);
+            expect(builtTx).toBeInstanceOf(Transaction);
+            // Dev inspect the transaction
+            try {
+                const result = yield suiClient.devInspectTransactionBlock({
+                    transactionBlock: builtTx,
+                    sender: testConfig.sender,
+                });
+                expect(result.error).toBeUndefined();
+                expect(result.effects.status.status).toBe("success");
+            }
+            catch (error) {
+                const balance = yield suiClient.getBalance({
+                    owner: testConfig.sender,
+                    coinType: constants.BTC_USD_TYPE,
+                });
+                if (BigInt(balance.totalBalance) <= BigInt(10)) {
+                    expect(error.message).toContain(`Not enough coins of type ${constants.BTC_USD_TYPE} to satisfy requested balance`);
+                }
+                else {
+                    expect(error.message).toBeUndefined();
+                }
+            }
+        }));
+        it("should build a valid burn transaction with all flag", () => __awaiter(void 0, void 0, void 0, function* () {
+            const tx = new Transaction();
+            const params = {
+                tx,
+                coinName: "BTC_USD",
+                all: true,
+                sender: testConfig.sender,
+            };
+            const builtTx = yield sdk.buildBurnTx(params);
+            expect(builtTx).toBeInstanceOf(Transaction);
+            try {
+                const result = yield suiClient.devInspectTransactionBlock({
+                    transactionBlock: builtTx,
+                    sender: testConfig.sender,
+                });
+                expect(result.error).toBeUndefined();
+                expect(result.effects.status.status).toBe("success");
+            }
+            catch (error) {
+                const balance = yield suiClient.getBalance({
+                    owner: testConfig.sender,
+                    coinType: constants.BTC_USD_TYPE,
+                });
+                if (BigInt(balance.totalBalance) <= BigInt(10)) {
+                    console.log(error);
+                    expect(error.message).toBeDefined();
+                }
+                else {
+                    expect(error.message).toBeUndefined();
+                }
+            }
+        }));
+    });
+    describe("buildClaimTx", () => {
+        it("should build a valid claim transaction", () => __awaiter(void 0, void 0, void 0, function* () {
+            const tx = new Transaction();
+            const params = {
+                tx,
+                coinName: "BTC_USD",
+                sender: testConfig.sender,
+            };
+            const builtTx = yield sdk.buildClaimTx(params);
+            expect(builtTx).toBeInstanceOf(Transaction);
+            // Dev inspect the transaction
+            const result = yield suiClient.devInspectTransactionBlock({
+                transactionBlock: builtTx,
+                sender: testConfig.sender,
+            });
+            expect(result.error).toBeUndefined();
+            expect(result.effects.status.status).toBe("success");
+        }));
+    });
+});

package/dist/generated/stable_layer/deps/bucket_v2_framework/liability.d.ts

@@ -0,0 +1,11 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+/** Module for managing Credit and Debt for DeFi protocol usage */
+import { MoveStruct } from '../../../utils/index.js';
+export declare const Credit: MoveStruct<{
+    value: import("@mysten/bcs").BcsType<string, string | number | bigint, "u64">;
+}, "bucket_v2_framework::liability::Credit">;
+export declare const Debt: MoveStruct<{
+    value: import("@mysten/bcs").BcsType<string, string | number | bigint, "u64">;
+}, "bucket_v2_framework::liability::Debt">;

package/dist/generated/stable_layer/deps/bucket_v2_framework/liability.js

@@ -0,0 +1,13 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+/** Module for managing Credit and Debt for DeFi protocol usage */
+import { MoveStruct } from '../../../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+const $moduleName = 'bucket_v2_framework::liability';
+export const Credit = new MoveStruct({ name: `${$moduleName}::Credit`, fields: {
+        value: bcs.u64()
+    } });
+export const Debt = new MoveStruct({ name: `${$moduleName}::Debt`, fields: {
+        value: bcs.u64()
+    } });

package/dist/generated/stable_layer/deps/bucket_v2_framework/sheet.d.ts

@@ -0,0 +1,57 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+/** Module for the record of Credit and Debt of certain entity */
+import { MoveTuple, MoveStruct } from '../../../utils/index.js';
+export declare const Entity: MoveTuple<MoveStruct<{
+    name: import("@mysten/bcs").BcsType<string, string, "string">;
+}, "std::type_name::TypeName">[], "bucket_v2_framework::sheet::Entity">;
+export declare const Sheet: MoveStruct<{
+    credits: MoveStruct<{
+        contents: import("@mysten/bcs").BcsType<{
+            key: {
+                name: string;
+            }[];
+            value: {
+                value: string;
+            };
+        }[], Iterable<{
+            key: {
+                name: string;
+            }[];
+            value: {
+                value: string | number | bigint;
+            };
+        }> & {
+            length: number;
+        }, string>;
+    }, "0x2::vec_map::VecMap<bucket_v2_framework::sheet::Entity, bucket_v2_framework::liability::Credit>">;
+    debts: MoveStruct<{
+        contents: import("@mysten/bcs").BcsType<{
+            key: {
+                name: string;
+            }[];
+            value: {
+                value: string;
+            };
+        }[], Iterable<{
+            key: {
+                name: string;
+            }[];
+            value: {
+                value: string | number | bigint;
+            };
+        }> & {
+            length: number;
+        }, string>;
+    }, "0x2::vec_map::VecMap<bucket_v2_framework::sheet::Entity, bucket_v2_framework::liability::Debt>">;
+    blacklist: MoveStruct<{
+        contents: import("@mysten/bcs").BcsType<{
+            name: string;
+        }[][], Iterable<{
+            name: string;
+        }[]> & {
+            length: number;
+        }, string>;
+    }, "0x2::vec_set::VecSet<bucket_v2_framework::sheet::Entity>">;
+}, "bucket_v2_framework::sheet::Sheet">;

package/dist/generated/stable_layer/deps/bucket_v2_framework/sheet.js

@@ -0,0 +1,16 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+/** Module for the record of Credit and Debt of certain entity */
+import { MoveTuple, MoveStruct } from '../../../utils/index.js';
+import * as type_name from '../std/type_name.js';
+import * as vec_map from '../sui/vec_map.js';
+import * as liability from './liability.js';
+import * as vec_set from '../sui/vec_set.js';
+const $moduleName = 'bucket_v2_framework::sheet';
+export const Entity = new MoveTuple({ name: `${$moduleName}::Entity`, fields: [type_name.TypeName] });
+export const Sheet = new MoveStruct({ name: `${$moduleName}::Sheet`, fields: {
+        credits: vec_map.VecMap(Entity, liability.Credit),
+        debts: vec_map.VecMap(Entity, liability.Debt),
+        blacklist: vec_set.VecSet(Entity)
+    } });

package/dist/generated/stable_layer/deps/std/type_name.d.ts

@@ -0,0 +1,17 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+/** Functionality for converting Move types into values. Use with care! */
+import { MoveStruct } from '../../../utils/index.js';
+export declare const TypeName: MoveStruct<{
+    /**
+       * String representation of the type. All types are represented using their source
+       * syntax: "u8", "u64", "bool", "address", "vector", and so on for primitive types.
+       * Struct types are represented as fully qualified type names; e.g.
+       * `00000000000000000000000000000001::string::String` or
+       * `0000000000000000000000000000000a::module_name1::type_name1<0000000000000000000000000000000a::module_name2::type_name2<u64>>`
+       * Addresses are hex-encoded lowercase values of length ADDRESS_LENGTH (16, 20, or
+       * 32 depending on the Move platform)
+       */
+    name: import("@mysten/bcs").BcsType<string, string, "string">;
+}, "std::type_name::TypeName">;

package/dist/generated/stable_layer/deps/std/type_name.js

@@ -0,0 +1,19 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+/** Functionality for converting Move types into values. Use with care! */
+import { MoveStruct } from '../../../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+const $moduleName = 'std::type_name';
+export const TypeName = new MoveStruct({ name: `${$moduleName}::TypeName`, fields: {
+        /**
+           * String representation of the type. All types are represented using their source
+           * syntax: "u8", "u64", "bool", "address", "vector", and so on for primitive types.
+           * Struct types are represented as fully qualified type names; e.g.
+           * `00000000000000000000000000000001::string::String` or
+           * `0000000000000000000000000000000a::module_name1::type_name1<0000000000000000000000000000000a::module_name2::type_name2<u64>>`
+           * Addresses are hex-encoded lowercase values of length ADDRESS_LENGTH (16, 20, or
+           * 32 depending on the Move platform)
+           */
+        name: bcs.string()
+    } });

package/dist/generated/stable_layer/deps/sui/balance.d.ts

@@ -0,0 +1,12 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+/**
+ * A storable handler for Balances in general. Is used in the `Coin` module to
+ * allow balance operations and can be used to implement custom coins with `Supply`
+ * and `Balance`s.
+ */
+import { MoveStruct } from '../../../utils/index.js';
+export declare const Supply: MoveStruct<{
+    value: import("@mysten/bcs").BcsType<string, string | number | bigint, "u64">;
+}, "0x2::balance::Supply">;

package/dist/generated/stable_layer/deps/sui/balance.js

@@ -0,0 +1,14 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+/**
+ * A storable handler for Balances in general. Is used in the `Coin` module to
+ * allow balance operations and can be used to implement custom coins with `Supply`
+ * and `Balance`s.
+ */
+import { MoveStruct } from '../../../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+const $moduleName = '0x2::balance';
+export const Supply = new MoveStruct({ name: `${$moduleName}::Supply`, fields: {
+        value: bcs.u64()
+    } });

package/dist/generated/stable_layer/deps/sui/coin.d.ts

@@ -0,0 +1,16 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+/**
+ * Defines the `Coin` type - platform wide representation of fungible tokens and
+ * coins. `Coin` can be described as a secure wrapper around `Balance` type.
+ */
+import { MoveStruct } from '../../../utils/index.js';
+export declare const TreasuryCap: MoveStruct<{
+    id: MoveStruct<{
+        id: import("@mysten/bcs").BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    }, "0x2::object::UID">;
+    total_supply: MoveStruct<{
+        value: import("@mysten/bcs").BcsType<string, string | number | bigint, "u64">;
+    }, "0x2::balance::Supply">;
+}, "0x2::coin::TreasuryCap">;

package/dist/generated/stable_layer/deps/sui/coin.js

@@ -0,0 +1,15 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+/**
+ * Defines the `Coin` type - platform wide representation of fungible tokens and
+ * coins. `Coin` can be described as a secure wrapper around `Balance` type.
+ */
+import { MoveStruct } from '../../../utils/index.js';
+import * as object from './object.js';
+import * as balance from './balance.js';
+const $moduleName = '0x2::coin';
+export const TreasuryCap = new MoveStruct({ name: `${$moduleName}::TreasuryCap`, fields: {
+        id: object.UID,
+        total_supply: balance.Supply
+    } });

package/dist/generated/stable_layer/deps/sui/object.d.ts

@@ -0,0 +1,8 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+/** Sui object identifiers */
+import { MoveStruct } from '../../../utils/index.js';
+export declare const UID: MoveStruct<{
+    id: import("@mysten/bcs").BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+}, "0x2::object::UID">;

package/dist/generated/stable_layer/deps/sui/object.js

@@ -0,0 +1,10 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+/** Sui object identifiers */
+import { MoveStruct } from '../../../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+const $moduleName = '0x2::object';
+export const UID = new MoveStruct({ name: `${$moduleName}::UID`, fields: {
+        id: bcs.Address
+    } });

package/dist/generated/stable_layer/deps/sui/vec_map.d.ts

@@ -0,0 +1,36 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+import { type BcsType } from '@mysten/sui/bcs';
+import { MoveStruct } from '../../../utils/index.js';
+/** An entry in the map */
+export declare function Entry<K extends BcsType<any>, V extends BcsType<any>>(...typeParameters: [
+    K,
+    V
+]): MoveStruct<{
+    key: K;
+    value: V;
+}, `0x2::vec_map::Entry<${K["name"]}, ${V["name"]}>`>;
+/**
+ * A map data structure backed by a vector. The map is guaranteed not to contain
+ * duplicate keys, but entries are _not_ sorted by key--entries are included in
+ * insertion order. All operations are O(N) in the size of the map--the intention
+ * of this data structure is only to provide the convenience of programming against
+ * a map API. Large maps should use handwritten parent/child relationships instead.
+ * Maps that need sorted iteration rather than insertion order iteration should
+ * also be handwritten.
+ */
+export declare function VecMap<K extends BcsType<any>, V extends BcsType<any>>(...typeParameters: [
+    K,
+    V
+]): MoveStruct<{
+    contents: BcsType<{
+        key: K extends BcsType<infer U, any, string> ? U : never;
+        value: V extends BcsType<infer U, any, string> ? U : never;
+    }[], Iterable<{
+        key: K extends BcsType<any, infer U_1, string> ? U_1 : never;
+        value: V extends BcsType<any, infer U_1, string> ? U_1 : never;
+    }> & {
+        length: number;
+    }, string>;
+}, `0x2::vec_map::VecMap<${K["name"]}, ${V["name"]}>`>;

package/dist/generated/stable_layer/deps/sui/vec_map.js

@@ -0,0 +1,27 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+import { bcs } from '@mysten/sui/bcs';
+import { MoveStruct } from '../../../utils/index.js';
+const $moduleName = '0x2::vec_map';
+/** An entry in the map */
+export function Entry(...typeParameters) {
+    return new MoveStruct({ name: `${$moduleName}::Entry<${typeParameters[0].name}, ${typeParameters[1].name}>`, fields: {
+            key: typeParameters[0],
+            value: typeParameters[1]
+        } });
+}
+/**
+ * A map data structure backed by a vector. The map is guaranteed not to contain
+ * duplicate keys, but entries are _not_ sorted by key--entries are included in
+ * insertion order. All operations are O(N) in the size of the map--the intention
+ * of this data structure is only to provide the convenience of programming against
+ * a map API. Large maps should use handwritten parent/child relationships instead.
+ * Maps that need sorted iteration rather than insertion order iteration should
+ * also be handwritten.
+ */
+export function VecMap(...typeParameters) {
+    return new MoveStruct({ name: `${$moduleName}::VecMap<${typeParameters[0].name}, ${typeParameters[1].name}>`, fields: {
+            contents: bcs.vector(Entry(typeParameters[0], typeParameters[1]))
+        } });
+}

package/dist/generated/stable_layer/deps/sui/vec_set.d.ts

@@ -0,0 +1,20 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+import { type BcsType } from '@mysten/sui/bcs';
+import { MoveStruct } from '../../../utils/index.js';
+/**
+ * A set data structure backed by a vector. The set is guaranteed not to contain
+ * duplicate keys. All operations are O(N) in the size of the set
+ *
+ * - the intention of this data structure is only to provide the convenience of
+ *   programming against a set API. Sets that need sorted iteration rather than
+ *   insertion order iteration should be handwritten.
+ */
+export declare function VecSet<K extends BcsType<any>>(...typeParameters: [
+    K
+]): MoveStruct<{
+    contents: BcsType<import("@mysten/bcs").InferBcsType<K>[], Iterable<import("@mysten/bcs").InferBcsInput<K>> & {
+        length: number;
+    }, string>;
+}, `0x2::vec_set::VecSet<${K["name"]}>`>;

package/dist/generated/stable_layer/deps/sui/vec_set.js

@@ -0,0 +1,19 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+import { bcs } from '@mysten/sui/bcs';
+import { MoveStruct } from '../../../utils/index.js';
+const $moduleName = '0x2::vec_set';
+/**
+ * A set data structure backed by a vector. The set is guaranteed not to contain
+ * duplicate keys. All operations are O(N) in the size of the set
+ *
+ * - the intention of this data structure is only to provide the convenience of
+ *   programming against a set API. Sets that need sorted iteration rather than
+ *   insertion order iteration should be handwritten.
+ */
+export function VecSet(...typeParameters) {
+    return new MoveStruct({ name: `${$moduleName}::VecSet<${typeParameters[0].name}>`, fields: {
+            contents: bcs.vector(typeParameters[0])
+        } });
+}