@scallop-io/sui-scallop-sdk 2.2.2 → 2.3.0-lst-x-oracle-alpha.1

package/src/builders/oracles/xOracleUpdater.ts

@@ -0,0 +1,160 @@
+import { SuiTxBlock, TransactionArgument } from '@scallop-io/sui-kit';
+import { SupportOracleType, xOracleRuleType } from 'src/types';
+import { SUPPORT_SUI_LST } from 'src/constants/xoracle';
+import { IOraclePackageRegistry } from './oraclePackageRegistry';
+import {
+  IXOracleUpdateStrategy,
+  PythDefaultUpdateStrategy,
+  PythSuiLstUpdateStrategy,
+  SupraDefaultUpdateStrategy,
+  SwitchboardDefaultUpdateStrategy,
+} from './xOracleUpdateStrategy';
+import { UnsupportedLstOracleError } from './error';
+
+export interface IXOracleUpdater<
+  T extends SupportOracleType = SupportOracleType,
+> {
+  oracleName: T; // e.g. 'pyth', 'supra', 'switchboard'
+  updateXOracle(
+    coinName: string,
+    rule: xOracleRuleType,
+    request: TransactionArgument
+  ): void;
+}
+
+abstract class BaseXOracleUpdater<
+  T extends SupportOracleType = SupportOracleType,
+> implements IXOracleUpdater
+{
+  protected strategies: Map<string, IXOracleUpdateStrategy<T>>;
+  abstract readonly oracleName: T;
+
+  constructor(
+    protected readonly tx: SuiTxBlock,
+    protected readonly registry: IOraclePackageRegistry<T>,
+    listStrategies: Record<string, IXOracleUpdateStrategy<T>>
+  ) {
+    this.strategies = new Map(Object.entries(listStrategies));
+  }
+
+  abstract updateXOracle(
+    coinName: string,
+    rule: xOracleRuleType,
+    request: TransactionArgument
+  ): void;
+}
+
+class PythXOracleUpdater extends BaseXOracleUpdater<'pyth'> {
+  readonly oracleName = 'pyth';
+  protected readonly SUPPORT_SUI_LST_SET: Set<string> = new Set(
+    SUPPORT_SUI_LST
+  );
+
+  constructor(tx: SuiTxBlock, registry: IOraclePackageRegistry<'pyth'>) {
+    super(tx, registry, {
+      default: new PythDefaultUpdateStrategy(registry),
+      sui_lst: new PythSuiLstUpdateStrategy(registry),
+    });
+  }
+
+  private resolveStrategy(
+    coinName: string
+  ): IXOracleUpdateStrategy<typeof this.oracleName> {
+    // decide which key to look up in this.strategies
+    let key: string;
+
+    if (this.SUPPORT_SUI_LST_SET.has(coinName)) {
+      key = 'sui_lst';
+    }
+    // else if (this.WALRUS_LST_SET.has(coinName)) {
+    //   key = 'walrus_lst';
+    // }
+    else {
+      key = 'default';
+    }
+
+    const strat = this.strategies.get(key);
+    if (!strat) {
+      // guard if you forgot to register default or list strategies
+      throw new UnsupportedLstOracleError(coinName, this.oracleName);
+    }
+
+    return strat as IXOracleUpdateStrategy<typeof this.oracleName>;
+  }
+
+  updateXOracle(
+    coinName: string,
+    rule: xOracleRuleType,
+    request: TransactionArgument
+  ): void {
+    const strategy = this.resolveStrategy(coinName);
+    strategy.updatePrice(this.tx, request, coinName, rule);
+  }
+}
+
+class SupraXOracleUpdater extends BaseXOracleUpdater<'supra'> {
+  readonly oracleName = 'supra';
+
+  constructor(tx: SuiTxBlock, registry: IOraclePackageRegistry<'supra'>) {
+    super(tx, registry, {
+      default: new SupraDefaultUpdateStrategy(registry), // Placeholder, implement Supra strategy
+    });
+  }
+
+  updateXOracle(
+    coinName: string,
+    rule: xOracleRuleType,
+    request: TransactionArgument
+  ): void {
+    const stragtegy = this.strategies.get('default');
+    stragtegy?.updatePrice(this.tx, request, coinName, rule);
+  }
+}
+
+class SwitchboardXOracleUpdater extends BaseXOracleUpdater<'switchboard'> {
+  readonly oracleName = 'switchboard';
+  constructor(tx: SuiTxBlock, registry: IOraclePackageRegistry<'switchboard'>) {
+    super(tx, registry, {
+      // Placeholder, implement Switchboard strategy
+      default: new SwitchboardDefaultUpdateStrategy(registry),
+    });
+  }
+
+  updateXOracle(
+    coinName: string,
+    rule: xOracleRuleType,
+    request: TransactionArgument
+  ): void {
+    const stragtegy = this.strategies.get('default');
+    stragtegy?.updatePrice(this.tx, request, coinName, rule);
+  }
+}
+
+export const createXOracleUpdater = (
+  tx: SuiTxBlock,
+  registry: IOraclePackageRegistry
+) => {
+  const oracleType = registry.oracleName;
+  switch (oracleType) {
+    case 'pyth': {
+      return new PythXOracleUpdater(
+        tx,
+        registry as IOraclePackageRegistry<'pyth'>
+      );
+    }
+    case 'supra': {
+      return new SupraXOracleUpdater(
+        tx,
+        registry as IOraclePackageRegistry<'supra'>
+      );
+    }
+    case 'switchboard': {
+      return new SwitchboardXOracleUpdater(
+        tx,
+        registry as IOraclePackageRegistry<'switchboard'>
+      );
+    }
+    default:
+      throw new Error(`Unsupported oracle type: ${oracleType}`);
+  }
+};

package/src/builders/vescaBuilder.ts

@@ -4,9 +4,9 @@ import {
   Transaction,
   SuiTxBlock as SuiKitTxBlock,
 } from '@scallop-io/sui-kit';
-import { SCA_COIN_TYPE } from 'src/constants';
+import { SCA_COIN_TYPE } from 'src/constants/common';
 import { ScallopBuilder } from 'src/models';
-import { getVeSca, getVeScas } from 'src/queries';
+import { getVeSca, getVeScas } from 'src/queries/vescaQuery';
 import {
   requireSender,
   checkLockSca,

package/src/constants/api.ts

@@ -0,0 +1,2 @@
+export const API_BASE_URL = 'https://sui.apis.scallop.io' as const;
+export const SDK_API_BASE_URL = 'https://sdk.api.scallop.io' as const;

package/src/constants/common.ts

@@ -1,6 +1,3 @@
-export const API_BASE_URL = 'https://sui.apis.scallop.io' as const;
-export const SDK_API_BASE_URL = 'https://sdk.api.scallop.io' as const;
-
 export const IS_VE_SCA_TEST: boolean = false;
 export const USE_TEST_ADDRESS: boolean = false;
 

package/src/constants/index.ts

@@ -1,8 +1,9 @@
+export * from './api';
 export * from './cache';
 export * from './common';
+export * from './package';
 export * from './queryKeys';
 export * from './rpc';
 export * from './testAddress';
 export * from './vesca';
-export * from './testAddress';
 export * from './xoracle';

package/src/constants/package.ts

@@ -0,0 +1,14 @@
+export const PACKAGE_NAMES = [
+  'coinDecimalsRegistry',
+  'math',
+  'whitelist',
+  'x',
+  'protocol',
+  'protocolWhitelist',
+  'query',
+  'supra',
+  'pyth',
+  'switchboard',
+  'xOracle',
+  'testCoin',
+] as const;