@cetusprotocol/sui-clmm-sdk 1.0.0

package/src/types/sui.ts

@@ -0,0 +1,124 @@
+import type { TransactionArgument } from '@mysten/sui/transactions'
+import type { SuiAddressType } from '@cetusprotocol/common-sdk'
+import { ClmmError, TypesErrorCode } from '../errors/errors'
+
+/**
+ * Constants for different modules in the CLMM (Cryptocurrency Liquidity Mining Module).
+ */
+export const ClmmPartnerModule = 'partner'
+export const ClmmIntegratePoolModule = 'pool_script'
+export const ClmmIntegratePoolV2Module = 'pool_script_v2'
+export const ClmmIntegratePoolV3Module = 'pool_script_v3'
+export const ClmmIntegrateRouterModule = 'router'
+export const ClmmIntegrateRouterWithPartnerModule = 'router_with_partner'
+export const ClmmFetcherModule = 'fetcher_script'
+export const ClmmExpectSwapModule = 'expect_swap'
+export const ClmmIntegrateUtilsModule = 'utils'
+
+export const DeepbookCustodianV2Module = 'custodian_v2'
+export const DeepbookClobV2Module = 'clob_v2'
+export const DeepbookEndpointsV2Module = 'endpoints_v2'
+
+/**
+ * Represents a Non-Fungible Token (NFT) with associated metadata.
+ */
+export type NFT = {
+  /**
+   * The address or identifier of the creator of the NFT.
+   */
+  creator: string
+
+  /**
+   * A description providing additional information about the NFT.
+   */
+  description: string
+
+  /**
+   * The URL to the image representing the NFT visually.
+   */
+  image_url: string
+
+  /**
+   * A link associated with the NFT, providing more details or interactions.
+   */
+  link: string
+
+  /**
+   * The name or title of the NFT.
+   */
+  name: string
+
+  /**
+   * The URL to the project or collection associated with the NFT.
+   */
+  project_url: string
+}
+
+/**
+ * Represents a SUI struct tag.
+ */
+export type SuiStructTag = {
+  /**
+   * The full address of the struct.
+   */
+  full_address: string
+
+  /**
+   * The source address of the struct.
+   */
+  source_address: string
+
+  /**
+   * The address of the struct.
+   */
+  address: SuiAddressType
+
+  /**
+   * The module to which the struct belongs.
+   */
+  module: string
+
+  /**
+   * The name of the struct.
+   */
+  name: string
+
+  /**
+   * An array of type arguments (SUI addresses) for the struct.
+   */
+  type_arguments: SuiAddressType[]
+}
+
+/**
+ * Represents basic SUI data types.
+ */
+export type SuiBasicTypes = 'address' | 'bool' | 'u8' | 'u16' | 'u32' | 'u64' | 'u128' | 'u256'
+
+/**
+ * Represents a SUI transaction argument, which can be of various types.
+ */
+export type SuiTxArg = TransactionArgument | string | number | bigint | boolean
+
+/**
+ * Represents input types for SUI data.
+ */
+export type SuiInputTypes = 'object' | SuiBasicTypes
+
+/**
+ * Gets the default SUI input type based on the provided value.
+ * @param value - The value to determine the default input type for.
+ * @returns The default SUI input type.
+ * @throws Error if the type of the value is unknown.
+ */
+export const getDefaultSuiInputType = (value: any): SuiInputTypes => {
+  if (typeof value === 'string' && value.startsWith('0x')) {
+    return 'object' // Treat value as an object if it starts with '0x'.
+  }
+  if (typeof value === 'number' || typeof value === 'bigint') {
+    return 'u64' // Treat number or bigint values as 'u64' type.
+  }
+  if (typeof value === 'boolean') {
+    return 'bool' // Treat boolean values as 'bool' type.
+  }
+  throw new ClmmError(`Unknown type for value: ${value}`, TypesErrorCode.InvalidType)
+}

package/src/types/token_type.ts

@@ -0,0 +1,189 @@
+import type { SuiObjectIdType } from '@cetusprotocol/common-sdk'
+
+/**
+ * Represents configuration for tokens.
+ */
+export type TokenConfig = {
+  /**
+   * The object identifier of the coin registry.
+   */
+  coin_registry_id: SuiObjectIdType
+
+  /**
+   * The object identifier of the coin list owner.
+   */
+  coin_list_owner: SuiObjectIdType
+
+  /**
+   * The object identifier of the pool registry.
+   */
+  pool_registry_id: SuiObjectIdType
+
+  /**
+   * The object identifier of the pool list owner.
+   */
+  pool_list_owner: SuiObjectIdType
+}
+
+/**
+ * Represents information about a token.
+ */
+export type TokenInfo = {
+  /**
+   * The name of the token.
+   */
+  name: string
+
+  /**
+   * The symbol of the token.
+   */
+  symbol: string
+
+  /**
+   * The official symbol of the token.
+   */
+  official_symbol: string
+
+  /**
+   * The Coingecko ID of the token.
+   */
+  coingecko_id: string
+
+  /**
+   * The number of decimal places for the token.
+   */
+  decimals: number
+
+  /**
+   * The project URL for the token.
+   */
+  project_url: string
+
+  /**
+   * The URL to the logo image of the token.
+   */
+  logo_url: string
+
+  /**
+   * The address of the token.
+   */
+  address: string
+
+  /**
+   * Additional properties for the token information.
+   */
+} & Record<string, any>
+
+/**
+ * Represents information about a liquidity pool.
+ */
+export type PoolInfo = {
+  /**
+   * The symbol of the pool.
+   */
+  symbol: string
+
+  /**
+   * The name of the pool.
+   */
+  name: string
+
+  /**
+   * The number of decimal places for the pool.
+   */
+  decimals: number
+
+  /**
+   * The fee for the pool.
+   */
+  fee: string
+
+  /**
+   * The tick spacing for the pool.
+   */
+  tick_spacing: number
+
+  /**
+   * The type of the pool.
+   */
+  type: string
+
+  /**
+   * The address of the pool.
+   */
+  address: string
+
+  /**
+   * The address of coin A for the pool.
+   */
+  coin_a_address: string
+
+  /**
+   * The address of coin B for the pool.
+   */
+  coin_b_address: string
+
+  /**
+   * The project URL for the pool.
+   */
+  project_url: string
+
+  /**
+   * The sort order for the pool.
+   */
+  sort: number
+
+  /**
+   * Indicates if the rewarder is displayed for the pool.
+   */
+  is_display_rewarder: boolean
+
+  /**
+   * Indicates if rewarder 1 is displayed for the pool.
+   */
+  rewarder_display1: boolean
+
+  /**
+   * Indicates if rewarder 2 is displayed for the pool.
+   */
+  rewarder_display2: boolean
+
+  /**
+   * Indicates if rewarder 3 is displayed for the pool.
+   */
+  rewarder_display3: boolean
+
+  /**
+   * Indicates if the pool is stable.
+   */
+  is_stable: boolean
+
+  /**
+   * Additional properties for the pool information.
+   */
+} & Record<string, any>
+
+/**
+ * Represents an event related to token configuration.
+ */
+export type TokenConfigEvent = {
+  /**
+   * The object identifier of the coin registry.
+   */
+  coin_registry_id: SuiObjectIdType
+
+  /**
+   * The object identifier of the coin list owner.
+   */
+  coin_list_owner: SuiObjectIdType
+
+  /**
+   * The object identifier of the pool registry.
+   */
+  pool_registry_id: SuiObjectIdType
+
+  /**
+   * The object identifier of the pool list owner.
+   */
+  pool_list_owner: SuiObjectIdType
+}