zo-sdk 0.0.3

package/src/index.ts

@@ -0,0 +1,5 @@
+export * from './api'
+export * from './consts'
+export * from './data'
+export * from './oracle'
+export * from './utils'

package/src/oracle.ts

@@ -0,0 +1,161 @@
+import type { SuiClient } from '@mysten/sui/client'
+import { Transaction } from '@mysten/sui/transactions'
+import type { PriceFeed } from '@pythnetwork/pyth-sui-js'
+import { SuiPriceServiceConnection, SuiPythClient } from '@pythnetwork/pyth-sui-js'
+
+import type { IConsts } from './consts'
+import { getConsts, getPriceIdToPythFeeder, getPythFeederToId, getPythFeederToPriceId, Network } from './consts'
+import jsonFile from './consts/price_id_to_object_id.mainnet.json'
+import { createJsonRpcProvider } from './utils'
+
+export class OracleAPI {
+  network: Network
+  consts: IConsts
+  connectionURL: string
+  PythFeederToPriceId: Record<string, string>
+  PythFeederToId: Record<string, string>
+  provider: SuiClient
+  client: SuiPythClient
+
+  private priceCache: Record<string, PriceFeed> = {}
+
+  constructor(
+    network: Network,
+    provider: SuiClient | null,
+    // todo 需要从配置文件中获取
+    connectionURL: string,
+  ) {
+    this.network = network
+    this.consts = getConsts(network)
+    this.connectionURL = connectionURL
+    this.PythFeederToPriceId = getPythFeederToPriceId(network)
+    this.PythFeederToId = getPythFeederToId(network)
+    this.provider = provider || createJsonRpcProvider(network)
+    this.client = new SuiPythClient(this.provider, this.consts.pythFeeder.state, this.consts.pythFeeder.wormhole.state)
+  }
+
+  validateCache() {
+    const now = Date.now() / 1000
+    for (const key in this.priceCache) {
+      if (now - (this.priceCache[key].getPriceUnchecked().publishTime || 0) > 7) {
+        delete this.priceCache[key]
+      }
+    }
+  }
+
+  async getOraclePrice(tokenId: string) {
+    this.validateCache()
+    if (this.priceCache[tokenId]) {
+      return this.priceCache[tokenId]
+    }
+    const res = await this.getOraclePrices([tokenId])
+    if (!res || !res[0]) {
+      throw new Error(`Unknown token: ${tokenId}`)
+    }
+    this.priceCache[tokenId] = res[0]
+    return res[0]
+  }
+
+  async getOraclePrices(tokens: string[]) {
+    const connection = new SuiPriceServiceConnection(this.connectionURL, {
+      priceFeedRequestConfig: {
+        binary: true,
+      },
+    })
+    const pythObjectIds = tokens.map(token => this.consts.pythFeeder.feeder[token])
+    const priceFeedIds = pythObjectIds.map(pythObjectId => `0x${this.PythFeederToPriceId[pythObjectId]}`)
+    const price = await connection.getLatestPriceFeeds(priceFeedIds)
+    return price
+  }
+
+  // memory leak
+  async subOraclePrices(tokens: string[], callback: (price: PriceFeed) => void) {
+    const connection = new SuiPriceServiceConnection(this.connectionURL, {
+      priceFeedRequestConfig: {
+        binary: true,
+      },
+    })
+    const pythObjectIds = tokens.map(token => this.consts.pythFeeder.feeder[token])
+    const priceFeedIds = pythObjectIds.map(pythObjectId => `0x${this.PythFeederToPriceId[pythObjectId]}`)
+    await connection.subscribePriceFeedUpdates(priceFeedIds, (price) => {
+      price.id = this.PythFeederToId[getPriceIdToPythFeeder(this.network)[price.id]]
+      this.priceCache[price.id] = price
+      callback(price)
+    })
+
+    return () => {
+      connection.unsubscribePriceFeedUpdates(priceFeedIds)
+    }
+  }
+
+  async initOracleTxb(tokens: string[], tx?: Transaction) {
+    let tx_ = tx
+    if (!tx_) {
+      tx_ = new Transaction()
+    }
+    // Remove redundant tokens first
+    const uniqueTokens = [...new Set(tokens)]
+
+    const connection = new SuiPriceServiceConnection(this.connectionURL, {
+      priceFeedRequestConfig: {
+        binary: true,
+      },
+    })
+    const pythObjectIds = uniqueTokens.map(token => this.consts.pythFeeder.feeder[token])
+    const needUpdateObjectIds = (await this.provider.multiGetObjects({
+      ids: pythObjectIds,
+      options: {
+        showContent: true,
+      },
+    })).map(pythObject => [
+      Number.parseInt((pythObject.data?.content as any).fields.price_info.fields.arrival_time || 0, 10) - Date.now() / 1000,
+      pythObject.data?.objectId,
+    ]).filter((x: any) => Math.abs(x[0]) >= 0).map(x => x[1] as string)
+
+    if (needUpdateObjectIds.length === 0) {
+      return tx_
+    }
+
+    const priceFeedIds = needUpdateObjectIds
+      .map(pythObjectId => this.PythFeederToPriceId[pythObjectId])
+      .filter(Boolean)
+      .map(x => `0x${x}`)
+
+    const priceUpdateData = await connection.getPriceFeedsUpdateData(priceFeedIds)
+
+    await this.client.updatePriceFeeds(tx_, priceUpdateData, priceFeedIds)
+    return tx_
+  }
+}
+
+export async function generatePriceIdToObjectIdJson() {
+  const provider = createJsonRpcProvider(Network.MAINNET)
+  const wormholeStateId = '0xaeab97f96cf9877fee2883315d459552b2b921edc16d7ceac6eab944dd88919c'
+  const pythStateId = '0x1f9310238ee9298fb703c3419030b35b22bb1cc37113e3bb5007c99aec79e5b8'
+  const client = new SuiPythClient(provider, pythStateId, wormholeStateId)
+  const ret: any = {}
+
+  const entries = Object.keys(jsonFile)
+
+  // 使用 Promise.all 并行处理所有请求
+  await Promise.all(
+    entries.map(async (key) => {
+      try {
+        const pythObjectId = await client.getPriceFeedObjectId(key)
+        if (pythObjectId) {
+          ret[key] = pythObjectId
+        }
+        else {
+          console.warn(`Failed to get pythObjectId for key: ${key}`)
+        }
+      }
+      catch (error) {
+        console.error(`Error getting pythObjectId for key ${key}:`, error)
+      }
+    }),
+  )
+
+  return ret
+}
+
+// generatePriceIdToObjectIdJson()

package/src/utils.ts

@@ -0,0 +1,184 @@
+import { SuiClient, SuiHTTPTransport } from '@mysten/sui/client'
+import { HermesClient } from '@pythnetwork/hermes-client'
+
+import type { IConsts } from './consts'
+import { Network } from './consts'
+
+export function createJsonRpcProvider(network: Network) {
+  let url = ''
+  switch (network) {
+    case Network.DEVNET: {
+      url = 'https://explorer-rpc.devnet.sui.io/'
+      break
+    }
+    case Network.TESTNET: {
+      url = 'https://sui-testnet.blockvision.org/v1/2sXCJEJNOCdIJhLaDtyhKzqwn6k'
+      break
+    }
+    case Network.MAINNET: {
+      url = 'https://rpc-mainnet.suiscan.xyz'
+      break
+    }
+    default: {
+      url = 'https://explorer-rpc.devnet.sui.io/'
+    }
+  }
+
+  return new SuiClient({
+    transport: new SuiHTTPTransport({ url }),
+  })
+}
+
+export function createPythConnection(network: Network) {
+  let priceConnectionUrl
+  switch (network) {
+    case Network.TESTNET: {
+      priceConnectionUrl = 'https://xc-testnet.pyth.network'
+      break
+    }
+    case Network.MAINNET: {
+      priceConnectionUrl = 'https://xc-mainnet.pyth.network'
+      break
+    }
+    default: {
+      priceConnectionUrl = 'https://xc-testnet.pyth.network'
+    }
+  }
+
+  return new HermesClient(priceConnectionUrl)
+}
+
+export function decimalToObject(decimal: { value: string }) {
+  return Number(BigInt(decimal.value)) / 1e18
+}
+
+export function rateToObject(rate: { value: string }) {
+  return Number(BigInt(rate.value)) / 1e18
+}
+
+interface SRate {
+  fields: {
+    is_positive: boolean
+    value: {
+      fields: {
+        value: string | number
+      }
+    }
+  }
+}
+
+export function sRateToObject(sRate: SRate) {
+  const sign = sRate.fields.is_positive ? 1 : -1
+  return Number(BigInt(sRate.fields.value.fields.value)) / 1e18 * sign
+}
+
+interface SuiDecimal {
+  fields: {
+    is_positive: boolean
+    value: {
+      fields: {
+        value: string
+      }
+    }
+  }
+}
+
+export function sDecimalToObject(sDecimal: SuiDecimal) {
+  const sign = sDecimal.fields.is_positive ? 1 : -1
+  return Number(BigInt(sDecimal.fields.value.fields.value)) / 1e18 * sign
+}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function parseValue(field: any): number {
+  if (field.type && field.type.endsWith('::decimal::Decimal')) {
+    return decimalToObject({ value: field.fields.value })
+  }
+  else if (field.type && field.type.endsWith('::rate::Rate')) {
+    return rateToObject({ value: field.fields.value })
+  }
+  else if (field.type && field.type.endsWith('::srate::SRate')) {
+    return sRateToObject(field)
+  }
+  else if (field.type && field.type.endsWith('::sdecimal::SDecimal')) {
+    return sDecimalToObject(field)
+  }
+  return Number.parseInt(field, 10)
+}
+
+export type ReversedKeyValue<T extends object> = {
+  [K in keyof T]: T[K] extends keyof T
+    ? keyof T
+    : T[K] extends keyof T | infer V
+      ? V
+      : never;
+}
+
+export function reverseKeyValue<T extends object>(obj: T): ReversedKeyValue<T> {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const reversed: any = {}
+
+  for (const key in obj) {
+    if (Object.hasOwn(obj, key)) {
+      const value = obj[key]
+      reversed[value] = key
+    }
+  }
+
+  return reversed
+}
+
+export function parseSymbolKey(input: string): string[] {
+  // This regex will match uppercase letters
+  const regex = /[A-Z]/
+  let result: string[] = []
+  let wordStart = 0
+
+  for (let i = 1; i < input.length; i += 1) {
+    if (regex.test(input[i])) {
+      // Found an uppercase letter, so we split the string here
+      result.push(input.slice(wordStart, i))
+      wordStart = i
+    }
+  }
+
+  // Add the last word to the result array
+  result.push(input.slice(wordStart))
+
+  // Convert the words to lowercase
+  result = result.map(word => word.toLowerCase())
+
+  return result
+}
+
+export function upperFirstCharacter(word: string): string {
+  return word.charAt(0).toUpperCase() + word.slice(1)
+}
+
+export function joinSymbol(direction: string, token: string): string {
+  return `${direction}${upperFirstCharacter(token)}`
+}
+
+export function suiSymbolToSymbol(symbol: string, consts: IConsts): string {
+  if (symbol === '0x2::sui::SUI') {
+    return 'sui'
+  }
+  const ret: Record<string, string> = {}
+  for (const key of Object.keys(consts.coins)) {
+    ret[consts.coins[key].module] = key
+  }
+  return ret[symbol]
+}
+
+export function base64ToUint8Array(base64: string) {
+  // Decode Base64 to binary
+  const binary = atob(base64)
+
+  // Create a Uint8Array from the binary data
+  const uint8Array = new Uint8Array(binary.length)
+  // Populate the Uint8Array with the binary data
+  for (let i = 0; i < binary.length; i += 1) {
+    uint8Array[i] = binary.codePointAt(i)!
+  }
+
+  return uint8Array
+}

package/tests/api.test.ts

@@ -0,0 +1,219 @@
+import { Ed25519Keypair, RawSigner } from '@mysten/sui'
+import consola from 'consola'
+import { describe, it } from 'vitest'
+
+import { API } from '../src/api'
+import { getConsts } from '../src/consts'
+import { base64ToUint8Array, createJsonRpcProvider } from '../src/utils'
+
+function getSigner() {
+  const privKey = process.env.PRIVKEY as string
+  if (!privKey)
+    throw new Error('no privkey')
+  const keypair = Ed25519Keypair.fromSecretKey(base64ToUint8Array(privKey))
+  const provider = createJsonRpcProvider('mainnet')
+  return new RawSigner(keypair, provider)
+}
+
+describe('API', () => {
+  it('should deposit', async () => {
+    const signer = getSigner()
+    const api = new API('testnet')
+    const tx = await api.deposit(
+      'usdt',
+      ['0x25ea697633f012d29b8eb04839fa3b1237b3f912c5c9a68790e1bece09a09cf5'],
+      10000 * 1e9,
+      0,
+    )
+    tx.setGasBudget(1e9)
+    const txid = await signer.signAndExecuteTransactionBlock({
+      transactionBlock: tx,
+    })
+    consola.log(txid)
+  }, 30000)
+
+  it('should withdraw', async () => {
+    const signer = getSigner()
+    const api = new API('testnet')
+    const tx = await api.withdraw(
+      'fsui',
+      ['0x7efdadea2bd3c14afba47506bdd1a798c67421a5d1d90e7b1e5e151ebfa7f6e8'],
+      100,
+      0,
+    )
+    tx.setGasBudget(1e9)
+    const txid = await signer.signAndExecuteTransactionBlock({
+      transactionBlock: tx,
+    })
+    consola.log(txid)
+  }, 30000)
+
+  it('should open position', async () => {
+    const signer = getSigner()
+    const api = new API('testnet')
+    const tx = await api.openPosition(
+      'fsui',
+      'btc',
+      BigInt(0.2 * 1e9),
+      BigInt(1000 * 1e9),
+      ['0x29a8ec9fb0482baae50832a4116d3245ffc5531ee00e65792feaca8c83b0401a'],
+      true,
+      BigInt(10000 * 1e9),
+      25000,
+      0.6,
+      0.3,
+      true,
+    )
+    tx.setGasBudget(1e9)
+    const txid = await signer.signAndExecuteTransactionBlock({
+      transactionBlock: tx,
+    })
+    consola.log(txid)
+  }, 30000)
+
+  it('should pledge in position', async () => {
+    const signer = getSigner()
+    const api = new API('testnet')
+    const tx = await api.pledgeInPosition(
+      '0xd6918be43aa57a1f67b80f175e0d374be13fb732efc978415b3460af26235dee',
+      'fsui',
+      'fsui',
+      100 * 1e9,
+      ['0x29a8ec9fb0482baae50832a4116d3245ffc5531ee00e65792feaca8c83b0401a'],
+      true,
+    )
+    tx.setGasBudget(1e9)
+    const txid = await signer.signAndExecuteTransactionBlock({
+      transactionBlock: tx,
+    })
+    consola.log(txid)
+  }, 30000)
+
+  it('should redeem from position', async () => {
+    const signer = getSigner()
+    const api = new API('testnet')
+    const tx = await api.redeemFromPosition(
+      '0xd6918be43aa57a1f67b80f175e0d374be13fb732efc978415b3460af26235dee',
+      'fsui',
+      'fsui',
+      100 * 1e9,
+      true,
+    )
+    tx.setGasBudget(1e9)
+    const txid = await signer.signAndExecuteTransactionBlock({
+      transactionBlock: tx,
+    })
+    consola.log(txid)
+  }, 30000)
+
+  it('should decrease position', async () => {
+    const signer = getSigner()
+    const api = new API('testnet')
+    const tx = await api.decreasePosition(
+      '0xd6918be43aa57a1f67b80f175e0d374be13fb732efc978415b3460af26235dee',
+      'fsui',
+      'btc',
+      BigInt(100 * 1e9),
+      true,
+      30000,
+      0.6,
+      true,
+      true,
+      false,
+      1,
+    )
+    tx.setGasBudget(1e9)
+    const txid = await signer.signAndExecuteTransactionBlock({
+      transactionBlock: tx,
+    })
+    consola.log(txid)
+  }, 30000)
+
+  it('should close position', async () => {
+    const signer = getSigner()
+    const api = new API('testnet')
+    const tx = await api.decreasePosition(
+      '0xd6918be43aa57a1f67b80f175e0d374be13fb732efc978415b3460af26235dee',
+      'fsui',
+      'fsui',
+      BigInt(100 * 1e9),
+      true,
+      0.6,
+      0.6,
+      false,
+      false,
+      false,
+      1,
+    )
+    tx.setGasBudget(1e9)
+    const txid = await signer.signAndExecuteTransactionBlock({
+      transactionBlock: tx,
+    })
+    consola.log(txid)
+  }, 30000)
+
+  it('should cancel order', async () => {
+    const signer = getSigner()
+    const api = new API('testnet')
+    const tx = await api.cancelOrder(
+      '0xdd7c2928545783697113c7e62ca62b622461590428db84cf164e915052455a83',
+      'fsui',
+      'btc',
+      true,
+      'OPEN_POSITION',
+    )
+    tx.setGasBudget(1e9)
+    const txid = await signer.signAndExecuteTransactionBlock({
+      transactionBlock: tx,
+    })
+    consola.log(txid)
+  }, 30000)
+
+  it('should stake', async () => {
+    const signer = getSigner()
+    const api = new API('testnet')
+    const consts = getConsts('testnet')
+    const tx = await api.stake(
+      ['0xaebfd8e05909880b7dd3e5b326f35e273510773b2219c73c41fd9ee3778f14f8'],
+      BigInt(100000),
+      consts.zoStaking.pool,
+    )
+    tx.setGasBudget(1e9)
+    const txid = await signer.signAndExecuteTransactionBlock({
+      transactionBlock: tx,
+    })
+
+    consola.log(txid)
+  }, 30000)
+
+  it('should unstake', async () => {
+    const signer = getSigner()
+    const api = new API('testnet')
+    const consts = getConsts('testnet')
+    const tx = await api.unstake(
+      (await api.getStaked(await signer.getAddress())).credentials,
+      BigInt(0),
+      consts.zoStaking.pool,
+    )
+    tx.setGasBudget(1e9)
+    const txid = await signer.signAndExecuteTransactionBlock({
+      transactionBlock: tx,
+    })
+
+    consola.log(txid)
+  }, 30000)
+
+  it('should referral', async () => {
+    const signer = getSigner()
+    const api = new API('mainnet')
+    const tx = await api.addReferral(
+      '0x2ccaa4a34c46e1bf6c22a52732ddbb589caefb9c5c0c0f3da485348a5441deb0',
+    )
+    tx.setGasBudget(0.01 * 1e9)
+    const txid = await signer.signAndExecuteTransactionBlock({
+      transactionBlock: tx,
+    })
+
+    consola.log(txid)
+  }, 30000)
+})