@tradeport/sui-trading-sdk 0.4.66 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @tradeport/sui-trading-sdk
 
+## 0.4.67
+
+### Patch Changes
+
+- e26b647: transferNfts: don't split the gas coin when no royalty is due in the direct-transfer path. Use `0x2::coin::zero` instead, so the transaction contains no GasCoin argument and can be sponsored (Enoki rejects PTBs that reference GasCoin with "Cannot use GasCoin as a transaction argument").
+
 ## 0.4.17
 
 ### Patch Changes

package/jest.config.js

@@ -1,7 +1,11 @@
 /** @type {import('ts-jest').JestConfigWithTsJest} */
-module.exports = {
-	preset: 'ts-jest',
+export default {
+	preset: 'ts-jest/presets/default-esm',
 	testEnvironment: 'node',
+	extensionsToTreatAsEsm: ['.ts'],
+	moduleNameMapper: {
+		'^(\\.{1,2}/.*)\\.js$': '$1',
+	},
 	verbose: true,
 	testTimeout: 1800000,
 	setupFiles: ['dotenv/config'],

package/package.json

@@ -1,66 +1,67 @@
 {
-	"name": "@tradeport/sui-trading-sdk",
-	"license": "MIT",
-	"version": "0.4.66",
-	"main": "dist/index.js",
-	"module": "dist/index.mjs",
-	"types": "dist/index.d.ts",
-	"scripts": {
-		"build": "tsup src/index.ts --sourcemap --format cjs,esm --dts",
-		"release": "pnpm run build && changeset publish",
-		"lint": "tsc && eslint --fix src/* --ignore-path .gitignore --ext .js,.ts",
-		"format": "prettier --write \"**/*.+(js|ts|json)\"",
-		"test": "jest",
-		"prepare": "husky install",
-		"pre-commit": "lint-staged"
-	},
-	"devDependencies": {
-		"@babel/core": "^7.23.3",
-		"@babel/preset-env": "^7.23.3",
-		"@changesets/cli": "^2.26.2",
-		"@types/jest": "^29.5.10",
-		"@types/ms": "^2.1.0",
-		"@types/node": "^20.10.0",
-		"@typescript-eslint/eslint-plugin": "^6.13.1",
-		"@typescript-eslint/parser": "^6.13.1",
-		"babel-jest": "^29.7.0",
-		"dotenv": "^16.3.1",
-		"eslint": "^8.54.0",
-		"eslint-config-prettier": "^9.0.0",
-		"eslint-config-xo": "^0.43.1",
-		"eslint-config-xo-typescript": "^1.0.1",
-		"husky": "^8.0.0",
-		"jest": "^29.7.0",
-		"lint-staged": "^16.2.7",
-		"prettier": "^3.1.0",
-		"ts-jest": "^29.1.1",
-		"tsup": "^8.0.1",
-		"typescript": "^5.3.2"
-	},
-	"dependencies": {
-		"@mysten/kiosk": "^0.7.13",
-		"@mysten/sui": "^1.17.0",
-		"@types/analytics-node": "^3.1.14",
-		"analytics-node": "^6.2.0",
-		"bignumber.js": "^9.3.1",
-		"graphql": "^16.12.0",
-		"graphql-request": "^6.1.0",
-		"ms": "^2.1.3"
-	},
-	"publishConfig": {
-		"access": "public",
-		"registry": "https://registry.npmjs.org/"
-	},
-	"lint-staged": {
-		"*.ts": [
-			"eslint --fix",
-			"bash -c 'tsc --noEmit'",
-			"prettier --write"
-		]
-	},
-	"pnpm": {
-		"overrides": {
-			"@mysten/sui": "^1.45.2"
-		}
-	}
-}
+  "name": "@tradeport/sui-trading-sdk",
+  "license": "MIT",
+  "version": "0.5.0",
+  "type": "module",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "devDependencies": {
+    "@babel/core": "^7.23.3",
+    "@babel/preset-env": "^7.23.3",
+    "@changesets/cli": "^2.26.2",
+    "@types/jest": "^29.5.10",
+    "@types/ms": "^2.1.0",
+    "@types/node": "^20.10.0",
+    "@typescript-eslint/eslint-plugin": "^6.13.1",
+    "@typescript-eslint/parser": "^6.13.1",
+    "babel-jest": "^29.7.0",
+    "dotenv": "^16.3.1",
+    "eslint": "^8.54.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-xo": "^0.43.1",
+    "eslint-config-xo-typescript": "^1.0.1",
+    "husky": "^8.0.0",
+    "jest": "^29.7.0",
+    "lint-staged": "^16.2.7",
+    "prettier": "^3.1.0",
+    "ts-jest": "^29.1.1",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.2"
+  },
+  "dependencies": {
+    "@mysten/kiosk": "^1.3.1",
+    "@mysten/sui": "^2.20.0",
+    "@types/analytics-node": "^3.1.14",
+    "analytics-node": "^6.2.0",
+    "bignumber.js": "^9.3.1",
+    "graphql": "^16.12.0",
+    "graphql-request": "^6.1.0",
+    "ms": "^2.1.3"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "lint-staged": {
+    "*.ts": [
+      "eslint --fix",
+      "bash -c 'tsc --noEmit'",
+      "prettier --write"
+    ]
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --sourcemap --format esm --dts",
+    "release": "pnpm run build && changeset publish",
+    "lint": "tsc && eslint --fix src/* --ignore-path .gitignore --ext .js,.ts",
+    "format": "prettier --write \"**/*.+(js|ts|json)\"",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "pre-commit": "lint-staged"
+  }
+}

package/src/SuiTradingClient.ts

@@ -1,4 +1,3 @@
-import { getFullnodeUrl } from '@mysten/sui/client';
 import { type Transaction } from '@mysten/sui/transactions';
 import { GraphQLClient } from 'graphql-request';
 import createKioskClient from './apiClients/createKioskClient';
@@ -53,6 +52,9 @@ import {
 } from './methods/withdrawProfitsFromKiosks/withdrawProfitsFromKiosks';
 import { addLeadingZerosAfter0x } from './utils/addLeadingZerosAfter0x';
 
+const DEFAULT_SUI_GRPC_URL = 'https://fullnode.mainnet.sui.io:443';
+const DEFAULT_SUI_GRAPHQL_URL = 'https://graphql.mainnet.sui.io/';
+
 type ApiConfig = {
 	apiUser: string;
 	apiKey: string;
@@ -60,6 +62,7 @@ type ApiConfig = {
 	tradeportRouterUrl?: string;
 	apiVercelId?: string;
 	suiNodeUrl?: string;
+	suiGraphqlUrl?: string;
 	graphQLClient?: GraphQLClient;
 };
 export interface RequestContext {
@@ -85,13 +88,14 @@ class SuiTradingClient {
 		apiUrl,
 		tradeportRouterUrl,
 		suiNodeUrl,
+		suiGraphqlUrl,
 		graphQLClient,
 	}: ApiConfig) {
 		this.apiUser = apiUser;
 		this.apiKey = apiKey;
 		this.tradeportRouterUrl = tradeportRouterUrl;
-		this.suiClient = createSuiClient(suiNodeUrl ?? getFullnodeUrl('mainnet'));
-		this.kioskClient = createKioskClient(this.suiClient);
+		this.suiClient = createSuiClient(suiNodeUrl ?? DEFAULT_SUI_GRPC_URL);
+		this.kioskClient = createKioskClient(suiGraphqlUrl ?? DEFAULT_SUI_GRAPHQL_URL);
 
 		if (graphQLClient) {
 			setGraphqlClient(graphQLClient);
@@ -269,12 +273,13 @@ class SuiTradingClient {
 				context,
 			);
 
-			let result = await this.suiClient.devInspectTransactionBlock({
-				transactionBlock: tx,
-				sender: addLeadingZerosAfter0x(walletAddress),
+			tx.setSenderIfNotSet(addLeadingZerosAfter0x(walletAddress));
+			let result = await this.suiClient.simulateTransaction({
+				transaction: tx,
+				include: { effects: true },
 			});
 
-			if (result.effects.status.status === 'success') {
+			if (result.$kind === 'Transaction') {
 				return tx;
 			}
 
@@ -291,18 +296,23 @@ class SuiTradingClient {
 						context,
 					);
 
-					result = await this.suiClient.devInspectTransactionBlock({
-						transactionBlock: tx,
-						sender: addLeadingZerosAfter0x(walletAddress),
+					tx.setSenderIfNotSet(addLeadingZerosAfter0x(walletAddress));
+					result = await this.suiClient.simulateTransaction({
+						transaction: tx,
+						include: { effects: true },
 					});
 
-					if (result?.effects.status.status === 'success') {
+					if (result?.$kind === 'Transaction') {
 						return tx;
 					}
 				}
 
 				throw new Error(
-					`Failed to validate accept bid transaction: ${result?.error ?? result?.effects?.status?.error ?? 'Unknown error'}`,
+					`Failed to validate accept bid transaction: ${
+						result?.FailedTransaction?.status?.error
+							? JSON.stringify(result.FailedTransaction.status.error)
+							: 'Unknown error'
+					}`,
 				);
 			}
 		}
@@ -364,8 +374,8 @@ class SuiTradingClient {
 
 			tx.setSenderIfNotSet(addLeadingZerosAfter0x(walletAddress));
 			const rawTransaction = await tx.build({ client: this.suiClient });
-			await this.suiClient.dryRunTransactionBlock({
-				transactionBlock: rawTransaction,
+			await this.suiClient.simulateTransaction({
+				transaction: rawTransaction,
 			});
 			return tx;
 		} catch (err) {

package/src/apiClients/createKioskClient.ts

@@ -1,11 +1,10 @@
-import { KioskClient, Network } from '@mysten/kiosk';
-import { type SuiClient } from '@mysten/sui/client';
+import { KioskClient } from '@mysten/kiosk';
+import { SuiGraphQLClient } from '@mysten/sui/graphql';
 
-const createKioskClient = (suiClient: SuiClient) =>
+const createKioskClient = (graphqlUrl: string) =>
 	new KioskClient({
-		// @ts-ignore
-		client: suiClient,
-		network: Network.MAINNET,
+		client: new SuiGraphQLClient({ url: graphqlUrl, network: 'mainnet' }),
+		network: 'mainnet',
 	});
 
 export default createKioskClient;

package/src/apiClients/createSuiClient.ts

@@ -1,5 +1,5 @@
-import { SuiClient } from '@mysten/sui/client';
+import { SuiGrpcClient } from '@mysten/sui/grpc';
 
-const createSuiClient = (url: string) => new SuiClient({ url });
+const createSuiClient = (baseUrl: string) => new SuiGrpcClient({ network: 'mainnet', baseUrl });
 
 export default createSuiClient;

package/src/helpers/getTransferPolicyRuleNamesFromSuiObject.ts

@@ -1,36 +1,24 @@
-import { type SuiClient } from '@mysten/sui/client';
+import { type SuiGrpcClient } from '@mysten/sui/grpc';
 import { normalizeStructTag, normalizeSuiObjectId } from '@mysten/sui/utils';
 
 export const getTransferPolicyRuleNamesFromSuiObject = async ({
 	suiClient,
 	transferPolicyId,
 }: {
-	suiClient: SuiClient;
+	suiClient: SuiGrpcClient;
 	transferPolicyId: string;
 }) => {
-	const { data, error } = await suiClient.getObject({
-		id: normalizeSuiObjectId(transferPolicyId),
-		options: {
-			showContent: true,
-		},
+	const { object } = await suiClient.getObject({
+		objectId: normalizeSuiObjectId(transferPolicyId),
+		include: { json: 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 content = object.json as unknown as {
+		rules: {
+			contents: string[];
 		};
 	};
-	const ruleNames = content.fields.rules.fields.contents.map((rule) =>
-		normalizeStructTag(rule.fields.name),
-	);
+	const ruleNames = content.rules.contents.map((rule) => normalizeStructTag(rule));
 
 	return ruleNames;
 };

package/src/helpers/isNonKioskListing.ts

@@ -1,4 +1,4 @@
-import { type SuiClient } from '@mysten/sui/client';
+import { type SuiGrpcClient } from '@mysten/sui/grpc';
 import { NON_KIOSK_LISTING_NONCE_TYPE } from '../constants';
 import { getObjectType } from './rpc/getObjectType';
 
@@ -6,7 +6,7 @@ export const isNonKioskListing = async ({
 	suiClient,
 	listingNonce,
 }: {
-	suiClient: SuiClient;
+	suiClient: SuiGrpcClient;
 	listingNonce: string;
 }): Promise<boolean> => {
 	const listingType = await getObjectType({ suiClient, objectId: listingNonce });

package/src/helpers/kiosk/getKioskCollectionRoyaltyFeeAmount.ts

@@ -1,5 +1,5 @@
 import { bcs } from '@mysten/sui/bcs';
-import { type SuiClient } from '@mysten/sui/client';
+import { type SuiGrpcClient } from '@mysten/sui/grpc';
 import {
 	Transaction,
 	type TransactionArgument,
@@ -9,7 +9,7 @@ import { addLeadingZerosAfter0x } from '../../utils/addLeadingZerosAfter0x';
 
 interface Args {
 	tx: Transaction;
-	suiClient: SuiClient;
+	suiClient: SuiGrpcClient;
 	walletAddress: string;
 	royaltyRulePackageId: string;
 	royaltyRuleModule: string;
@@ -45,17 +45,17 @@ export async function getKioskCollectionRoyaltyFeeAmount({
 		typeArguments: [nftType],
 	});
 
-	const res = await suiClient.devInspectTransactionBlock({
-		sender: addLeadingZerosAfter0x(walletAddress),
-		transactionBlock: feeTx,
+	feeTx.setSender(addLeadingZerosAfter0x(walletAddress));
+	const res = await suiClient.simulateTransaction({
+		transaction: feeTx,
+		include: { commandResults: true },
+		checksEnabled: false,
 	});
 
 	let feeAmount: TransactionArgument | bigint | undefined;
-	if (res?.results?.[0]?.returnValues?.[0]?.[0]) {
-		const returnedAmount = res?.results?.[0]?.returnValues?.[0]?.[0];
-		if (returnedAmount) {
-			feeAmount = BigInt(bcs.U64.parse(new Uint8Array(returnedAmount)));
-		}
+	const returnedAmount = res?.commandResults?.[0]?.returnValues?.[0]?.bcs;
+	if (returnedAmount) {
+		feeAmount = BigInt(bcs.U64.parse(returnedAmount));
 	}
 
 	// We were not able to calculate the amount outside of the transaction, so fall back to resolving it within the PTB

package/src/helpers/kiosk/getKioskIdFromKioskTx.ts

@@ -8,14 +8,22 @@ export const getKioskIdFromKioskTx = ({
 	kioskTx: KioskTransaction;
 	tx: Transaction;
 }): string => {
+	const kioskArg = kioskTx.kiosk as any;
+
+	if (!kioskArg || !('Input' in kioskArg)) {
+		throw new Error('Invalid kiosk transaction structure');
+	}
+
+	const input = (tx as any).getData().inputs[kioskArg.Input];
 	const kioskId =
-		'value' in kioskTx.kiosk
-			? kioskTx.kiosk.value
-			: 'Input' in kioskTx.kiosk
-				? tx.blockData.inputs[(kioskTx.kiosk as { Input: number }).Input].value
-				: (() => {
-						throw new Error('Invalid kiosk transaction structure');
-					})();
+		input?.UnresolvedObject?.objectId ??
+		input?.Object?.ImmOrOwnedObject?.objectId ??
+		input?.Object?.SharedObject?.objectId ??
+		input?.Object?.Receiving?.objectId;
+
+	if (!kioskId) {
+		throw new Error('Invalid kiosk transaction structure');
+	}
 
 	return kioskId;
 };

package/src/helpers/kiosk/getKioskPlaceBidCoin.ts

@@ -1,4 +1,4 @@
-import { type SuiClient } from '@mysten/sui/dist/cjs/client';
+import { type SuiGrpcClient } from '@mysten/sui/grpc';
 import { type Transaction } from '@mysten/sui/transactions';
 import { splitCoins } from '../splitCoins';
 import { getKioskCollectionRoyaltyFeeAmount } from './getKioskCollectionRoyaltyFeeAmount';
@@ -15,7 +15,7 @@ export async function getKioskPlaceBidCoin({
 	transferPolicyId,
 }: {
 	tx: Transaction;
-	suiClient: SuiClient;
+	suiClient: SuiGrpcClient;
 	bidder: string;
 	nftType: string;
 	bidAmount: number;

package/src/helpers/kiosk/getRulePackageId.ts

@@ -1,5 +1,5 @@
 import { getNormalizedRuleType, type KioskClient } from '@mysten/kiosk';
-import { type SuiClient } from '@mysten/sui/client';
+import { type SuiGrpcClient } from '@mysten/sui/grpc';
 import { addHexPrefix } from '../../utils/addHexPrefix';
 import { normalizedNftType } from '../../utils/normalizeNftType';
 import { getTransferPolicyRuleNamesFromSuiObject } from '../getTransferPolicyRuleNamesFromSuiObject';
@@ -16,7 +16,7 @@ export const getRulePackageId = async ({
 	suiClient,
 }: {
 	transferPolicies: any[];
-	suiClient: SuiClient;
+	suiClient: SuiGrpcClient;
 	nftType: string;
 	ruleType: RuleType;
 	kioskClient: KioskClient;

package/src/helpers/kiosk/getTransferPoliciesToResolve.ts

@@ -1,5 +1,5 @@
 import { getNormalizedRuleType, type KioskClient } from '@mysten/kiosk';
-import { type SuiClient } from '@mysten/sui/client';
+import { type SuiGrpcClient } from '@mysten/sui/grpc';
 import { normalizedNftType } from '../../utils/normalizeNftType';
 import { getTransferPolicyRuleNamesFromSuiObject } from '../getTransferPolicyRuleNamesFromSuiObject';
 import {
@@ -23,7 +23,7 @@ export type Policy = {
 
 type Props = {
 	transferPolicies: any[];
-	suiClient: SuiClient;
+	suiClient: SuiGrpcClient;
 	kioskClient: KioskClient;
 	nftType: string;
 	customTransferPolicies?: any;

package/src/helpers/kiosk/kioskListingBcs.ts

@@ -0,0 +1,19 @@
+import { bcs } from '@mysten/sui/bcs';
+
+const PurchaseCap = bcs.struct('PurchaseCap', {
+	id: bcs.Address,
+	kiosk_id: bcs.Address,
+	item_id: bcs.Address,
+	min_price: bcs.u64(),
+});
+
+export const KioskListing = bcs.struct('KioskListing', {
+	id: bcs.Address,
+	seller: bcs.Address,
+	kiosk_id: bcs.Address,
+	nft_id: bcs.Address,
+	cap: PurchaseCap,
+	price: bcs.u64(),
+	commission: bcs.u64(),
+	beneficiary: bcs.Address,
+});

package/src/helpers/kiosk/kioskTxWrapper.ts

@@ -105,7 +105,7 @@ export const kioskTxWrapper = async ({
 			})
 		).personalCap.id;
 		kioskTx = new KioskTransaction({
-			transactionBlock: tx as any,
+			transaction: tx,
 			kioskClient,
 			cap: {
 				isPersonal: true,
@@ -124,7 +124,7 @@ export const kioskTxWrapper = async ({
 			})
 		).ownerCap?.id;
 		kioskTx = new KioskTransaction({
-			transactionBlock: tx as any,
+			transaction: tx,
 			kioskClient,
 			cap: {
 				isPersonal: false,
@@ -136,7 +136,7 @@ export const kioskTxWrapper = async ({
 		});
 	} else {
 		// creating new personal kiosk
-		kioskTx = new KioskTransaction({ transactionBlock: tx as any, kioskClient });
+		kioskTx = new KioskTransaction({ transaction: tx, kioskClient });
 		kioskTx.createPersonal(true);
 	}
 

package/src/helpers/kiosk/lockNftInsideKioskIfNotLocked.ts

@@ -29,11 +29,11 @@ export const lockNftInsideKioskIfNotLocked = async ({
 	let takeFromKiosk = true;
 
 	if (!nftInKiosk) {
-		const result = (await kioskClient.client.getObject({
-			id: nftTokenId,
-			options: { showOwner: true },
-		})) as { data: { owner: { AddressOwner?: string } } };
-		if (result.data.owner.AddressOwner) {
+		const { object } = await (kioskClient.client as any).getObject({
+			objectId: nftTokenId,
+			include: {},
+		});
+		if (object?.owner?.$kind === 'AddressOwner') {
 			// NFT is owned by account
 			takeFromKiosk = false;
 		} else {
@@ -50,11 +50,11 @@ export const lockNftInsideKioskIfNotLocked = async ({
 				itemType: nftType,
 			});
 
-			takenNftId = 'value' in takenNft ? takenNft.value : takenNft;
+			takenNftId = (takenNft as any).value ?? takenNft;
 		}
 
 		kioskTx.lock({
-			itemId: takenNftId ?? nftTokenId,
+			item: takenNftId ?? nftTokenId,
 			itemType: nftType,
 			policy: transferPolicyId,
 		});
@@ -75,7 +75,7 @@ function lockNftInsideKioskIfKioskCreatedInThisTx({
 	transferPolicyId: string;
 }) {
 	if (Array.isArray(kioskTx.kiosk.NestedResult)) {
-		const transaction = tx.blockData.transactions[kioskTx.kiosk.NestedResult[0]] as {
+		const transaction = (tx as any).getData().commands[kioskTx.kiosk.NestedResult[0]] as {
 			target: string;
 		};
 		if (
@@ -86,7 +86,7 @@ function lockNftInsideKioskIfKioskCreatedInThisTx({
 		) {
 			// just created in this transaction block kiosk
 			kioskTx.lock({
-				itemId: nftTokenId,
+				item: nftTokenId,
 				itemType: nftType,
 				policy: transferPolicyId,
 			});