@tradeport/sui-trading-sdk 0.5.1 → 0.5.3

package/src/helpers/kiosk/preProcessSharedBulkBuyingData.ts

@@ -1,171 +0,0 @@
-import type { KioskClient } from '@mysten/kiosk';
-import { bcs } from '@mysten/sui/bcs';
-import type { SuiGrpcClient } from '@mysten/sui/grpc';
-import { Transaction } from '@mysten/sui/transactions';
-import { TRADEPORT_KIOSK_LISTING_STORE } from '../../constants';
-import { addLeadingZerosAfter0x } from '../../utils/addLeadingZerosAfter0x';
-import { getNftType } from '../getNftType';
-import { getSharedObjects } from '../getSharedObjects';
-import { isOriginByteCollection } from '../originByte/isOriginByteCollection';
-import { getTransferPoliciesToResolve } from './getTransferPoliciesToResolve';
-import { KioskListing } from './kioskListingBcs';
-
-export type SharedBulkBuyingDataByNftType = Record<
-	string,
-	{
-		sharedObjects?: any;
-		transferPoliciesToResolve?: any[];
-		royaltyFeeAmountsByListingId?: Record<string, bigint>;
-		commissionFeeAmountsByListingId?: Record<string, number>;
-	}
->;
-
-export const preProcessSharedBulkBuyingData = async ({
-	listings,
-	suiClient,
-	kioskClient,
-	walletAddress,
-}: {
-	listings: any[];
-	suiClient: SuiGrpcClient;
-	kioskClient: KioskClient;
-	walletAddress: string;
-}) => {
-	const sharedBulkBuyingDataByNftType: SharedBulkBuyingDataByNftType = {};
-
-	const listingsByNftType = listings.reduce<Record<string, any[]>>(
-		(acc: Record<string, any[]>, listing: any) => {
-			const nftType = getNftType({
-				collectionId: listing?.collection?.id,
-				collectionChainState: listing?.collection?.chain_state,
-				nft: listing?.nft,
-			});
-
-			acc[nftType] = [...(acc[nftType] || []), listing];
-
-			return acc;
-		},
-		{},
-	);
-
-	for (const nftType of Object.keys(listingsByNftType)) {
-		sharedBulkBuyingDataByNftType[nftType] = {
-			sharedObjects: [],
-			transferPoliciesToResolve: [],
-			royaltyFeeAmountsByListingId: {},
-			commissionFeeAmountsByListingId: {},
-		};
-
-		const transferPolicies =
-			listingsByNftType[nftType]?.[0]?.collection?.chain_state?.transfer_policies;
-
-		if (isOriginByteCollection(transferPolicies)) {
-			sharedBulkBuyingDataByNftType[nftType].sharedObjects = await getSharedObjects(nftType);
-			continue;
-		}
-
-		const tradeportLegacyKioskListings = listingsByNftType[nftType]?.filter(
-			(listing: any) =>
-				listing.market_name === 'tradeport' &&
-				!listing.nonce?.startsWith('0::') &&
-				!listing.nonce?.startsWith('1::') &&
-				listing.price &&
-				listing.listed &&
-				!(listing?.nonce && isOriginByteCollection(transferPolicies)) &&
-				listing.nft?.chain_state?.kiosk_id,
-		);
-
-		if (tradeportLegacyKioskListings.length === 0) {
-			continue;
-		}
-
-		const transferPoliciesToResolve = await getTransferPoliciesToResolve({
-			transferPolicies,
-			suiClient,
-			kioskClient,
-			nftType,
-		});
-		sharedBulkBuyingDataByNftType[nftType].transferPoliciesToResolve = transferPoliciesToResolve;
-
-		const transferPolicyToResolve = transferPoliciesToResolve.at(0);
-
-		const royaltyRuleToResolve = transferPolicyToResolve.rules.find(
-			(rule: any) => rule.moduleName === 'royalty_rule' || rule.moduleName === 'kiosk_royalty_rule',
-		);
-
-		if (royaltyRuleToResolve?.rulePackageId && royaltyRuleToResolve?.moduleName) {
-			// for each tp kiosk listing, create fee_amount txs and dev inspect the tx block to get the royalty fee amounts and store them in shared data
-			const feeTx = new Transaction();
-			for (const listing of tradeportLegacyKioskListings) {
-				feeTx.moveCall({
-					target: `${royaltyRuleToResolve.rulePackageId}::${royaltyRuleToResolve.moduleName}::fee_amount`,
-					arguments: [feeTx.object(transferPolicyToResolve?.id), feeTx.pure.u64(listing.price)],
-					typeArguments: [nftType],
-				});
-			}
-
-			feeTx.setSender(addLeadingZerosAfter0x(walletAddress));
-			const res = await suiClient.simulateTransaction({
-				transaction: feeTx,
-				include: { commandResults: true },
-				checksEnabled: false,
-			});
-
-			const commandResults = res.commandResults ?? [];
-			for (let i = 0; i < commandResults.length; i++) {
-				const result = commandResults[i];
-				const returnedAmount = result?.returnValues?.[0]?.bcs;
-				if (!returnedAmount) {
-					continue;
-				}
-
-				const feeAmount = BigInt(bcs.U64.parse(returnedAmount));
-
-				if (!feeAmount && feeAmount !== 0n) {
-					// We were not able to calculate the fee amount outside of the transaction via simulation, so skip pre processing
-					continue;
-				}
-
-				sharedBulkBuyingDataByNftType[nftType].royaltyFeeAmountsByListingId[
-					tradeportLegacyKioskListings[i].id
-				] = feeAmount;
-			}
-		}
-
-		// for each tp kiosk listing, pre-fetch commission fee amounts in batches and store them in shared data
-		const batchSize = 10;
-		const commissionResults: Array<{ listingId: string; commission: number }> = [];
-		for (let i = 0; i < tradeportLegacyKioskListings.length; i += batchSize) {
-			const batch = tradeportLegacyKioskListings.slice(i, i + batchSize);
-			const batchPromises = batch.map(async (listing: any) => {
-				try {
-					const { object } = await suiClient.core.getDynamicObjectField({
-						parentId: TRADEPORT_KIOSK_LISTING_STORE,
-						name: {
-							type: '0x2::object::ID',
-							bcs: bcs.Address.serialize(listing.nft.token_id).toBytes(),
-						},
-						include: { content: true },
-					});
-
-					return {
-						listingId: listing.id,
-						commission: Number(KioskListing.parse(object.content).commission),
-					};
-				} catch {
-					throw new Error(`Not found kiosk listing object of token ${listing.nft.token_id}`);
-				}
-			});
-
-			const batchResults = await Promise.all(batchPromises);
-			commissionResults.push(...batchResults);
-		}
-
-		for (const result of commissionResults) {
-			sharedBulkBuyingDataByNftType[nftType].commissionFeeAmountsByListingId[result.listingId] =
-				result.commission;
-		}
-	}
-
-	return sharedBulkBuyingDataByNftType;
-};

package/src/helpers/kiosk/resolveCustomTransferPolicyRules.ts

@@ -1,75 +0,0 @@
-import {
-	type Transaction,
-	type TransactionArgument,
-	type TransactionObjectInput,
-} from '@mysten/sui/transactions';
-import { CUSTOM_TRANSFER_RULES_BY_COLLECTION } from '../../constants';
-import { resolveTableAllowlistRule } from './resolveTableAllowlistRule';
-
-type ResolverArgs = {
-	tx: Transaction;
-	packageId: string;
-	transferRequest: TransactionArgument;
-	nftType: string;
-	policyId: TransactionObjectInput;
-	params: Record<string, string>;
-};
-
-type CustomRuleResolver = (args: ResolverArgs) => void;
-
-const customRuleResolvers: Record<string, CustomRuleResolver> = {
-	table_allowlist_rule: resolveTableAllowlistRule,
-};
-
-export const customTransferPolicyRuleNames = Object.keys(customRuleResolvers);
-
-type RuleData = {
-	rule: string;
-	rulePackageId?: string;
-	moduleName?: string;
-	params?: Record<string, string>;
-};
-
-function findParamsFromConfig(moduleName: string, packageId: string): Record<string, string> {
-	for (const configs of Object.values(CUSTOM_TRANSFER_RULES_BY_COLLECTION)) {
-		const match = configs.find((c) => c.moduleName === moduleName && c.packageId === packageId);
-		if (match) return match.params;
-	}
-
-	throw new Error(`No custom rule config found for ${moduleName} at package ${packageId}`);
-}
-
-export function resolveCustomTransferPolicyRules({
-	tx,
-	rules,
-	transferRequest,
-	nftType,
-	policyId,
-}: {
-	tx: Transaction;
-	rules: RuleData[];
-	transferRequest: TransactionArgument;
-	nftType: string;
-	policyId: TransactionObjectInput;
-}): boolean {
-	let resolved = false;
-	for (const rule of rules) {
-		const moduleName = rule.moduleName ?? rule.rule?.split('::')?.[1];
-		const resolver = moduleName ? customRuleResolvers[moduleName] : undefined;
-		if (resolver) {
-			const packageId = rule.rulePackageId ?? rule.rule?.split('::')?.[0];
-			const params = rule.params ?? findParamsFromConfig(moduleName, packageId);
-			resolver({
-				tx,
-				packageId,
-				transferRequest,
-				nftType,
-				policyId,
-				params,
-			});
-			resolved = true;
-		}
-	}
-
-	return resolved;
-}

package/src/helpers/kiosk/resolveFloorPriceRule.ts

@@ -1,21 +0,0 @@
-import {
-	type Transaction,
-	type TransactionArgument,
-	type TransactionObjectInput,
-} from '@mysten/sui/transactions';
-
-type Args = {
-	tx: Transaction;
-	packageId: string;
-	transferRequest: TransactionArgument;
-	nftType: string;
-	policyId: TransactionObjectInput;
-};
-
-export function resolveFloorPriceRule({ tx, packageId, nftType, policyId, transferRequest }: Args) {
-	tx.moveCall({
-		target: `${packageId}::floor_price_rule::prove`,
-		typeArguments: [nftType],
-		arguments: [tx.object(policyId), transferRequest],
-	});
-}

package/src/helpers/kiosk/resolveKioskLockRule.ts

@@ -1,47 +0,0 @@
-import {
-	type Transaction,
-	type TransactionArgument,
-	type TransactionObjectInput,
-} from '@mysten/sui/transactions';
-
-type Args = {
-	tx: Transaction;
-	policyId: TransactionObjectInput;
-	packageId: string;
-	transferRequest: TransactionArgument;
-	nftType: string;
-	kiosk: TransactionObjectInput;
-	kioskCap: TransactionObjectInput;
-	kioskItem?: TransactionObjectInput;
-	shouldSkipLocking?: boolean;
-};
-
-export function resolveKioskLockRule({
-	tx,
-	packageId,
-	policyId,
-	transferRequest,
-	nftType,
-	kiosk,
-	kioskCap,
-	kioskItem,
-	shouldSkipLocking,
-}: Args) {
-	if (!kiosk || !kioskCap) throw new Error('Missing Owned Kiosk or Owned Kiosk Cap');
-
-	if (!shouldSkipLocking) {
-		if (!kioskItem) throw new Error('Missing Kiosk Item');
-
-		tx.moveCall({
-			target: '0x2::kiosk::lock',
-			typeArguments: [nftType],
-			arguments: [tx.object(kiosk), tx.object(kioskCap), tx.object(policyId), tx.object(kioskItem)],
-		});
-	}
-
-	tx.moveCall({
-		target: `${packageId}::kiosk_lock_rule::prove`,
-		typeArguments: [nftType],
-		arguments: [transferRequest, tx.object(kiosk)],
-	});
-}

package/src/helpers/kiosk/resolvePersonalKioskRule.ts

@@ -1,23 +0,0 @@
-import {
-	type Transaction,
-	type TransactionArgument,
-	type TransactionObjectInput,
-} from '@mysten/sui/transactions';
-
-type Args = {
-	tx: Transaction;
-	packageId: string;
-	transferRequest: TransactionArgument;
-	nftType: string;
-	kiosk: TransactionObjectInput;
-};
-
-export function resolvePersonalKioskRule({ tx, packageId, nftType, kiosk, transferRequest }: Args) {
-	if (!kiosk) throw new Error('Missing owned Kiosk.');
-
-	tx.moveCall({
-		target: `${packageId}::personal_kiosk_rule::prove`,
-		typeArguments: [nftType],
-		arguments: [tx.object(kiosk), transferRequest],
-	});
-}

package/src/helpers/kiosk/resolveRoyaltyRule.ts

@@ -1,57 +0,0 @@
-import { type SuiGrpcClient } from '@mysten/sui/grpc';
-import {
-	type Transaction,
-	type TransactionArgument,
-	type TransactionObjectInput,
-} from '@mysten/sui/transactions';
-import { getKioskCollectionRoyaltyFeeAmount } from './getKioskCollectionRoyaltyFeeAmount';
-
-type Args = {
-	tx: Transaction;
-	suiClient: SuiGrpcClient;
-	walletAddress: string;
-	policyId: TransactionObjectInput;
-	moduleName: string;
-	packageId: string;
-	transferRequest: TransactionArgument;
-	nftType: string;
-	price: string;
-	coinToSplit?: any;
-	royaltyFeeAmount?: bigint;
-};
-
-export async function resolveRoyaltyRule({
-	tx,
-	suiClient,
-	walletAddress,
-	packageId,
-	moduleName,
-	policyId,
-	transferRequest,
-	nftType,
-	price,
-	coinToSplit,
-	royaltyFeeAmount,
-}: Args) {
-	let feeAmount: bigint | TransactionArgument | undefined = royaltyFeeAmount;
-	if (!feeAmount) {
-		feeAmount = await getKioskCollectionRoyaltyFeeAmount({
-			tx,
-			suiClient,
-			walletAddress,
-			royaltyRulePackageId: packageId,
-			royaltyRuleModule: moduleName,
-			transferPolicyId: policyId,
-			price,
-			nftType,
-		});
-	}
-
-	const feeCoin = tx.splitCoins(coinToSplit ? coinToSplit : tx.gas, [feeAmount]);
-
-	tx.moveCall({
-		target: `${packageId}::${moduleName}::pay`,
-		typeArguments: [nftType],
-		arguments: [tx.object(policyId), transferRequest, feeCoin],
-	});
-}

package/src/helpers/kiosk/resolveTableAllowlistRule.ts

@@ -1,34 +0,0 @@
-import {
-	type Transaction,
-	type TransactionArgument,
-	type TransactionObjectInput,
-} from '@mysten/sui/transactions';
-
-type Args = {
-	tx: Transaction;
-	packageId: string;
-	transferRequest: TransactionArgument;
-	nftType: string;
-	policyId: TransactionObjectInput;
-	params: Record<string, string>;
-};
-
-export function resolveTableAllowlistRule({
-	tx,
-	packageId,
-	nftType,
-	policyId,
-	transferRequest,
-	params,
-}: Args) {
-	const { registryId } = params;
-	if (!registryId) {
-		throw new Error(`Missing registryId in params for table_allowlist_rule (package ${packageId})`);
-	}
-
-	tx.moveCall({
-		target: `${packageId}::table_allowlist_rule::resolve`,
-		typeArguments: [nftType],
-		arguments: [tx.object(policyId), transferRequest, tx.object(registryId)],
-	});
-}

package/src/helpers/kiosk/resolveTransferPolicies.ts

@@ -1,158 +0,0 @@
-import { type KioskClient } from '@mysten/kiosk';
-import { type SuiGrpcClient } from '@mysten/sui/grpc';
-import {
-	type Transaction,
-	type TransactionArgument,
-	type TransactionObjectInput,
-} from '@mysten/sui/transactions';
-import { getTransferPoliciesToResolve } from './getTransferPoliciesToResolve';
-import { resolveFloorPriceRule } from './resolveFloorPriceRule';
-import { resolveKioskLockRule } from './resolveKioskLockRule';
-import { resolvePersonalKioskRule } from './resolvePersonalKioskRule';
-import { resolveRoyaltyRule } from './resolveRoyaltyRule';
-import { resolveCustomTransferPolicyRules } from './resolveCustomTransferPolicyRules';
-
-export type Policy = {
-	data: any;
-	transferRequest: TransactionArgument;
-	isCustom: boolean;
-	type?: string;
-};
-
-type Props = {
-	tx: Transaction;
-	transferPolicies: any[];
-	suiClient: SuiGrpcClient;
-	walletAddress: string;
-	kioskClient: KioskClient;
-	kioskTx: any;
-	nftType: string;
-	kioskToLockRuleProve?: TransactionObjectInput;
-	kioskItem?: TransactionObjectInput;
-	transferRequest: TransactionArgument;
-	customTransferPolicies?: any;
-	price: string;
-	shouldSkipKioskLocking?: boolean;
-	shouldSkipResolvingRoyaltyRule?: boolean;
-	coinToSplit?: any;
-	beforeResolveKioskTransferRequest?: (transferRequest: any) => void | Promise<void>;
-	transferPoliciesToResolve?: any[];
-	royaltyFeeAmount?: bigint;
-};
-
-export const resolveTransferPolicies = async ({
-	tx,
-	transferPolicies,
-	suiClient,
-	walletAddress,
-	kioskClient,
-	kioskTx,
-	nftType,
-	kioskToLockRuleProve,
-	kioskItem,
-	transferRequest,
-	customTransferPolicies,
-	price,
-	shouldSkipKioskLocking,
-	shouldSkipResolvingRoyaltyRule,
-	coinToSplit,
-	beforeResolveKioskTransferRequest,
-	transferPoliciesToResolve,
-	royaltyFeeAmount,
-}: Props) => {
-	const policies =
-		transferPoliciesToResolve ??
-		(await getTransferPoliciesToResolve({
-			transferPolicies,
-			suiClient,
-			kioskClient,
-			nftType,
-			customTransferPolicies,
-		}));
-
-	let hasLockRule = false;
-	for (const policy of policies) {
-		for (const rule of policy.rules) {
-			switch (rule.moduleName) {
-				case 'kiosk_lock_rule':
-					hasLockRule = true;
-					resolveKioskLockRule({
-						tx,
-						packageId: rule.rulePackageId,
-						policyId: policy.id,
-						transferRequest,
-						nftType: policy.isCustom && policy.type ? policy.type : nftType,
-						kiosk: kioskToLockRuleProve ? kioskToLockRuleProve : kioskTx.kiosk,
-						kioskCap: kioskTx.kioskCap,
-						kioskItem,
-						shouldSkipLocking: shouldSkipKioskLocking,
-					});
-					break;
-				case 'personal_kiosk_rule':
-					resolvePersonalKioskRule({
-						tx,
-						packageId: rule.rulePackageId,
-						nftType: policy.isCustom && policy.type ? policy.type : nftType,
-						kiosk: kioskTx.kiosk,
-						transferRequest,
-					});
-					break;
-				case 'royalty_rule':
-				case 'kiosk_royalty_rule':
-					if (shouldSkipResolvingRoyaltyRule) break;
-					await resolveRoyaltyRule({
-						tx,
-						suiClient,
-						walletAddress,
-						packageId: rule.rulePackageId,
-						moduleName: rule.moduleName,
-						policyId: policy.id,
-						transferRequest,
-						nftType: policy.isCustom && policy.type ? policy.type : nftType,
-						price,
-						coinToSplit,
-						royaltyFeeAmount,
-					});
-					break;
-				case 'floor_price_rule':
-					resolveFloorPriceRule({
-						tx,
-						packageId: rule.rulePackageId,
-						nftType: policy.isCustom && policy.type ? policy.type : nftType,
-						policyId: policy.id,
-						transferRequest,
-					});
-					break;
-				default: {
-					const nftTypeForRule = policy.isCustom && policy.type ? policy.type : nftType;
-					const wasResolved = resolveCustomTransferPolicyRules({
-						tx,
-						rules: [rule],
-						transferRequest,
-						nftType: nftTypeForRule,
-						policyId: policy.id,
-					});
-					if (!wasResolved) {
-						throw new Error(`No resolver for the following rule: ${rule.rule}.`);
-					}
-
-					break;
-				}
-			}
-		}
-	}
-
-	if (!hasLockRule && kioskItem) {
-		kioskTx.place({ itemType: nftType, item: kioskItem });
-	}
-
-	await beforeResolveKioskTransferRequest?.(transferRequest);
-
-	for (const policy of policies) {
-		tx.moveCall({
-			target: '0x2::transfer_policy::confirm_request',
-			arguments: [tx.object(policy.id), transferRequest],
-			typeArguments: [policy.isCustom && policy.type ? policy.type : nftType],
-		});
-	}
-};

package/src/helpers/kiosk/sharedKioskState.type.ts

@@ -1,11 +0,0 @@
-import type { KioskTransaction } from '@mysten/kiosk';
-
-export type SharedKioskState = {
-	kioskTx: KioskTransaction | undefined;
-	ownerKiosks?: Array<{
-		id: string;
-		is_personal: boolean;
-		is_origin_byte: boolean;
-		is_shared: boolean;
-	}>;
-};

package/src/helpers/kiosk/takeAndBorrowNftFromKiosk.ts

@@ -1,50 +0,0 @@
-import { type KioskClient, type KioskTransaction, type TransferPolicy } from '@mysten/kiosk';
-import { type SuiGrpcClient } from '@mysten/sui/grpc';
-import { type Transaction } from '@mysten/sui/transactions';
-import { getKioskIdFromKioskTx } from './getKioskIdFromKioskTx';
-import { takeLockedNftFromKiosk } from './takeLockedNftFromKiosk';
-
-export const takeAndBorrowNftFromKiosk = async ({
-	tx,
-	transferPolicies,
-	kioskTx,
-	kioskClient,
-	nftTokenId,
-	nftType,
-	suiClient,
-	kioskOwner,
-}: {
-	tx: Transaction;
-	transferPolicies: TransferPolicy[];
-	kioskTx: KioskTransaction;
-	kioskClient: KioskClient;
-	nftTokenId: string;
-	nftType: string;
-	suiClient: SuiGrpcClient;
-	kioskOwner: string;
-}) => {
-	const kioskId = getKioskIdFromKioskTx({ kioskTx, tx });
-	const res = await kioskClient.getKiosk({ id: kioskId });
-	const nftInKiosk = res.items.find((i) => i.objectId === nftTokenId);
-
-	let borrowedNft = null;
-	if (nftInKiosk?.isLocked) {
-		borrowedNft = await takeLockedNftFromKiosk({
-			tx,
-			transferPolicies,
-			kioskTx,
-			nftTokenId,
-			nftType,
-			suiClient,
-			kioskClient,
-			kioskOwner,
-		});
-	} else {
-		borrowedNft = kioskTx.take({
-			itemId: nftTokenId,
-			itemType: nftType,
-		}) as any;
-	}
-
-	return borrowedNft;
-};