@typemove/sui 1.2.3-rc.2 → 1.2.4-rc.1

package/src/builtin/index.ts

@@ -1,6 +0,0 @@
-/* Autogenerated file. Do not edit manually. */
-/* tslint:disable */
-/* eslint-disable */
-export * as _0x1 from './0x1.js'
-export * as _0x2 from './0x2.js'
-export * as _0x3 from './0x3.js'

package/src/codegen/codegen.ts

@@ -1,211 +0,0 @@
-import { SuiMoveNormalizedModule, SuiEvent, SuiMoveObject, SuiClient } from '@mysten/sui.js/client'
-
-import * as fs from 'fs'
-import chalk from 'chalk'
-import {
-  InternalMoveModule,
-  InternalMoveStruct,
-  AbstractCodegen,
-  structQname,
-  InternalMoveFunction,
-  InternalMoveFunctionVisibility,
-  normalizeToJSName,
-  camel
-} from '@typemove/move'
-import { join } from 'path'
-import { SuiChainAdapter } from '../sui-chain-adapter.js'
-
-export async function codegen(
-  abisDir: string,
-  outDir = join('src', 'types', 'sui'),
-  endpoint: string,
-  genExample = false,
-  builtin = false
-) {
-  if (!fs.existsSync(abisDir)) {
-    return
-  }
-  const gen = new SuiCodegen(endpoint)
-  const numFiles = await gen.generate(abisDir, outDir, builtin)
-  console.log(chalk.green(`Generated ${numFiles} for Sui`))
-}
-
-export class SuiCodegen extends AbstractCodegen<
-  // SuiNetwork,
-  SuiMoveNormalizedModule,
-  SuiEvent | SuiMoveObject
-> {
-  ADDRESS_TYPE = 'string'
-  SYSTEM_PACKAGE = '@typemove/sui'
-  // ADDRESS_TYPE = 'string'
-  // MAIN_NET = SuiNetwork.MAIN_NET
-  // TEST_NET = SuiNetwork.TEST_NET
-  PREFIX = 'Sui'
-  // STRUCT_FIELD_NAME = 'fields'
-  // GENERATE_ON_ENTRY = true
-  PAYLOAD_OPTIONAL = true
-
-  constructor(endpoint: string) {
-    super(new SuiChainAdapter(new SuiClient({ url: endpoint })))
-  }
-
-  readModulesFile(fullPath: string) {
-    const res = super.readModulesFile(fullPath)
-    if (res.result) {
-      return res.result
-    }
-    return res
-  }
-
-  generateStructs(module: InternalMoveModule, struct: InternalMoveStruct, events: Set<string>): string {
-    let content = ''
-    switch (structQname(module, struct)) {
-      // TODO they should still have module code generated
-      case '0x1::ascii::Char':
-      case '0x1::ascii::String':
-      case '0x2::object::ID':
-        content += `export type ${struct.name} = string`
-        break
-      case '0x2::coin::Coin':
-        content += `export type ${struct.name}<T> = string`
-        break
-      case '0x2::balance::Balance':
-        content += `export type ${struct.name}<T> = bigint`
-        break
-      case '0x1::option::Option':
-        content += `export type Option<T> = T | undefined`
-        break
-    }
-    return content + super.generateStructs(module, struct, events, content !== '')
-  }
-
-  generateForEvents(module: InternalMoveModule, struct: InternalMoveStruct): string {
-    switch (structQname(module, struct)) {
-      case '0x1::ascii::Char':
-      case '0x1::ascii::String':
-      case '0x2::object::ID':
-      case '0x2::coin::Coin':
-      case '0x1::option::Option':
-      case '0x2::balance::Balance':
-        return ''
-    }
-    return super.generateForEvents(module, struct)
-  }
-
-  protected generateExtra(module: InternalMoveModule): string {
-    const funcs = module.exposedFunctions.map((f) => this.generateBuilderForFunction(module, f))
-
-    const viewFuncs = module.exposedFunctions.map((f) => this.generateViewFunction(module, f))
-
-    return `
-    export namespace builder {
-      ${funcs.join('\n')}
-    }
-    export namespace view {
-      ${viewFuncs.join('\n')}
-    }
-    `
-  }
-
-  private generateArgs(module: InternalMoveModule, func: InternalMoveFunction) {
-    const args = []
-    for (const [idx, arg] of func.params.entries()) {
-      if (arg.reference) {
-        args.push({
-          paramType: `${this.ADDRESS_TYPE} | ObjectCallArg | TransactionArgument`,
-          callValue: `_args.push(transactionArgumentOrObject(args[${idx}], tx))`
-        })
-      } else if (arg.isVector()) {
-        args.push({
-          paramType: `(${this.ADDRESS_TYPE} | ObjectCallArg)[] | TransactionArgument`,
-          callValue: `_args.push(transactionArgumentOrVec(args[${idx}], tx))`
-        })
-      } else {
-        args.push({
-          paramType: `${this.generateTypeForDescriptor(arg, module.address)} | TransactionArgument`,
-          callValue: `_args.push(transactionArgumentOrPure(args[${idx}], tx))`
-        })
-      }
-    }
-    return args
-  }
-
-  protected generateViewFunction(module: InternalMoveModule, func: InternalMoveFunction): string {
-    if (func.visibility !== InternalMoveFunctionVisibility.PUBLIC) {
-      return ''
-    }
-    const genericString = this.generateFunctionTypeParameters(func)
-
-    const typeParamArg = func.typeParams
-      .map((v, idx) => {
-        return `TypeDescriptor<T${idx}> | string`
-      })
-      .join(',')
-
-    const args = this.generateArgs(module, func)
-    const returnType = `${this.generateFunctionReturnTypeParameters(func, module.address)}`
-
-    return `export async function ${camel(normalizeToJSName(func.name))}${genericString}(
-      client: SuiClient,
-      args: [${args.map((a) => a.paramType).join(',')}],
-      ${
-        typeParamArg.length > 0 ? `typeArguments: [${typeParamArg}]` : ``
-      } ): Promise<TypedDevInspectResults<${returnType}>> {
-      const tx = new TransactionBlock()
-      builder.${camel(normalizeToJSName(func.name))}(tx, args ${typeParamArg.length > 0 ? `, typeArguments` : ''})
-      const insepctRes = await client.devInspectTransactionBlock({
-        transactionBlock: tx,
-        sender: ZERO_ADDRESS
-      })
-      
-      return (await getMoveCoder(client)).decodeDevInspectResult<${returnType}>(insepctRes)
-    }`
-  }
-
-  protected generateBuilderForFunction(module: InternalMoveModule, func: InternalMoveFunction): string {
-    if (func.visibility !== InternalMoveFunctionVisibility.PUBLIC) {
-      return ''
-    }
-
-    const args = this.generateArgs(module, func)
-
-    const genericString = this.generateFunctionTypeParameters(func)
-
-    const typeParamArg = func.typeParams
-      .map((v, idx) => {
-        return `TypeDescriptor<T${idx}> | string`
-      })
-      .join(',')
-    const typeParamToString = func.typeParams
-      .map((v, idx) => {
-        return `typeof typeArguments[${idx}] === 'string' ? typeArguments[${idx}] : typeArguments[${idx}].getSignature()`
-      })
-      .join(',')
-
-    return `export function ${camel(normalizeToJSName(func.name))}${genericString}(tx: TransactionBlock, 
-      args: [${args.map((a) => a.paramType).join(',')}],
-      ${typeParamArg.length > 0 ? `typeArguments: [${typeParamArg}]` : ``} ):
-       TransactionArgument & [ ${'TransactionArgument,'.repeat(func.params.length)} ] {
-      const _args: any[] = []
-      ${args.map((a) => a.callValue).join('\n')}
-      
-      // @ts-ignore
-      return tx.moveCall({
-        target: "${module.address}::${module.name}::${func.name}",
-        arguments: _args,
-        ${typeParamArg.length > 0 ? `typeArguments: [${typeParamToString}]` : ``}
-      })
-    }`
-  }
-
-  generateImports(): string {
-    return `
-      ${super.generateImports()}
-      import { ZERO_ADDRESS, TypedDevInspectResults, getMoveCoder } from '@typemove/sui'
-      import { TransactionBlock, TransactionArgument } from '@mysten/sui.js/transactions'
-      import { SuiClient } from '@mysten/sui.js/client'
-      import { type ObjectCallArg } from "@mysten/sui.js/dist/esm/builder/Inputs.js";
-      import { transactionArgumentOrObject, transactionArgumentOrPure, transactionArgumentOrVec } from '@typemove/sui'
-    `
-  }
-}

package/src/codegen/index.ts

@@ -1 +0,0 @@
-export * from './codegen.js'

package/src/codegen/run.ts

@@ -1,20 +0,0 @@
-// #!/usr/bin/env node
-
-import { codegen } from './codegen.js'
-
-if (process.argv.length > 3) {
-  const abisDir = process.argv[2]
-  const targetDir = process.argv[3]
-  let endpoint: string | undefined = process.argv[4]
-  if (!endpoint || endpoint == 'mainnet') {
-    endpoint = 'https://fullnode.mainnet.sui.io/'
-  }
-  if (endpoint == 'testnet') {
-    endpoint = 'https://fullnode.testnet.sui.io/'
-  }
-
-  await codegen(abisDir, targetDir, endpoint, false, true)
-} else {
-  console.error('Not enough argument')
-  process.exit(1)
-}

package/src/index.ts

@@ -1,4 +0,0 @@
-export * from './models.js'
-export * from './transaction.js'
-
-export { MoveCoder, defaultMoveCoder, getMoveCoder } from './move-coder.js'

package/src/models.ts

@@ -1,21 +0,0 @@
-import type { SuiEvent, MoveCallSuiTransaction, SuiMoveObject, DevInspectResults } from '@mysten/sui.js/client'
-import { DecodedStruct } from '@typemove/move'
-
-export const ZERO_ADDRESS = '0x0000000000000000000000000000000000000000000000000000000000000000'
-
-export type TypedEventInstance<T> = DecodedStruct<SuiEvent, T>
-export type TypedSuiMoveObject<T> = DecodedStruct<SuiMoveObject, T>
-
-export type TypedFunctionPayload<T extends Array<any>> = MoveCallSuiTransaction & {
-  /**
-   * decoded argument data using ABI, undefined if there is decoding error, usually because the ABI/data mismatch
-   */
-  arguments_decoded: T
-}
-
-export type TypedDevInspectResults<T extends Array<any>> = DevInspectResults & {
-  /**
-   * Decoded return values using ABI, undefined if there is decoding error, usually because the ABI/data mismatch
-   */
-  results_decoded?: T
-}

package/src/move-coder.ts

@@ -1,276 +0,0 @@
-import { TypedDevInspectResults, TypedEventInstance, TypedFunctionPayload } from './models.js'
-import {
-  AbstractMoveCoder,
-  ANY_TYPE,
-  DecodedStruct,
-  parseMoveType,
-  SPLITTER,
-  TypeDescriptor,
-  InternalMoveModule
-} from '@typemove/move'
-import {
-  MoveCallSuiTransaction,
-  SuiCallArg,
-  SuiEvent,
-  SuiMoveNormalizedModule,
-  SuiMoveObject,
-  DevInspectResults,
-  SuiClient
-} from '@mysten/sui.js/client'
-import { toInternalModule } from './to-internal.js'
-import { SuiChainAdapter } from './sui-chain-adapter.js'
-import { dynamic_field } from './builtin/0x2.js'
-import { BCS, getSuiMoveConfig, StructTypeDefinition } from '@mysten/bcs'
-
-// import { Encoding } from '@mysten/bcs/types', this doesn't get exported correctly
-export type Encoding = 'base58' | 'base64' | 'hex'
-
-import { normalizeSuiObjectId, normalizeSuiAddress } from '@mysten/sui.js/utils'
-
-export class MoveCoder extends AbstractMoveCoder<
-  // SuiNetwork,
-  SuiMoveNormalizedModule,
-  SuiEvent | SuiMoveObject
-> {
-  bcs = new BCS(getSuiMoveConfig())
-
-  constructor(client: SuiClient) {
-    super(new SuiChainAdapter(client))
-  }
-
-  load(module: SuiMoveNormalizedModule): InternalMoveModule {
-    let m = this.moduleMapping.get(module.address + '::' + module.name)
-    if (m) {
-      return m
-    }
-    m = toInternalModule(module)
-    this.loadInternal(m)
-    return m
-  }
-
-  protected async decode(data: any, type: TypeDescriptor): Promise<any> {
-    switch (type.qname) {
-      case '0x1::ascii::Char':
-        if (data !== undefined && typeof data !== 'string') {
-          // bcs
-          const byte = (await super.decode(data, type)).byte as number
-          return String.fromCharCode(byte)
-        }
-      case '0x1::ascii::String':
-        if (data !== undefined && typeof data !== 'string') {
-          // bcs verified
-          const bytes = (await super.decode(data, type)).bytes as number[]
-          return new TextDecoder().decode(new Uint8Array(bytes))
-        }
-      case '0x2::object::ID':
-        if (data !== undefined && typeof data !== 'string') {
-          // bcs verified
-          const bytes = (await super.decode(data, type)).bytes as string
-          return normalizeSuiObjectId(bytes)
-        }
-      case '0x2::url::Url':
-        if (data !== undefined && typeof data !== 'string') {
-          // bcs
-          return (await super.decode(data, type)).url
-        }
-      case '0x2::coin::Coin':
-        if (data !== undefined && typeof data !== 'string') {
-          // bcs
-          const bytes = (await super.decode(data, type)).id.id.bytes as number[]
-          return new TextDecoder().decode(new Uint8Array(bytes))
-        }
-        return data
-      case '0x2::balance::Balance':
-        if (data.value) {
-          // bcs verfied
-          const balance = await super.decode(data, type)
-          return balance.value
-        }
-        return BigInt(data)
-      case '0x1::option::Option':
-        if (data === null) {
-          return data
-        }
-        if (data.vec) {
-          // bcs verifed
-          let vec = await super.decode(data, type)
-          vec = vec.vec
-          if (vec.length === 0) {
-            return null
-          }
-          return vec[0]
-        }
-        return this.decode(data, type.typeArgs[0])
-      case 'Address':
-        const str = data as string
-        return normalizeSuiAddress(str)
-      case '0x1::string::String':
-        if (typeof data !== 'string') {
-          // bcs
-          return new TextDecoder().decode(new Uint8Array(data.bytes))
-        }
-      default:
-        return super.decode(data, type)
-    }
-  }
-
-  decodeEvent<T>(event: SuiEvent): Promise<TypedEventInstance<T> | undefined> {
-    return this.decodedStruct(event)
-  }
-  filterAndDecodeEvents<T>(type: TypeDescriptor<T> | string, resources: SuiEvent[]): Promise<TypedEventInstance<T>[]> {
-    if (typeof type === 'string') {
-      type = parseMoveType(type)
-    }
-    return this.filterAndDecodeStruct(type, resources)
-  }
-
-  async getDynamicFields<T1, T2>(
-    objects: SuiMoveObject[],
-    keyType: TypeDescriptor<T1> = ANY_TYPE,
-    valueType: TypeDescriptor<T2> = ANY_TYPE
-  ): Promise<dynamic_field.Field<T1, T2>[]> {
-    // const type = dynamic_field.Field.TYPE
-    // Not using the code above to avoid cycle initialize failed
-    const type = new TypeDescriptor<dynamic_field.Field<T1, T2>>('0x2::dynamic_field::Field')
-    type.typeArgs = [keyType, valueType]
-    const res = await this.filterAndDecodeObjects(type, objects)
-    return res.map((o) => o.data_decoded)
-  }
-
-  filterAndDecodeObjects<T>(
-    type: TypeDescriptor<T>,
-    objects: SuiMoveObject[]
-  ): Promise<DecodedStruct<SuiMoveObject, T>[]> {
-    return this.filterAndDecodeStruct(type, objects)
-  }
-
-  async decodeFunctionPayload(payload: MoveCallSuiTransaction, inputs: SuiCallArg[]): Promise<MoveCallSuiTransaction> {
-    const functionType = [payload.package, payload.module, payload.function].join(SPLITTER)
-    const func = await this.getMoveFunction(functionType)
-    const params = this.adapter.getMeaningfulFunctionParams(func.params)
-    const args = []
-    for (const value of payload.arguments || []) {
-      const argValue = value as any
-      if ('Input' in (argValue as any)) {
-        const idx = argValue.Input
-        const arg = inputs[idx]
-        if (arg.type === 'pure') {
-          args.push(arg.value)
-        } else if (arg.type === 'object') {
-          // object is not there
-          args.push(undefined)
-        } else {
-          console.error('unexpected function arg value')
-          args.push(undefined)
-        }
-        // args.push(arg) // TODO check why ts not work using arg.push(arg)
-      } else {
-        args.push(undefined)
-      }
-    }
-
-    const argumentsTyped = await this.decodeArray(args, params, false)
-    return {
-      ...payload,
-      arguments_decoded: argumentsTyped
-    } as TypedFunctionPayload<any>
-  }
-
-  private async _registerBCSType(qname: string): Promise<void> {
-    if (this.bcs.hasType(qname)) {
-      return
-    }
-    const moveStruct = await this.getMoveStruct(qname)
-    const structDef: StructTypeDefinition = {}
-
-    for (const field of moveStruct.fields) {
-      structDef[field.name] = field.type.getNormalizedSignature()
-    }
-    let typeName = qname
-    const generics = moveStruct.typeParams.map((p, idx) => 'T' + idx).join(', ')
-    if (generics) {
-      typeName = typeName + '<' + generics + '>'
-    }
-
-    this.bcs.registerStructType(typeName, structDef)
-
-    for (const field of moveStruct.fields) {
-      await this.registerBCSTypes(field.type)
-    }
-  }
-
-  private bcsRegistered = new Set<string>()
-
-  async registerBCSTypes(type: TypeDescriptor): Promise<void> {
-    const sig = type.getNormalizedSignature()
-    if (this.bcsRegistered.has(sig)) {
-      return
-    }
-    this.bcsRegistered.add(sig)
-
-    await this._registerBCSType('0x1::string::String')
-
-    for (const typeArg of type.dependedTypes()) {
-      await this._registerBCSType(typeArg)
-    }
-  }
-
-  async decodeBCS(type: TypeDescriptor, data: Uint8Array | string, encoding?: Encoding): Promise<any> {
-    await this.registerBCSTypes(type)
-    return this.bcs.de(type.getNormalizedSignature(), data, encoding)
-  }
-
-  async decodeDevInspectResult<T extends any[]>(insepctRes: DevInspectResults): Promise<TypedDevInspectResults<T>> {
-    const returnValues = []
-    if (insepctRes.results != null) {
-      for (const r of insepctRes.results) {
-        if (r.returnValues) {
-          const type = parseMoveType(r.returnValues[0][1])
-          const value = r.returnValues[0][0]
-          const bcsDecoded = await this.decodeBCS(type, new Uint8Array(value))
-          const decoded = await this.decodedType(bcsDecoded, type)
-          returnValues.push(decoded)
-        } else {
-          returnValues.push(null)
-        }
-      }
-    }
-    return { ...insepctRes, results_decoded: returnValues as any }
-  }
-}
-
-const DEFAULT_ENDPOINT = 'https://fullnode.mainnet.sui.io/'
-const CODER_MAP = new Map<string, MoveCoder>()
-const CHAIN_ID_CODER_MAP = new Map<string, MoveCoder>()
-
-export function defaultMoveCoder(endpoint: string = DEFAULT_ENDPOINT): MoveCoder {
-  let coder = CODER_MAP.get(endpoint)
-  if (!coder) {
-    coder = new MoveCoder(new SuiClient({ url: DEFAULT_ENDPOINT }))
-    CODER_MAP.set(endpoint, coder)
-  }
-  return coder
-}
-
-const PROVIDER_CODER_MAP = new Map<SuiClient, MoveCoder>()
-
-let DEFAULT_CHAIN_ID: string | undefined
-
-export async function getMoveCoder(client: SuiClient): Promise<MoveCoder> {
-  let coder = PROVIDER_CODER_MAP.get(client)
-  if (!coder) {
-    coder = new MoveCoder(client)
-    // TODO how to dedup
-    const id = await client.getChainIdentifier()
-    const defaultCoder = defaultMoveCoder()
-    if (!DEFAULT_CHAIN_ID) {
-      DEFAULT_CHAIN_ID = await defaultCoder.adapter.getChainId()
-    }
-    if (id === DEFAULT_CHAIN_ID) {
-      coder = defaultCoder
-    }
-
-    PROVIDER_CODER_MAP.set(client, coder)
-  }
-  return coder
-}

package/src/sui-chain-adapter.ts

@@ -1,121 +0,0 @@
-import { toInternalModule } from './to-internal.js'
-import {
-  InternalMoveModule,
-  InternalMoveStruct,
-  ChainAdapter,
-  moduleQname,
-  SPLITTER,
-  TypeDescriptor
-} from '@typemove/move'
-
-import { SuiMoveNormalizedModule, SuiEvent, SuiMoveObject, SuiClient } from '@mysten/sui.js/client'
-
-export class SuiChainAdapter extends ChainAdapter<
-  // SuiNetwork,
-  SuiMoveNormalizedModule,
-  SuiEvent | SuiMoveObject
-> {
-  async getChainId() {
-    return this.client.getChainIdentifier()
-  }
-  // static INSTANCE = new SuiChainAdapter()
-
-  client: SuiClient
-  constructor(client: SuiClient) {
-    super()
-    this.client = client
-  }
-
-  async fetchModule(
-    account: string,
-    module: string
-    // network: SuiNetwork
-  ): Promise<SuiMoveNormalizedModule> {
-    return await this.client.getNormalizedMoveModule({ package: account, module })
-  }
-
-  async fetchModules(
-    account: string
-    // network: SuiNetwork
-  ): Promise<SuiMoveNormalizedModule[]> {
-    const modules = await this.client.getNormalizedMoveModulesByPackage({
-      package: account
-    })
-    return Object.values(modules)
-  }
-
-  getMeaningfulFunctionParams(params: TypeDescriptor[]): TypeDescriptor[] {
-    return params
-    // if (params.length === 0) {
-    //   return params
-    // }
-    // return params.slice(0, params.length - 1)
-  }
-
-  toInternalModules(modules: SuiMoveNormalizedModule[]): InternalMoveModule[] {
-    return Object.values(modules).map(toInternalModule)
-  }
-
-  getAllEventStructs(modules: InternalMoveModule[]): Map<string, InternalMoveStruct> {
-    const eventMap = new Map<string, InternalMoveStruct>()
-
-    for (const module of modules) {
-      const qname = moduleQname(module)
-
-      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
-  }
-
-  getType(base: SuiEvent | SuiMoveObject): string {
-    return base.type
-  }
-
-  getData(val: SuiEvent | SuiMoveObject) {
-    // if (val.parsedJson) {
-    //   return val.parsedJson as any
-    // }
-    if (val === undefined) {
-      throw Error('val is undefined')
-    }
-    if ('parsedJson' in val) {
-      return val.parsedJson as any
-    }
-    // if (SuiParsedData.is(val)) {
-    //   return val.fields as any
-    // }
-    if (val.dataType === 'moveObject') {
-      return val.fields as any
-    }
-    // if (SuiMoveObject.is(val)) {
-    //   return val.fields as any
-    // }
-    // This may not be perfect, just think everything has
-    if ('fields' in val) {
-      if ('type' in val && Object.keys(val).length === 2) {
-        return val.fields as any
-      }
-    }
-    return val as any
-  }
-  // validateAndNormalizeAddress(address: string) {
-  //   return validateAndNormalizeAddress(address)
-  // }
-}
-
-// 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(endpoint: string): SuiClient {
-  return new SuiClient({ url: endpoint })
-}