@tradeport/sui-trading-sdk 0.4.13 → 0.4.15

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tradeport/sui-trading-sdk",
   "license": "MIT",
-  "version": "0.4.13",
+  "version": "0.4.15",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",

package/src/helpers/getTransferPolicyRuleNamesFromSuiObject.ts

@@ -0,0 +1,36 @@
+import { type SuiClient } from '@mysten/sui/client';
+import { normalizeStructTag, normalizeSuiObjectId } from '@mysten/sui/utils';
+
+export const getTransferPolicyRuleNamesFromSuiObject = async ({
+	suiClient,
+	transferPolicyId,
+}: {
+	suiClient: SuiClient;
+	transferPolicyId: string;
+}) => {
+	const { data, error } = await suiClient.getObject({
+		id: normalizeSuiObjectId(transferPolicyId),
+		options: {
+			showContent: true,
+		},
+	});
+
+	if (error) {
+		throw new Error(`Error on getting SUI object ${transferPolicyId}: ${error.code}`);
+	}
+
+	const content = data.content as unknown as {
+		fields: {
+			rules: {
+				fields: {
+					contents: Array<{ fields: { name: string } }>;
+				};
+			};
+		};
+	};
+	const ruleNames = content.fields.rules.fields.contents.map((rule) =>
+		normalizeStructTag(rule.fields.name),
+	);
+
+	return ruleNames;
+};

package/src/helpers/hasTransferPolicyRules.ts

@@ -1,6 +1,4 @@
 import { getNativeKioskTransferPolicies } from './kiosk/getNativeKioskTransferPolicies';
 
-export const hasNativeKioskTransferPolicyRules = (transferPolicies: any): boolean => {
-	const nativeKioskTransferPolicies = getNativeKioskTransferPolicies(transferPolicies);
-	return nativeKioskTransferPolicies?.some((policy: any) => policy?.rules?.length > 0);
-};
+export const hasNativeKioskTransferPolicyRules = (transferPolicies: any): boolean =>
+	getNativeKioskTransferPolicies(transferPolicies)?.length > 0;

package/src/helpers/kiosk/getRulePackageId.ts

@@ -1,25 +1,47 @@
 import { getNormalizedRuleType, type KioskClient } from '@mysten/kiosk';
+import { type SuiClient } from '@mysten/sui/client';
 import { addHexPrefix } from '../../utils/addHexPrefix';
 import { normalizedNftType } from '../../utils/normalizeNftType';
+import { getTransferPolicyRuleNamesFromSuiObject } from '../getTransferPolicyRuleNamesFromSuiObject';
+import { getNativeKioskTransferPolicies } from './getNativeKioskTransferPolicies';
 
 type RuleType = 'kiosk_royalty_rule' | 'royalty_rule' | 'personal_kiosk_rule' | 'kiosk_lock_rule';
 
 export const getRulePackageId = async ({
+	transferPolicies,
 	nftType,
 	ruleType,
 	kioskClient,
+	suiClient,
 }: {
+	transferPolicies: any[];
+	suiClient: SuiClient;
 	nftType: string;
 	ruleType: RuleType;
 	kioskClient: KioskClient;
 }) => {
-	const transferPolicies = await kioskClient.getTransferPolicies({
+	const transferPoliciesFromMystenSdk = await kioskClient.getTransferPolicies({
 		type: normalizedNftType(nftType),
 	});
 
-	const rule = transferPolicies
-		.flatMap((policy) => policy.rules)
-		.filter((rule) => rule?.split('::')?.[1] === ruleType)?.[0];
+	let rule: string | undefined;
+
+	if (transferPoliciesFromMystenSdk.length > 0) {
+		rule = transferPoliciesFromMystenSdk
+			.flatMap((policy) => policy.rules)
+			.filter((rule) => rule?.split('::')?.[1] === ruleType)?.[0];
+	} else if (transferPolicies.length > 0) {
+		const transferPolicyId = getNativeKioskTransferPolicies(transferPolicies)?.at(0)?.id;
+
+		const ruleNames = await getTransferPolicyRuleNamesFromSuiObject({
+			suiClient,
+			transferPolicyId,
+		});
+
+		rule = ruleNames.filter((ruleName) => ruleName?.split('::')?.[1] === ruleType)?.[0];
+	} else {
+		throw new Error(`No transfer policy found for ${nftType}`);
+	}
 
 	const ruleDefinition = kioskClient.rules.find(
 		(x) => getNormalizedRuleType(x.rule) === getNormalizedRuleType(rule),

package/src/helpers/kiosk/resolveTransferPolicies.ts

@@ -6,6 +6,11 @@ import {
 	type TransactionObjectInput,
 } from '@mysten/sui/transactions';
 import { normalizedNftType } from '../../utils/normalizeNftType';
+import { getTransferPolicyRuleNamesFromSuiObject } from '../getTransferPolicyRuleNamesFromSuiObject';
+import {
+	getNativeKioskTransferPolicies,
+	knownTransferPolicyRules,
+} from './getNativeKioskTransferPolicies';
 import { resolveFloorPriceRule } from './resolveFloorPriceRule';
 import { resolveKioskLockRule } from './resolveKioskLockRule';
 import { resolvePersonalKioskRule } from './resolvePersonalKioskRule';
@@ -20,6 +25,7 @@ export type Policy = {
 
 type Props = {
 	tx: Transaction;
+	transferPolicies: any[];
 	suiClient: SuiClient;
 	walletAddress: string;
 	kioskClient: KioskClient;
@@ -40,6 +46,7 @@ const originByteRuleModules = ['royalty_strategy_bps', 'transfer_allowlist'];
 
 export const resolveTransferPolicies = async ({
 	tx,
+	transferPolicies,
 	suiClient,
 	walletAddress,
 	kioskClient,
@@ -55,49 +62,56 @@ export const resolveTransferPolicies = async ({
 	coinToSplit,
 	beforeResolveKioskTransferRequest,
 }: Props) => {
-	const transferPolicies = await kioskClient.getTransferPolicies({
+	const transferPoliciesFromMystenSdk = await kioskClient.getTransferPolicies({
 		type: normalizedNftType(nftType),
 	});
 
-	if (
-		transferPolicies.length === 0 &&
-		(customTransferPolicies ?? []).every(
-			(p: { transferRequest: TransactionArgument }) => p.transferRequest !== transferRequest,
-		)
-	) {
-		throw new Error(
-			`Missing transfer policy of ${nftType}. No way to resolve the transfer request.`,
-		);
-	}
+	let policies: Policy[] = [];
 
-	let policies: Policy[] =
-		transferPolicies.length > 0
-			? [
-					{
-						data: transferPolicies?.filter(
-							(policy) =>
-								policy?.rules?.filter(
-									(rule) =>
-										rule?.includes('royalty_rule') ||
-										rule?.includes('kiosk_lock_rule') ||
-										rule?.includes('personal_kiosk_rule') ||
-										rule?.includes('floor_price_rule'),
-								)?.length > 0,
-						)?.[0],
-						transferRequest,
-						isCustom: false,
-					},
-				]
-			: [];
-
-	if (!policies?.[0]?.data && transferPolicies.length > 0) {
+	if (transferPoliciesFromMystenSdk.length > 0) {
 		policies = [
 			{
-				data: transferPolicies?.[0],
+				data:
+					// Find first policy with relevant rules, or fall back to first policy
+					transferPoliciesFromMystenSdk.find((policy) =>
+						policy?.rules?.some((rule) =>
+							knownTransferPolicyRules.some((ruleType) => rule?.includes(ruleType)),
+						),
+					) ?? transferPoliciesFromMystenSdk[0],
 				transferRequest,
 				isCustom: false,
 			},
 		];
+	} else if (transferPolicies.length > 0) {
+		const transferPolicyId = getNativeKioskTransferPolicies(transferPolicies)?.at(0)?.id;
+
+		if (transferPolicyId) {
+			const ruleNames = await getTransferPolicyRuleNamesFromSuiObject({
+				suiClient,
+				transferPolicyId,
+			});
+
+			if (ruleNames.length > 0) {
+				policies = [
+					{
+						data: {
+							id: transferPolicyId,
+							rules: ruleNames,
+						},
+						transferRequest,
+						isCustom: false,
+					},
+				];
+			}
+		}
+	} else if (
+		(customTransferPolicies ?? []).every(
+			(p: { transferRequest: TransactionArgument }) => p.transferRequest !== transferRequest,
+		)
+	) {
+		throw new Error(
+			`Missing transfer policy of ${nftType}. No way to resolve the transfer request.`,
+		);
 	}
 
 	if (customTransferPolicies) {

package/src/methods/acceptCollectionBid/addAcceptCollectionBIdTxs.ts

@@ -278,6 +278,8 @@ export async function addTradePortAcceptCollectionBidTxHandler(txData: AcceptCol
 	if (isTradePortKioskBid(bidType)) {
 		const royaltyRuleModule = getRoyaltyRuleModule(txData?.nftType);
 		const royaltyRulePackageId = await getRulePackageId({
+			transferPolicies: txData?.transferPolicies,
+			suiClient: txData?.suiClient,
 			nftType: txData?.nftType,
 			ruleType: 'royalty_rule',
 			kioskClient: txData?.kioskClient,

package/src/methods/acceptNftBids/addAcceptNftBidTxs.ts

@@ -14,6 +14,7 @@ import { gqlChainRequest } from '../../graphql/gqlChainRequest';
 import { fetchMultibidChainIdById } from '../../graphql/queries/fetchMultibidById';
 import { getRoyaltyRuleModule } from '../../helpers/getRoyaltyRuleModule';
 import { getSharedObjects } from '../../helpers/getSharedObjects';
+import { getTransferPolicyRuleNamesFromSuiObject } from '../../helpers/getTransferPolicyRuleNamesFromSuiObject';
 import { hasPersonalKioskRule } from '../../helpers/hasPersonalKioskRule';
 import { isSingleBid } from '../../helpers/isSIngleBid';
 import { assertNftInSharedKiosk } from '../../helpers/kiosk/assertNftInSharedKiosk';
@@ -115,6 +116,7 @@ export async function addTradeportKioskAcceptNftBidTx({
 
 		await resolveTransferPolicies({
 			tx,
+			transferPolicies,
 			suiClient,
 			walletAddress: seller,
 			kioskTx,
@@ -151,6 +153,7 @@ export async function addTradeportKioskAcceptNftBidTx({
 
 		await resolveTransferPolicies({
 			tx,
+			transferPolicies,
 			suiClient,
 			walletAddress: seller,
 			kioskTx,
@@ -247,7 +250,7 @@ export function addBluemoveAcceptNftBidTx({
 }
 
 export async function addSingleBidAcceptNftBidTx(txData: AcceptNftBidTx) {
-	const { nftType, tx, bidNonce, multiBidId, kioskClient, nftTokenId } = txData;
+	const { nftType, tx, bidNonce, multiBidId, kioskClient, nftTokenId, suiClient } = txData;
 	const transferPolicies = getNativeKioskTransferPolicies(txData?.transferPolicies);
 	const transferPolicy = transferPolicies?.find(
 		(policy: { rules: any[] }) => policy?.rules?.length > 0,
@@ -270,7 +273,15 @@ export async function addSingleBidAcceptNftBidTx(txData: AcceptNftBidTx) {
 		const transferPolicies = await kioskClient.getTransferPolicies({
 			type: normalizeStructTag(nftType),
 		});
-		const { rules: allRules } = transferPolicies.find((p) => p.id === transferPolicy.id);
+		let { rules: allRules } = transferPolicies.find((p) => p.id === transferPolicy.id);
+
+		if (allRules.length === 0) {
+			allRules = await getTransferPolicyRuleNamesFromSuiObject({
+				suiClient,
+				transferPolicyId: transferPolicy.id,
+			});
+		}
+
 		const unsupportedRule = allRules.find(
 			(r) => !knownTransferPolicyRules.includes(r.split('::').at(1)),
 		);
@@ -353,6 +364,8 @@ export async function addTradePortAcceptNftBidTxHandler(txData: AcceptNftBidTx)
 		if (txData?.sellerKiosk) {
 			const royaltyRuleModule = getRoyaltyRuleModule(txData?.nftType);
 			const royaltyRulePackageId = await getRulePackageId({
+				transferPolicies: txData?.transferPolicies,
+				suiClient: txData?.suiClient,
 				nftType: txData?.nftType,
 				ruleType: 'royalty_rule',
 				kioskClient: txData?.kioskClient,

package/src/methods/buyListings/addBuyListingTxs.ts

@@ -19,7 +19,9 @@ import {
 } from '../../constants';
 import { getCommissionByNftContractId } from '../../graphql/queries/getCommissionByListingId';
 import { destroyZeroCoin } from '../../helpers/destroyZeroCoin';
+import { getSharedObjects } from '../../helpers/getSharedObjects';
 import { assertNftInSharedKiosk } from '../../helpers/kiosk/assertNftInSharedKiosk';
+import { getNativeKioskTransferPolicies } from '../../helpers/kiosk/getNativeKioskTransferPolicies';
 import { kioskTxWrapper } from '../../helpers/kiosk/kioskTxWrapper';
 import { resolveTransferPolicies } from '../../helpers/kiosk/resolveTransferPolicies';
 import { confirmOBTranfer } from '../../helpers/originByte/confirmOBTranfer';
@@ -29,8 +31,6 @@ import { shareOriginByteKiosk } from '../../helpers/originByte/shareOriginByteKi
 import { splitCoins } from '../../helpers/splitCoins';
 import { addLeadingZerosAfter0x } from '../../utils/addLeadingZerosAfter0x';
 import { type BuyTx, type TocenBuyTx } from './buyListings';
-import { getSharedObjects } from '../../helpers/getSharedObjects';
-import { getNativeKioskTransferPolicies } from '../../helpers/kiosk/getNativeKioskTransferPolicies';
 
 export function addTradePortBuyTx({ tx, nftType, listingNonce, price, sharedObjects }: BuyTx) {
 	const [coin] = splitCoins({ tx, amounts: [tx.pure.u64(price)] });
@@ -68,6 +68,7 @@ export function addTradePortBuyTx({ tx, nftType, listingNonce, price, sharedObje
 
 export const addTradeportKioskBuyTx = async ({
 	tx,
+	transferPolicies,
 	kioskTx,
 	suiClient,
 	kioskClient,
@@ -110,6 +111,7 @@ export const addTradeportKioskBuyTx = async ({
 
 	await resolveTransferPolicies({
 		tx,
+		transferPolicies,
 		suiClient,
 		walletAddress: seller,
 		kioskTx,
@@ -172,6 +174,7 @@ export async function addOriginByteBuyTx({
 
 export const addHyperspaceKioskBuyTx = async ({
 	tx,
+	transferPolicies,
 	suiClient,
 	kioskTx,
 	kioskClient,
@@ -211,6 +214,7 @@ export const addHyperspaceKioskBuyTx = async ({
 
 	await resolveTransferPolicies({
 		tx,
+		transferPolicies,
 		suiClient,
 		walletAddress: seller,
 		kioskTx,
@@ -286,6 +290,7 @@ export async function addBluemoveKioskBuyTx({
 	await beforeResolveKioskTransferRequest?.(transferRequest);
 	await resolveTransferPolicies({
 		tx,
+		transferPolicies,
 		suiClient,
 		walletAddress: seller,
 		kioskTx,

package/src/methods/claimNfts/addClaimNftsTxs.ts

@@ -69,6 +69,7 @@ export const addClaimAcceptedBidNftTx = async ({
 
 	await resolveTransferPolicies({
 		tx,
+		transferPolicies,
 		suiClient,
 		walletAddress: claimer,
 		kioskTx,
@@ -109,6 +110,7 @@ export const addClaimAcceptedBidNftWithPurchaseCapTx = async ({
 
 	await resolveTransferPolicies({
 		tx,
+		transferPolicies,
 		suiClient,
 		walletAddress: claimer,
 		kioskTx,
@@ -148,6 +150,7 @@ export const addClaimTransferredNftTx = async ({
 
 	await resolveTransferPolicies({
 		tx,
+		transferPolicies,
 		suiClient,
 		walletAddress: claimer,
 		kioskTx,
@@ -190,6 +193,7 @@ export const addClaimTransferredNftWithPurchaseCapTx = async ({
 
 	await resolveTransferPolicies({
 		tx,
+		transferPolicies,
 		suiClient,
 		walletAddress: claimer,
 		kioskTx,

package/src/methods/exerciseLongLocks/exerciseLongLocks.ts

@@ -104,6 +104,7 @@ export async function exerciseLongLocks(
 
 				await resolveTransferPolicies({
 					tx,
+					transferPolicies,
 					suiClient: context.suiClient,
 					walletAddress,
 					kioskTx,
@@ -177,6 +178,7 @@ export async function exerciseLongLocks(
 
 					await resolveTransferPolicies({
 						tx,
+						transferPolicies,
 						suiClient: context.suiClient,
 						walletAddress,
 						kioskTx,

package/src/methods/exerciseShortLocks/exerciseShortLocks.ts

@@ -173,6 +173,7 @@ export async function exerciseShortLocks(
 					});
 					await resolveTransferPolicies({
 						tx,
+						transferPolicies,
 						suiClient: context.suiClient,
 						walletAddress,
 						kioskTx,

package/src/methods/placeCollectionBids/addPlaceCollectionBidTxs.ts

@@ -132,6 +132,8 @@ export async function addTradePortPlaceCollectionBidTxHandler(txData: PlaceColle
 	if (hasRoyaltyRule(txData?.transferPolicies)) {
 		const royaltyRuleModule = getRoyaltyRuleModule(txData?.nftType);
 		const royaltyRulePackageId = await getRulePackageId({
+			transferPolicies: txData?.transferPolicies,
+			suiClient: txData?.suiClient,
 			nftType: txData.nftType,
 			ruleType: getRoyaltyRuleModule(txData?.collectionId),
 			kioskClient: txData?.kioskClient,

package/src/methods/transferNfts/addTransferNftTx.ts

@@ -2,18 +2,18 @@ import { type KioskClient } from '@mysten/kiosk';
 import { type SuiClient } from '@mysten/sui/client';
 import { type Transaction } from '@mysten/sui/transactions';
 import {
-	TRADEPORT_KIOSK_TRANSFERS_STORE,
 	MYSTEN_TRANFER_POLICY_RULES_PACKAGE_ID,
+	TRADEPORT_KIOSK_TRANSFERS_STORE,
 } from '../../constants';
 import { destroyZeroCoin } from '../../helpers/destroyZeroCoin';
 import { getNftType } from '../../helpers/getNftType';
+import { getTransferPolicyRuleNamesFromSuiObject } from '../../helpers/getTransferPolicyRuleNamesFromSuiObject';
 import { assertNftInSharedKiosk } from '../../helpers/kiosk/assertNftInSharedKiosk';
+import { getNativeKioskTransferPolicies } from '../../helpers/kiosk/getNativeKioskTransferPolicies';
 import { kioskTxWrapper } from '../../helpers/kiosk/kioskTxWrapper';
 import { getOBKiosk } from '../../helpers/originByte/getOBKiosk';
 import { addLeadingZerosAfter0x } from '../../utils/addLeadingZerosAfter0x';
 import { type TransferNftTx } from './transferNfts';
-import { getNativeKioskTransferPolicies } from '../../helpers/kiosk/getNativeKioskTransferPolicies';
-import { normalizeSuiObjectId, normalizeStructTag } from '@mysten/sui/utils';
 
 type CollectionChainState = {
 	transfer_policies: TransferPolicy[];
@@ -200,29 +200,10 @@ export async function getTransferPolicyForDirectTransfer(
 	);
 
 	if (validateRules && candidatePolicy) {
-		const { data, error } = await suiClient.getObject({
-			id: normalizeSuiObjectId(candidatePolicy.id),
-			options: {
-				showContent: true,
-			},
+		const ruleNames = await getTransferPolicyRuleNamesFromSuiObject({
+			suiClient,
+			transferPolicyId: candidatePolicy.id,
 		});
-
-		if (error) {
-			throw new Error(`Error on getting SUI object ${candidatePolicy.id}: ${error.code}`);
-		}
-
-		const content = data.content as unknown as {
-			fields: {
-				rules: {
-					fields: {
-						contents: Array<{ fields: { name: string } }>;
-					};
-				};
-			};
-		};
-		const ruleNames = content.fields.rules.fields.contents.map((rule) =>
-			normalizeStructTag(rule.fields.name),
-		);
 		if (!ruleNames.every((name) => name.startsWith(MYSTEN_TRANFER_POLICY_RULES_PACKAGE_ID))) {
 			return undefined;
 		}

package/src/tests/SuiWallet.ts

@@ -27,14 +27,20 @@ export class SuiWallet {
 		return 1;
 	}
 
-	async simulateCall(tx: Transaction): Promise<any> {
-		tx.setSenderIfNotSet(this.keypair.toSuiAddress());
-		const rawTransaction = await tx.build({ client: this.suiClient });
-		const result = await this.suiClient.dryRunTransactionBlock({
-			transactionBlock: rawTransaction,
+	async simulateCall(tx: Transaction, sender?: string): Promise<any> {
+		const result = await this.suiClient.devInspectTransactionBlock({
+			transactionBlock: tx,
+			sender: sender ?? this.keypair.toSuiAddress(),
 		});
-		if (result.balanceChanges.length === 0) {
-			throw new Error('No balance changes were found');
+
+		if (result?.effects?.status?.status === 'failure') {
+			throw new Error(
+				`Error on transaction simulation (from effect): ${result.effects.status.error}`,
+			); // result.effects.status.error
+		}
+
+		if (result?.error) {
+			throw new Error(`Error on transaction simulation: ${result.error}`); // result.error
 		}
 
 		return result;