@tradeport/sui-trading-sdk 0.5.1 → 0.5.3

package/src/methods/transferNfts/transferNfts.ts

@@ -1,216 +0,0 @@
-import type { KioskClient } from '@mysten/kiosk';
-import type { SuiGrpcClient } from '@mysten/sui/grpc';
-import { Transaction } from '@mysten/sui/transactions';
-import { type RequestContext } from '../../SuiTradingClient';
-import {
-	DELOREAN_TOKEN_IDS_TO_DISABLE,
-	DELOREAN_TOKEN_IDS_TO_DISABLE_MESSAGE,
-	XOCIETY_FRONTIER_COLLECTION_ID,
-} from '../../constants';
-import { gqlChainRequest } from '../../graphql/gqlChainRequest';
-import { fetchNftsById } from '../../graphql/queries/fetchNftsById';
-import { getNftType } from '../../helpers/getNftType';
-import { hasNativeKioskTransferPolicyRules } from '../../helpers/hasTransferPolicyRules';
-import { kioskTxWrapper } from '../../helpers/kiosk/kioskTxWrapper';
-import { type SharedKioskState } from '../../helpers/kiosk/sharedKioskState.type';
-import { takeAndBorrowNftFromKiosk } from '../../helpers/kiosk/takeAndBorrowNftFromKiosk';
-import { isOBKiosk } from '../../helpers/originByte/isOBKiosk';
-import { addLeadingZerosAfter0x } from '../../utils/addLeadingZerosAfter0x';
-import {
-	addOriginByteTransferNftTx,
-	addTradeportKioskDirectTransferTx,
-	addTradeportKioskTransferTx,
-	canBeTransferedDirectly,
-} from './addTransferNftTx';
-
-export type TransferNftTx = {
-	tx: Transaction;
-	kioskClient: KioskClient;
-	sharedKioskState?: SharedKioskState;
-	nftType: string;
-	nftTokenId: string;
-	senderKiosk: string;
-	senderAddress: string;
-	recipientAddress: string;
-	transferPolicies: any;
-	kioskTx?: any;
-	transferPolicy?: any;
-	suiClient: SuiGrpcClient;
-};
-
-export type TransferNfts = {
-	nftIds: string[];
-	recipientAddress: string;
-	walletAddress: string;
-};
-
-export const transferNfts = async (
-	{ nftIds, recipientAddress, walletAddress }: TransferNfts,
-	context: RequestContext,
-): Promise<Transaction> => {
-	if (addLeadingZerosAfter0x(recipientAddress) === addLeadingZerosAfter0x(walletAddress)) {
-		throw new Error('Cannot transfer to self');
-	}
-
-	// Recipient address needs to have a balance to be a valid address
-	if (!recipientAddress?.includes('0x') || recipientAddress?.length < 65) {
-		throw new Error('Invalid recipient address');
-	}
-
-	const res = await gqlChainRequest({
-		chain: 'sui',
-		query: fetchNftsById,
-		variables: { nftIds },
-	});
-
-	if (res?.nfts?.length === 0) {
-		throw new Error('No nfts found');
-	}
-
-	const nftsForTracking = [];
-	const nftsToTransferDirectly = [];
-	const tx = new Transaction();
-
-	const sharedKioskState: SharedKioskState = {
-		kioskTx: undefined,
-	};
-
-	for (const nft of res.nfts) {
-		if (DELOREAN_TOKEN_IDS_TO_DISABLE?.includes(nft?.token_id)) {
-			throw new Error(DELOREAN_TOKEN_IDS_TO_DISABLE_MESSAGE);
-		}
-
-		if (nft?.listed) {
-			throw new Error('Cannot transfer a listed NFT');
-		}
-
-		const nftType = getNftType({
-			collectionId: nft?.collection?.id,
-			collectionChainState: nft?.collection?.chain_state,
-			nft,
-		});
-
-		const transferPolicies = nft?.collection?.chain_state?.transfer_policies;
-
-		const txData: TransferNftTx = {
-			tx,
-			suiClient: context.suiClient,
-			kioskClient: context.kioskClient,
-			sharedKioskState,
-			nftType,
-			nftTokenId: nft?.token_id,
-			senderKiosk: nft?.chain_state?.kiosk_id,
-			senderAddress: walletAddress,
-			recipientAddress,
-			transferPolicies,
-		};
-
-		// If NFT is not inside kiosk, transfer the NFT directly
-		if (!txData.senderKiosk) {
-			tx.transferObjects(
-				[tx.object(txData.nftTokenId)],
-				tx.pure.address(addLeadingZerosAfter0x(recipientAddress)),
-			);
-			continue;
-		}
-
-		const isSenderKioskOriginByte = await isOBKiosk(txData.senderAddress, txData.senderKiosk);
-
-		// If NFT is inside ob kiosk
-		if (isSenderKioskOriginByte) {
-			await addOriginByteTransferNftTx(txData);
-
-			continue;
-		}
-
-		// If NFT is inside native kiosk and has no transfer policy rules or is XOCIETY Frontier collection, take it out of the kiosk and transfer it directly
-		if (
-			txData?.senderKiosk &&
-			(!hasNativeKioskTransferPolicyRules(txData?.transferPolicies) ||
-				nft?.collection?.id === XOCIETY_FRONTIER_COLLECTION_ID)
-		) {
-			await kioskTxWrapper({
-				tx: txData?.tx,
-				kioskClient: txData?.kioskClient,
-				kioskOwner: txData?.senderAddress,
-				kiosk: txData?.senderKiosk,
-				shouldAssertNftInSharedKiosk: true,
-				sharedKioskState: txData?.sharedKioskState,
-				shouldUseSharedKioskTx: false,
-				async runCommands(kioskTx) {
-					const borrowedItem = await takeAndBorrowNftFromKiosk({
-						tx: txData?.tx,
-						transferPolicies: txData?.transferPolicies,
-						kioskTx,
-						kioskClient: txData?.kioskClient,
-						nftTokenId: txData?.nftTokenId,
-						nftType: txData?.nftType,
-						suiClient: txData?.suiClient,
-						kioskOwner: txData?.senderAddress,
-					});
-
-					tx.transferObjects(
-						[tx.object(borrowedItem)],
-						tx.pure.address(addLeadingZerosAfter0x(recipientAddress)),
-					);
-				},
-			});
-
-			continue;
-		}
-
-		// If NFT can be transferred directly by creating new kiosk for receiver
-		if (await canBeTransferedDirectly(context.suiClient, nft?.collection?.chain_state)) {
-			nftsToTransferDirectly.push(nft);
-		} else {
-			await kioskTxWrapper({
-				tx: txData?.tx,
-				kioskClient: txData?.kioskClient,
-				kioskOwner: txData?.senderAddress,
-				kiosk: txData?.senderKiosk,
-				shouldAssertNftInSharedKiosk: true,
-				sharedKioskState: txData?.sharedKioskState,
-				shouldUseSharedKioskTx: false,
-				async runCommands(kioskTx) {
-					await addTradeportKioskTransferTx({ ...txData, kioskTx });
-				},
-			});
-		}
-
-		nftsForTracking.push({
-			nftType,
-			senderAddress: walletAddress,
-			recipientAddress,
-		});
-	}
-
-	await addTradeportKioskDirectTransferTx(
-		{
-			tx,
-			kioskClient: context.kioskClient,
-			sharedKioskState,
-			senderAddress: walletAddress,
-			recipientAddress,
-		},
-		nftsToTransferDirectly,
-		context.suiClient,
-	);
-
-	// currently turned off $1 bulk transfer fee
-	// if (res?.nfts?.length > 1) {
-	// 	await addOneDollarFee(tx);
-	// }
-
-	sharedKioskState?.kioskTx?.finalize();
-
-	// if (process.env.ENABLE_SEGMENT_TRACKING === 'true' && nftsForTracking.length > 0) {
-	// 	trackMethodCall({
-	// 		apiUser: context.apiUser,
-	// 		apiKey: context.apiKey,
-	// 		event: 'TRANSFER_NFTS',
-	// 		items: nftsForTracking,
-	// 	});
-	// }
-
-	return Transaction.from(tx);
-};

package/src/methods/unlistListings/addUnlistListingTxs.ts

@@ -1,399 +0,0 @@
-import {
-	BLUEMOVE_KIOSK_MARKETPLACE_KIOSK_OBJECT,
-	BLUEMOVE_MARKET_CONFIG_OBJECT,
-	HYPERSPACE_MP_TRANSFER_POLICY_TYPE,
-	KEEPSAKE_MARKETPLACE_KIOSK,
-	KEEPSAKE_MARKETPLACE_OBJECT,
-	ORIGIN_BYTE_NFT_TYPES_MISSING_ORDERBOOK,
-	SOUFFL3_VERSION_OBJECT,
-	TOCEN_MARKETPLACE_OBJECT,
-	TRADEPORT_KIOSK_LISTING_STORE,
-	TRADEPORT_LISTING_STORE,
-	TRADEPORT_LISTINGS_PACKAGE,
-	TRADEPORT_LISTINGS_STORE,
-	TRADEPORT_ORDERBOOK_STORE,
-	XOCIETY_FRONTIER_COLLECTION_ID,
-} from '../../constants';
-import { getSharedObjects } from '../../helpers/getSharedObjects';
-import { hasNativeKioskTransferPolicyRules } from '../../helpers/hasTransferPolicyRules';
-import { isNonKioskListing } from '../../helpers/isNonKioskListing';
-import { kioskTxWrapper } from '../../helpers/kiosk/kioskTxWrapper';
-import { takeAndBorrowNftFromKiosk } from '../../helpers/kiosk/takeAndBorrowNftFromKiosk';
-import { isOriginByteCollection } from '../../helpers/originByte/isOriginByteCollection';
-import { addLeadingZerosAfter0x } from '../../utils/addLeadingZerosAfter0x';
-import { normalizedNftType } from '../../utils/normalizeNftType';
-import { type UnlistListingTx } from './unlistListings';
-
-export function addLegacyTradePortUnlistTx({ tx, listingNonce, nftType }: UnlistListingTx) {
-	tx.moveCall({
-		target: '0xb42dbb7413b79394e1a0175af6ae22b69a5c7cc5df259cd78072b6818217c027::listings::unlist',
-		arguments: [tx.object(TRADEPORT_LISTING_STORE), tx.pure.address(listingNonce)],
-		typeArguments: [nftType],
-	});
-}
-
-export async function addLegacyTradePortKioskUnlistTx({
-	tx,
-	kioskTx,
-	nftTokenId,
-	nftType,
-}: UnlistListingTx) {
-	tx.moveCall({
-		target:
-			'0x475e98e9c436ec118909f3b9e241d86bcbbc2cf9fba05e99a934823fefb375b7::kiosk_listings::unlist',
-		arguments: [
-			tx.object(TRADEPORT_KIOSK_LISTING_STORE),
-			tx.object(kioskTx.kiosk),
-			tx.object(kioskTx.kioskCap),
-			tx.pure.address(nftTokenId),
-		],
-		typeArguments: [nftType],
-	});
-}
-
-export function addTradePortUnlistTx({ tx, nftTokenId, nftType }: UnlistListingTx) {
-	tx.moveCall({
-		target: `${TRADEPORT_LISTINGS_PACKAGE}::tradeport_listings::cancel_ob_listing_without_transfer_policy`,
-		arguments: [
-			tx.object(TRADEPORT_LISTINGS_STORE),
-			tx.object(TRADEPORT_ORDERBOOK_STORE),
-			tx.pure.id(nftTokenId),
-		],
-		typeArguments: [nftType],
-	});
-}
-
-export async function addKioskTradePortUnlistTx({
-	tx,
-	kioskTx,
-	nftTokenId,
-	nftType,
-}: UnlistListingTx) {
-	tx.moveCall({
-		target: `${TRADEPORT_LISTINGS_PACKAGE}::tradeport_listings::cancel_ob_listing_with_transfer_policy`,
-		arguments: [
-			tx.object(TRADEPORT_LISTINGS_STORE),
-			tx.object(TRADEPORT_ORDERBOOK_STORE),
-			tx.object(kioskTx.kiosk),
-			tx.object(kioskTx.kioskCap),
-			tx.pure.id(nftTokenId),
-		],
-		typeArguments: [nftType],
-	});
-}
-
-export function addOriginByteUnlistTx({
-	tx,
-	sharedObjects,
-	listingNonce,
-	price,
-	nftTokenId,
-	nftType,
-}: UnlistListingTx) {
-	const { orderbook } = sharedObjects;
-
-	tx.moveCall({
-		target:
-			'0x8534e4cdfd28709c94330a9783c3d5fe6f5daba0bffb69102ce303c5b38aed5a::orderbook::cancel_ask',
-		arguments: [
-			tx.object(orderbook),
-			tx.object(listingNonce),
-			tx.pure.u64(price),
-			tx.pure.address(nftTokenId),
-		],
-		typeArguments: [nftType, '0x2::sui::SUI'],
-	});
-}
-
-export function addSouffl3UnlistTx({ tx, listingNonce, nftType }: UnlistListingTx) {
-	tx.moveCall({
-		target:
-			'0x30d90b5b67be77e6e06f02dae9f0f2fcdad16e38854316ae8a7b4f5b4971f5e0::Market::delist_generic',
-		arguments: [tx.object(SOUFFL3_VERSION_OBJECT), tx.object(listingNonce)],
-		typeArguments: [nftType, '0x2::sui::SUI'],
-	});
-}
-
-export function addBluemoveUnlistTx({ tx, nftTokenId, nftType }: UnlistListingTx) {
-	tx.moveCall({
-		target:
-			'0xd5dd28cc24009752905689b2ba2bf90bfc8de4549b9123f93519bb8ba9bf9981::marketplace::delist_and_take',
-		arguments: [tx.object(BLUEMOVE_MARKET_CONFIG_OBJECT), tx.pure.address(nftTokenId)],
-		typeArguments: [nftType, nftType],
-	});
-}
-
-export async function addBluemoveKioskUnlistTx({
-	tx,
-	kioskTx,
-	nftTokenId,
-	nftType,
-}: UnlistListingTx) {
-	tx.moveCall({
-		target:
-			'0xcc97b74ed95c8e8a3ed88050a898727dee37896da579fc400d482b64db6149ff::kiosk_trade::kiosk_delist',
-		arguments: [
-			tx.object(BLUEMOVE_KIOSK_MARKETPLACE_KIOSK_OBJECT),
-			tx.object(kioskTx.kiosk),
-			tx.pure.address(nftTokenId),
-		],
-		typeArguments: [nftType],
-	});
-}
-
-export function addKeepsakeUnlistTx({ tx, nftTokenId, nftType }: UnlistListingTx) {
-	tx.moveCall({
-		target:
-			'0x2be8c4a1a3cea4d3255d870d367c87838a8cc2bfe4f216a6b67b153027087a7::keepsake_marketplace::delist_and_take',
-		arguments: [
-			tx.object(KEEPSAKE_MARKETPLACE_OBJECT),
-			tx.object(KEEPSAKE_MARKETPLACE_KIOSK),
-			tx.pure.address(nftTokenId),
-		],
-		typeArguments: [nftType],
-	});
-}
-
-export async function addHyperspaceKioskUnlistTx({
-	tx,
-	kioskTx,
-	nftTokenId,
-	nftType,
-}: UnlistListingTx) {
-	tx.moveCall({
-		target:
-			'0x6ea97b03c441edd54ae89224bf9560e583ee66c37e6c246f5db35258e580ba94::hyperspace::delist',
-		arguments: [tx.object(kioskTx.kiosk), tx.object(kioskTx.kioskCap), tx.pure.address(nftTokenId)],
-		typeArguments: [nftType, HYPERSPACE_MP_TRANSFER_POLICY_TYPE],
-	});
-}
-
-export function addTocenUnlistTx({ tx, nftTokenId, nftType }: UnlistListingTx) {
-	tx.moveCall({
-		target:
-			'0x3605d91c559e80cf8fdeabae9abaccb0bc38f96eac0b32bf47e95a9159a5277f::tocen_marketplace::delist_and_take',
-		arguments: [tx.object(TOCEN_MARKETPLACE_OBJECT), tx.pure.address(nftTokenId)],
-		typeArguments: [nftType],
-	});
-}
-
-export function addSomisUnlistTx({
-	tx,
-	sharedObjects,
-	nftTokenId,
-	nftType,
-	price,
-}: UnlistListingTx) {
-	const { marketplace } = sharedObjects;
-
-	tx.moveCall({
-		target:
-			'0xf0b0beb956e26bde50dbd6ac393026c4525aee3b194a9478f09748f7211b5a02::marketplace::cancel_ask',
-		arguments: [tx.object(marketplace), tx.pure.address(nftTokenId), tx.pure.u64(price)],
-		typeArguments: [nftType, '0x2::sui::SUI'],
-	});
-}
-
-export async function addTradePortUnlistTxHandler(txData: UnlistListingTx) {
-	if (
-		txData?.listingNonce &&
-		isOriginByteCollection(txData?.transferPolicies) &&
-		!ORIGIN_BYTE_NFT_TYPES_MISSING_ORDERBOOK?.includes(normalizedNftType(txData?.nftType))
-	) {
-		const sharedObjects = await getSharedObjects(txData?.nftType);
-		addOriginByteUnlistTx({ ...txData, sharedObjects });
-
-		return;
-	}
-
-	// If non kiosk listing (nonce starts with "0::")
-	if (txData?.listingNonce?.startsWith('0::')) {
-		addTradePortUnlistTx(txData);
-		return;
-	}
-
-	// If kiosk listing (nonce starts with "1::")
-	if (txData?.listingNonce?.startsWith('1::')) {
-		return kioskTxWrapper({
-			tx: txData?.tx,
-			kioskClient: txData?.kioskClient,
-			kioskOwner: txData?.seller,
-			kiosk: txData?.sellerKiosk,
-			shouldAllowNftUnsharedKiosk: true,
-			sharedKioskState: txData?.sharedKioskState,
-			shouldUseSharedKioskTx: false,
-			async runCommands(kioskTx) {
-				await addKioskTradePortUnlistTx({
-					...txData,
-					kioskTx,
-				});
-
-				// If XOCIETY Frontier collection, take NFT out of kiosk and transfer it back to user (seller)
-				if (txData?.collectionId === XOCIETY_FRONTIER_COLLECTION_ID) {
-					const borrowedItem = await takeAndBorrowNftFromKiosk({
-						tx: txData?.tx,
-						transferPolicies: txData?.transferPolicies,
-						kioskTx,
-						kioskClient: txData?.kioskClient,
-						nftTokenId: txData?.nftTokenId,
-						nftType: txData?.nftType,
-						suiClient: txData?.suiClient,
-						kioskOwner: txData?.seller,
-					});
-
-					txData?.tx.transferObjects(
-						[txData?.tx.object(borrowedItem)],
-						txData?.tx.pure.address(addLeadingZerosAfter0x(txData?.seller)),
-					);
-				}
-			},
-		});
-	}
-
-	// Fallback to legacy contract logic
-	if (
-		txData?.listingNonce &&
-		(await isNonKioskListing({ suiClient: txData?.suiClient, listingNonce: txData?.listingNonce }))
-	) {
-		if (txData?.isPartOfRelist) {
-			throw new Error(
-				'Cannot relist this non kiosk NFT in one transaction from legacy contract. You must unlist and list again',
-			);
-		}
-
-		addLegacyTradePortUnlistTx(txData);
-		return;
-	}
-
-	// If legacy kiosk listing
-	if (txData?.sellerKiosk) {
-		return kioskTxWrapper({
-			tx: txData?.tx,
-			kioskClient: txData?.kioskClient,
-			kioskOwner: txData?.seller,
-			kiosk: txData?.sellerKiosk,
-			shouldAllowNftUnsharedKiosk: true,
-			sharedKioskState: txData?.sharedKioskState,
-			shouldUseSharedKioskTx: false,
-			async runCommands(kioskTx) {
-				await addLegacyTradePortKioskUnlistTx({
-					...txData,
-					kioskTx,
-				});
-
-				// if nft has no transfer policy rule but is inside a kiosk, take it out of the kiosk
-				if (!hasNativeKioskTransferPolicyRules(txData?.transferPolicies)) {
-					const borrowedItem = await takeAndBorrowNftFromKiosk({
-						tx: txData?.tx,
-						transferPolicies: txData?.transferPolicies,
-						kioskTx,
-						kioskClient: txData?.kioskClient,
-						nftTokenId: txData?.nftTokenId,
-						nftType: txData?.nftType,
-						suiClient: txData?.suiClient,
-						kioskOwner: txData?.seller,
-					});
-
-					// Transfer the borrowed item back to the seller
-					txData?.tx.transferObjects(
-						[txData?.tx.object(borrowedItem)],
-						txData?.tx.pure.address(addLeadingZerosAfter0x(txData?.seller)),
-					);
-				}
-			},
-		});
-	}
-
-	// If legacy non kiosk listing
-	addLegacyTradePortUnlistTx(txData);
-}
-
-export async function addHyperspaceUnlistTxHandler(txData: UnlistListingTx) {
-	if (
-		txData?.listingNonce &&
-		isOriginByteCollection(txData?.transferPolicies) &&
-		!ORIGIN_BYTE_NFT_TYPES_MISSING_ORDERBOOK?.includes(normalizedNftType(txData?.nftType))
-	) {
-		const sharedObjects = await getSharedObjects(txData?.nftType);
-		addOriginByteUnlistTx({ ...txData, sharedObjects });
-
-		return;
-	}
-
-	return kioskTxWrapper({
-		tx: txData?.tx,
-		kioskClient: txData?.kioskClient,
-		kioskOwner: txData?.seller,
-		kiosk: txData?.sellerKiosk,
-		shouldAllowNftUnsharedKiosk: true,
-		sharedKioskState: txData?.sharedKioskState,
-		shouldUseSharedKioskTx: false,
-		async runCommands(kioskTx) {
-			await addHyperspaceKioskUnlistTx({
-				...txData,
-				kioskTx,
-			});
-		},
-	});
-}
-
-export async function addBluemoveUnlistTxHandler(txData: UnlistListingTx) {
-	if (
-		txData?.listingNonce &&
-		isOriginByteCollection(txData?.transferPolicies) &&
-		!ORIGIN_BYTE_NFT_TYPES_MISSING_ORDERBOOK?.includes(normalizedNftType(txData?.nftType))
-	) {
-		const sharedObjects = await getSharedObjects(txData?.nftType);
-		addOriginByteUnlistTx({ ...txData, sharedObjects });
-
-		return;
-	}
-
-	if (txData?.sellerKiosk) {
-		return kioskTxWrapper({
-			tx: txData?.tx,
-			kioskClient: txData?.kioskClient,
-			kioskOwner: txData?.seller,
-			kiosk: txData?.sellerKiosk,
-			shouldAllowNftUnsharedKiosk: true,
-			sharedKioskState: txData?.sharedKioskState,
-			shouldUseSharedKioskTx: false,
-			async runCommands(kioskTx) {
-				await addBluemoveKioskUnlistTx({
-					...txData,
-					kioskTx,
-				});
-			},
-		});
-	}
-
-	addBluemoveUnlistTx(txData);
-}
-
-export async function addClutchyUnlistTxHandler(txData: UnlistListingTx) {
-	const sharedObjects = await getSharedObjects(txData?.nftType);
-	addOriginByteUnlistTx({ ...txData, sharedObjects });
-}
-
-export async function addSouffl3UnlistTxHandler(txData: UnlistListingTx) {
-	addSouffl3UnlistTx(txData);
-}
-
-export async function addSomisUnlistTxHandler(txData: UnlistListingTx) {
-	const sharedObjects = await getSharedObjects(txData?.nftType);
-
-	if (sharedObjects?.marketplace) {
-		addSomisUnlistTx(txData);
-		return;
-	}
-
-	addOriginByteUnlistTx({ ...txData, sharedObjects });
-}
-
-export async function addKeepsakeUnlistTxHandler(txData: UnlistListingTx) {
-	addKeepsakeUnlistTx(txData);
-}
-
-export function addTocenUnlistTxHandler(txData: UnlistListingTx) {
-	addTocenUnlistTx(txData);
-}