@sentio/sdk 1.37.0-rc.1 → 1.37.0-rc.3

package/src/aptos-codegen/codegen.ts

@@ -1,428 +0,0 @@
-import fs from 'fs'
-import path from 'path'
-import prettier from 'prettier'
-import { MoveFunction, MoveModule, MoveModuleBytecode, MoveStruct } from 'aptos-sdk/src/generated'
-import { AccountModulesImportInfo, AccountRegister, generateType } from './typegen'
-import { getMeaningfulFunctionParams, isFrameworkAccount, moduleQname, SPLITTER } from '../aptos/utils'
-import chalk from 'chalk'
-import { AptosNetwork, getAptosChainName, getRpcClient } from '../aptos/network'
-import { parseMoveType } from '../aptos/types'
-
-export function codeGenAptosProcessor(abisDir: string, outDir = 'src/types/aptos') {
-  if (!fs.existsSync(abisDir)) {
-    return
-  }
-  console.log(chalk.green('Generated Types for Aptos'))
-  generate(abisDir, outDir)
-}
-
-export async function generate(srcDir: string, outputDir: string) {
-  await generateForNetwork(srcDir, outputDir, AptosNetwork.MAIN_NET)
-  await generateForNetwork(path.join(srcDir, 'testnet'), path.join(outputDir, 'testnet'), AptosNetwork.TEST_NET)
-}
-
-export async function generateForNetwork(srcDir: string, outputDir: string, network: AptosNetwork) {
-  if (!fs.existsSync(srcDir)) {
-    return
-  }
-  if (network === AptosNetwork.TEST_NET) {
-    console.log('Found testnet directory, generate code for testnet modules')
-  }
-  const files = fs.readdirSync(srcDir)
-  outputDir = path.resolve(outputDir)
-  const outputs: OutputFile[] = []
-
-  fs.mkdirSync(outputDir, { recursive: true })
-
-  const loader = new AccountRegister()
-
-  // when generating user code, don't need to generate framework account
-  loader.accountImports.set('0x1', new AccountModulesImportInfo('0x1', '0x1'))
-  loader.accountImports.set('0x2', new AccountModulesImportInfo('0x2', '0x2'))
-  loader.accountImports.set('0x3', new AccountModulesImportInfo('0x3', '0x3'))
-  const client = getRpcClient(network)
-
-  for (const file of files) {
-    if (!file.endsWith('.json')) {
-      continue
-    }
-    const fullPath = path.resolve(srcDir, file)
-    const modules = JSON.parse(fs.readFileSync(fullPath, 'utf-8'))
-
-    for (const module of modules) {
-      if (module.abi) {
-        loader.register(module.abi, path.basename(file, '.json'))
-      }
-    }
-    const codeGen = new AccountCodegen(loader, modules, {
-      fileName: path.basename(file, '.json'),
-      outputDir: outputDir,
-      network,
-    })
-
-    outputs.push(...codeGen.generate())
-  }
-
-  while (loader.pendingAccounts.size > 0) {
-    for (const account of loader.pendingAccounts) {
-      console.log(`download dependent module for account ${account} at ${getAptosChainName(network)}`)
-
-      try {
-        const modules = await client.getAccountModules(account)
-        fs.writeFileSync(path.resolve(srcDir, account + '.json'), JSON.stringify(modules, null, '\t'))
-
-        for (const module of modules) {
-          if (module.abi) {
-            loader.register(module.abi, account)
-          }
-        }
-        const codeGen = new AccountCodegen(loader, modules, {
-          fileName: account,
-          outputDir: outputDir,
-          network,
-        })
-
-        outputs.push(...codeGen.generate())
-      } catch (e) {
-        console.error(
-          chalk.red(
-            'Error downloading account module, check if you choose the right network，or download account modules manually into your director'
-          )
-        )
-        console.error(e)
-        process.exit(1)
-      }
-    }
-  }
-
-  for (const output of outputs) {
-    const content = prettier.format(output.fileContent, { parser: 'typescript' })
-    fs.writeFileSync(path.join(outputDir, output.fileName), content)
-  }
-}
-
-interface OutputFile {
-  fileName: string
-  fileContent: string
-}
-
-interface Config {
-  fileName: string
-  outputDir: string
-  network: AptosNetwork
-}
-
-export class AccountCodegen {
-  modules: MoveModuleBytecode[]
-  config: Config
-  loader: AccountRegister
-
-  constructor(loader: AccountRegister, modules: MoveModuleBytecode[], config: Config) {
-    // const json = fs.readFileSync(config.srcFile, 'utf-8')
-    this.modules = modules
-    this.config = config
-    this.loader = loader
-  }
-
-  generate(): OutputFile[] {
-    if (!this.modules) {
-      return []
-    }
-    // const baseName = path.basename(this.config.fileName, '.json')
-
-    let address: string | undefined
-    for (const module of this.modules) {
-      if (module.abi && module.abi.address) {
-        address = module.abi.address
-      }
-    }
-    if (!address) {
-      return []
-    }
-
-    const imports = `
-    import { aptos } from "@sentio/sdk"
-    import { Address, MoveModule } from "aptos-sdk/src/generated"
-    `
-
-    const dependedAccounts: string[] = []
-
-    const moduleImports: string[] = []
-
-    const info = this.loader.accountImports.get(address)
-
-    if (info) {
-      for (const [account] of info.imports.entries()) {
-        // Remap to user's filename if possible, TODO codepath not well tested
-        let tsAccountModule = './' + (this.loader.accountImports.get(account)?.moduleName || account)
-        if (isFrameworkAccount(account) && !isFrameworkAccount(address)) {
-          // Decide where to find runtime library
-          let srcRoot = 'lib'
-          if (__dirname.includes('sdk/src/aptos-codegen')) {
-            srcRoot = 'src'
-          }
-          tsAccountModule = `@sentio/sdk/${srcRoot}/builtin/aptos/${account}`
-        }
-        moduleImports.push(`import * as _${account} from "${tsAccountModule}"`)
-
-        dependedAccounts.push(account)
-      }
-    }
-
-    const source = `
-    /* Autogenerated file. Do not edit manually. */
-    /* tslint:disable */
-    /* eslint-disable */
-  
-    /* Generated modules for account ${address} */
-  
-    ${imports}
-    
-    ${moduleImports.join('\n')}
-    
-    ${this.modules.map((m) => generateModule(m, this.config.network)).join('\n')}
-    
-    export function loadAllTypes(_r: aptos.TypeRegistry) {
-      ${dependedAccounts.map((a) => `_${a}.loadAllTypes(_r)`).join('\n')}
-
-      ${this.modules
-        .map((m) => {
-          return `_r.load(${m.abi?.name}.ABI)`
-        })
-        .join('\n')}
-    }
-    ` // source
-
-    return [
-      {
-        fileName: this.config.fileName + '.ts',
-        fileContent: source,
-      },
-    ]
-  }
-}
-
-function generateNetworkOption(network: AptosNetwork) {
-  switch (network) {
-    case AptosNetwork.TEST_NET:
-      return 'TEST_NET'
-  }
-  return 'MAIN_NET'
-}
-
-function generateModule(moduleByteCode: MoveModuleBytecode, network: AptosNetwork) {
-  if (!moduleByteCode.abi) {
-    return ''
-  }
-  const module = moduleByteCode.abi
-
-  const functions = module.exposed_functions.map((f) => generateOnEntryFunctions(module, f)).filter((s) => s !== '')
-
-  const eventStructs = getEventStructs(module)
-  const eventTypes = new Set(eventStructs.keys())
-  const events = Array.from(eventStructs.values())
-    .map((e) => generateOnEvents(module, e))
-    .filter((s) => s !== '')
-  const structs = module.structs.map((s) => generateStructs(module, s, eventTypes))
-  const callArgs = module.exposed_functions.map((f) => generateCallArgsStructs(module, f))
-
-  let processor = ''
-  if (functions.length > 0 || events.length > 0) {
-    processor = `export class ${module.name} extends aptos.AptosBaseProcessor {
-
-    constructor(options: aptos.AptosBindOptions) {
-      super("${module.name}", options)
-    }
-    static DEFAULT_OPTIONS: aptos.AptosBindOptions = {
-      address: "${module.address}",
-      network: aptos.AptosNetwork.${generateNetworkOption(network)}       
-    }
-
-    static bind(options: Partial<aptos.AptosBindOptions> = {}): ${module.name} {
-      return new ${module.name}({ ...${module.name}.DEFAULT_OPTIONS, ...options })
-    }
-    
-    ${functions.join('\n')}
-    
-    ${events.join('\n')}
-    
-    loadTypesInternal(registry: aptos.TypeRegistry) {
-      loadAllTypes(registry)
-    }
-  }
-  `
-  }
-
-  return `
-  ${processor}
-
-  export namespace ${module.name} {
-    ${structs.join('\n')}
-    
-    ${callArgs.join('\n')}
-       
-    export function loadTypes(_r: aptos.TypeRegistry) {
-      loadAllTypes(_r)
-    }
-    export const ABI: MoveModule = JSON.parse('${JSON.stringify(module)}')
- }
-  `
-}
-
-function generateStructs(module: MoveModule, struct: MoveStruct, events: Set<string>) {
-  const genericString = generateStructTypeParameters(struct)
-  const genericStringAny = generateStructTypeParameters(struct, true)
-
-  const fields = struct.fields.map((field) => {
-    return `${field.name}: ${generateType(field.type, module.address)}`
-  })
-
-  let eventPayload = ''
-  if (events.has(moduleQname(module) + SPLITTER + struct.name)) {
-    eventPayload = `
-    export interface ${struct.name}Instance extends 
-        aptos.TypedEventInstance<${struct.name}${genericStringAny}> {
-      data_typed: ${struct.name}${genericStringAny}
-      type_arguments: [${struct.generic_type_params.map((_) => 'string').join(', ')}]
-    }
-    `
-  }
-
-  return `
-  export class ${struct.name}${genericString} {
-    static TYPE_QNAME = '${module.address}::${module.name}::${struct.name}'
-    ${fields.join('\n')} 
-  }
-  
-  ${eventPayload}
-  `
-}
-
-function generateFunctionTypeParameters(func: MoveFunction) {
-  let genericString = ''
-  if (func.generic_type_params && func.generic_type_params.length > 0) {
-    const params = func.generic_type_params
-      .map((v, idx) => {
-        return `T${idx}=any`
-      })
-      .join(',')
-    genericString = `<${params}>`
-  }
-  return genericString
-}
-
-function generateStructTypeParameters(struct: MoveStruct, useAny = false) {
-  let genericString = ''
-
-  if (struct.generic_type_params && struct.generic_type_params.length > 0) {
-    const params = struct.generic_type_params
-      .map((v, idx) => {
-        return useAny ? 'any' : 'T' + idx
-      })
-      .join(',')
-    genericString = `<${params}>`
-  }
-  return genericString
-}
-
-function generateCallArgsStructs(module: MoveModule, func: MoveFunction) {
-  if (!func.is_entry) {
-    return
-  }
-
-  const fields = getMeaningfulFunctionParams(func).map((param) => {
-    return `${generateType(param, module.address)}`
-  })
-
-  const camelFuncName = capitalizeFirstChar(camelize(func.name))
-
-  const genericString = generateFunctionTypeParameters(func)
-  return `
-  export interface ${camelFuncName}Payload${genericString}
-      extends aptos.TypedEntryFunctionPayload<[${fields.join(',')}]> {
-    arguments_typed: [${fields.join(',')}],
-    type_arguments: [${func.generic_type_params.map((_) => 'string').join(', ')}]
-  }
-  `
-}
-
-function generateOnEntryFunctions(module: MoveModule, func: MoveFunction) {
-  if (!func.is_entry) {
-    return ''
-  }
-
-  // const genericString = generateFunctionTypeParameters(func)
-
-  const camelFuncName = capitalizeFirstChar(camelize(func.name))
-  const source = `
-  onEntry${camelFuncName}(func: (call: ${module.name}.${camelFuncName}Payload, ctx: aptos.AptosContext) => void, filter?: aptos.CallFilter): ${module.name} {
-    this.onEntryFunctionCall(func, {
-      ...filter,
-      function: '${module.name}::${func.name}'
-    })
-    return this
-  }`
-
-  return source
-}
-
-function getEventStructs(module: MoveModule) {
-  const qname = moduleQname(module)
-  const structMap = new Map<string, MoveStruct>()
-  const eventMap = new Map<string, MoveStruct>()
-
-  for (const struct of module.structs) {
-    structMap.set(qname + SPLITTER + struct.name, struct)
-  }
-
-  for (const struct of module.structs) {
-    for (const field of struct.fields) {
-      const t = parseMoveType(field.type)
-      if (t.qname === '0x1::event::EventHandle') {
-        const event = t.typeArgs[0].qname
-        const eventStruct = structMap.get(event)
-        if (eventStruct) {
-          eventMap.set(event, eventStruct)
-        }
-      }
-    }
-  }
-
-  return eventMap
-}
-
-function generateOnEvents(module: MoveModule, struct: MoveStruct): string {
-  // for struct that has drop + store
-  // if (!isEvent(struct, module)) {
-  //   return ''
-  // }
-
-  // const genericString = generateStructTypeParameters(struct)
-
-  const source = `
-  onEvent${struct.name}(func: (event: ${module.name}.${struct.name}Instance, ctx: aptos.AptosContext) => void): ${module.name} {
-    this.onEvent(func, {
-      type: '${module.name}::${struct.name}'
-    })
-    return this
-  }
-  `
-  return source
-}
-
-function camelize(input: string): string {
-  return input
-    .split('_')
-    .reduce(
-      (res, word, i) =>
-        i === 0 ? word.toLowerCase() : `${res}${word.charAt(0).toUpperCase()}${word.substr(1).toLowerCase()}`,
-      ''
-    )
-}
-
-function capitalizeFirstChar(input: string): string {
-  if (!input) {
-    return input
-  }
-  return input[0].toUpperCase() + (input.length > 1 ? input.substring(1) : '')
-}

package/src/aptos-codegen/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../../../tsconfig.json",
-  "compilerOptions": {
-    "rootDir": "..",
-    "outDir": "../../lib"
-  },
-  "exclude": ["lib"],
-  "include": ["."]
-}

package/src/aptos-codegen/typegen.ts

@@ -1,153 +0,0 @@
-import { MoveModule } from 'aptos-sdk/src/generated'
-import { parseMoveType, TypeDescriptor } from '../aptos/types'
-import { moduleQname, moduleQnameForType, SPLITTER, VECTOR_STR } from '../aptos/utils'
-
-function generateTypeForDescriptor(type: TypeDescriptor, currentAddress: string): string {
-  // TODO &signer is defintely an address, but what if &OTHER_TYPE?
-  if (type.qname.startsWith('&')) {
-    return 'Address'
-  }
-
-  switch (type.qname) {
-    case 'signer': // TODO check this
-    case 'address':
-      return 'Address'
-    case '0x1::string::String':
-      return 'string'
-    case 'bool':
-      return 'Boolean'
-    case 'u8':
-    case 'u16':
-    case 'u32':
-      return 'number'
-    case 'u64':
-    case 'u128':
-      return 'bigint'
-  }
-
-  if (type.qname === VECTOR_STR) {
-    // vector<u8> as hex string
-    const elementTypeQname = type.typeArgs[0].qname
-    if (elementTypeQname === 'u8') {
-      return 'string'
-    }
-    if (elementTypeQname.startsWith('T') && !elementTypeQname.includes(SPLITTER)) {
-      return `${elementTypeQname}[] | string`
-    }
-    return generateTypeForDescriptor(type.typeArgs[0], currentAddress) + '[]'
-  }
-
-  const simpleName = generateSimpleType(type.qname, currentAddress)
-  if (simpleName.length === 0) {
-    console.error('unexpected error')
-  }
-  if (simpleName.includes('vector')) {
-    console.error('unexpected error')
-  }
-  if (type.typeArgs.length > 0) {
-    // return simpleName
-    return simpleName + '<' + type.typeArgs.map((t) => generateTypeForDescriptor(t, currentAddress)).join(',') + '>'
-  }
-  return simpleName
-}
-
-function generateSimpleType(type: string, currentAddress: string): string {
-  const parts = type.split(SPLITTER)
-  if (parts.length < 2) {
-    return parts[0]
-  }
-  if (parts[0] === currentAddress) {
-    return parts.slice(1).join('.')
-  }
-  return '_' + parts.join('.')
-}
-
-// TODO ctx need to have type parameters
-export function generateType(type: string, currentAddress: string): string {
-  return generateTypeForDescriptor(parseMoveType(type), currentAddress)
-}
-
-export class AccountModulesImportInfo {
-  // account to module
-  imports: Map<string, Set<string>>
-  account: string
-  moduleName: string
-
-  constructor(account: string, tsModuleName: string) {
-    this.account = account
-    this.moduleName = tsModuleName
-    this.imports = new Map<string, Set<string>>()
-  }
-
-  addImport(account: string, module: string) {
-    if (account === this.account) {
-      return
-    }
-    let accountModules = this.imports.get(account)
-    if (!accountModules) {
-      accountModules = new Set<string>()
-      this.imports.set(account, accountModules)
-    }
-    accountModules.add(module)
-  }
-}
-
-export class AccountRegister {
-  accountImports = new Map<string, AccountModulesImportInfo>()
-  pendingAccounts = new Set<string>()
-
-  // loadedAccount = new Set<string>()
-  typeRegistry = new Map<string, TypeDescriptor>()
-
-  private loadTypeDescriptor(type: string) {
-    let descriptor = this.typeRegistry.get(type)
-
-    // const descriptparseMoveType(type)
-    if (!descriptor) {
-      descriptor = parseMoveType(type)
-      this.typeRegistry.set(type, descriptor)
-    }
-    return descriptor
-  }
-
-  register(module: MoveModule, tsModuleName: string): AccountModulesImportInfo {
-    const currentModuleFqn = moduleQname(module)
-
-    let accountModuleImports = this.accountImports.get(module.address)
-    if (!accountModuleImports) {
-      accountModuleImports = new AccountModulesImportInfo(module.address, tsModuleName)
-      this.accountImports.set(module.address, accountModuleImports)
-      // the account has already be processed, delete pending task
-      this.pendingAccounts.delete(module.address)
-    }
-
-    for (const struct of module.structs) {
-      for (const field of struct.fields) {
-        for (const type of this.loadTypeDescriptor(field.type).dependedTypes()) {
-          const [account, module] = moduleQnameForType(type)
-          accountModuleImports.addImport(account, module)
-          if (!this.accountImports.has(account)) {
-            this.pendingAccounts.add(account)
-          }
-        }
-      }
-    }
-
-    for (const func of module.exposed_functions) {
-      if (!func.is_entry) {
-        continue
-      }
-      for (const param of func.params) {
-        for (const type of this.loadTypeDescriptor(param).dependedTypes()) {
-          const [account, module] = moduleQnameForType(type)
-          accountModuleImports.addImport(account, module)
-          if (!this.accountImports.has(account)) {
-            this.pendingAccounts.add(account)
-          }
-        }
-      }
-    }
-    this.accountImports.set(currentModuleFqn, accountModuleImports)
-    return accountModuleImports
-  }
-}