@tradeport/sui-trading-sdk 0.5.1 → 0.5.3

package/jest.config.js

@@ -1,12 +0,0 @@
-/** @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/src/SuiTradingClient.ts

@@ -1,442 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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

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

package/src/apiClients/graphqlClient.ts

@@ -1,17 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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;