aftermath-ts-sdk 0.0.162 → 0.0.164

package/dist/packages/suiFrens/api/suiFrensApi.js

@@ -0,0 +1,564 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SuiFrensApi = void 0;
+const sui_js_1 = require("@mysten/sui.js");
+const suiFrensApiCasting_1 = require("./suiFrensApiCasting");
+const coin_1 = require("../../coin/coin");
+const helpers_1 = require("../../../general/utils/helpers");
+const suiFrens_1 = require("../suiFrens");
+const utils_1 = require("../../../general/utils");
+const eventsApiHelpers_1 = require("../../../general/api/eventsApiHelpers");
+class SuiFrensApi {
+    // =========================================================================
+    //  Constructor
+    // =========================================================================
+    constructor(Provider) {
+        this.Provider = Provider;
+        // =========================================================================
+        //  Public Methods
+        // =========================================================================
+        // =========================================================================
+        //  Inspections
+        // =========================================================================
+        this.fetchStakedSuiFrenFeesEarned = (stakedSuiFrenReceiptObjectId) => __awaiter(this, void 0, void 0, function* () {
+            const [suiFrenFeesEarnedIndividual, suiFrenFeesEarnedGlobal] = yield Promise.all([
+                this.fetchStakedSuiFrenFeesEarnedIndividual(stakedSuiFrenReceiptObjectId),
+                this.fetchStakedSuiFrenFeesEarnedGlobal(),
+            ]);
+            return {
+                individualFees: suiFrenFeesEarnedIndividual,
+                globalFees: suiFrenFeesEarnedGlobal,
+            };
+        });
+        this.fetchIsSuiFrenPackageOnChain = () => this.Provider.Objects().fetchDoesObjectExist(this.addresses.packages.suiFren);
+        this.fetchSuiFrensStakedInSuiFrenVaultWithAttributes = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const { limit, attributes } = inputs;
+            const isComplete = (suiFrens) => {
+                return (this.filterSuiFrensWithAttributes(suiFrens, attributes).length >=
+                    limit);
+            };
+            const suiFrensWithCursor = yield this.Provider.DynamicFields().fetchDynamicFieldsUntil(Object.assign(Object.assign({}, inputs), { fetchFunc: this.fetchSuiFrensStakedInSuiFrenVault, isComplete }));
+            const filteredSuiFrens = this.filterSuiFrensWithAttributes(suiFrensWithCursor.dynamicFieldObjects, attributes);
+            const resizedSuiFrensWithCursor = {
+                nextCursor: ((_a = suiFrensWithCursor.nextCursor) !== null && _a !== void 0 ? _a : limit < filteredSuiFrens.length)
+                    ? filteredSuiFrens[limit].objectId
+                    : suiFrensWithCursor.nextCursor,
+                dynamicFieldObjects: filteredSuiFrens.slice(0, limit),
+            };
+            return resizedSuiFrensWithCursor;
+        });
+        this.fetchStakedSuiFrenFeesEarnedIndividual = (stakingReceiptId) => __awaiter(this, void 0, void 0, function* () {
+            const tx = this.suiFrenFeesEarnedIndividualDevInspectTransaction(stakingReceiptId);
+            const bytes = yield this.Provider.Inspections().fetchFirstBytesFromTxOutput(tx);
+            return utils_1.Casting.bigIntFromBytes(bytes);
+        });
+        this.fetchStakedSuiFrenFeesEarnedGlobal = () => __awaiter(this, void 0, void 0, function* () {
+            const tx = this.suiFrenFeesEarnedGlobalDevInspectTransaction();
+            const bytes = yield this.Provider.Inspections().fetchFirstBytesFromTxOutput(tx);
+            return utils_1.Casting.bigIntFromBytes(bytes);
+        });
+        this.suiFrenFeesEarnedIndividualDevInspectTransaction = (stakingReceiptId) => {
+            const tx = new sui_js_1.TransactionBlock();
+            tx.moveCall({
+                target: helpers_1.Helpers.transactions.createTxTarget(this.addresses.packages.suiFrenVault, SuiFrensApi.constants.suiFrenVault.modules.suiFrenVault.moduleName, SuiFrensApi.constants.suiFrenVault.modules.suiFrenVault.functions
+                    .feesEarnedIndividual.name),
+                typeArguments: [],
+                arguments: [
+                    tx.object(this.addresses.objects.suiFrenVault),
+                    tx.object(stakingReceiptId),
+                ],
+            });
+            return tx;
+        };
+        this.suiFrenFeesEarnedGlobalDevInspectTransaction = () => {
+            const tx = new sui_js_1.TransactionBlock();
+            tx.moveCall({
+                target: helpers_1.Helpers.transactions.createTxTarget(this.addresses.packages.suiFrenVault, SuiFrensApi.constants.suiFrenVault.modules.suiFrenVault.moduleName, SuiFrensApi.constants.suiFrenVault.modules.suiFrenVault.functions
+                    .feesEarnedGlobal.name),
+                typeArguments: [],
+                arguments: [tx.object(this.addresses.objects.suiFrenVault)],
+            });
+            return tx;
+        };
+        // =========================================================================
+        //  Events
+        // =========================================================================
+        this.fetchSuiFrenBornEvents = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            return yield this.Provider.Events().fetchCastEventsWithCursor(Object.assign(Object.assign({}, inputs), { query: {
+                    MoveEventType: this.eventTypes.suiFrenBorn,
+                }, eventFromEventOnChain: suiFrensApiCasting_1.SuiFrensApiCasting.suiFrenBornEventFromOnChain }));
+        });
+        this.fetchBreedSuiFrensEvents = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            return yield this.Provider.Events().fetchCastEventsWithCursor(Object.assign(Object.assign({}, inputs), { query: {
+                    MoveEventType: this.eventTypes.breedSuiFrens,
+                }, eventFromEventOnChain: suiFrensApiCasting_1.SuiFrensApiCasting.breedSuiFrensEventFromOnChain }));
+        });
+        this.fetchStakeSuiFrenEvents = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            return yield this.Provider.Events().fetchCastEventsWithCursor(Object.assign(Object.assign({}, inputs), { query: {
+                    MoveEventType: this.eventTypes.stakeSuiFren,
+                }, eventFromEventOnChain: suiFrensApiCasting_1.SuiFrensApiCasting.stakeSuiFrenEventFromOnChain }));
+        });
+        this.fetchUnstakeSuiFrenEvents = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            return yield this.Provider.Events().fetchCastEventsWithCursor(Object.assign(Object.assign({}, inputs), { query: {
+                    MoveEventType: this.eventTypes.unstakeSuiFren,
+                }, eventFromEventOnChain: suiFrensApiCasting_1.SuiFrensApiCasting.unstakeSuiFrenEventFromOnChain }));
+        });
+        // =========================================================================
+        //  Objects
+        // =========================================================================
+        // =========================================================================
+        //  SuiFren Objects
+        // =========================================================================
+        this.fetchSuiFrens = (suiFrenIds) => __awaiter(this, void 0, void 0, function* () {
+            return this.Provider.Objects().fetchCastObjectBatch({
+                objectIds: suiFrenIds,
+                objectFromSuiObjectResponse: suiFrensApiCasting_1.SuiFrensApiCasting.suiFrenObjectFromSuiObjectResponse,
+            });
+        });
+        this.fetchSuiFrensOwnedByAddress = (walletAddress) => __awaiter(this, void 0, void 0, function* () {
+            return yield this.Provider.Objects().fetchCastObjectsOwnedByAddressOfType({
+                walletAddress,
+                objectType: this.objectTypes.suiFrenObjectType,
+                objectFromSuiObjectResponse: suiFrensApiCasting_1.SuiFrensApiCasting.suiFrenObjectFromSuiObjectResponse,
+            });
+        });
+        this.fetchStakedSuiFrens = (suiFrenIds) => __awaiter(this, void 0, void 0, function* () {
+            return this.Provider.Objects().fetchCastObjectBatch({
+                objectIds: suiFrenIds,
+                objectFromSuiObjectResponse: suiFrensApiCasting_1.SuiFrensApiCasting.suiFrenObjectFromSuiObjectResponse,
+            });
+        });
+        this.fetchStakedSuiFrensOwnedByAddress = (walletAddress) => __awaiter(this, void 0, void 0, function* () {
+            // i. obtain all owned StakingReceipt
+            const suiFrenIdsStakedByAddress = (yield this.fetchStakedSuiFrenReceiptOwnedByAddress(walletAddress)).map((suiFrenStakingReceipt) => suiFrenStakingReceipt.suiFrenId);
+            // ii. obtain a SuiFren object from each SuiFren ObjectId
+            const stakedSuiFrens = yield this.fetchStakedSuiFrens(suiFrenIdsStakedByAddress);
+            return stakedSuiFrens;
+        });
+        this.fetchSuiFrenVault = (suiFrenVaultId) => __awaiter(this, void 0, void 0, function* () {
+            return this.Provider.Objects().fetchCastObject({
+                objectId: suiFrenVaultId,
+                objectFromSuiObjectResponse: suiFrensApiCasting_1.SuiFrensApiCasting.suiFrenVaultObjectFromSuiObjectResponse,
+            });
+        });
+        this.fetchSuiFrensStakedInSuiFrenVault = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            const suiFrenVaultId = this.addresses.objects.suiFrenVault;
+            const suiFrenType = this.objectTypes.suiFrenObjectType;
+            return yield this.Provider.DynamicFields().fetchCastDynamicFieldsOfTypeWithCursor(Object.assign(Object.assign({}, inputs), { parentObjectId: suiFrenVaultId, objectsFromObjectIds: this.fetchSuiFrens, dynamicFieldType: suiFrenType }));
+        });
+        // =========================================================================
+        //  Staked SuiFren Receipt Objects
+        // =========================================================================
+        this.fetchStakedSuiFrenReceipt = (suiFrenStakingReceipt) => __awaiter(this, void 0, void 0, function* () {
+            return this.Provider.Objects().fetchCastObject({
+                objectId: suiFrenStakingReceipt,
+                objectFromSuiObjectResponse: suiFrensApiCasting_1.SuiFrensApiCasting.stakedSuiFrenReceiptObjectFromSuiObjectResponse,
+            });
+        });
+        this.fetchStakedSuiFrenReceipts = (suiFrenStakingReceipts) => __awaiter(this, void 0, void 0, function* () {
+            return this.Provider.Objects().fetchCastObjectBatch({
+                objectIds: suiFrenStakingReceipts,
+                objectFromSuiObjectResponse: suiFrensApiCasting_1.SuiFrensApiCasting.stakedSuiFrenReceiptObjectFromSuiObjectResponse,
+            });
+        });
+        this.fetchStakedSuiFrenReceiptOwnedByAddress = (walletAddress) => __awaiter(this, void 0, void 0, function* () {
+            return yield this.Provider.Objects().fetchCastObjectsOwnedByAddressOfType({
+                walletAddress,
+                objectType: this.objectTypes.stakedSuiFrenReceiptObjectType,
+                objectFromSuiObjectResponse: suiFrensApiCasting_1.SuiFrensApiCasting.stakedSuiFrenReceiptObjectFromSuiObjectResponse,
+            });
+        });
+        this.fetchStakedSuiFrenReceiptWithSuiFrensOwnedByAddress = (walletAddress) => __awaiter(this, void 0, void 0, function* () {
+            // i. obtain all owned StakingReceipt
+            const stakingReceipts = yield this.fetchStakedSuiFrenReceiptOwnedByAddress(walletAddress);
+            // ii. obtain all SuiFren Object Ids
+            const suiFrenIdsStakedByAddress = stakingReceipts.map((suiFrenStakingReceipt) => suiFrenStakingReceipt.suiFrenId);
+            // iii. obtain a SuiFren object from each SuiFren ObjectId
+            let indexStakedSuiFrens = {};
+            (yield this.fetchStakedSuiFrens(suiFrenIdsStakedByAddress)).forEach((stakedSuiFren) => {
+                indexStakedSuiFrens[stakedSuiFren.objectId] = stakedSuiFren;
+            });
+            // iv. construct a StakingReceiptWithSuiFren object from each StakingReceipt <> SuiFren pair
+            const suiFrenStakingReceiptsWithSuiFren = stakingReceipts.map((stakingReceipt) => {
+                return {
+                    objectId: stakingReceipt.objectId,
+                    suiFren: indexStakedSuiFrens[stakingReceipt.suiFrenId],
+                    unlockEpoch: stakingReceipt.unlockEpoch,
+                };
+            });
+            return suiFrenStakingReceiptsWithSuiFren;
+        });
+        // =========================================================================
+        //  Transactions
+        // =========================================================================
+        // =========================================================================
+        //  SuiFren Staking
+        // =========================================================================
+        this.fetchStakeSuiFrenTransaction = (suiFrenId) => this.Provider.Transactions().fetchSetGasBudgetAndSerializeTx(this.suiFrenStakeSuiFrenTransaction(suiFrenId));
+        this.fetchUnstakeSuiFrenTransaction = (stakingReceiptId) => this.Provider.Transactions().fetchSetGasBudgetAndSerializeTx(this.suiFrenUnstakeSuiFrenTransaction(stakingReceiptId));
+        this.fetchWithdrawStakedSuiFrenFeesTransaction = (stakingReceiptId) => this.Provider.Transactions().fetchSetGasBudgetAndSerializeTx(this.suiFrenWithdrawFeesTransaction(stakingReceiptId));
+        this.fetchWithdrawStakedSuiFrenFeesAmountTransaction = (stakingReceiptId, amount) => this.Provider.Transactions().fetchSetGasBudgetAndSerializeTx(this.suiFrenWithdrawFeesAmountTransaction(stakingReceiptId, amount));
+        this.fetchSuiFrenTransferTransaction = (stakingReceiptId, recipient) => this.Provider.Transactions().fetchSetGasBudgetAndSerializeTx(this.suiFrenTransferTransaction(stakingReceiptId, recipient));
+        // =========================================================================
+        //  Breeding Transactions
+        // =========================================================================
+        this.fetchBreedSuiFrensTransaction = (walletAddress, parentOneId, parentTwoId) => __awaiter(this, void 0, void 0, function* () {
+            const [parentOneIsOwned, parentTwoIsOwned] = yield Promise.all([
+                this.Provider.Objects().fetchIsObjectOwnedByAddress({
+                    objectId: parentOneId,
+                    walletAddress,
+                }),
+                this.Provider.Objects().fetchIsObjectOwnedByAddress({
+                    objectId: parentTwoId,
+                    walletAddress,
+                }),
+            ]);
+            const transaction = yield this.fetchSuiFrenBuildBreedTransaction(walletAddress, parentOneId, parentOneIsOwned, parentTwoId, parentTwoIsOwned);
+            return this.Provider.Transactions().fetchSetGasBudgetAndSerializeTx(transaction);
+        });
+        this.fetchSuiFrenBuildBreedTransaction = (walletAddress, parentOneId, parentOneIsOwned, parentTwoId, parentTwoIsOwned) => __awaiter(this, void 0, void 0, function* () {
+            if (parentOneIsOwned && parentTwoIsOwned) {
+                // i. both suiFrens are owned
+                return this.fetchBuildBreedAndKeepTransaction(walletAddress, parentOneId, parentTwoId);
+            }
+            else if (parentOneIsOwned && !parentTwoIsOwned) {
+                // iia. one of the SuiFrens is owned and the other is staked
+                return this.fetchBuildBreedWithStakedAndKeepTransaction(walletAddress, parentOneId, parentTwoId);
+            }
+            else if (!parentOneIsOwned && parentTwoIsOwned) {
+                // iib. one of the SuiFren's is owned and the other is staked
+                return this.fetchBuildBreedWithStakedAndKeepTransaction(walletAddress, parentTwoId, parentOneId);
+            }
+            else {
+                // iii. both SuiFrens are staked
+                return this.fetchBuildBreedStakedWithStakedAndKeepTransaction(walletAddress, parentTwoId, parentOneId);
+            }
+        });
+        this.fetchBuildBreedWithStakedAndKeepTransaction = (walletAddress, parentOneId, parentTwoId) => __awaiter(this, void 0, void 0, function* () {
+            const tx = new sui_js_1.TransactionBlock();
+            tx.setSender(walletAddress);
+            const feeCoinType = suiFrens_1.SuiFrens.constants.breedingFees.coinType;
+            const feeCoinAmount = suiFrens_1.SuiFrens.constants.breedingFees.amounts.breedWithStakedAndKeep;
+            const coinArg = yield this.Provider.Coin().fetchCoinWithAmountTx({
+                tx,
+                walletAddress,
+                coinType: feeCoinType,
+                coinAmount: feeCoinAmount,
+            });
+            const finalTx = this.addStakeBreedWithStakedAndKeepCommandToTransaction(tx, coinArg, parentOneId, parentTwoId);
+            return finalTx;
+        });
+        this.fetchBuildBreedStakedWithStakedAndKeepTransaction = (walletAddress, parentOneId, parentTwoId) => __awaiter(this, void 0, void 0, function* () {
+            const tx = new sui_js_1.TransactionBlock();
+            tx.setSender(walletAddress);
+            const feeCoinType = suiFrens_1.SuiFrens.constants.breedingFees.coinType;
+            const feeCoinAmount = suiFrens_1.SuiFrens.constants.breedingFees.amounts.breedStakedWithStakedAndKeep;
+            const coinArg = yield this.Provider.Coin().fetchCoinWithAmountTx({
+                tx,
+                walletAddress,
+                coinType: feeCoinType,
+                coinAmount: feeCoinAmount,
+            });
+            const finalTx = this.addStakeBreedWithStakedAndKeepCommandToTransaction(tx, coinArg, parentOneId, parentTwoId);
+            return finalTx;
+        });
+        this.fetchBuildBreedAndKeepTransaction = (walletAddress, parentOneId, parentTwoId) => __awaiter(this, void 0, void 0, function* () {
+            const tx = new sui_js_1.TransactionBlock();
+            tx.setSender(walletAddress);
+            const feeCoinType = suiFrens_1.SuiFrens.constants.breedingFees.coinType;
+            const feeCoinAmount = suiFrens_1.SuiFrens.constants.breedingFees.amounts.breedAndKeep;
+            const coinArg = yield this.Provider.Coin().fetchCoinWithAmountTx({
+                tx,
+                walletAddress,
+                coinType: feeCoinType,
+                coinAmount: feeCoinAmount,
+            });
+            const finalTx = this.addStakeBreedAndKeepCommandToTransaction(tx, coinArg, parentOneId, parentTwoId);
+            return finalTx;
+        });
+        // =========================================================================
+        //  Transaction Commands
+        // =========================================================================
+        // =========================================================================
+        //  Breeding Transaction
+        // =========================================================================
+        this.addStakeBreedAndKeepCommandToTransaction = (tx, coinId, parentOneId, parentTwoId) => {
+            tx.add({
+                kind: "MoveCall",
+                target: helpers_1.Helpers.transactions.createTxTarget(this.addresses.packages.suiFrenVault, SuiFrensApi.constants.suiFrenVault.modules.interface.moduleName, SuiFrensApi.constants.suiFrenVault.modules.interface.functions
+                    .breedAndKeep.name),
+                typeArguments: [],
+                arguments: [
+                    tx.object(this.addresses.objects.suiFrenVault),
+                    tx.object(this.addresses.objects.suiFrenRegistry),
+                    typeof coinId === "string" ? tx.object(coinId) : coinId,
+                    tx.object(parentOneId),
+                    tx.object(parentTwoId),
+                ],
+            });
+            return tx;
+        };
+        this.addStakeBreedWithStakedAndKeepCommandToTransaction = (tx, coinId, parentOneId, parentTwoId) => {
+            tx.add({
+                kind: "MoveCall",
+                target: helpers_1.Helpers.transactions.createTxTarget(this.addresses.packages.suiFrenVault, SuiFrensApi.constants.suiFrenVault.modules.interface.moduleName, SuiFrensApi.constants.suiFrenVault.modules.interface.functions
+                    .breedWithStakedAndKeep.name),
+                typeArguments: [],
+                arguments: [
+                    tx.object(this.addresses.objects.suiFrenVault),
+                    tx.object(this.addresses.objects.suiFrenRegistry),
+                    typeof coinId === "string" ? tx.object(coinId) : coinId,
+                    tx.object(parentOneId),
+                    tx.object(parentTwoId),
+                ],
+            });
+            return tx;
+        };
+        this.addStakeBreedStakedWithStakedAndKeepCommandToTransaction = (tx, coinId, parentOneId, parentTwoId) => {
+            tx.add({
+                kind: "MoveCall",
+                target: helpers_1.Helpers.transactions.createTxTarget(this.addresses.packages.suiFrenVault, SuiFrensApi.constants.suiFrenVault.modules.interface.moduleName, SuiFrensApi.constants.suiFrenVault.modules.interface.functions
+                    .breedStakedWithStakedAndKeep.name),
+                typeArguments: [],
+                arguments: [
+                    tx.object(this.addresses.objects.suiFrenVault),
+                    tx.object(this.addresses.objects.suiFrenRegistry),
+                    tx.object(coinId),
+                    tx.object(parentOneId),
+                    tx.object(parentTwoId),
+                ],
+            });
+            return tx;
+        };
+        // =========================================================================
+        //  Staking Transaction Commands
+        // =========================================================================
+        this.suiFrenStakeSuiFrenTransaction = (suiFrenId) => {
+            const tx = new sui_js_1.TransactionBlock();
+            tx.moveCall({
+                target: helpers_1.Helpers.transactions.createTxTarget(this.addresses.packages.suiFrenVault, SuiFrensApi.constants.suiFrenVault.modules.interface.moduleName, SuiFrensApi.constants.suiFrenVault.modules.interface.functions
+                    .stakeSuiFren.name),
+                typeArguments: [],
+                arguments: [
+                    tx.object(this.addresses.objects.suiFrenVault),
+                    tx.object(suiFrenId),
+                ],
+            });
+            return tx;
+        };
+        this.suiFrenUnstakeSuiFrenTransaction = (stakingReceiptId) => {
+            const tx = new sui_js_1.TransactionBlock();
+            tx.moveCall({
+                target: helpers_1.Helpers.transactions.createTxTarget(this.addresses.packages.suiFrenVault, SuiFrensApi.constants.suiFrenVault.modules.interface.moduleName, SuiFrensApi.constants.suiFrenVault.modules.interface.functions
+                    .unstakeSuiFren.name),
+                typeArguments: [],
+                arguments: [
+                    tx.object(this.addresses.objects.suiFrenVault),
+                    tx.object(stakingReceiptId),
+                ],
+            });
+            return tx;
+        };
+        this.suiFrenTransferTransaction = (stakingReceiptId, recipient) => {
+            const tx = new sui_js_1.TransactionBlock();
+            tx.moveCall({
+                target: helpers_1.Helpers.transactions.createTxTarget(this.addresses.packages.suiFrenVault, SuiFrensApi.constants.suiFrenVault.modules.interface.moduleName, SuiFrensApi.constants.suiFrenVault.modules.interface.functions
+                    .transfer.name),
+                typeArguments: [],
+                arguments: [
+                    tx.object(this.addresses.objects.suiFrenVault),
+                    tx.object(stakingReceiptId),
+                    tx.pure(recipient),
+                ],
+            });
+            return tx;
+        };
+        // =========================================================================
+        //  Fee Transaction Commands
+        // =========================================================================
+        this.suiFrenWithdrawFeesTransaction = (stakingReceiptId) => {
+            const tx = new sui_js_1.TransactionBlock();
+            tx.moveCall({
+                target: helpers_1.Helpers.transactions.createTxTarget(this.addresses.packages.suiFrenVault, SuiFrensApi.constants.suiFrenVault.modules.interface.moduleName, SuiFrensApi.constants.suiFrenVault.modules.interface.functions
+                    .withdrawFees.name),
+                typeArguments: [],
+                arguments: [
+                    tx.object(this.addresses.objects.suiFrenVault),
+                    tx.object(stakingReceiptId),
+                ],
+            });
+            return tx;
+        };
+        this.suiFrenWithdrawFeesAmountTransaction = (stakingReceiptId, amount) => {
+            const tx = new sui_js_1.TransactionBlock();
+            tx.moveCall({
+                target: helpers_1.Helpers.transactions.createTxTarget(this.addresses.packages.suiFrenVault, SuiFrensApi.constants.suiFrenVault.modules.interface.moduleName, SuiFrensApi.constants.suiFrenVault.modules.interface.functions
+                    .withdrawFeesAmount.name),
+                typeArguments: [],
+                arguments: [
+                    tx.object(this.addresses.objects.suiFrenVault),
+                    tx.object(stakingReceiptId),
+                    tx.pure(amount.toString()),
+                ],
+            });
+            return tx;
+        };
+        // =========================================================================
+        //  Stats
+        // =========================================================================
+        // TODO: make this function not exported from sdk (only internal use)
+        // NOTE: this calculation will be  incorrect if feeCoinType is different for each fee
+        this.calcSuiFrenBreedingFees = (breedSuiFrenEvents, feeCoinDecimals, feeCoinPrice) => {
+            const breedingFeesInFeeCoin = helpers_1.Helpers.sum(breedSuiFrenEvents.map((event) => coin_1.Coin.balanceWithDecimals(event.feeCoinWithBalance.balance, feeCoinDecimals)));
+            const breedingFeesUsd = feeCoinPrice * breedingFeesInFeeCoin;
+            return {
+                amount: breedingFeesInFeeCoin,
+                amountUsd: breedingFeesUsd,
+            };
+        };
+        this.fetchSuiFrenStats = () => __awaiter(this, void 0, void 0, function* () {
+            const breedSuiFrenEventsWithinTime = yield this.Provider.Events().fetchEventsWithinTime({
+                fetchEventsFunc: this.fetchBreedSuiFrensEvents,
+                timeUnit: "hour",
+                time: 24,
+            });
+            const feeCoin = breedSuiFrenEventsWithinTime.length === 0
+                ? suiFrens_1.SuiFrens.constants.breedingFees.coinType
+                : breedSuiFrenEventsWithinTime[0].feeCoinWithBalance.coin;
+            const feeCoinDecimals = (yield this.Provider.Coin().fetchCoinMetadata(feeCoin)).decimals;
+            const feeCoinPrice = yield this.Provider.Prices().fetchPrice(feeCoin);
+            const breedingFeesDaily = this.calcSuiFrenBreedingFees(breedSuiFrenEventsWithinTime, feeCoinDecimals, feeCoinPrice);
+            const suiFrenVault = yield this.fetchSuiFrenVault(this.addresses.objects.suiFrenVault);
+            const { bredSuiFrens, stakedSuiFrens, breedingFeesGlobal } = yield this.fetchSuiFrenVaultStats(suiFrenVault, feeCoinDecimals, feeCoinPrice);
+            return {
+                bredSuiFrens,
+                stakedSuiFrens,
+                breedingFeeCoin: feeCoin,
+                breedingFeesGlobal,
+                breedingFeesDaily,
+                breedingVolumeDaily: breedSuiFrenEventsWithinTime.length,
+            };
+        });
+        this.fetchSuiFrenVaultStats = (suiFrenVault, feeCoinDecimals, feeCoinPrice) => __awaiter(this, void 0, void 0, function* () {
+            const globalFeesWithDecimals = coin_1.Coin.balanceWithDecimals(suiFrenVault.globalFees, feeCoinDecimals);
+            const globalFeesUsd = feeCoinPrice * globalFeesWithDecimals;
+            const breedingFeesGlobal = {
+                amount: globalFeesWithDecimals,
+                amountUsd: globalFeesUsd,
+            };
+            return {
+                bredSuiFrens: suiFrenVault.bredSuiFrens,
+                stakedSuiFrens: suiFrenVault.stakedSuiFrens,
+                breedingFeesGlobal,
+            };
+        });
+        // =========================================================================
+        //  SuiFren Attribute Filtering
+        // =========================================================================
+        this.filterSuiFrensWithAttributes = (suiFrens, attributes) => suiFrens.filter((suiFren) => attributes.every((attribute) => suiFren.fields.attributes.some((suiFrenAttribute) => suiFrenAttribute.name === attribute.name &&
+            suiFrenAttribute.value === attribute.value)));
+        // =========================================================================
+        //  Helpers
+        // =========================================================================
+        this.isStakedSuiFrenReceiptObjectType = (suiObjectInfo) => suiObjectInfo.type === this.objectTypes.stakedSuiFrenReceiptObjectType;
+        this.isSuiFrenObjectType = (suiObjectInfo) => suiObjectInfo.type === this.objectTypes.suiFrenObjectType;
+        // =========================================================================
+        //  Private Methods
+        // =========================================================================
+        // =========================================================================
+        //  Event Types
+        // =========================================================================
+        this.suiFrenBornEventType = () => eventsApiHelpers_1.EventsApiHelpers.createEventType(this.addresses.packages.suiFren, SuiFrensApi.constants.suiFren.modules.suiFren.moduleName, SuiFrensApi.constants.eventNames.suiFrenBorn);
+        this.breedSuiFrensEventType = () => eventsApiHelpers_1.EventsApiHelpers.createEventType(this.addresses.packages.suiFrenVault, SuiFrensApi.constants.suiFrenVault.modules.interface.moduleName, SuiFrensApi.constants.eventNames.breedSuiFren);
+        this.stakeSuiFrenEventType = () => eventsApiHelpers_1.EventsApiHelpers.createEventType(this.addresses.packages.suiFrenVault, SuiFrensApi.constants.suiFrenVault.modules.interface.moduleName, SuiFrensApi.constants.eventNames.stakeSuiFren);
+        this.unstakeSuiFrenEventType = () => eventsApiHelpers_1.EventsApiHelpers.createEventType(this.addresses.packages.suiFrenVault, SuiFrensApi.constants.suiFrenVault.modules.interface.moduleName, SuiFrensApi.constants.eventNames.unstakeSuiFren);
+        const addresses = this.Provider.addresses.suiFrens;
+        if (!addresses)
+            throw new Error("not all required addresses have been set in provider");
+        this.addresses = addresses;
+        this.objectTypes = {
+            suiFrenObjectType: `${addresses.packages.suiFren}::suiFren::SuiFren`,
+            stakedSuiFrenReceiptObjectType: `${addresses.packages.suiFrenVault}::suiFren_vault::StakingReceipt`,
+        };
+        this.eventTypes = {
+            suiFrenBorn: this.suiFrenBornEventType(),
+            breedSuiFrens: this.breedSuiFrensEventType(),
+            stakeSuiFren: this.stakeSuiFrenEventType(),
+            unstakeSuiFren: this.unstakeSuiFrenEventType(),
+        };
+    }
+}
+exports.SuiFrensApi = SuiFrensApi;
+// =========================================================================
+//  Constants
+// =========================================================================
+SuiFrensApi.constants = {
+    suiFren: {
+        modules: {
+            suiFren: {
+                moduleName: "suiFren",
+            },
+        },
+    },
+    suiFrenVault: {
+        modules: {
+            interface: {
+                moduleName: "interface",
+                functions: {
+                    stakeSuiFren: {
+                        name: "stake_suiFren",
+                    },
+                    unstakeSuiFren: {
+                        name: "unstake_suiFren",
+                    },
+                    withdrawFees: {
+                        name: "withdraw_fees",
+                    },
+                    withdrawFeesAmount: {
+                        name: "withdraw_fees_amount",
+                    },
+                    breedAndKeep: {
+                        name: "breed_and_keep",
+                    },
+                    breedWithStakedAndKeep: {
+                        name: "breed_with_staked_and_keep",
+                    },
+                    breedStakedWithStakedAndKeep: {
+                        name: "breed_staked_with_staked_and_keep",
+                    },
+                    transfer: {
+                        name: "transfer",
+                    },
+                },
+            },
+            suiFrenVault: {
+                moduleName: "suiFren_vault",
+                functions: {
+                    feesEarnedIndividual: {
+                        name: "fees_earned_individual",
+                    },
+                    feesEarnedGlobal: {
+                        name: "fees_earned_global",
+                    },
+                },
+            },
+        },
+    },
+    eventNames: {
+        suiFrenBorn: "SuiFrenBorn",
+        breedSuiFren: "BreedSuiFrenEvent",
+        stakeSuiFren: "StakeSuiFrenEvent",
+        unstakeSuiFren: "UnstakeSuiFrenEvent",
+        withdrawFees: "WithdrawFeesEvent",
+    },
+};

package/dist/packages/suiFrens/api/suiFrensApiCasting.d.ts

@@ -0,0 +1,13 @@
+import { SuiObjectResponse } from "@mysten/sui.js";
+import { BreedSuiFrensEvent, SuiFrenBornEvent, SuiFrenObject, SuiFrenVaultObject, StakeSuiFrenEvent, StakedSuiFrenReceiptObject, UnstakeSuiFrenEvent } from "../suiFrensTypes";
+import { BreedSuiFrenEventOnChain as BreedSuiFrensEventOnChain, SuiFrenBornEventOnChain, StakeSuiFrenEventOnChain, UnstakeSuiFrenEventOnChain } from "./suiFrensApiCastingTypes";
+export declare class SuiFrensApiCasting {
+    static suiFrenObjectFromSuiObjectResponse: (data: SuiObjectResponse) => SuiFrenObject;
+    static stakedSuiFrenReceiptObjectFromSuiObjectResponse: (data: SuiObjectResponse) => StakedSuiFrenReceiptObject;
+    static suiFrenVaultObjectFromSuiObjectResponse: (data: SuiObjectResponse) => SuiFrenVaultObject;
+    static suiFrenBornEventFromOnChain: (eventOnChain: SuiFrenBornEventOnChain) => SuiFrenBornEvent;
+    static breedSuiFrensEventFromOnChain: (eventOnChain: BreedSuiFrensEventOnChain) => BreedSuiFrensEvent;
+    static stakeSuiFrenEventFromOnChain: (eventOnChain: StakeSuiFrenEventOnChain) => StakeSuiFrenEvent;
+    static unstakeSuiFrenEventFromOnChain: (eventOnChain: UnstakeSuiFrenEventOnChain) => UnstakeSuiFrenEvent;
+}
+//# sourceMappingURL=suiFrensApiCasting.d.ts.map

package/dist/packages/suiFrens/api/suiFrensApiCasting.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suiFrensApiCasting.d.ts","sourceRoot":"","sources":["../../../../src/packages/suiFrens/api/suiFrensApiCasting.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,iBAAiB,EAGjB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACN,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,iBAAiB,EACjB,0BAA0B,EAC1B,mBAAmB,EACnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,wBAAwB,IAAI,yBAAyB,EACrD,uBAAuB,EAGvB,wBAAwB,EAExB,0BAA0B,EAC1B,MAAM,2BAA2B,CAAC;AAGnC,qBAAa,kBAAkB;IAK9B,OAAc,kCAAkC,SACzC,iBAAiB,KACrB,aAAa,CAgBd;IAEF,OAAc,+CAA+C,SACtD,iBAAiB,KACrB,0BAA0B,CAS3B;IAgBF,OAAc,uCAAuC,SAC9C,iBAAiB,KACrB,kBAAkB,CASnB;IAMF,OAAc,2BAA2B,6CAEtC,gBAAgB,CAWjB;IAEF,OAAc,6BAA6B,+CAExC,kBAAkB,CAenB;IAEF,OAAc,4BAA4B,8CAEvC,iBAAiB,CAWlB;IAEF,OAAc,8BAA8B,gDAEzC,mBAAmB,CASpB;CACF"}