@sentio/sdk 2.13.0-rc.2 → 2.13.0-rc.3

package/src/move/abstract-codegen.ts

@@ -12,6 +12,7 @@ import { format } from 'prettier'
 import { isFrameworkAccount, moduleQname, normalizeToJSName, SPLITTER, VECTOR_STR } from './utils.js'
 import { camelCase, upperFirst } from 'lodash-es'
 import { TypeDescriptor } from './types.js'
+import { ChainAdapter } from './chain-adapter.js'
 
 interface OutputFile {
   fileName: string
@@ -34,13 +35,11 @@ export abstract class AbstractCodegen<ModuleTypes, NetworkType> {
   GENERATE_ON_ENTRY = true
   PAYLOAD_OPTIONAL = false
 
-  abstract fetchModules(account: string, network: NetworkType): Promise<ModuleTypes>
-  abstract toInternalModules(modules: ModuleTypes): InternalMoveModule[]
-  // Get the structs that represent Events
-  abstract getEventStructs(module: InternalMoveModule): Map<string, InternalMoveStruct>
-  // Get the parameters that actually have arguments in runtime
-  // Aptos first signer and Sui's last TxContext are no use
-  abstract getMeaningfulFunctionParams(params: TypeDescriptor[]): TypeDescriptor[]
+  chainAdapter: ChainAdapter<NetworkType, ModuleTypes>
+
+  protected constructor(chainAdapter: ChainAdapter<NetworkType, ModuleTypes>) {
+    this.chainAdapter = chainAdapter
+  }
 
   readModulesFile(fullPath: string) {
     return JSON.parse(fs.readFileSync(fullPath, 'utf-8'))
@@ -81,7 +80,7 @@ export abstract class AbstractCodegen<ModuleTypes, NetworkType> {
       }
       const fullPath = path.resolve(srcDir, file)
       const abi = this.readModulesFile(fullPath)
-      const modules = this.toInternalModules(abi)
+      const modules = this.chainAdapter.toInternalModules(abi)
 
       for (const module of modules) {
         loader.register(module, path.basename(file, '.json'))
@@ -100,8 +99,8 @@ export abstract class AbstractCodegen<ModuleTypes, NetworkType> {
         console.log(`download dependent module for account ${account} at ${network}`)
 
         try {
-          const rawModules = await this.fetchModules(account, network)
-          const modules = this.toInternalModules(rawModules)
+          const rawModules = await this.chainAdapter.fetchModules(account, network)
+          const modules = this.chainAdapter.toInternalModules(rawModules)
 
           fs.writeFileSync(path.resolve(srcDir, account + '.json'), JSON.stringify(rawModules, null, '\t'))
           for (const module of modules) {
@@ -163,7 +162,7 @@ export abstract class AbstractCodegen<ModuleTypes, NetworkType> {
     const clientFunctions = this.GENERATE_CLIENT
       ? module.exposedFunctions.map((f) => this.generateClientFunctions(module, f)).filter((s) => s !== '')
       : []
-    const eventStructs = this.getEventStructs(module)
+    const eventStructs = this.chainAdapter.getEventStructs(module)
     const eventTypes = new Set(eventStructs.keys())
     const events = Array.from(eventStructs.values())
       .map((e) => this.generateOnEvents(module, e))
@@ -282,7 +281,7 @@ export abstract class AbstractCodegen<ModuleTypes, NetworkType> {
       return
     }
 
-    const fields = this.getMeaningfulFunctionParams(func.params).map((param) => {
+    const fields = this.chainAdapter.getMeaningfulFunctionParams(func.params).map((param) => {
       return this.generateTypeForDescriptor(param, module.address) + (this.PAYLOAD_OPTIONAL ? ' | undefined' : '')
     })
 
@@ -307,7 +306,7 @@ export abstract class AbstractCodegen<ModuleTypes, NetworkType> {
     }
     // const moduleName = normalizeToJSName(module.name)
     const funcName = camelCase(func.name)
-    const fields = this.getMeaningfulFunctionParams(func.params).map((param) => {
+    const fields = this.chainAdapter.getMeaningfulFunctionParams(func.params).map((param) => {
       return this.generateTypeForDescriptor(param, module.address)
     })
     const genericString = this.generateFunctionTypeParameters(func)

package/src/move/abstract-move-coder.ts

@@ -2,6 +2,7 @@ import { moduleQname, SPLITTER, VECTOR_STR } from './utils.js'
 import { parseMoveType, TypeDescriptor } from './types.js'
 import { InternalMoveFunction, InternalMoveModule, InternalMoveStruct } from './internal-models.js'
 import { bytesToBigInt } from '../utils/index.js'
+import { ChainAdapter } from './chain-adapter.js'
 
 export type StructWithTag<Base> = {
   type: string
@@ -13,16 +14,22 @@ export type DecodedStructWithTag<B, T> = StructWithTag<B> & {
   type_arguments: string[]
 }
 
-export abstract class AbstractMoveCoder<StructType> {
+export abstract class AbstractMoveCoder<Network, ModuleTypes, StructType> {
   private moduleMapping = new Map<string, InternalMoveModule>()
   private typeMapping = new Map<string, InternalMoveStruct>()
   private funcMapping = new Map<string, InternalMoveFunction>()
+  network: Network
+  adapter: ChainAdapter<Network, ModuleTypes>
+
+  protected constructor(network: Network) {
+    this.network = network
+  }
 
   contains(account: string, name: string) {
     return this.moduleMapping.has(account + '::' + name)
   }
 
-  protected abstract getMeaningfulFunctionParams(params: TypeDescriptor[]): TypeDescriptor[]
+  // protected abstract getMeaningfulFunctionParams(params: TypeDescriptor[]): TypeDescriptor[]
 
   protected toStructWithTag(val: StructType): StructWithTag<StructType> {
     return val as any
@@ -232,7 +239,7 @@ export abstract class AbstractMoveCoder<StructType> {
 
   encodeCallArgs(args: any[], func: string): any[] {
     const f = this.getMoveFunction(func)
-    return this.encodeArray(args, this.getMeaningfulFunctionParams(f.params))
+    return this.encodeArray(args, this.adapter.getMeaningfulFunctionParams(f.params))
   }
 
   decodeCallResult(res: any[], func: string): any[] {

package/src/move/chain-adapter.ts

@@ -0,0 +1,14 @@
+import { InternalMoveModule, InternalMoveStruct } from './internal-models.js'
+import { TypeDescriptor } from './types.js'
+
+export abstract class ChainAdapter<NetworkType, ModuleTypes> {
+  abstract fetchModules(account: string, network: NetworkType): Promise<ModuleTypes>
+
+  abstract fetchModules(account: string, network: NetworkType): Promise<ModuleTypes>
+  abstract toInternalModules(modules: ModuleTypes): InternalMoveModule[]
+  // Get the structs that represent Events
+  abstract getEventStructs(module: InternalMoveModule): Map<string, InternalMoveStruct>
+  // Get the parameters that actually have arguments in runtime
+  // Aptos first signer and Sui's last TxContext are no use
+  abstract getMeaningfulFunctionParams(params: TypeDescriptor[]): TypeDescriptor[]
+}

package/src/move/index.ts

@@ -2,3 +2,4 @@ export * from './filter.js'
 export * from './types.js'
 export * from './utils.js'
 export * from './account.js'
+export * from './chain-adapter.js'

package/src/sui/codegen/codegen.ts

@@ -1,14 +1,13 @@
-import { Connection, JsonRpcProvider, SuiMoveNormalizedModules } from '@mysten/sui.js'
+import { SuiMoveNormalizedModules } from '@mysten/sui.js'
 
 import { SuiNetwork } from '../network.js'
 import * as fs from 'fs'
 import chalk from 'chalk'
 import { InternalMoveModule, InternalMoveStruct } from '../../move/internal-models.js'
 import { AbstractCodegen } from '../../move/abstract-codegen.js'
-import { toInternalModule } from '../move-types.js'
-import { moduleQname, SPLITTER, structQname, TypeDescriptor } from '../../move/index.js'
-import { getMeaningfulFunctionParams } from '../utils.js'
+import { structQname } from '../../move/index.js'
 import { join } from 'path'
+import { SuiChainAdapter } from '../sui-chain-adapter.js'
 
 export async function codegen(abisDir: string, outDir = join('src', 'types', 'sui'), genExample = false) {
   if (!fs.existsSync(abisDir)) {
@@ -19,18 +18,6 @@ export async function codegen(abisDir: string, outDir = join('src', 'types', 'su
   console.log(chalk.green(`Generated ${numFiles} for Sui`))
 }
 
-function getRpcEndpoint(network: SuiNetwork): string {
-  switch (network) {
-    case SuiNetwork.TEST_NET:
-      return 'https://fullnode.testnet.sui.io/'
-  }
-  return 'https://fullnode.mainnet.sui.io/'
-}
-
-function getRpcClient(network: SuiNetwork): JsonRpcProvider {
-  return new JsonRpcProvider(new Connection({ fullnode: getRpcEndpoint(network) }))
-}
-
 class SuiCodegen extends AbstractCodegen<SuiMoveNormalizedModules, SuiNetwork> {
   ADDRESS_TYPE = 'SuiAddress'
   MAIN_NET = SuiNetwork.MAIN_NET
@@ -40,30 +27,8 @@ class SuiCodegen extends AbstractCodegen<SuiMoveNormalizedModules, SuiNetwork> {
   // GENERATE_ON_ENTRY = true
   PAYLOAD_OPTIONAL = true
 
-  async fetchModules(account: string, network: SuiNetwork): Promise<SuiMoveNormalizedModules> {
-    const client = getRpcClient(network)
-    return await client.getNormalizedMoveModulesByPackage({ package: account })
-  }
-
-  getMeaningfulFunctionParams(params: TypeDescriptor[]): TypeDescriptor[] {
-    return getMeaningfulFunctionParams(params)
-  }
-
-  toInternalModules(modules: SuiMoveNormalizedModules): InternalMoveModule[] {
-    return Object.values(modules).map(toInternalModule)
-  }
-
-  getEventStructs(module: InternalMoveModule) {
-    const qname = moduleQname(module)
-    const eventMap = new Map<string, InternalMoveStruct>()
-
-    for (const struct of module.structs) {
-      const abilities = new Set(struct.abilities)
-      if (abilities.has('Drop') && abilities.has('Copy')) {
-        eventMap.set(qname + SPLITTER + struct.name, struct)
-      }
-    }
-    return eventMap
+  constructor() {
+    super(new SuiChainAdapter())
   }
 
   readModulesFile(fullPath: string) {

package/src/sui/move-coder.ts

@@ -2,18 +2,25 @@ import { TypedEventInstance, TypedFunctionPayload, TypedSuiMoveObject } from './
 import { AbstractMoveCoder, StructWithTag } from '../move/abstract-move-coder.js'
 import {
   MoveCallSuiTransaction,
+  SuiCallArg,
   SuiEvent,
   SuiMoveNormalizedModule,
-  SuiCallArg,
   SuiMoveObject,
   SuiRawData,
+  SuiMoveNormalizedModules,
 } from '@mysten/sui.js'
 import { toInternalModule } from './move-types.js'
 import { SPLITTER, TypeDescriptor } from '../move/index.js'
-import { getMeaningfulFunctionParams } from './utils.js'
 import { dynamic_field } from './builtin/0x2.js'
+import { SuiNetwork } from './network.js'
+import { SuiChainAdapter } from './sui-chain-adapter.js'
+
+export class MoveCoder extends AbstractMoveCoder<SuiNetwork, SuiMoveNormalizedModules, SuiEvent | SuiMoveObject> {
+  constructor(network: SuiNetwork) {
+    super(network)
+    this.adapter = new SuiChainAdapter()
+  }
 
-export class MoveCoder extends AbstractMoveCoder<SuiEvent | SuiMoveObject> {
   load(module: SuiMoveNormalizedModule) {
     if (this.contains(module.address, module.name)) {
       return
@@ -65,14 +72,10 @@ export class MoveCoder extends AbstractMoveCoder<SuiEvent | SuiMoveObject> {
     return this.filterAndDecodeStruct(typeQname, objects)
   }
 
-  getMeaningfulFunctionParams(params: TypeDescriptor[]): TypeDescriptor[] {
-    return getMeaningfulFunctionParams(params)
-  }
-
   decodeFunctionPayload(payload: MoveCallSuiTransaction, inputs: SuiCallArg[]): MoveCallSuiTransaction {
     const functionType = [payload.package, payload.module, payload.function].join(SPLITTER)
     const func = this.getMoveFunction(functionType)
-    const params = getMeaningfulFunctionParams(func.params)
+    const params = this.adapter.getMeaningfulFunctionParams(func.params)
     const args = []
     for (const value of payload.arguments || []) {
       const argValue = value as any
@@ -101,7 +104,7 @@ export class MoveCoder extends AbstractMoveCoder<SuiEvent | SuiMoveObject> {
   }
 }
 
-export const MOVE_CODER = new MoveCoder()
+export const MOVE_CODER = new MoveCoder(SuiNetwork.MAIN_NET)
 
 export function defaultMoveCoder(): MoveCoder {
   return MOVE_CODER

package/src/sui/sui-chain-adapter.ts

@@ -0,0 +1,50 @@
+import { ChainAdapter, moduleQname, SPLITTER, TypeDescriptor } from '../move/index.js'
+import { toInternalModule } from './move-types.js'
+import { SuiNetwork } from './network.js'
+import { InternalMoveModule, InternalMoveStruct } from '../move/internal-models.js'
+import { Connection, JsonRpcProvider, SuiMoveNormalizedModules } from '@mysten/sui.js'
+
+export class SuiChainAdapter extends ChainAdapter<SuiNetwork, SuiMoveNormalizedModules> {
+  static INSTANCE = new SuiChainAdapter()
+
+  async fetchModules(account: string, network: SuiNetwork): Promise<SuiMoveNormalizedModules> {
+    const client = getRpcClient(network)
+    return await client.getNormalizedMoveModulesByPackage({ package: account })
+  }
+
+  getMeaningfulFunctionParams(params: TypeDescriptor[]): TypeDescriptor[] {
+    if (params.length === 0) {
+      return params
+    }
+    return params.slice(0, params.length - 1)
+  }
+
+  toInternalModules(modules: SuiMoveNormalizedModules): InternalMoveModule[] {
+    return Object.values(modules).map(toInternalModule)
+  }
+
+  getEventStructs(module: InternalMoveModule) {
+    const qname = moduleQname(module)
+    const eventMap = new Map<string, InternalMoveStruct>()
+
+    for (const struct of module.structs) {
+      const abilities = new Set(struct.abilities)
+      if (abilities.has('Drop') && abilities.has('Copy')) {
+        eventMap.set(qname + SPLITTER + struct.name, struct)
+      }
+    }
+    return eventMap
+  }
+}
+
+function getRpcEndpoint(network: SuiNetwork): string {
+  switch (network) {
+    case SuiNetwork.TEST_NET:
+      return 'https://fullnode.testnet.sui.io/'
+  }
+  return 'https://fullnode.mainnet.sui.io/'
+}
+
+function getRpcClient(network: SuiNetwork): JsonRpcProvider {
+  return new JsonRpcProvider(new Connection({ fullnode: getRpcEndpoint(network) }))
+}

package/src/sui/utils.ts

@@ -6,7 +6,6 @@ import {
   ProgrammableTransaction,
   SuiTransaction,
 } from '@mysten/sui.js'
-import { TypeDescriptor } from '../move/index.js'
 
 export function getMoveCalls(txBlock: SuiTransactionBlockResponse) {
   const txKind = getTransactionKind(txBlock)
@@ -33,10 +32,3 @@ export function getMoveCalls(txBlock: SuiTransactionBlockResponse) {
     return []
   })
 }
-
-export function getMeaningfulFunctionParams(params: TypeDescriptor[]): TypeDescriptor[] {
-  if (params.length === 0) {
-    return params
-  }
-  return params.slice(0, params.length - 1)
-}

package/lib/aptos/utils.d.ts

@@ -1,2 +0,0 @@
-import { TypeDescriptor } from '../move/index.js';
-export declare function getMeaningfulFunctionParams(params: TypeDescriptor[]): TypeDescriptor[];

package/lib/aptos/utils.js

@@ -1,10 +0,0 @@
-export function getMeaningfulFunctionParams(params) {
-    if (params.length === 0) {
-        return params;
-    }
-    if (params[0].qname === 'signer' && params[0].reference) {
-        params = params.slice(1);
-    }
-    return params;
-}
-//# sourceMappingURL=utils.js.map

package/lib/aptos/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/aptos/utils.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,2BAA2B,CAAC,MAAwB;IAClE,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QACvB,OAAO,MAAM,CAAA;KACd;IACD,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE;QACvD,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;KACzB;IACD,OAAO,MAAM,CAAA;AACf,CAAC","sourcesContent":["import { TypeDescriptor } from '../move/index.js'\n\nexport function getMeaningfulFunctionParams(params: TypeDescriptor[]): TypeDescriptor[] {\n  if (params.length === 0) {\n    return params\n  }\n  if (params[0].qname === 'signer' && params[0].reference) {\n    params = params.slice(1)\n  }\n  return params\n}\n"]}

package/src/aptos/utils.ts

@@ -1,11 +0,0 @@
-import { TypeDescriptor } from '../move/index.js'
-
-export function getMeaningfulFunctionParams(params: TypeDescriptor[]): TypeDescriptor[] {
-  if (params.length === 0) {
-    return params
-  }
-  if (params[0].qname === 'signer' && params[0].reference) {
-    params = params.slice(1)
-  }
-  return params
-}