@typemove/move 1.0.0-rc.4

package/src/abstract-move-coder.ts

@@ -0,0 +1,394 @@
+import {
+  accountAddressString,
+  moduleQname,
+  SPLITTER,
+  VECTOR_STR,
+} from './utils.js'
+import {
+  DecodedStruct,
+  matchType,
+  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 abstract class AbstractMoveCoder<Network, ModuleType, StructType> {
+  protected moduleMapping = new Map<string, InternalMoveModule>()
+  private typeMapping = new Map<string, InternalMoveStruct>()
+  private funcMapping = new Map<string, InternalMoveFunction>()
+  network: Network
+  adapter: ChainAdapter<Network, ModuleType, StructType>
+
+  protected constructor(network: Network) {
+    this.network = network
+  }
+
+  contains(account: string, name: string) {
+    return this.moduleMapping.has(moduleQname({ address: account, name }))
+  }
+
+  abstract load(module: ModuleType): InternalMoveModule
+
+  protected loadInternal(module: InternalMoveModule) {
+    const account = accountAddressString(module.address)
+    if (this.contains(account, module.name)) {
+      return
+    }
+    this.moduleMapping.set(
+      moduleQname({ address: account, name: module.name }),
+      module
+    )
+
+    for (const struct of module.structs) {
+      // TODO move to util
+      const key = [account, module.name, struct.name].join(SPLITTER)
+      this.typeMapping.set(key, struct)
+    }
+
+    for (const func of module.exposedFunctions) {
+      // if (!func.isEntry) {
+      //   continue
+      // }
+      const key = [account, module.name, func.name].join(SPLITTER)
+      this.funcMapping.set(key, func)
+    }
+  }
+
+  protected decodeBigInt(data: any): bigint {
+    if (Array.isArray(data)) {
+      throw new Error('data is in byte array')
+      // Only sui function need this, strange
+      // const bytes = data as number[]
+      // return bytesToBigInt(new Uint8Array(bytes.slice().reverse()))
+    }
+
+    return BigInt(data)
+  }
+
+  protected encodeBigInt(data: bigint): any {
+    return '0x' + data.toString(16)
+  }
+
+  private requestMap = new Map<string, Promise<InternalMoveModule>>()
+
+  async getMoveStruct(type: string): Promise<InternalMoveStruct> {
+    const [account_, module, typeName] = type.split(SPLITTER)
+    const account = accountAddressString(account_)
+    type = [account, module, typeName].join(SPLITTER)
+
+    let struct = this.typeMapping.get(type)
+    if (struct) {
+      return struct
+    }
+    const key = account + SPLITTER + module
+    let resp = this.requestMap.get(account + SPLITTER + module)
+    if (!resp) {
+      resp = this.adapter
+        .fetchModule(account, module, this.network)
+        .then((m) => {
+          return this.load(m)
+        })
+      this.requestMap.set(key, resp)
+    }
+    await resp
+    struct = this.typeMapping.get(type)
+    if (struct) {
+      return struct
+    }
+    throw new Error(
+      'Failed to load function ' + type + ' type are not imported anywhere'
+    )
+  }
+
+  async getMoveFunction(type: string): Promise<InternalMoveFunction> {
+    const [account_, module, typeName] = type.split(SPLITTER)
+    const account = accountAddressString(account_)
+    type = [account, module, typeName].join(SPLITTER)
+
+    let func = this.funcMapping.get(type)
+    if (func) {
+      return func
+    }
+    const key = account + SPLITTER + module
+    let resp = this.requestMap.get(account + SPLITTER + module)
+    if (!resp) {
+      resp = this.adapter
+        .fetchModule(account, module, this.network)
+        .then((m) => {
+          return this.load(m)
+        })
+      this.requestMap.set(key, resp)
+    }
+    await resp
+    func = this.funcMapping.get(type)
+    if (func) {
+      return func
+    }
+    throw new Error(
+      'Failed to load function ' + type + ' type are not imported anywhere'
+    )
+  }
+
+  protected async decode<T>(data: any, type: TypeDescriptor<T>): Promise<T> {
+    // process simple type
+    if (type.reference) {
+      return data
+    }
+    switch (type.qname) {
+      case 'signer': // TODO check this, aptos only
+      case 'address':
+      case 'Address':
+      case '0x1::string::String':
+      case 'bool':
+      case 'Bool':
+      case 'u8':
+      case 'U8':
+      case 'u16':
+      case 'U16':
+      case 'u32':
+      case 'U32':
+        return data
+      case 'u64':
+      case 'U64':
+      case 'u128':
+      case 'U128':
+      case 'u256':
+      case 'U256':
+        return this.decodeBigInt(data) as any
+    }
+
+    // process vector
+    if (type.qname.toLowerCase() === VECTOR_STR) {
+      // vector<u8> as hex string
+      if (type.typeArgs[0].qname === 'u8' || type.typeArgs[0].qname === 'U8') {
+        return data
+      }
+
+      const res = []
+      for (const entry of data) {
+        res.push(await this.decode(entry, type.typeArgs[0]))
+      }
+      return res as any
+    }
+
+    // Process complex type
+    const struct = await this.getMoveStruct(type.qname)
+
+    const typeCtx = new Map<string, TypeDescriptor>()
+    for (const [idx, typeArg] of type.typeArgs.entries()) {
+      typeCtx.set('T' + idx, typeArg)
+    }
+
+    const typedData: any = {}
+
+    for (const field of struct.fields) {
+      let filedType = field.type
+      filedType = filedType.applyTypeArgs(typeCtx)
+      const fieldValue = this.adapter.getData(data)[field.name]
+      const value = await this.decode(fieldValue, filedType)
+      typedData[field.name] = value
+    }
+    return typedData
+  }
+
+  protected async encode(data: any, type: TypeDescriptor): Promise<any> {
+    // process simple type
+    if (type.reference) {
+      return data
+    }
+    switch (type.qname) {
+      case 'signer': // TODO check this, aptos only
+      case 'address':
+      case 'Address':
+      case '0x2::object::ID':
+      case '0x2::coin::Coin':
+      case '0x1::string::String':
+      case 'bool':
+      case 'Bool':
+      case 'u8':
+      case 'U8':
+      case 'u16':
+      case 'U16':
+      case 'u32':
+      case 'U32':
+        return data
+      case 'u64':
+      case 'U64':
+      case 'u128':
+      case 'U128':
+      case 'u256':
+      case 'U256':
+        return this.encodeBigInt(data)
+    }
+
+    // process vector
+    if (type.qname.toLowerCase() === VECTOR_STR) {
+      // vector<u8> as hex string
+      if (type.typeArgs[0].qname === 'u8' || type.typeArgs[0].qname === 'U8') {
+        return data
+      }
+
+      const res = []
+      for (const entry of data) {
+        res.push(this.encode(entry, type.typeArgs[0]))
+      }
+      return res
+    }
+
+    // Process complex type
+    const struct = await this.getMoveStruct(type.qname)
+
+    const typeCtx = new Map<string, TypeDescriptor>()
+    for (const [idx, typeArg] of type.typeArgs.entries()) {
+      typeCtx.set('T' + idx, typeArg)
+    }
+
+    const typedData: any = {}
+
+    for (const field of struct.fields) {
+      let filedType = field.type
+      filedType = filedType.applyTypeArgs(typeCtx)
+      const value = await this.encode(data[field.name], filedType)
+      typedData[field.name] = value
+    }
+    return typedData
+  }
+
+  async decodeArray(
+    entries: any[],
+    types: TypeDescriptor[],
+    strict = true
+  ): Promise<any[]> {
+    const entriesDecoded: any[] = []
+    for (const [idx, arg] of entries.entries()) {
+      // TODO consider apply payload.type_arguments, but this might be hard since we don't code gen for them
+      const argType = types[idx]
+      try {
+        if (!strict && arg === undefined) {
+          entriesDecoded.push(arg)
+        } else {
+          entriesDecoded.push(await this.decode(arg, argType))
+        }
+      } catch (e) {
+        throw Error(
+          'Decoding error for ' +
+            JSON.stringify(arg) +
+            'using type' +
+            argType +
+            e.toString()
+        )
+      }
+    }
+    return entriesDecoded
+  }
+
+  async encodeArray(
+    entriesDecoded: any[],
+    types: TypeDescriptor[]
+  ): Promise<any[]> {
+    const entries: any[] = []
+    for (const [idx, arg] of entriesDecoded.entries()) {
+      // TODO consider apply payload.type_arguments, but this might be hard since we don't code gen for them
+      const argType = types[idx]
+      try {
+        entries.push(await this.encode(arg, argType))
+      } catch (e) {
+        throw Error(
+          'Decoding error for ' +
+            JSON.stringify(arg) +
+            'using type' +
+            argType +
+            e.toString()
+        )
+      }
+    }
+    return entries
+  }
+
+  async encodeCallArgs(args: any[], func: string): Promise<any[]> {
+    const f = await this.getMoveFunction(func)
+    return this.encodeArray(
+      args,
+      this.adapter.getMeaningfulFunctionParams(f.params)
+    )
+  }
+
+  async decodeCallResult(res: any[], func: string): Promise<any[]> {
+    const f = await this.getMoveFunction(func)
+    return this.decodeArray(res, f.return)
+  }
+
+  async filterAndDecodeStruct<T, ST extends StructType>(
+    typeMatcher: TypeDescriptor<T>,
+    structsWithTags: ST[]
+  ): Promise<DecodedStruct<ST, T>[]> {
+    if (!structsWithTags) {
+      return [] as any
+    }
+    // const typeMatcherDescriptor = parseMoveType(typeMatcher)
+    const results: DecodedStruct<ST, T>[] = []
+    for (const resource of structsWithTags) {
+      const resourceType = this.adapter.getType(resource)
+      const resourceTypeDescriptor = parseMoveType(resourceType)
+      if (!matchType(typeMatcher, resourceTypeDescriptor)) {
+        continue
+      }
+
+      const result = await this.decodedStruct<T, ST>(resource)
+      if (result) {
+        results.push(result)
+      } else {
+        console.error('decoding error')
+      }
+    }
+    return results
+  }
+
+  protected async decodedStruct<T, ST extends StructType>(
+    typeStruct: ST
+  ): Promise<DecodedStruct<ST, T> | undefined> {
+    const typeDescriptor = parseMoveType(this.adapter.getType(typeStruct))
+    const typeArguments = typeDescriptor.typeArgs.map((t) => t.getSignature())
+
+    let dataTyped = undefined
+    try {
+      dataTyped = await this.decode(typeStruct, typeDescriptor)
+    } catch (e) {
+      throw Error(
+        'Decoding error for struct' + JSON.stringify(typeStruct) + e.toString()
+      )
+      // return undefined
+    }
+    return {
+      ...typeStruct,
+      data_decoded: dataTyped,
+      type_arguments: typeArguments,
+    }
+  }
+  async decodedType<T, ST>(
+    typeStruct: ST,
+    type: TypeDescriptor<T>
+  ): Promise<T | undefined> {
+    if (typeStruct === null || typeStruct == undefined) {
+      return typeStruct as any
+    }
+    if (typeof typeStruct === 'object') {
+      if ('type' in typeStruct) {
+        const typeInStruct = parseMoveType(
+          (typeStruct.type as any).toString() || ''
+        )
+        if (!matchType(type, typeInStruct)) {
+          return undefined
+        }
+      }
+    }
+
+    return await this.decode(typeStruct, type)
+  }
+}

package/src/account.ts

@@ -0,0 +1,93 @@
+import { moduleQname, moduleQnameForType } from './utils.js'
+import { InternalMoveModule } from './internal-models.js'
+
+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>()
+
+  register(
+    module: InternalMoveModule,
+    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)
+    }
+
+    this.registerStruct(module, accountModuleImports)
+    this.registerFunctions(module, accountModuleImports)
+
+    this.accountImports.set(currentModuleFqn, accountModuleImports)
+    return accountModuleImports
+  }
+
+  private registerFunctions(
+    module: InternalMoveModule,
+    accountModuleImports: AccountModulesImportInfo
+  ): void {
+    for (const func of module.exposedFunctions) {
+      if (!func.isEntry) {
+        continue
+      }
+      for (const param of func.params) {
+        for (const type of param.dependedTypes()) {
+          const [account, module] = moduleQnameForType(type)
+          accountModuleImports.addImport(account, module)
+          if (!this.accountImports.has(account)) {
+            this.pendingAccounts.add(account)
+          }
+        }
+      }
+    }
+  }
+
+  private registerStruct(
+    module: InternalMoveModule,
+    accountModuleImports: AccountModulesImportInfo
+  ): void {
+    for (const struct of module.structs) {
+      for (const field of struct.fields) {
+        for (const type of field.type.dependedTypes()) {
+          const [account, module] = moduleQnameForType(type)
+          accountModuleImports.addImport(account, module)
+          if (!this.accountImports.has(account)) {
+            this.pendingAccounts.add(account)
+          }
+        }
+      }
+    }
+  }
+}

package/src/chain-adapter.ts

@@ -0,0 +1,30 @@
+import { InternalMoveModule, InternalMoveStruct } from './internal-models.js'
+import { TypeDescriptor } from './types.js'
+
+export abstract class ChainAdapter<NetworkType, ModuleType, StructType> {
+  abstract fetchModule(
+    account: string,
+    module: string,
+    network: NetworkType
+  ): Promise<ModuleType>
+
+  abstract fetchModules(
+    account: string,
+    network: NetworkType
+  ): Promise<ModuleType[]>
+  abstract toInternalModules(modules: ModuleType[]): InternalMoveModule[]
+
+  // Get all structs that represent Events
+  abstract getAllEventStructs(
+    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[]
+
+  abstract getType(base: StructType): string
+  abstract getData<T>(base: StructType): any
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './types.js'
+export * from './utils.js'
+export * from './account.js'
+export * from './chain-adapter.js'

package/src/internal-models.ts

@@ -0,0 +1,40 @@
+import { TypeDescriptor } from './types.js'
+
+export interface InternalMoveModule {
+  address: string
+  name: string
+  exposedFunctions: InternalMoveFunction[]
+  structs: InternalMoveStruct[]
+}
+
+export interface InternalMoveFunction {
+  name: string
+  visibility: InternalMoveFunctionVisibility
+  isEntry: boolean
+  typeParams: InternalMoveTypeParam[]
+  params: TypeDescriptor[]
+  return: TypeDescriptor[]
+}
+
+export interface InternalMoveStruct {
+  name: string
+  isNative: boolean
+  abilities: string[]
+  typeParams: InternalMoveTypeParam[]
+  fields: InternalMoveStructField[]
+}
+
+export interface InternalMoveStructField {
+  name: string
+  type: TypeDescriptor
+}
+
+export enum InternalMoveFunctionVisibility {
+  PRIVATE = 'private',
+  PUBLIC = 'public',
+  FRIEND = 'friend',
+}
+
+export type InternalMoveTypeParam = {
+  constraints: string[]
+}