@0xobelisk/client 0.2.8 → 0.3.0

package/dist/types/index.d.ts

@@ -1,114 +0,0 @@
-import { Infer } from 'superstruct';
-import { DisplayFieldsResponse, ObjectCallArg, ObjectContentFields, SharedObjectRef, SuiObjectRef, TransactionArgument, TransactionBlock, SuiTransactionBlockResponse, DevInspectResults, SuiMoveNormalizedModules } from '@mysten/sui.js';
-import { SuiMoveMoudleFuncType } from '../libs/suiContractFactory/types';
-export type ObeliskObjectData = {
-    objectId: string;
-    objectType: string;
-    objectVersion: number;
-    objectDisplay: DisplayFieldsResponse;
-    objectFields: ObjectContentFields;
-};
-export type ObeliskParams = {
-    mnemonics?: string;
-    secretKey?: string;
-    fullnodeUrls?: string[];
-    faucetUrl?: string;
-    networkType?: NetworkType;
-    packageId?: string;
-    metadata?: SuiMoveNormalizedModules;
-};
-export type ComponentFieldType = {
-    components: {
-        type: string;
-        fields: {
-            id: {
-                id: string;
-            };
-            size: string;
-        };
-    };
-};
-export type ComponentValueType = {
-    id: {
-        id: string;
-    };
-    name: string;
-    value: {
-        type: string;
-        fields: ComponentFieldType;
-    };
-};
-export type SuiTxArgument = {
-    kind: "Input";
-    index: number;
-    type?: "object" | "pure" | undefined;
-    value?: any;
-} | {
-    kind: "GasCoin";
-} | {
-    kind: "Result";
-    index: number;
-} | {
-    kind: "NestedResult";
-    index: number;
-    resultIndex: number;
-};
-export type ComponentContentType = {
-    type: string;
-    fields: ComponentValueType;
-    hasPublicTransfer: boolean;
-    dataType: "moveObject";
-};
-export interface MessageMeta {
-    readonly meta: SuiMoveMoudleFuncType;
-}
-export interface ContractQuery extends MessageMeta {
-    (tx: TransactionBlock, params: SuiTxArgument[], isRaw?: boolean): Promise<DevInspectResults | TransactionBlock>;
-}
-export interface ContractTx extends MessageMeta {
-    (tx: TransactionBlock, params: SuiTxArgument[], isRaw?: boolean): SuiTransactionBlockResponse | TransactionBlock;
-}
-export type MapMessageTx = Record<string, ContractTx>;
-export type MapMessageQuery = Record<string, ContractQuery>;
-export type MapMoudleFuncTx = Record<string, MapMessageTx>;
-export type MapMoudleFuncQuery = Record<string, MapMessageQuery>;
-export type MapMoudleFuncTest = Record<string, Record<string, string>>;
-export type MapMoudleFuncQueryTest = Record<string, Record<string, string>>;
-export type AccountMangerParams = {
-    mnemonics?: string;
-    secretKey?: string;
-};
-export type DerivePathParams = {
-    accountIndex?: number;
-    isExternal?: boolean;
-    addressIndex?: number;
-};
-export type NetworkType = 'testnet' | 'mainnet' | 'devnet' | 'localnet';
-export type FaucetNetworkType = 'testnet' | 'devnet' | 'localnet';
-export type SuiKitParams = {
-    mnemonics?: string;
-    secretKey?: string;
-    fullnodeUrls?: string[];
-    faucetUrl?: string;
-    networkType?: NetworkType;
-};
-export type ObjectData = {
-    objectId: string;
-    objectType: string;
-    objectVersion: number;
-    objectDigest: string;
-    initialSharedVersion?: number;
-    objectDisplay: DisplayFieldsResponse;
-    objectFields: ObjectContentFields;
-};
-export type SuiTxArg = Infer<typeof TransactionArgument> | Infer<typeof ObjectCallArg> | string | number | bigint | boolean;
-export type SuiObjectArg = SharedObjectRef | Infer<typeof SuiObjectRef> | string | Infer<typeof ObjectCallArg> | Infer<typeof TransactionArgument>;
-export type SuiVecTxArg = {
-    value: SuiTxArg[];
-    vecType: SuiInputTypes;
-} | SuiTxArg[];
-/**
- * These are the basics types that can be used in the SUI
- */
-export type SuiBasicTypes = 'address' | 'bool' | 'u8' | 'u16' | 'u32' | 'u64' | 'u128' | 'u256';
-export type SuiInputTypes = 'object' | SuiBasicTypes;

package/dist/utils/index.d.ts

@@ -1 +0,0 @@
-export declare function capitalizeFirstLetter(input: string): string;

package/src/framework/bcs.ts

@@ -1,6 +0,0 @@
-
-import { BCS, getSuiMoveConfig } from '@mysten/bcs'
-
-export const bcsSource = new BCS(getSuiMoveConfig())
-export const bcsOnchain = new BCS(getSuiMoveConfig())
-

package/src/framework/loader.ts

@@ -1,152 +0,0 @@
-
-import { FieldsWithTypes, Type, parseTypeName } from './util'
-
-export type PrimitiveValue = string | number | boolean | bigint
-
-export class StructClassLoader {
-  private map: Map<
-    string,
-    {
-      numTypeParams: number
-      fromFields: (fields: Record<string, any>, typeArgs?: Type[]) => any
-      fromFieldsWithTypes: (item: FieldsWithTypes) => any
-    }
-  > = new Map()
-
-  register(...classes: any) {
-    for (const cls of classes) {
-      if (
-        '$typeName' in cls === false ||
-        '$numTypeParams' in cls === false ||
-        'fromFields' in cls === false ||
-        'fromFieldsWithTypes' in cls === false
-      ) {
-        throw new Error(`class ${cls.name} is not a valid struct class`)
-      }
-
-      const typeName = cls.$typeName
-      const numTypeParams = cls.$numTypeParams
-
-      this.map.set(typeName, {
-        numTypeParams,
-        fromFields: (fields: Record<string, any>, typeArgs: Type[] = []) => {
-          if (typeArgs.length !== numTypeParams) {
-            throw new Error(`expected ${numTypeParams} type args, got ${typeArgs.length}`)
-          }
-          if (numTypeParams === 0) {
-            return cls.fromFields(fields)
-          } else if (numTypeParams === 1) {
-            return cls.fromFields(typeArgs[0], fields)
-          } else {
-            return cls.fromFields(typeArgs, fields)
-          }
-        },
-        fromFieldsWithTypes: (item: FieldsWithTypes) => {
-          return cls.fromFieldsWithTypes(item)
-        },
-      })
-    }
-  }
-
-  fromFields(type: Type, value: Record<string, any> | PrimitiveValue) {
-    const ret = this.#handlePrimitiveValue(type, value, this.fromFields.bind(this))
-    if (ret !== undefined) {
-      return ret
-    }
-    value = value as FieldsWithTypes // type hint
-
-    const { typeName, typeArgs } = parseTypeName(type)
-
-    const loader = this.map.get(typeName)
-    if (!loader) {
-      throw new Error(`no loader registered for type ${typeName}, include relevant package in gen.toml`)
-    }
-
-    if (loader.numTypeParams !== typeArgs.length) {
-      throw new Error(`expected ${loader.numTypeParams} type args, got ${typeArgs.length}`)
-    }
-
-    return loader.fromFields(value, typeArgs)
-  }
-
-  fromFieldsWithTypes(type: Type, value: FieldsWithTypes | PrimitiveValue) {
-    const { typeName, typeArgs } = parseTypeName(type)
-
-    // some types are special-cased in the RPC so we need to handle this manually
-    // https://github.com/MystenLabs/sui/blob/416a980749ba8208917bae37a1ec1d43e50037b7/crates/sui-json-rpc-types/src/sui_move.rs#L482-L533
-    switch (typeName) {
-      case '0x1::string::String':
-      case '0x1::ascii::String':
-      case '0x2::url::Url':
-        return value
-      case '0x2::object::ID':
-        return value
-      case '0x2::object::UID':
-        return (value as unknown as { id: string }).id
-      case '0x2::balance::Balance': {
-        const loader = this.map.get('0x2::balance::Balance')
-        if (!loader) {
-          throw new Error('no loader registered for type 0x2::balance::Balance')
-        }
-        return loader.fromFields({ value }, typeArgs)
-      }
-      case '0x1::option::Option': {
-        if (value === null) {
-          return null
-        }
-
-        const loader = this.map.get('0x1::option::Option')
-        if (!loader) {
-          throw new Error('no loader registered for type 0x1::option::Option')
-        }
-        return loader.fromFieldsWithTypes({
-          type: type,
-          fields: { vec: [value] },
-        }).vec[0]
-      }
-    }
-
-    const ret = this.#handlePrimitiveValue(type, value, this.fromFieldsWithTypes.bind(this))
-    if (ret !== undefined) {
-      return ret
-    }
-    value = value as FieldsWithTypes // type hint
-
-    const loader = this.map.get(typeName)
-    if (!loader) {
-      throw new Error(`no loader registered for type ${typeName}, include relevant package in gen.toml`)
-    }
-
-    return loader.fromFieldsWithTypes(value)
-  }
-
-  #handlePrimitiveValue(type: Type, value: any, vecCb: (type: Type, value: any) => any) {
-    const { typeName, typeArgs } = parseTypeName(type)
-
-    switch (typeName) {
-      case 'bool':
-        return value as boolean
-      case 'u8':
-      case 'u16':
-      case 'u32':
-        return value as number
-      case 'u64':
-      case 'u128':
-      case 'u256':
-        return BigInt(value)
-      case 'address':
-        return value as string
-      case 'signer':
-        return value as string
-      case 'vector':
-        value = value as any[]
-        return value.map((item: any) => vecCb(typeArgs[0], item))
-      default:
-        return undefined
-    }
-  }
-}
-
-export const structClassLoaderSource = new StructClassLoader()
-export const structClassLoaderOnchain = new StructClassLoader()
-

package/src/framework/util.ts

@@ -1,219 +0,0 @@
-
-import {
-  is,
-  ObjectCallArg,
-  ObjectId,
-  TransactionArgument,
-  TransactionBlock,
-  normalizeSuiAddress,
-  bcs,
-} from '@mysten/sui.js'
-import { BCS } from '@mysten/bcs'
-
-/** A Move type, e.g., `address`, `bool`, `u64`, `vector<u64>`, `0x2::sui::SUI`... */
-export type Type = string
-
-export interface FieldsWithTypes {
-  /* eslint-disable @typescript-eslint/no-explicit-any */
-  fields: Record<string, any>
-  type: string
-}
-
-export type ObjectArg = ObjectId | ObjectCallArg | TransactionArgument
-export type PureArg =
-  | bigint
-  | string
-  | number
-  | boolean
-  | null
-  | TransactionArgument
-  | Array<PureArg>
-export type GenericArg = ObjectArg | PureArg | Array<ObjectArg> | Array<PureArg> | Array<GenericArg>
-
-export function parseTypeName(name: Type): { typeName: string; typeArgs: Type[] } {
-  const parsed = bcs.parseTypeName(name)
-  return { typeName: parsed.name, typeArgs: parsed.params as string[] }
-}
-
-export function obj(txb: TransactionBlock, arg: ObjectArg) {
-  return is(arg, TransactionArgument) ? arg : txb.object(arg)
-}
-
-export function pure(txb: TransactionBlock, arg: PureArg, type: Type) {
-  if (is(arg, TransactionArgument)) {
-    return obj(txb, arg)
-  }
-
-  function convertType(type: Type): string {
-    const { typeName, typeArgs } = parseTypeName(type)
-    switch (typeName) {
-      case '0x1::string::String':
-      case '0x1::ascii::String':
-        return BCS.STRING
-      case '0x2::object::ID':
-        return BCS.ADDRESS
-      case '0x1::option::Option':
-        return `vector<${convertType(typeArgs[0])}>`
-      case 'vector':
-        return `vector<${convertType(typeArgs[0])}>`
-      default:
-        return type
-    }
-  }
-
-  function isOrHasNestedTransactionArgument(arg: PureArg): boolean {
-    if (Array.isArray(arg)) {
-      return arg.some(item => isOrHasNestedTransactionArgument(item))
-    }
-    return is(arg, TransactionArgument)
-  }
-
-  function convertArg(arg: PureArg, type: Type): PureArg {
-    const { typeName, typeArgs } = parseTypeName(type)
-    if (typeName === '0x1::option::Option') {
-      if (arg === null) {
-        return []
-      } else {
-        return [convertArg(arg, typeArgs[0])]
-      }
-    } else if (typeName === 'vector' && Array.isArray(arg)) {
-      return arg.map(item => convertArg(item, typeArgs[0]))
-    } else if (typeName === '0x2::object::ID' || typeName === 'address') {
-      return normalizeSuiAddress(arg as string)
-    } else {
-      return arg
-    }
-  }
-
-  // handle some cases when TransactionArgument is nested within a vector or option
-  const { typeName, typeArgs } = parseTypeName(type)
-  switch (typeName) {
-    case '0x1::option::Option':
-      if (arg === null) {
-        return txb.pure([], `vector<${convertType(typeArgs[0])}>`)
-      }
-      if (isOrHasNestedTransactionArgument(arg)) {
-        throw new Error('nesting TransactionArgument is not currently supported')
-      }
-      break
-    case 'vector':
-      if (!Array.isArray(arg)) {
-        throw new Error('expected an array for vector type')
-      }
-      if (arg.length === 0) {
-        return txb.pure([], `vector<${convertType(typeArgs[0])}>`)
-      }
-      if (arg.some(arg => Array.isArray(arg) && isOrHasNestedTransactionArgument(arg))) {
-        throw new Error('nesting TransactionArgument is not currently supported')
-      }
-      if (
-        is(arg[0], TransactionArgument) &&
-        arg.filter(arg => !is(arg, TransactionArgument)).length > 0
-      ) {
-        throw new Error('mixing TransactionArgument with other types is not currently supported')
-      }
-      if (is(arg[0], TransactionArgument)) {
-        return txb.makeMoveVec({
-          objects: arg as Array<TransactionArgument>,
-          type: typeArgs[0],
-        })
-      }
-  }
-
-  return txb.pure(convertArg(arg, type), convertType(type))
-}
-
-export function option(txb: TransactionBlock, type: Type, arg: GenericArg | null) {
-  if (arg === null) {
-    return pure(txb, arg, `0x1::option::Option<${type}>`)
-  }
-
-  if (typeArgIsPure(type)) {
-    return pure(txb, arg as PureArg | TransactionArgument, `0x1::option::Option<${type}>`)
-  } else if (is(arg, TransactionArgument)) {
-    return arg
-  } else {
-    if (arg === null) {
-      return pure(txb, arg, `vector<${type}>`)
-    }
-
-    // wrap it with some
-    const val = generic(txb, type, arg)
-    return txb.moveCall({
-      target: `0x1::option::some`,
-      typeArguments: [type],
-      arguments: [val],
-    })
-  }
-}
-
-export function generic(txb: TransactionBlock, type: Type, arg: GenericArg) {
-  if (typeArgIsPure(type)) {
-    return pure(txb, arg as PureArg | TransactionArgument, type)
-  } else {
-    const { typeName, typeArgs } = parseTypeName(type)
-    if (typeName === 'vector' && Array.isArray(arg)) {
-      const itemType = typeArgs[0]
-
-      return txb.makeMoveVec({
-        objects: arg.map(item => obj(txb, item as ObjectArg)),
-        type: itemType,
-      })
-    } else {
-      return obj(txb, arg as ObjectArg)
-    }
-  }
-}
-
-export function vector(
-  txb: TransactionBlock,
-  itemType: Type,
-  items: Array<GenericArg> | TransactionArgument
-) {
-  if (typeArgIsPure(itemType)) {
-    return pure(txb, items as PureArg, `vector<${itemType}>`)
-  } else if (is(items, TransactionArgument)) {
-    return items
-  } else {
-    const { typeName: itemTypeName, typeArgs: itemTypeArgs } = parseTypeName(itemType)
-    if (itemTypeName === '0x1::option::Option') {
-      const objects = items.map(item => option(txb, itemTypeArgs[0], item))
-      return txb.makeMoveVec({
-        objects,
-        type: itemType,
-      })
-    }
-
-    return txb.makeMoveVec({
-      objects: items as Array<TransactionArgument>,
-      type: itemType,
-    })
-  }
-}
-
-export function typeArgIsPure(type: Type): boolean {
-  const { typeName, typeArgs } = parseTypeName(type)
-  switch (typeName) {
-    case 'bool':
-    case 'u8':
-    case 'u16':
-    case 'u32':
-    case 'u64':
-    case 'u128':
-    case 'u256':
-    case 'address':
-    case 'signer':
-      return true
-    case 'vector':
-      return typeArgIsPure(typeArgs[0])
-    case '0x1::string::String':
-    case '0x1::ascii::String':
-    case '0x2::object::ID':
-      return true
-    case '0x1::option::Option':
-      return typeArgIsPure(typeArgs[0])
-    default:
-      return false
-  }
-}
-