aftermath-ts-sdk 0.0.162 → 0.0.164

package/dist/general/utils/helpers.js

@@ -9,9 +9,9 @@ const objectsApiHelpers_1 = require("../api/objectsApiHelpers");
 const rpcApiHelpers_1 = require("../api/rpcApiHelpers");
 const transactionsApiHelpers_1 = require("../api/transactionsApiHelpers");
 class Helpers {
-    /////////////////////////////////////////////////////////////////////
-    //// Type Checking
-    /////////////////////////////////////////////////////////////////////
+    // =========================================================================
+    //  Type Checking
+    // =========================================================================
     static isArrayOfStrings(value) {
         return (Array.isArray(value) &&
             value.every((item) => typeof item === "string"));
@@ -19,18 +19,18 @@ class Helpers {
 }
 exports.Helpers = Helpers;
 _a = Helpers;
-/////////////////////////////////////////////////////////////////////
-//// Api Helpers
-/////////////////////////////////////////////////////////////////////
+// =========================================================================
+//  Api Helpers
+// =========================================================================
 Helpers.dynamicFields = dynamicFieldsApiHelpers_1.DynamicFieldsApiHelpers;
 Helpers.events = eventsApiHelpers_1.EventsApiHelpers;
 Helpers.inspections = inspectionsApiHelpers_1.InspectionsApiHelpers;
 Helpers.objects = objectsApiHelpers_1.ObjectsApiHelpers;
 Helpers.rpc = rpcApiHelpers_1.RpcApiHelpers;
 Helpers.transactions = transactionsApiHelpers_1.TransactionsApiHelpers;
-/////////////////////////////////////////////////////////////////////
-//// Type Manipulation
-/////////////////////////////////////////////////////////////////////
+// =========================================================================
+//  Type Manipulation
+// =========================================================================
 Helpers.stripLeadingZeroesFromType = (type) => type.replaceAll(/x0+/g, "x");
 Helpers.addLeadingZeroesToType = (type) => {
     const expectedTypeLength = 64;
@@ -48,9 +48,9 @@ Helpers.addLeadingZeroesToType = (type) => {
     const newType = "0x" + zeros + strippedType;
     return newType + typeSuffix;
 };
-/////////////////////////////////////////////////////////////////////
-//// Numbers
-/////////////////////////////////////////////////////////////////////
+// =========================================================================
+//  Numbers
+// =========================================================================
 Helpers.isNumber = (str) => /^\d*\.?\d*$/g.test(str);
 Helpers.sum = (arr) => arr.reduce((prev, cur) => prev + cur, 0);
 Helpers.sumBigInt = (arr) => arr.reduce((prev, cur) => prev + cur, BigInt(0));
@@ -65,13 +65,13 @@ Helpers.blendedOperations = {
     mulBBN: (a, b) => Number(a * b),
     mulBBB: (a, b) => a * b,
 };
-/////////////////////////////////////////////////////////////////////
-//// Display
-/////////////////////////////////////////////////////////////////////
+// =========================================================================
+//  Display
+// =========================================================================
 Helpers.capitalizeOnlyFirstLetter = (str) => str.charAt(0).toUpperCase() + str.slice(1).toLowerCase();
-/////////////////////////////////////////////////////////////////////
-//// JSON
-/////////////////////////////////////////////////////////////////////
+// =========================================================================
+//  JSON
+// =========================================================================
 Helpers.parseJsonWithBigint = (json, unsafeStringNumberConversion = false) => JSON.parse(json, (key, value) => {
     // handles bigint casting
     if (typeof value === "string" && /^\d+n$/.test(value)) {
@@ -84,9 +84,9 @@ Helpers.parseJsonWithBigint = (json, unsafeStringNumberConversion = false) => JS
     }
     return value;
 });
-/////////////////////////////////////////////////////////////////////
-//// General
-/////////////////////////////////////////////////////////////////////
+// =========================================================================
+//  General
+// =========================================================================
 Helpers.deepCopy = (target) => {
     if (target === null) {
         return target;

package/dist/general/wallet/wallet.js

@@ -17,9 +17,9 @@ class Wallet extends caller_1.Caller {
         this.address = address;
         this.network = network;
     }
-    /////////////////////////////////////////////////////////////////////
-    //// Balances
-    /////////////////////////////////////////////////////////////////////
+    // =========================================================================
+    //  Balances
+    // =========================================================================
     getBalance(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.fetchApi(`balances/${inputs.coin}`);
@@ -37,9 +37,9 @@ class Wallet extends caller_1.Caller {
             return this.fetchApi("balances");
         });
     }
-    /////////////////////////////////////////////////////////////////////
-    //// Transactions
-    /////////////////////////////////////////////////////////////////////
+    // =========================================================================
+    //  Transactions
+    // =========================================================================
     getPastAftermathTransactions(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.fetchApi("transactions", inputs);

package/dist/general/wallet/walletApi.js

@@ -13,17 +13,17 @@ exports.WalletApi = void 0;
 const helpers_1 = require("../utils/helpers");
 const transactionsApiHelpers_1 = require("../api/transactionsApiHelpers");
 class WalletApi {
-    /////////////////////////////////////////////////////////////////////
-    //// Constructor
-    /////////////////////////////////////////////////////////////////////
+    // =========================================================================
+    //  Constructor
+    // =========================================================================
     constructor(Provider) {
         this.Provider = Provider;
-        /////////////////////////////////////////////////////////////////////
-        //// Fetching
-        /////////////////////////////////////////////////////////////////////
-        /////////////////////////////////////////////////////////////////////
-        //// Coins
-        /////////////////////////////////////////////////////////////////////
+        // =========================================================================
+        //  Fetching
+        // =========================================================================
+        // =========================================================================
+        //  Coins
+        // =========================================================================
         this.fetchCoinBalance = (account, coin) => __awaiter(this, void 0, void 0, function* () {
             const coinBalance = yield this.Provider.provider.getBalance({
                 owner: account,
@@ -42,9 +42,9 @@ class WalletApi {
             }, {});
             return coinsToBalance;
         });
-        /////////////////////////////////////////////////////////////////////
-        //// Transactions
-        /////////////////////////////////////////////////////////////////////
+        // =========================================================================
+        //  Transactions
+        // =========================================================================
         // TODO: make this only look at aftermath relevant addresses in to address
         // TODO: restrict all filtering for events, etc. similarly using updated sdk filters
         this.fetchPastAftermathTransactions = (address, cursor, limit) => __awaiter(this, void 0, void 0, function* () {

package/dist/packages/capys/capy.d.ts

@@ -1,11 +1,11 @@
-import { CapyObject } from "../../types";
+import { SuiFrenObject } from "../../types";
 import { Caller } from "../../general/utils/caller";
 import { TransactionBlock } from "@mysten/sui.js";
-export declare class Capy extends Caller {
-    readonly capy: CapyObject;
+export declare class SuiFren extends Caller {
+    readonly suiFren: SuiFrenObject;
     readonly network?: string | undefined;
     readonly isStaked: boolean;
-    constructor(capy: CapyObject, network?: string | undefined, isStaked?: boolean);
+    constructor(suiFren: SuiFrenObject, network?: string | undefined, isStaked?: boolean);
     getStakeTransaction(): Promise<TransactionBlock>;
 }
 //# sourceMappingURL=capy.d.ts.map

package/dist/packages/capys/capy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"capy.d.ts","sourceRoot":"","sources":["../../../src/packages/capys/capy.ts"],"names":[],"mappings":"AAAA,OAAO,EAGN,UAAU,EAGV,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD,qBAAa,IAAK,SAAQ,MAAM;aAMd,IAAI,EAAE,UAAU;aAChB,OAAO,CAAC;aACR,QAAQ,EAAE,OAAO;gBAFjB,IAAI,EAAE,UAAU,EAChB,OAAO,CAAC,oBAAkB,EAC1B,QAAQ,GAAE,OAAe;IAW7B,mBAAmB;CAWhC"}
+{"version":3,"file":"capy.d.ts","sourceRoot":"","sources":["../../../src/packages/capys/capy.ts"],"names":[],"mappings":"AAAA,OAAO,EAGN,aAAa,EAGb,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD,qBAAa,OAAQ,SAAQ,MAAM;aAMjB,OAAO,EAAE,aAAa;aACtB,OAAO,CAAC;aACR,QAAQ,EAAE,OAAO;gBAFjB,OAAO,EAAE,aAAa,EACtB,OAAO,CAAC,oBAAkB,EAC1B,QAAQ,GAAE,OAAe;IAW7B,mBAAmB;CAWhC"}

package/dist/packages/capys/capy.js

@@ -9,31 +9,31 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Capy = void 0;
+exports.SuiFren = void 0;
 const caller_1 = require("../../general/utils/caller");
-class Capy extends caller_1.Caller {
-    /////////////////////////////////////////////////////////////////////
-    //// Constructor
-    /////////////////////////////////////////////////////////////////////
-    constructor(capy, network, isStaked = false) {
-        super(network, "capys");
-        this.capy = capy;
+class SuiFren extends caller_1.Caller {
+    // =========================================================================
+    //  Constructor
+    // =========================================================================
+    constructor(suiFren, network, isStaked = false) {
+        super(network, "suiFrens");
+        this.suiFren = suiFren;
         this.network = network;
         this.isStaked = isStaked;
-        this.capy = capy;
+        this.suiFren = suiFren;
         this.isStaked = isStaked;
     }
-    /////////////////////////////////////////////////////////////////////
-    //// Transactions
-    /////////////////////////////////////////////////////////////////////
+    // =========================================================================
+    //  Transactions
+    // =========================================================================
     getStakeTransaction() {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.isStaked)
-                throw new Error("unable to stake already staked capy");
+                throw new Error("unable to stake already staked suiFren");
             return this.fetchApiTransaction("transactions/stake", {
-                capyId: this.capy.objectId,
+                suiFrenId: this.suiFren.objectId,
             });
         });
     }
 }
-exports.Capy = Capy;
+exports.SuiFren = SuiFren;

package/dist/packages/coin/api/coinApi.d.ts

@@ -1,12 +1,25 @@
-import { CoinMetadata } from "@mysten/sui.js";
+import { SuiAddress, TransactionArgument, TransactionBlock } from "@mysten/sui.js";
 import { AftermathApi } from "../../../general/providers/aftermathApi";
-import { CoinType } from "../../../types";
-import { CoinApiHelpers } from "./coinApiHelpers";
+import { Balance, CoinMetadaWithInfo, CoinType } from "../../../types";
 export declare class CoinApi {
     private readonly Provider;
-    readonly Helpers: CoinApiHelpers;
     constructor(Provider: AftermathApi);
-    fetchCoinMetadata: (coin: CoinType) => Promise<CoinMetadata>;
+    fetchCoinMetadata: (coin: CoinType) => Promise<CoinMetadaWithInfo>;
+    fetchCoinWithAmountTx: (inputs: {
+        tx: TransactionBlock;
+        walletAddress: SuiAddress;
+        coinType: CoinType;
+        coinAmount: Balance;
+    }) => Promise<TransactionArgument>;
+    fetchCoinsWithAmountTx: (inputs: {
+        tx: TransactionBlock;
+        walletAddress: SuiAddress;
+        coinTypes: CoinType[];
+        coinAmounts: Balance[];
+    }) => Promise<TransactionArgument[]>;
+    static formatCoinTypesForMoveCall: (coins: CoinType[]) => number[][];
+    private fetchCoinsUntilAmountReachedOrEnd;
     private createLpCoinMetadata;
+    private static coinWithAmountTx;
 }
 //# sourceMappingURL=coinApi.d.ts.map

package/dist/packages/coin/api/coinApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"coinApi.d.ts","sourceRoot":"","sources":["../../../../src/packages/coin/api/coinApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,qBAAa,OAAO;IAWP,OAAO,CAAC,QAAQ,CAAC,QAAQ;IANrC,SAAgB,OAAO,iBAAC;gBAMK,QAAQ,EAAE,YAAY;IAS5C,iBAAiB,SACjB,QAAQ,KACZ,QAAQ,YAAY,CAAC,CA4BtB;IAGF,OAAO,CAAC,oBAAoB,CAmD1B;CACF"}
+{"version":3,"file":"coinApi.d.ts","sourceRoot":"","sources":["../../../../src/packages/coin/api/coinApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAKN,UAAU,EACV,mBAAmB,EACnB,gBAAgB,EAChB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAKvE,qBAAa,OAAO;IAKP,OAAO,CAAC,QAAQ,CAAC,QAAQ;gBAAR,QAAQ,EAAE,YAAY;IAQ5C,iBAAiB,SACjB,QAAQ,KACZ,QAAQ,kBAAkB,CAAC,CAgC5B;IAMK,qBAAqB,WAAkB;QAC7C,EAAE,EAAE,gBAAgB,CAAC;QACrB,aAAa,EAAE,UAAU,CAAC;QAC1B,QAAQ,EAAE,QAAQ,CAAC;QACnB,UAAU,EAAE,OAAO,CAAC;KACpB,KAAG,QAAQ,mBAAmB,CAAC,CAW9B;IAEK,sBAAsB,WAAkB;QAC9C,EAAE,EAAE,gBAAgB,CAAC;QACrB,aAAa,EAAE,UAAU,CAAC;QAC1B,SAAS,EAAE,QAAQ,EAAE,CAAC;QACtB,WAAW,EAAE,OAAO,EAAE,CAAC;KACvB,KAAG,QAAQ,mBAAmB,EAAE,CAAC,CA4BhC;IAMF,OAAc,0BAA0B,UAAW,QAAQ,EAAE,gBACG;IAUhE,OAAO,CAAC,iCAAiC,CAmCvC;IAGF,OAAO,CAAC,oBAAoB,CAqD1B;IAMF,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAgD7B;CACF"}

package/dist/packages/coin/api/coinApi.js

@@ -13,16 +13,16 @@ exports.CoinApi = void 0;
 const coin_1 = require("../coin");
 const helpers_1 = require("../../../general/utils/helpers");
 const pools_1 = require("../../pools/pools");
-const coinApiHelpers_1 = require("./coinApiHelpers");
+const utils_1 = require("../../../general/utils");
 class CoinApi {
-    /////////////////////////////////////////////////////////////////////
-    //// Constructor
-    /////////////////////////////////////////////////////////////////////
+    // =========================================================================
+    //  Constructor
+    // =========================================================================
     constructor(Provider) {
         this.Provider = Provider;
-        /////////////////////////////////////////////////////////////////////
-        //// Inspections
-        /////////////////////////////////////////////////////////////////////
+        // =========================================================================
+        //  Inspections
+        // =========================================================================
         this.fetchCoinMetadata = (coin) => __awaiter(this, void 0, void 0, function* () {
             try {
                 const coinMetadata = yield this.Provider.provider.getCoinMetadata({
@@ -30,11 +30,11 @@ class CoinApi {
                 });
                 if (coinMetadata === null)
                     throw new Error("coin metadata is null");
-                return coinMetadata;
+                return Object.assign(Object.assign({}, coinMetadata), { isGenerated: false });
             }
             catch (error) {
-                if (this.Provider.Pools().Helpers.isLpCoin(coin)) {
-                    return this.createLpCoinMetadata(coin);
+                if (this.Provider.Pools().isLpCoin(coin)) {
+                    return this.createLpCoinMetadata({ lpCoinType: coin });
                 }
                 const coinClass = new coin_1.Coin(coin);
                 const symbol = coinClass.coinTypeSymbol;
@@ -49,16 +49,71 @@ class CoinApi {
                         .join(" "),
                     decimals: 9,
                     iconUrl: null,
+                    isGenerated: true,
                 };
             }
         });
+        // =========================================================================
+        //  Transaction Builders
+        // =========================================================================
+        this.fetchCoinWithAmountTx = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            const { tx, walletAddress, coinType, coinAmount } = inputs;
+            tx.setSender(walletAddress);
+            const coinData = yield this.fetchCoinsUntilAmountReachedOrEnd(inputs);
+            return CoinApi.coinWithAmountTx({
+                tx,
+                coinData,
+                coinAmount,
+            });
+        });
+        this.fetchCoinsWithAmountTx = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            const { tx, walletAddress, coinTypes, coinAmounts } = inputs;
+            tx.setSender(walletAddress);
+            // TODO: handle cursoring until necessary coin amount is found
+            const allCoinsData = yield Promise.all(coinTypes.map((coinType, index) => __awaiter(this, void 0, void 0, function* () {
+                return this.fetchCoinsUntilAmountReachedOrEnd(Object.assign(Object.assign({}, inputs), { coinAmount: coinAmounts[index], coinType }));
+            })));
+            let coinArgs = [];
+            for (const [index, coinData] of allCoinsData.entries()) {
+                const coinArg = CoinApi.coinWithAmountTx({
+                    tx,
+                    coinData,
+                    coinAmount: coinAmounts[index],
+                });
+                coinArgs = [...coinArgs, coinArg];
+            }
+            return coinArgs;
+        });
+        // =========================================================================
+        //  Private Methods
+        // =========================================================================
+        // =========================================================================
+        //  Helpers
+        // =========================================================================
+        this.fetchCoinsUntilAmountReachedOrEnd = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            let allCoinData = [];
+            let cursor = undefined;
+            do {
+                const paginatedCoins = yield this.Provider.provider.getCoins(Object.assign(Object.assign({}, inputs), { owner: inputs.walletAddress, cursor }));
+                const coinData = paginatedCoins.data.filter((data) => !data.lockedUntilEpoch && BigInt(data.balance) > BigInt(0));
+                allCoinData = [...allCoinData, ...coinData];
+                const totalAmount = helpers_1.Helpers.sumBigInt(allCoinData.map((data) => BigInt(data.balance)));
+                if (totalAmount >= inputs.coinAmount)
+                    return allCoinData;
+                if (paginatedCoins.data.length === 0 ||
+                    !paginatedCoins.hasNextPage ||
+                    !paginatedCoins.nextCursor)
+                    return allCoinData;
+                cursor = paginatedCoins.nextCursor;
+            } while (true);
+        });
         // NOTE: this is temporary until LP coin metadata issue is solved on Sui
-        this.createLpCoinMetadata = (coin) => __awaiter(this, void 0, void 0, function* () {
+        this.createLpCoinMetadata = (inputs) => __awaiter(this, void 0, void 0, function* () {
             try {
                 const PoolsApi = this.Provider.Pools();
                 // TODO: find the best way to do all of this using cached server data
-                const poolObjectId = yield PoolsApi.fetchPoolObjectIdForLpCoinType(coin);
-                const pool = yield PoolsApi.fetchPool(poolObjectId);
+                const poolObjectId = yield PoolsApi.fetchPoolObjectIdForLpCoinType(inputs);
+                const pool = yield PoolsApi.fetchPool({ objectId: poolObjectId });
                 const maxCoinSymbolLength = 5;
                 const notPrettyCoinSymbol = pool.name.length > maxCoinSymbolLength
                     ? pool.name.toUpperCase().slice(0, maxCoinSymbolLength)
@@ -70,7 +125,7 @@ class CoinApi {
                     .split(" ")
                     .map((word) => helpers_1.Helpers.capitalizeOnlyFirstLetter(word))
                     .join(" ");
-                const coinDescription = yield PoolsApi.Helpers.createLpCoinMetadataDescription({
+                const coinDescription = yield PoolsApi.createLpCoinMetadataDescription({
                     poolName: pool.name,
                     coinTypes: Object.keys(pool.coins),
                 });
@@ -81,6 +136,7 @@ class CoinApi {
                     name: `Af Lp ${coinName}`,
                     decimals: pools_1.Pools.constants.decimals.lpCoinDecimals,
                     iconUrl: null,
+                    isGenerated: true,
                 };
             }
             catch (e) {
@@ -91,11 +147,49 @@ class CoinApi {
                     name: "Af Lp",
                     decimals: pools_1.Pools.constants.decimals.lpCoinDecimals,
                     iconUrl: null,
+                    isGenerated: true,
                 };
             }
         });
         this.Provider = Provider;
-        this.Helpers = new coinApiHelpers_1.CoinApiHelpers(Provider);
     }
 }
 exports.CoinApi = CoinApi;
+// =========================================================================
+//  Helpers
+// =========================================================================
+CoinApi.formatCoinTypesForMoveCall = (coins) => coins.map((coin) => utils_1.Casting.u8VectorFromString(coin.slice(2))); // slice to remove 0x
+// =========================================================================
+//  Private Static Methods
+// =========================================================================
+CoinApi.coinWithAmountTx = (inputs) => {
+    const { tx, coinData, coinAmount } = inputs;
+    const isSuiCoin = coin_1.Coin.isSuiCoin(coinData[0].coinType);
+    const totalCoinBalance = helpers_1.Helpers.sumBigInt(coinData.map((data) => BigInt(data.balance)));
+    if (totalCoinBalance < coinAmount)
+        throw new Error("wallet does not have coins of sufficient balance");
+    if (isSuiCoin) {
+        tx.setGasPayment(coinData.map((obj) => {
+            return Object.assign(Object.assign({}, obj), { objectId: obj.coinObjectId });
+        }));
+        return tx.splitCoins(tx.gas, [tx.pure(coinAmount)]);
+    }
+    const coinObjectIds = coinData.map((data) => data.coinObjectId);
+    const mergedCoinObjectId = coinObjectIds[0];
+    if (coinObjectIds.length > 1) {
+        tx.add({
+            kind: "MergeCoins",
+            destination: tx.object(mergedCoinObjectId),
+            sources: [
+                ...coinObjectIds
+                    .slice(1)
+                    .map((coinId) => tx.object(coinId)),
+            ],
+        });
+    }
+    return tx.add({
+        kind: "SplitCoins",
+        coin: tx.object(mergedCoinObjectId),
+        amounts: [tx.pure(coinAmount)],
+    });
+};

package/dist/packages/coin/coin.d.ts

@@ -1,6 +1,5 @@
-import { Balance, CoinDecimal, CoinPriceInfo, CoinsToBalance, CoinsToDecimals, CoinSymbol, CoinSymbolToCoinTypes, CoinType, CoinWithAmount, CoinWithAmountOrUndefined, KeyType } from "../../types";
+import { Balance, CoinDecimal, CoinMetadaWithInfo, CoinPriceInfo, CoinsToBalance, CoinsToDecimals, CoinSymbol, CoinSymbolToCoinTypes, CoinType, CoinWithAmount, CoinWithAmountOrUndefined, KeyType } from "../../types";
 import { Caller } from "../../general/utils/caller";
-import { CoinMetadata } from "@mysten/sui.js";
 export declare class Coin extends Caller {
     readonly coinType?: string | undefined;
     readonly network?: string | undefined;
@@ -10,14 +9,14 @@ export declare class Coin extends Caller {
     readonly coinTypePackageName: string;
     readonly coinTypeSymbol: string;
     readonly innerCoinType: string;
-    metadata: CoinMetadata | undefined;
+    metadata: CoinMetadaWithInfo | undefined;
     priceInfo: CoinPriceInfo | undefined;
     constructor(coinType?: string | undefined, network?: string | undefined);
     getCoinsToDecimals(inputs: {
         coins: CoinType[];
     }): Promise<CoinsToDecimals>;
-    getCoinMetadata(coin?: CoinType): Promise<CoinMetadata>;
-    setCoinMetadata(metadata: CoinMetadata): void;
+    getCoinMetadata(coin?: CoinType): Promise<CoinMetadaWithInfo>;
+    setCoinMetadata(metadata: CoinMetadaWithInfo): void;
     getPrice(coin?: CoinType): Promise<CoinPriceInfo>;
     setPriceInfo(priceInfo: CoinPriceInfo): void;
     static getCoinTypePackageName: (coin: CoinType) => string;

package/dist/packages/coin/coin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"coin.d.ts","sourceRoot":"","sources":["../../../src/packages/coin/coin.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,OAAO,EACP,WAAW,EACX,aAAa,EACb,cAAc,EACd,eAAe,EACf,UAAU,EACV,qBAAqB,EACrB,QAAQ,EACR,cAAc,EACd,yBAAyB,EACzB,OAAO,EAGP,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAEpD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C,qBAAa,IAAK,SAAQ,MAAM;aA0Bd,QAAQ,CAAC;aACT,OAAO,CAAC;IAtBzB,gBAAuB,SAAS;;MAE9B;IAMF,SAAgB,mBAAmB,EAAE,MAAM,CAAC;IAC5C,SAAgB,cAAc,EAAE,MAAM,CAAC;IACvC,SAAgB,aAAa,EAAE,MAAM,CAAC;IAE/B,QAAQ,EAAE,YAAY,GAAG,SAAS,CAAC;IACnC,SAAS,EAAE,aAAa,GAAG,SAAS,CAAC;gBAQ3B,QAAQ,CAAC,oBAAU,EACnB,OAAO,CAAC,oBAAkB;IAwB9B,kBAAkB,CAAC,MAAM,EAAE;QACvC,KAAK,EAAE,QAAQ,EAAE,CAAC;KAClB,GAAG,OAAO,CAAC,eAAe,CAAC;IAgBf,eAAe,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC;IAW7D,eAAe,CAAC,QAAQ,EAAE,YAAY;IAIhC,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,CAAC;IAiBvD,YAAY,CAAC,SAAS,EAAE,aAAa;IAa5C,OAAc,sBAAsB,SAAU,QAAQ,KAAG,MAAM,CAM7D;IAGF,OAAc,iBAAiB,SAAU,QAAQ,KAAG,MAAM,CASxD;IAEF,OAAc,gBAAgB,SAAU,QAAQ,YACW;IAE3D,OAAc,mBAAmB,YAAa,OAAO,YAInD;IAEF,OAAc,SAAS,SAAU,QAAQ,aAEuB;IAMhE,OAAc,uBAAuB,gBACvB,OAAO,QAAQ,EAAE,MAAM,CAAC;;;MAWpC;IAEF,OAAc,wBAAwB,mBACrB,cAAc;;;MAW7B;IAEF,OAAc,oBAAoB,4BACR,yBAAyB,GAAG,SAAS,KAC5D,cAAc,GAAG,SAAS,CAKmB;IAEhD,OAAc,qBAAqB,aACxB,QAAQ,yBACK,qBAAqB,KAC1C,UAAU,GAAG,SAAS,CAevB;IAcF,OAAc,gBAAgB,YACpB,MAAM,YACL,WAAW,KACnB,OAAO,CAIP;IAEH,OAAc,mBAAmB,WACxB,MAAM,GAAG,MAAM,YACb,MAAM,YAIf;IAEF,OAAc,sBAAsB,WAC3B,MAAM,GAAG,MAAM,YACb,MAAM,SACT,MAAM,YAGZ;CACF"}
+{"version":3,"file":"coin.d.ts","sourceRoot":"","sources":["../../../src/packages/coin/coin.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,OAAO,EACP,WAAW,EACX,kBAAkB,EAClB,aAAa,EACb,cAAc,EACd,eAAe,EACf,UAAU,EACV,qBAAqB,EACrB,QAAQ,EACR,cAAc,EACd,yBAAyB,EACzB,OAAO,EAGP,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAIpD,qBAAa,IAAK,SAAQ,MAAM;aA2Bd,QAAQ,CAAC;aACT,OAAO,CAAC;IAvBzB,gBAAuB,SAAS;;MAG9B;IAMF,SAAgB,mBAAmB,EAAE,MAAM,CAAC;IAC5C,SAAgB,cAAc,EAAE,MAAM,CAAC;IACvC,SAAgB,aAAa,EAAE,MAAM,CAAC;IAE/B,QAAQ,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACzC,SAAS,EAAE,aAAa,GAAG,SAAS,CAAC;gBAQ3B,QAAQ,CAAC,oBAAU,EACnB,OAAO,CAAC,oBAAkB;IAwB9B,kBAAkB,CAAC,MAAM,EAAE;QACvC,KAAK,EAAE,QAAQ,EAAE,CAAC;KAClB,GAAG,OAAO,CAAC,eAAe,CAAC;IAgBf,eAAe,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAWnE,eAAe,CAAC,QAAQ,EAAE,kBAAkB;IAItC,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,aAAa,CAAC;IAiBvD,YAAY,CAAC,SAAS,EAAE,aAAa;IAa5C,OAAc,sBAAsB,SAAU,QAAQ,KAAG,MAAM,CAM7D;IAGF,OAAc,iBAAiB,SAAU,QAAQ,KAAG,MAAM,CASxD;IAEF,OAAc,gBAAgB,SAAU,QAAQ,YACW;IAE3D,OAAc,mBAAmB,YAAa,OAAO,YAInD;IAEF,OAAc,SAAS,SAAU,QAAQ,aAEuB;IAMhE,OAAc,uBAAuB,gBACvB,OAAO,QAAQ,EAAE,MAAM,CAAC;;;MAWpC;IAEF,OAAc,wBAAwB,mBACrB,cAAc;;;MAW7B;IAEF,OAAc,oBAAoB,4BACR,yBAAyB,GAAG,SAAS,KAC5D,cAAc,GAAG,SAAS,CAKmB;IAEhD,OAAc,qBAAqB,aACxB,QAAQ,yBACK,qBAAqB,KAC1C,UAAU,GAAG,SAAS,CAevB;IAcF,OAAc,gBAAgB,YACpB,MAAM,YACL,WAAW,KACnB,OAAO,CAIP;IAEH,OAAc,mBAAmB,WACxB,MAAM,GAAG,MAAM,YACb,MAAM,YAIf;IAEF,OAAc,sBAAsB,WAC3B,MAAM,GAAG,MAAM,YACb,MAAM,SACT,MAAM,YAGZ;CACF"}

package/dist/packages/coin/coin.js

@@ -14,9 +14,9 @@ const caller_1 = require("../../general/utils/caller");
 const helpers_1 = require("../../general/utils/helpers");
 const prices_1 = require("../../general/prices/prices");
 class Coin extends caller_1.Caller {
-    /////////////////////////////////////////////////////////////////////
-    //// Constructor
-    /////////////////////////////////////////////////////////////////////
+    // =========================================================================
+    //  Constructor
+    // =========================================================================
     // TODO: update this class to not be instantiated with a coin type at all
     constructor(coinType, network) {
         super(network, "coins");
@@ -33,12 +33,12 @@ class Coin extends caller_1.Caller {
             ? Coin.getInnerCoinType(this.coinType)
             : "";
     }
-    /////////////////////////////////////////////////////////////////////
-    //// Public Methods
-    /////////////////////////////////////////////////////////////////////
-    /////////////////////////////////////////////////////////////////////
-    //// Inspections
-    /////////////////////////////////////////////////////////////////////
+    // =========================================================================
+    //  Public Methods
+    // =========================================================================
+    // =========================================================================
+    //  Inspections
+    // =========================================================================
     getCoinsToDecimals(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
             const { coins } = inputs;
@@ -87,18 +87,18 @@ class Coin extends caller_1.Caller {
     }
 }
 exports.Coin = Coin;
-/////////////////////////////////////////////////////////////////////
-//// Constants
-/////////////////////////////////////////////////////////////////////
+// =========================================================================
+//  Constants
+// =========================================================================
 Coin.constants = {
-    suiCoinType: "0x0000000000000000000000000000000000000002::sui::SUI",
+    suiCoinType: "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
 };
-/////////////////////////////////////////////////////////////////////
-//// Public Static Methods
-/////////////////////////////////////////////////////////////////////
-/////////////////////////////////////////////////////////////////////
-//// Coin Type
-/////////////////////////////////////////////////////////////////////
+// =========================================================================
+//  Public Static Methods
+// =========================================================================
+// =========================================================================
+//  Coin Type
+// =========================================================================
 // TODO: remove in favor of sui js implementation Coin.getCoinStructTag() if it is the same
 Coin.getCoinTypePackageName = (coin) => {
     const splitCoin = coin.split("::");
@@ -127,9 +127,9 @@ Coin.coinTypeFromKeyType = (keyType) => {
 };
 Coin.isSuiCoin = (coin) => helpers_1.Helpers.stripLeadingZeroesFromType(coin) ===
     helpers_1.Helpers.stripLeadingZeroesFromType(Coin.constants.suiCoinType);
-/////////////////////////////////////////////////////////////////////
-//// Helpers
-/////////////////////////////////////////////////////////////////////
+// =========================================================================
+//  Helpers
+// =========================================================================
 Coin.coinsAndAmountsOverZero = (coinAmounts) => {
     // NOTE: will these loops always run in same order (is this a js gurantee or not) ?
     const coins = Object.keys(coinAmounts).filter((key) => coinAmounts[key] > 0);
@@ -162,12 +162,12 @@ Coin.coinSymbolForCoinType = (coinType, coinSymbolToCoinTypes) => {
         return undefined;
     }
 };
-/////////////////////////////////////////////////////////////////////
-//// Balance
-/////////////////////////////////////////////////////////////////////
-/////////////////////////////////////////////////////////////////////
-//// Conversions
-/////////////////////////////////////////////////////////////////////
+// =========================================================================
+//  Balance
+// =========================================================================
+// =========================================================================
+//  Conversions
+// =========================================================================
 /*
     Convert user-inputted values into their onchain counterparts (e.g. u64)
     TO-DO: change name

package/dist/packages/coin/coinTypes.d.ts

@@ -1,3 +1,4 @@
+import { CoinMetadata } from "@mysten/sui.js";
 import { Balance, Percentage } from "../../general/types/generalTypes";
 export type CoinDecimal = number;
 export type CoinType = string;
@@ -27,4 +28,7 @@ export interface CoinPriceInfo {
     price: number;
     priceChange24HoursPercentage: Percentage;
 }
+export type CoinMetadaWithInfo = CoinMetadata & {
+    isGenerated?: boolean;
+};
 //# sourceMappingURL=coinTypes.d.ts.map

package/dist/packages/coin/coinTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"coinTypes.d.ts","sourceRoot":"","sources":["../../../src/packages/coin/coinTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAMvE,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AACjC,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAMhC,MAAM,MAAM,eAAe,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC;AAEnE,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CACf;AACD,MAAM,WAAW,yBAAyB;IACzC,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B;AAMD,MAAM,WAAW,kBAAkB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CAClB;AAMD,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AACvD,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AACpD,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;AAC5D,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;AAC/D,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;AAEnE,MAAM,WAAW,aAAa;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,4BAA4B,EAAE,UAAU,CAAC;CACzC"}
+{"version":3,"file":"coinTypes.d.ts","sourceRoot":"","sources":["../../../src/packages/coin/coinTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAMvE,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AACjC,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAMhC,MAAM,MAAM,eAAe,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC;AAEnE,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CACf;AACD,MAAM,WAAW,yBAAyB;IACzC,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B;AAMD,MAAM,WAAW,kBAAkB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CAClB;AAMD,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AACvD,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AACpD,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;AAC5D,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;AAC/D,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;AAEnE,MAAM,WAAW,aAAa;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,4BAA4B,EAAE,UAAU,CAAC;CACzC;AAMD,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG;IAC/C,WAAW,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC"}