@tradeport/sui-trading-sdk 0.5.3 → 0.5.4

package/jest.config.js

@@ -0,0 +1,12 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+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,72 +1,67 @@
 {
-	"name": "@tradeport/sui-trading-sdk",
-	"license": "MIT",
-	"version": "0.5.3",
-	"type": "module",
-	"module": "dist/index.js",
-	"types": "dist/index.d.ts",
-	"files": [
-		"dist"
-	],
-	"exports": {
-		".": {
-			"types": "./dist/index.d.ts",
-			"import": "./dist/index.js",
-			"default": "./dist/index.js"
-		}
-	},
-	"scripts": {
-		"build": "tsup src/index.ts --sourcemap --format esm --dts",
-		"prepublishOnly": "pnpm run build",
-		"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",
-		"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": "^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"
-		]
-	}
-}
+  "name": "@tradeport/sui-trading-sdk",
+  "license": "MIT",
+  "version": "0.5.4",
+  "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

@@ -0,0 +1,442 @@
+import { type Transaction } from '@mysten/sui/transactions';
+import { GraphQLClient } from 'graphql-request';
+import createKioskClient from './apiClients/createKioskClient';
+import createSuiClient from './apiClients/createSuiClient';
+import { getGraphqlClient, setGraphqlClient } from './apiClients/graphqlClient';
+import { gqlChainRequest } from './graphql/gqlChainRequest';
+import { fetchCollectionBidsById } from './graphql/queries/fetchCollectionBidById';
+import { fetchCollectionBidsAtSamePrice } from './graphql/queries/fetchCollectionBidsAtSamePrice';
+import {
+	acceptCollectionBid,
+	type AcceptCollectionBid,
+} from './methods/acceptCollectionBid/acceptCollectionBid';
+import { acceptNftBids, type AcceptNftBids } from './methods/acceptNftBids/acceptNftBids';
+import { applyFtStrategy, type ApplyFtStrategy } from './methods/applyFtStrategy/applyFtStrategy';
+import {
+	type ApplyNftStrategy,
+	applyTradeportNftStrategy,
+} from './methods/applyNftStrategy/applyNftStrategy';
+import { buyListings, type BuyListings } from './methods/buyListings/buyListings';
+import { cancelMultiBid, type CancelMultiBid } from './methods/cancelMultiBid/cancelMultiBid';
+import {
+	cancelNftTransfers,
+	type CancelNftTransfers,
+} from './methods/cancelNftTransfers/cancelNftTransfers';
+import { claimNfts, type ClaimNfts } from './methods/claimNfts/claimNfts';
+import { createMultiBid, type CreateMultiBid } from './methods/createMultiBid/createMultiBid';
+import { listNfts, type ListNfts } from './methods/listNfts/listNfts';
+import {
+	migrateNftsFromUnsharedToSharedKiosks,
+	type MigrateNftsFromUnsharedToSharedKiosks,
+} from './methods/migrateNftsFromUnsharedToSharedKiosks/migrateNftsFromUnsharedToSharedKiosks';
+import {
+	type PlaceCollectionBid,
+	placeCollectionBids,
+} from './methods/placeCollectionBids/placeCollectionBids';
+import { placeNftBids, type PlaceNftBids } from './methods/placeNftBids/placeNftBids';
+import {
+	removeCollectionBids,
+	type RemoveCollectionBids,
+} from './methods/removeCollectionBids/removeCollectionBids';
+import { removeNftBids, type RemoveNftBids } from './methods/removeNftBids/removeNftBids';
+import {
+	type SponsorNftListing,
+	sponsorNftListing,
+} from './methods/sponsorNftListing/sponsorNftListing';
+import { transferNfts, type TransferNfts } from './methods/transferNfts/transferNfts';
+import { unlistListings, type UnlistListings } from './methods/unlistListings/unlistListings';
+import { updateMultiBid, type UpdateMultiBid } from './methods/updateMultiBid/updateMultiBid';
+import {
+	withdrawProfitsFromKiosks,
+	type WithdrawProfitsFromKiosks,
+} 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;
+	apiUrl?: string;
+	tradeportRouterUrl?: string;
+	apiVercelId?: string;
+	suiNodeUrl?: string;
+	suiGraphqlUrl?: string;
+	graphQLClient?: GraphQLClient;
+};
+export interface RequestContext {
+	apiUser: string;
+	apiKey: string;
+	tradeportRouterUrl?: string;
+	suiClient: ReturnType<typeof createSuiClient>;
+	kioskClient: ReturnType<typeof createKioskClient>;
+}
+
+class SuiTradingClient {
+	private readonly apiUser: string;
+	private readonly apiKey: string;
+	private readonly tradeportRouterUrl?: string;
+	private readonly suiClient: ReturnType<typeof createSuiClient>;
+	private readonly kioskClient: ReturnType<typeof createKioskClient>;
+	private readonly allowedApiUsersForUnsharedKiosksMigration = ['tradeport.xyz', 'mercato.xyz'];
+
+	constructor({
+		apiUser,
+		apiKey,
+		apiVercelId,
+		apiUrl,
+		tradeportRouterUrl,
+		suiNodeUrl,
+		suiGraphqlUrl,
+		graphQLClient,
+	}: ApiConfig) {
+		this.apiUser = apiUser;
+		this.apiKey = apiKey;
+		this.tradeportRouterUrl = tradeportRouterUrl;
+		this.suiClient = createSuiClient(suiNodeUrl ?? DEFAULT_SUI_GRPC_URL);
+		this.kioskClient = createKioskClient(suiGraphqlUrl ?? DEFAULT_SUI_GRAPHQL_URL);
+
+		if (graphQLClient) {
+			setGraphqlClient(graphQLClient);
+		} else {
+			setGraphqlClient(new GraphQLClient(apiUrl ?? 'https://graphql.tradeport.gg'));
+		}
+
+		getGraphqlClient().setHeaders({
+			'x-api-user': apiUser,
+			'x-api-key': apiKey,
+			...(apiVercelId && { 'x-vercel-id': apiVercelId }),
+		});
+
+		// trackMethodCall({ apiUser, apiKey, event: 'INITIALIZE_CLIENT' });
+	}
+
+	public async buyListings(args: BuyListings): Promise<Transaction> {
+		const context: RequestContext = {
+			apiUser: this.apiUser,
+			apiKey: this.apiKey,
+			tradeportRouterUrl: this.tradeportRouterUrl,
+			suiClient: this.suiClient,
+			kioskClient: this.kioskClient,
+		};
+		return buyListings(args, context);
+	}
+
+	public async listNfts({ nfts, walletAddress, tx }: ListNfts) {
+		const context: RequestContext = {
+			apiUser: this.apiUser,
+			apiKey: this.apiKey,
+			tradeportRouterUrl: this.tradeportRouterUrl,
+			suiClient: this.suiClient,
+			kioskClient: this.kioskClient,
+		};
+
+		return listNfts({ nfts, walletAddress, tx }, context);
+	}
+
+	public async unlistListings({ listingIds, walletAddress }: UnlistListings) {
+		const context: RequestContext = {
+			apiUser: this.apiUser,
+			apiKey: this.apiKey,
+			tradeportRouterUrl: this.tradeportRouterUrl,
+			suiClient: this.suiClient,
+			kioskClient: this.kioskClient,
+		};
+
+		return unlistListings({ listingIds, walletAddress }, context);
+	}
+
+	public async placeNftBids(data: PlaceNftBids) {
+		const context: RequestContext = {
+			apiUser: this.apiUser,
+			apiKey: this.apiKey,
+			tradeportRouterUrl: this.tradeportRouterUrl,
+			suiClient: this.suiClient,
+			kioskClient: this.kioskClient,
+		};
+
+		return placeNftBids(data, context);
+	}
+
+	public async removeNftBids({ bidIds, tx }: RemoveNftBids) {
+		const context: RequestContext = {
+			apiUser: this.apiUser,
+			tradeportRouterUrl: this.tradeportRouterUrl,
+			apiKey: this.apiKey,
+			suiClient: this.suiClient,
+			kioskClient: this.kioskClient,
+		};
+
+		return removeNftBids({ bidIds, tx }, context);
+	}
+
+	public async acceptNftBids({ bidIds, walletAddress }: AcceptNftBids) {
+		const context: RequestContext = {
+			apiUser: this.apiUser,
+			apiKey: this.apiKey,
+			tradeportRouterUrl: this.tradeportRouterUrl,
+			suiClient: this.suiClient,
+			kioskClient: this.kioskClient,
+		};
+
+		return acceptNftBids({ bidIds, walletAddress }, context);
+	}
+
+	public async placeCollectionBid({
+		collectionId,
+		bidAmountInMist,
+		numOfBids,
+		walletAddress,
+		multiBidId,
+		multiBidChainId,
+		expireAt,
+		tx,
+	}: PlaceCollectionBid): Promise<Transaction> {
+		const context: RequestContext = {
+			apiUser: this.apiUser,
+			apiKey: this.apiKey,
+			tradeportRouterUrl: this.tradeportRouterUrl,
+			suiClient: this.suiClient,
+			kioskClient: this.kioskClient,
+		};
+
+		return placeCollectionBids(
+			{
+				collections: [
+					{
+						id: collectionId,
+						bidAmountInMist,
+						numOfBids,
+						expireAt,
+					},
+				],
+				walletAddress,
+				multiBidId,
+				multiBidChainId,
+				tx,
+			},
+			context,
+		);
+	}
+
+	public async acceptCollectionBid({ bidId, nftId, walletAddress }: AcceptCollectionBid) {
+		const context: RequestContext = {
+			apiUser: this.apiUser,
+			apiKey: this.apiKey,
+			tradeportRouterUrl: this.tradeportRouterUrl,
+			suiClient: this.suiClient,
+			kioskClient: this.kioskClient,
+		};
+
+		const collectionBidRes = await gqlChainRequest({
+			chain: 'sui',
+			query: fetchCollectionBidsById,
+			variables: { bidIds: [bidId] },
+		});
+		const bid = collectionBidRes?.bids?.[0];
+
+		if (!bid) {
+			throw new Error('No bid found');
+		}
+
+		if (addLeadingZerosAfter0x(bid?.bidder) === addLeadingZerosAfter0x(walletAddress)) {
+			throw new Error('Wallet cannot accept its own bid');
+		}
+
+		if (bid?.status !== 'active') {
+			throw new Error('Bid not active');
+		}
+
+		if (bid?.type !== 'collection') {
+			throw new Error('Bid is not a collection bid. Use acceptNftBid() instead.');
+		}
+
+		const allBidsWithSameHighestPriceRes = await gqlChainRequest({
+			chain: 'sui',
+			query: fetchCollectionBidsAtSamePrice,
+			variables: {
+				collectionId: bid?.collection_id,
+				price: bid?.price,
+			},
+		});
+		const allBidsWithSameHighestPrice = allBidsWithSameHighestPriceRes?.bids;
+
+		// loop through all highest bids at same price until one succeeds
+		for (let i = 0; i < (allBidsWithSameHighestPrice?.length ?? 0); i++) {
+			const tx = await acceptCollectionBid(
+				{
+					bid: allBidsWithSameHighestPrice?.[i],
+					nftId,
+					walletAddress,
+				},
+				context,
+			);
+
+			tx.setSenderIfNotSet(addLeadingZerosAfter0x(walletAddress));
+			let result = await this.suiClient.simulateTransaction({
+				transaction: tx,
+				include: { effects: true },
+			});
+
+			if (result.$kind === 'Transaction') {
+				return tx;
+			}
+
+			if (i === allBidsWithSameHighestPrice.length - 1) {
+				// next loop through all the same bids and try with splitting royalty from user gas coins in case royalty has changed and the amount in escrow is not ennough
+				for (let j = 0; j < allBidsWithSameHighestPrice?.length; j++) {
+					const tx = await acceptCollectionBid(
+						{
+							bid: allBidsWithSameHighestPrice?.[j],
+							nftId,
+							walletAddress,
+							shouldSplitRoyaltyFromUserGasCoins: true,
+						},
+						context,
+					);
+
+					tx.setSenderIfNotSet(addLeadingZerosAfter0x(walletAddress));
+					result = await this.suiClient.simulateTransaction({
+						transaction: tx,
+						include: { effects: true },
+					});
+
+					if (result?.$kind === 'Transaction') {
+						return tx;
+					}
+				}
+
+				throw new Error(
+					`Failed to validate accept bid transaction: ${
+						result?.FailedTransaction?.status?.error
+							? JSON.stringify(result.FailedTransaction.status.error)
+							: 'Unknown error'
+					}`,
+				);
+			}
+		}
+	}
+
+	public async removeCollectionBids({ bidIds, tx }: RemoveCollectionBids) {
+		const context: RequestContext = {
+			apiUser: this.apiUser,
+			apiKey: this.apiKey,
+			tradeportRouterUrl: this.tradeportRouterUrl,
+			suiClient: this.suiClient,
+			kioskClient: this.kioskClient,
+		};
+
+		return removeCollectionBids({ bidIds, tx }, context);
+	}
+
+	public async transferNfts({ nftIds, recipientAddress, walletAddress }: TransferNfts) {
+		const context: RequestContext = {
+			apiUser: this.apiUser,
+			apiKey: this.apiKey,
+			tradeportRouterUrl: this.tradeportRouterUrl,
+			suiClient: this.suiClient,
+			kioskClient: this.kioskClient,
+		};
+
+		return transferNfts({ nftIds, recipientAddress, walletAddress }, context);
+	}
+
+	public async cancelNftTransfers({ nftIds, walletAddress }: CancelNftTransfers) {
+		const context: RequestContext = {
+			apiUser: this.apiUser,
+			apiKey: this.apiKey,
+			tradeportRouterUrl: this.tradeportRouterUrl,
+			suiClient: this.suiClient,
+			kioskClient: this.kioskClient,
+		};
+
+		try {
+			return await cancelNftTransfers({ nftIds, walletAddress }, context);
+		} catch (err) {
+			throw new Error(
+				'Cannot cancel NFT transfer unless the NFT was transferred using kiosk_transfers::transfer_with_purchase_capability',
+			);
+		}
+	}
+
+	public async claimNfts({ nftIds, walletAddress }: ClaimNfts) {
+		const context: RequestContext = {
+			apiUser: this.apiUser,
+			apiKey: this.apiKey,
+			tradeportRouterUrl: this.tradeportRouterUrl,
+			suiClient: this.suiClient,
+			kioskClient: this.kioskClient,
+		};
+
+		try {
+			const tx = await claimNfts({ nftIds, walletAddress }, context, true);
+
+			tx.setSenderIfNotSet(addLeadingZerosAfter0x(walletAddress));
+			const rawTransaction = await tx.build({ client: this.suiClient });
+			await this.suiClient.simulateTransaction({
+				transaction: rawTransaction,
+			});
+			return tx;
+		} catch (err) {
+			return claimNfts({ nftIds, walletAddress }, context);
+		}
+	}
+
+	public async withdrawProfitsFromKiosks(args: WithdrawProfitsFromKiosks) {
+		const context: RequestContext = {
+			apiUser: this.apiUser,
+			apiKey: this.apiKey,
+			tradeportRouterUrl: this.tradeportRouterUrl,
+			suiClient: this.suiClient,
+			kioskClient: this.kioskClient,
+		};
+
+		return withdrawProfitsFromKiosks(args, context);
+	}
+
+	public async migrateNftsFromUnsharedToSharedKiosks(args: MigrateNftsFromUnsharedToSharedKiosks) {
+		if (!this.allowedApiUsersForUnsharedKiosksMigration.includes(this.apiUser)) {
+			throw new Error('This method is not available for your API user.');
+		}
+
+		const context: RequestContext = {
+			apiUser: this.apiUser,
+			apiKey: this.apiKey,
+			tradeportRouterUrl: this.tradeportRouterUrl,
+			suiClient: this.suiClient,
+			kioskClient: this.kioskClient,
+		};
+
+		return migrateNftsFromUnsharedToSharedKiosks(args, context);
+	}
+
+	public async createMultiBid(args: CreateMultiBid) {
+		return createMultiBid(args);
+	}
+
+	public async cancelMultiBid(args: CancelMultiBid) {
+		return cancelMultiBid(args);
+	}
+
+	public async updateMultiBid(args: UpdateMultiBid) {
+		return updateMultiBid(args, {
+			suiClient: this.suiClient,
+			tradeportRouterUrl: this.tradeportRouterUrl,
+		});
+	}
+
+	public async sponsorNftListing(args: SponsorNftListing) {
+		return sponsorNftListing(args);
+	}
+
+	public async applyFtStrategy(args: ApplyFtStrategy) {
+		return applyFtStrategy(args);
+	}
+
+	public async applyTradeportNftStrategy(args: ApplyNftStrategy) {
+		return applyTradeportNftStrategy(args);
+	}
+}
+
+export default SuiTradingClient;

package/src/apiClients/createKioskClient.ts

@@ -0,0 +1,10 @@
+import { KioskClient } from '@mysten/kiosk';
+import { SuiGraphQLClient } from '@mysten/sui/graphql';
+
+const createKioskClient = (graphqlUrl: string) =>
+	new KioskClient({
+		client: new SuiGraphQLClient({ url: graphqlUrl, network: 'mainnet' }),
+		network: 'mainnet',
+	});
+
+export default createKioskClient;

package/src/apiClients/createSuiClient.ts

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

package/src/apiClients/graphqlClient.ts

@@ -0,0 +1,17 @@
+import type { GraphQLClient } from 'graphql-request';
+
+let graphqlClient: GraphQLClient;
+
+export const getGraphqlClient = () => {
+	if (!graphqlClient) {
+		throw new Error(
+			'GraphQL client not initialized. Please provide apiUrl to SuiTradingClient constructor.',
+		);
+	}
+
+	return graphqlClient;
+};
+
+export function setGraphqlClient(client: GraphQLClient) {
+	graphqlClient = client;
+}

package/src/bigNumberConfig.ts

@@ -0,0 +1,10 @@
+import { BigNumber } from 'bignumber.js';
+
+BigNumber.set({
+	POW_PRECISION: 64,
+});
+
+export const ZERO = new BigNumber(0);
+export const ONE = new BigNumber(1);
+
+export default BigNumber;