@cetusprotocol/xcetus-sdk 1.0.0 → 1.0.1

package/src/sdk.ts

@@ -1,59 +0,0 @@
-import type { BaseSdkOptions, Package } from '@cetusprotocol/common-sdk'
-import { SdkWrapper } from '@cetusprotocol/common-sdk'
-import { xcetus_mainnet, xcetus_testnet } from './config'
-import { XCetusModule } from './modules/xcetusModule'
-import type { DividendConfig, XcetusConfig } from './types/xcetus_type'
-
-/**
- * Represents options and configurations for an SDK.
- */
-export interface SdkOptions extends BaseSdkOptions {
-  xcetus: Package<XcetusConfig>
-  xcetus_dividends: Package<DividendConfig>
-  cetus_faucet: Package
-}
-
-/**
- * The entry class of CetusXcetusSDK, which is almost responsible for all interactions with Xcetus.
- */
-export class CetusXcetusSDK extends SdkWrapper<SdkOptions> {
-  /**
-   * Provide interact with Xcetus interface.
-   */
-  protected _xcetusModule: XCetusModule
-
-  constructor(options: SdkOptions) {
-    super(options)
-
-    this._xcetusModule = new XCetusModule(this)
-  }
-
-  /**
-   * Getter for the Xcetus property.
-   * @returns {XCetusModule} The Xcetus property value.
-   */
-  get XCetusModule() {
-    return this._xcetusModule
-  }
-
-  /**
-   * Static factory method to initialize the SDK
-   * @param options SDK initialization options
-   * @returns An instance of CetusXcetusSDK
-   */
-  static createSDK(options: BaseSdkOptions): CetusXcetusSDK {
-    const { env = 'mainnet', full_rpc_url } = options
-    return env === 'mainnet'
-      ? CetusXcetusSDK.createCustomSDK({ ...xcetus_mainnet, ...options })
-      : CetusXcetusSDK.createCustomSDK({ ...xcetus_testnet, ...options })
-  }
-
-  /**
-   * Create a custom SDK instance with the given options
-   * @param options The options for the SDK
-   * @returns An instance of CetusBurnSDK
-   */
-  static createCustomSDK<T extends BaseSdkOptions>(options: T & SdkOptions): CetusXcetusSDK {
-    return new CetusXcetusSDK(options)
-  }
-}

package/src/types/index.ts

@@ -1,2 +0,0 @@
-export * from './xcetus_type';
-

package/src/types/xcetus_type.ts

@@ -1,166 +0,0 @@
-import type { NFT, SuiAddressType, SuiObjectIdType } from '@cetusprotocol/common-sdk'
-
-export const XcetusRouterModule = 'router'
-export const DividendsRouterModule = 'router'
-
-export const ONE_DAY_SECONDS = 24 * 3600
-export const EXCHANGE_RATE_MULTIPLIER = 1000
-export const REDEEM_NUM_MULTIPLIER = 100000000000
-
-export type XcetusConfig = {
-  xcetus_manager_id: SuiObjectIdType
-  lock_manager_id: SuiObjectIdType
-  lock_handle_id: SuiObjectIdType
-}
-
-export type DividendConfig = {
-  dividend_admin_id?: SuiObjectIdType
-  dividend_settle_id?: SuiObjectIdType
-  dividend_manager_id: SuiObjectIdType
-  venft_dividends_id: SuiAddressType
-  venft_dividends_id_v2: SuiAddressType
-}
-
-export type LockUpConfig = {
-  min_lock_day: number
-  max_lock_day: number
-  max_percent_numerator: number
-  min_percent_numerator: number
-}
-
-export const defaultLockUpConfig: LockUpConfig = {
-  min_lock_day: 15,
-  max_lock_day: 180,
-  max_percent_numerator: 1000,
-  min_percent_numerator: 500,
-}
-
-export type LockUpManager = {
-  id: string
-  balance: string
-  treasury_manager: string
-  extra_treasury: string
-  lock_infos: {
-    lock_handle_id: string
-    size: number
-  }
-  type_name: string
-  min_lock_day: number
-  max_lock_day: number
-
-  package_version: number
-  max_percent_numerator: number
-  min_percent_numerator: number
-}
-
-export type VeNFT = {
-  id: SuiObjectIdType
-  type: string
-  index: string
-  xcetus_balance: string
-} & NFT
-
-export type LockCetus = {
-  id: SuiObjectIdType
-  type: SuiAddressType
-  locked_start_time: number
-  locked_until_time: number
-  lock_day: number
-  cetus_amount: string
-  xcetus_amount: string
-}
-
-export type ConvertParams = {
-  amount: string
-  venft_id?: SuiObjectIdType
-}
-
-export type RedeemLockParams = {
-  amount: string
-  venft_id: SuiObjectIdType
-  lock_day: number
-}
-
-export type RedeemXcetusParams = {
-  venft_id: SuiObjectIdType
-  lock_id: SuiObjectIdType
-}
-
-export type CancelRedeemParams = {
-  venft_id: SuiObjectIdType
-  lock_id: SuiObjectIdType
-}
-
-export type XcetusManager = {
-  id: SuiObjectIdType
-  index: number
-  has_venft: {
-    handle: SuiObjectIdType
-    size: number
-  }
-  nfts: {
-    handle: SuiObjectIdType
-    size: number
-  }
-  total_locked: string
-  treasury: string
-}
-
-export type VeNFTDividendInfo = {
-  id: SuiObjectIdType
-  venft_id: SuiObjectIdType
-  rewards: DividendReward[]
-}
-
-export type DividendReward = {
-  period: number
-  rewards: { coin_type: SuiAddressType; amount: string }[]
-  version: string
-}
-
-export type PhaseDividendInfo = {
-  id: string
-  phase: string
-  settled_num: string
-  register_time: string
-  redeemed_num: {
-    name: string
-    value: string
-  }[]
-  is_settled: boolean
-  bonus_types: string[]
-  bonus: {
-    name: string
-    value: string
-  }[]
-  phase_end_time: string
-}
-
-export type DividendManager = {
-  id: SuiObjectIdType
-  /// Dividend info of every phase.
-  dividends: {
-    id: SuiObjectIdType
-    size: number
-  }
-  /// Dividend info of every venft.
-  venft_dividends: {
-    id: SuiObjectIdType
-    size: number
-  }
-  /// Current bonus type supported.
-  bonus_types: SuiAddressType[]
-  /// init time
-  start_time: number
-  /// interval day between each settlement phase
-  interval_day: number
-  /// hold the bonus of different types.
-  balances: {
-    id: SuiObjectIdType
-    size: number
-  }
-  /// status
-  is_open: boolean
-}
-
-export type BonusTypesV2 = Record<SuiAddressType, number[]>

package/src/utils/index.ts

@@ -1 +0,0 @@
-export * from './xcetus'

package/src/utils/xcetus.ts

@@ -1,175 +0,0 @@
-import { d, extractStructTagFromType, normalizeCoinType } from '@cetusprotocol/common-sdk'
-import type {
-  BonusTypesV2,
-  DividendManager,
-  DividendReward,
-  LockCetus,
-  LockUpManager,
-  VeNFT,
-  VeNFTDividendInfo,
-} from '../types/xcetus_type'
-import { ONE_DAY_SECONDS } from '../types/xcetus_type'
-
-export class XCetusUtil {
-  static buildVeNFTDividendInfo(fields: any): VeNFTDividendInfo {
-    const veNFTDividendInfo: VeNFTDividendInfo = {
-      id: fields.id.id,
-      venft_id: fields.name,
-      rewards: [],
-    }
-
-    fields.value.fields.value.fields.dividends.fields.contents.forEach((item: any) => {
-      const periodRewards: any[] = []
-      item.fields.value.fields.contents.forEach((reward: any) => {
-        const rewardAmount = reward.fields.value
-        if (d(rewardAmount).gt(0)) {
-          periodRewards.push({
-            coin_type: extractStructTagFromType(reward.fields.key.fields.name).source_address,
-            amount: rewardAmount,
-          })
-        }
-      })
-
-      if (periodRewards.length > 0) {
-        veNFTDividendInfo.rewards.push({
-          period: Number(item.fields.key),
-          rewards: periodRewards,
-          version: 'v1',
-        })
-      }
-    })
-
-    return veNFTDividendInfo
-  }
-
-  static buildDividendManager(fields: any): DividendManager {
-    const dividendManager: DividendManager = {
-      id: fields.id.id,
-      dividends: {
-        id: fields.dividends.fields.id.id,
-        size: fields.dividends.fields.size,
-      },
-      venft_dividends: {
-        id: fields.venft_dividends.fields.id.id,
-        size: fields.venft_dividends.fields.size,
-      },
-      bonus_types: [],
-      start_time: Number(fields.start_time),
-      interval_day: Number(fields.interval_day),
-      balances: {
-        id: fields.balances.fields.id.id,
-        size: fields.balances.fields.size,
-      },
-      is_open: fields.is_open,
-    }
-
-    fields.bonus_types.forEach((item: any) => {
-      dividendManager.bonus_types.push(extractStructTagFromType(item.fields.name).source_address)
-    })
-
-    return dividendManager
-  }
-
-  static buildLockUpManager(fields: any): LockUpManager {
-    const lockUpManager: LockUpManager = {
-      id: fields.id.id,
-      balance: fields.balance,
-      treasury_manager: fields.treasury_manager,
-      extra_treasury: fields.extra_treasury,
-      lock_infos: {
-        lock_handle_id: fields.lock_infos.fields.id.id,
-        size: Number(fields.lock_infos.fields.size),
-      },
-      type_name: normalizeCoinType(fields.type_name.fields.name),
-      min_lock_day: Number(fields.min_lock_day),
-      max_lock_day: Number(fields.max_lock_day),
-      package_version: Number(fields.package_version),
-      max_percent_numerator: Number(fields.max_percent_numerator),
-      min_percent_numerator: Number(fields.min_percent_numerator),
-    }
-
-    return lockUpManager
-  }
-
-  static buildLockCetus(data: any): LockCetus {
-    const fields = data.fields as any
-    const lockCetus = {
-      id: fields.id.id,
-      type: extractStructTagFromType(data.type).source_address,
-      locked_start_time: Number(fields.locked_start_time),
-      locked_until_time: Number(fields.locked_until_time),
-      cetus_amount: fields.balance,
-      xcetus_amount: '0',
-      lock_day: 0,
-    }
-    lockCetus.lock_day = (lockCetus.locked_until_time - lockCetus.locked_start_time) / ONE_DAY_SECONDS
-    return lockCetus
-  }
-
-  static getAvailableXCetus(venft: VeNFT, locks: LockCetus[]): string {
-    let lockAmount = d(0)
-    locks.forEach((lock) => {
-      lockAmount = lockAmount.add(lock.xcetus_amount)
-    })
-
-    return d(venft.xcetus_balance).sub(lockAmount).toString()
-  }
-
-  static getWaitUnLockCetus(locks: LockCetus[]): LockCetus[] {
-    return locks.filter((lock) => {
-      return !XCetusUtil.isLocked(lock)
-    })
-  }
-
-  static getLockingCetus(locks: LockCetus[]): LockCetus[] {
-    return locks.filter((lock) => {
-      return XCetusUtil.isLocked(lock)
-    })
-  }
-
-  static isLocked(lock: LockCetus): boolean {
-    return lock.locked_until_time > Date.parse(new Date().toString()) / 1000
-  }
-
-  static buildDividendRewardTypeList(reward_list?: DividendReward[], reward_list_v2?: DividendReward[]): string[] {
-    const uniqueItems = new Set<string>()
-    reward_list?.forEach((obj) => {
-      obj.rewards.forEach((item) => {
-        uniqueItems.add(item.coin_type)
-      })
-    })
-    reward_list_v2?.forEach((obj) => {
-      obj.rewards.forEach((item) => {
-        uniqueItems.add(item.coin_type)
-      })
-    })
-    return Array.from(uniqueItems)
-  }
-
-  static buildDividendRewardTypeListV2(reward_list?: DividendReward[]): BonusTypesV2 {
-    const uniqueItems: BonusTypesV2 = {}
-    reward_list?.forEach((obj: DividendReward) => {
-      if (obj.version === 'v2') {
-        obj.rewards.forEach((item) => {
-          if (uniqueItems[item.coin_type]) {
-            uniqueItems[item.coin_type].push(obj.period)
-          } else {
-            uniqueItems[item.coin_type] = []
-            uniqueItems[item.coin_type].push(obj.period)
-          }
-        })
-      }
-    })
-    return uniqueItems
-  }
-
-  static getNextStartTime(dividend_manager: DividendManager): number {
-    const currentTime = Date.now() / 1000
-    const { start_time, interval_day } = dividend_manager
-
-    const currentPeriod = Math.ceil((currentTime - start_time) / (interval_day * ONE_DAY_SECONDS))
-    const nextStartTime = start_time + currentPeriod * interval_day * ONE_DAY_SECONDS
-
-    return nextStartTime
-  }
-}

package/tests/tsconfig.json

@@ -1,26 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "commonjs",
-    "allowJs": false,
-    "declaration": true,
-    "lib": [
-      "DOM",
-      "ES6",
-      "DOM.Iterable",
-      "ScriptHost",
-      "ES2016.Array.Include"
-    ],
-    "outDir": "./dist",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "resolveJsonModule": true,
-    "experimentalDecorators": true
-  },
-  "filesGlob": [
-    "src/**/*",
-    "tests/**/*"
-  ]
-}

package/tests/xcetus.test.ts

@@ -1,197 +0,0 @@
-import type { Ed25519Keypair } from '@mysten/sui/keypairs/ed25519'
-import { d, getPackagerConfigs, printTransaction } from '@cetusprotocol/common-sdk'
-import { buildTestAccount } from '@cetusprotocol/test-utils'
-import 'isomorphic-fetch'
-import { CetusXcetusSDK } from '../src/sdk'
-import { XCetusUtil } from '../src/utils/xcetus'
-let send_key_pair: Ed25519Keypair
-const account_id = '0x3992ecfe4eca00d482210cddfceb063608f45f3ca41ce7eedea33f27870eb55a'
-const venft_id = '0x653edd0c372ee7b5fc38e7934caab30b8a45b1680d727f127b05140806034067'
-const lock_id = '0x005ba9202a5d9e41c73155a1b4e473a0283191954fb47fe3f927c7026aefec40'
-const redeem_lock_id = '0x6c7cb48929308e7213747c0710ea38db89e3067aa7c80645a0b41dca596fa375'
-describe('xcetus Module', () => {
-  const sdk = CetusXcetusSDK.createSDK({ env: 'mainnet' })
-
-  beforeEach(async () => {
-    send_key_pair = buildTestAccount()
-    sdk.setSenderAddress(send_key_pair.toSuiAddress())
-  })
-
-  test('getOwnerVeNFT', async () => {
-    const ownerVeNFT = await sdk.XCetusModule.getOwnerVeNFT(account_id)
-    console.log('ownerVeNFT: ', ownerVeNFT)
-  })
-
-  test('getOwnerRedeemLockList', async () => {
-    const lockCetus = await sdk.XCetusModule.getOwnerRedeemLockList(account_id)
-    console.log('lockCetus: ', lockCetus)
-  })
-
-  test('getLockCetus', async () => {
-    const lockCetus = await sdk.XCetusModule.getLockCetus(lock_id)
-    console.log('lockCetus: ', lockCetus)
-  })
-
-  test('getOwnerCetusCoins', async () => {
-    const coins = await sdk.XCetusModule.getOwnerCetusCoins(send_key_pair.getPublicKey().toSuiAddress())
-    console.log('coins: ', coins)
-  })
-
-  test('mintVeNFTPayload', async () => {
-    const payload = sdk.XCetusModule.mintVeNFTPayload()
-    const tx = await sdk.FullClient.sendTransaction(send_key_pair, payload)
-    console.log('mintVeNFTPayload : ', tx)
-  })
-
-  test(' Convert Cetus to Xcetus', async () => {
-    sdk.setSenderAddress(send_key_pair.getPublicKey().toSuiAddress())
-    const payload = await sdk.XCetusModule.convertPayload({
-      amount: '10000000000',
-      venft_id,
-    })
-
-    printTransaction(payload)
-
-    const tx = await sdk.FullClient.sendTransaction(send_key_pair, payload)
-    console.log('convertPayload : ', tx)
-  })
-
-  test('redeemLockPayload', async () => {
-    const payload = sdk.XCetusModule.redeemLockPayload({
-      venft_id: venft_id,
-      amount: '1000',
-      lock_day: 30,
-    })
-
-    const tx = await sdk.FullClient.sendTransaction(send_key_pair, payload)
-    console.log('redeemLockPayload : ', tx)
-  })
-
-  test('redeemPayload', async () => {
-    const lockCetus = await sdk.XCetusModule.getLockCetus(redeem_lock_id)
-    console.log('lockCetus: ', lockCetus)
-
-    if (lockCetus && !XCetusUtil.isLocked(lockCetus)) {
-      const payload = sdk.XCetusModule.redeemPayload({
-        venft_id: venft_id,
-        lock_id: redeem_lock_id,
-      })
-
-      const tx = await sdk.FullClient.sendTransaction(send_key_pair, payload)
-      console.log('redeemPayload : ', tx)
-    } else {
-      console.log(' not reach  lock time')
-    }
-  })
-
-  test('redeemDividendPayload', async () => {})
-
-  test('redeemDividendV2Payload', async () => {})
-
-  test('redeemDividendV3Payload', async () => {
-    const dividendManager = await sdk.XCetusModule.getDividendManager()
-    const { venft_dividends_id_v2 } = getPackagerConfigs(sdk.sdkOptions.xcetus_dividends)
-
-    const veNFTDividendInfo = await sdk.XCetusModule.getVeNFTDividendInfo(venft_id)
-
-    if (veNFTDividendInfo) {
-      const payload = await sdk.XCetusModule.redeemDividendV3Payload(venft_id, veNFTDividendInfo.rewards)
-      printTransaction(payload)
-      try {
-        const res = await sdk.FullClient.devInspectTransactionBlock({ transactionBlock: payload, sender: send_key_pair.toSuiAddress() })
-        // const result = await sdk.ClmmSDK.fullClient.sendTransaction(send_key_pair, payload)
-        // console.log('redeemDividendV3Payload: ', result)
-      } catch (error) {
-        console.log('🚀🚀🚀 ~ file: xcetus.test.ts:216 ~ test ~ error:', error)
-      }
-    }
-  })
-
-  test('redeemDividendXTokenPayload', async () => {})
-
-  test('buildCetusCoinType', async () => {})
-
-  test('buildXTokenCoinType', async () => {})
-
-  test('cancelRedeemPayload', async () => {
-    const lockCetus = await sdk.XCetusModule.getLockCetus(redeem_lock_id)
-    console.log('lockCetus: ', lockCetus)
-
-    if (lockCetus && XCetusUtil.isLocked(lockCetus)) {
-      const payload = sdk.XCetusModule.cancelRedeemPayload({
-        venft_id: venft_id,
-        lock_id: redeem_lock_id,
-      })
-
-      const tx = await sdk.FullClient.sendTransaction(send_key_pair, payload)
-      console.log('cancelRedeemPayload : ', tx)
-    }
-  })
-
-  test('getInitConfigs', async () => {})
-
-  test('getLockUpManager', async () => {
-    const lockUpManagerEvent = await sdk.XCetusModule.getLockUpManager()
-    console.log(lockUpManagerEvent)
-  })
-
-  test('getDividendConfigs', async () => {})
-
-  test('getDividendManager', async () => {})
-
-  test('getXcetusManager', async () => {
-    const xcetusManager = await sdk.XCetusModule.getXcetusManager()
-    console.log('xcetusManager: ', xcetusManager)
-  })
-
-  test('getVeNFTDividendInfo', async () => {
-    const veNFTDividendInfo = await sdk.XCetusModule.getVeNFTDividendInfo(venft_id)
-    console.log('🚀🚀🚀 ~ file: xcetus.test.ts:175 ~ test ~ veNFTDividendInfo:', JSON.stringify(veNFTDividendInfo, null, 2))
-  })
-
-  test('redeemNum', async () => {
-    const n = 15
-    const amountInput = 20000
-    const amount = await sdk.XCetusModule.redeemNum(amountInput, n)
-    const rate = d(n).sub(15).div(165).mul(0.5).add(0.5)
-    const amount1 = rate.mul(amountInput)
-    console.log('amount : ', amount, amount1, rate)
-  })
-
-  test('reverseRedeemNum', async () => {})
-
-  test('getXCetusAmount', async () => {})
-
-  test('getVeNftAmount', async () => {})
-
-  test('getPhaseDividendInfo', async () => {
-    const phaseDividendInfo = await sdk.XCetusModule.getPhaseDividendInfo('10')
-    console.log('phaseDividendInfo: ', phaseDividendInfo)
-  })
-
-  /**-------------------------------------xWHALE Holder Rewards--------------------------------------- */
-  test('get my share', async () => {
-    const ownerVeNFT = await sdk.XCetusModule.getOwnerVeNFT(send_key_pair.getPublicKey().toSuiAddress())
-    console.log('ownerVeNFT: ', ownerVeNFT)
-
-    if (ownerVeNFT) {
-      const xcetusManager = await sdk.XCetusModule.getXcetusManager()
-      console.log('xcetusManager: ', xcetusManager)
-
-      const veNftAmount = await sdk.XCetusModule.getVeNftAmount(xcetusManager.nfts.handle, ownerVeNFT.id)
-      console.log('veNftAmount: ', veNftAmount)
-
-      const rate = d(ownerVeNFT.xcetus_balance).div(xcetusManager.treasury)
-      console.log('rate: ', rate)
-    }
-  })
-
-  test('getNextStartTime', async () => {
-    const dividendManager = await sdk.XCetusModule.getDividendManager()
-    console.log('dividendManager: ', dividendManager)
-
-    const nextTime = XCetusUtil.getNextStartTime(dividendManager)
-
-    console.log('nextTime: ', nextTime)
-  })
-})

package/tsconfig.json

@@ -1,5 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
-}

package/tsup.config.ts

@@ -1,9 +0,0 @@
-import { defineConfig } from 'tsup'
-
-export default defineConfig({
-    entry: ['src/index.ts'],
-    splitting: false,
-    sourcemap: true,
-    minify: true,
-    target: 'esnext',
-})