@0xobelisk/client 0.4.7 → 1.2.0-pre.100

package/dist/types/index.d.ts

@@ -1,141 +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 SchemaFieldType = {
-    schemas: {
-        type: string;
-        fields: {
-            id: {
-                id: string;
-            };
-            size: string;
-        };
-    };
-};
-export type SchemaValueType = {
-    id: {
-        id: string;
-    };
-    name: string;
-    value: {
-        type: string;
-        fields: SchemaFieldType;
-    };
-};
-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 SchemaContentType = {
-    type: string;
-    fields: SchemaValueType;
-    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 ObjectFieldType = {
-    id: {
-        id: string;
-    };
-    name: string;
-    value: string;
-};
-export type EntityData = {
-    objectId: string;
-    index: string;
-    key: string;
-};
-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;
-export type SuiReturnValues = {
-    returnValues: [number[], string][];
-}[];
-export type DynamicFieldContentType = {
-    type: string;
-    fields: Record<string, any>;
-    hasPublicTransfer: boolean;
-    dataType: string;
-};
-export type ObjectContent = {
-    type: string;
-    fields: Record<string, any>;
-    hasPublicTransfer: boolean;
-    dataType: string;
-};

package/dist/utils/index.d.ts

@@ -1,3 +0,0 @@
-export declare function capitalizeFirstLetter(input: string): string;
-export declare function normalizeHexAddress(input: string): string | null;
-export declare function numberToAddressHex(num: number): string;

package/src/libs/suiAccountManager/crypto.ts

@@ -1,7 +0,0 @@
-import { generateMnemonic as genMnemonic } from '@scure/bip39';
-import { wordlist } from '@scure/bip39/wordlists/english';
-
-export const generateMnemonic = (numberOfWords: 12 | 24 = 24) => {
-  const strength = numberOfWords === 12 ? 128 : 256;
-  return genMnemonic(wordlist, strength);
-};

package/src/libs/suiAccountManager/index.ts

@@ -1,72 +0,0 @@
-import { Ed25519Keypair } from '@mysten/sui.js';
-import { getKeyPair } from './keypair';
-import { hexOrBase64ToUint8Array, normalizePrivateKey } from './util';
-import { generateMnemonic } from './crypto';
-import type { AccountMangerParams, DerivePathParams } from '../../types';
-
-export class SuiAccountManager {
-  private mnemonics: string;
-  private secretKey: string;
-  public currentKeyPair: Ed25519Keypair;
-  public currentAddress: string;
-
-  /**
-   * Support the following ways to init the SuiToolkit:
-   * 1. mnemonics
-   * 2. secretKey (base64 or hex)
-   * If none of them is provided, will generate a random mnemonics with 24 words.
-   *
-   * @param mnemonics, 12 or 24 mnemonics words, separated by space
-   * @param secretKey, base64 or hex string, when mnemonics is provided, secretKey will be ignored
-   */
-  constructor({ mnemonics, secretKey }: AccountMangerParams = {}) {
-    // If the mnemonics or secretKey is provided, use it
-    // Otherwise, generate a random mnemonics with 24 words
-    this.mnemonics = mnemonics || '';
-    this.secretKey = secretKey || '';
-    if (!this.mnemonics && !this.secretKey) {
-      this.mnemonics = generateMnemonic(24);
-    }
-
-    // Init the current account
-    this.currentKeyPair = this.secretKey
-      ? Ed25519Keypair.fromSecretKey(
-          normalizePrivateKey(hexOrBase64ToUint8Array(this.secretKey))
-        )
-      : getKeyPair(this.mnemonics);
-    this.currentAddress = this.currentKeyPair.getPublicKey().toSuiAddress();
-  }
-
-  /**
-   * if derivePathParams is not provided or mnemonics is empty, it will return the currentKeyPair.
-   * else:
-   * it will generate keyPair from the mnemonic with the given derivePathParams.
-   */
-  getKeyPair(derivePathParams?: DerivePathParams) {
-    if (!derivePathParams || !this.mnemonics) return this.currentKeyPair;
-    return getKeyPair(this.mnemonics, derivePathParams);
-  }
-
-  /**
-   * if derivePathParams is not provided or mnemonics is empty, it will return the currentAddress.
-   * else:
-   * it will generate address from the mnemonic with the given derivePathParams.
-   */
-  getAddress(derivePathParams?: DerivePathParams) {
-    if (!derivePathParams || !this.mnemonics) return this.currentAddress;
-    return getKeyPair(this.mnemonics, derivePathParams)
-      .getPublicKey()
-      .toSuiAddress();
-  }
-
-  /**
-   * Switch the current account with the given derivePathParams.
-   * This is only useful when the mnemonics is provided. For secretKey mode, it will always use the same account.
-   */
-  switchAccount(derivePathParams: DerivePathParams) {
-    if (this.mnemonics) {
-      this.currentKeyPair = getKeyPair(this.mnemonics, derivePathParams);
-      this.currentAddress = this.currentKeyPair.getPublicKey().toSuiAddress();
-    }
-  }
-}

package/src/libs/suiAccountManager/keypair.ts

@@ -1,38 +0,0 @@
-import { Ed25519Keypair, fromB64 } from '@mysten/sui.js';
-import type { DerivePathParams } from 'src/types';
-
-/**
- * @description Get ed25519 derive path for SUI
- * @param derivePathParams
- */
-export const getDerivePathForSUI = (
-  derivePathParams: DerivePathParams = {}
-) => {
-  const {
-    accountIndex = 0,
-    isExternal = false,
-    addressIndex = 0,
-  } = derivePathParams;
-  return `m/44'/784'/${accountIndex}'/${isExternal ? 1 : 0}'/${addressIndex}'`;
-};
-
-/**
- * the format is m/44'/784'/accountIndex'/${isExternal ? 1 : 0}'/addressIndex'
- *
- * accountIndex is the index of the account, default is 0.
- *
- * isExternal is the type of the address, default is false. Usually, the external address is used to receive coins. The internal address is used to change coins.
- *
- * addressIndex is the index of the address, default is 0. It's used to generate multiple addresses for one account.
- *
- * @description Get keypair from mnemonics and derive path
- * @param mnemonics
- * @param derivePathParams
- */
-export const getKeyPair = (
-  mnemonics: string,
-  derivePathParams: DerivePathParams = {}
-) => {
-  const derivePath = getDerivePathForSUI(derivePathParams);
-  return Ed25519Keypair.deriveKeypair(mnemonics, derivePath);
-};

package/src/libs/suiAccountManager/util.ts

@@ -1,70 +0,0 @@
-import { fromB64 } from '@mysten/sui.js';
-
-/**
- * @description This regular expression matches any string that contains only hexadecimal digits (0-9, A-F, a-f).
- * @param str
- */
-export const isHex = (str: string) =>
-  /^0x[0-9a-fA-F]+$|^[0-9a-fA-F]+$/.test(str);
-
-/**
- * @description This regular expression matches any string that contains only base64 digits (0-9, A-Z, a-z, +, /, =).
- * Note that the "=" signs at the end are optional padding characters that may be present in some base64 encoded strings.
- * @param str
- */
-export const isBase64 = (str: string) => /^[a-zA-Z0-9+/]+={0,2}$/g.test(str);
-
-/**
- * Convert a hex string to Uint8Array
- * @param hexStr
- */
-export const fromHEX = (hexStr: string): Uint8Array => {
-  if (!hexStr) {
-    throw new Error('cannot parse empty string to Uint8Array');
-  }
-  const intArr = hexStr
-    .replace('0x', '')
-    .match(/.{1,2}/g)
-    ?.map((byte) => parseInt(byte, 16));
-
-  if (!intArr || intArr.length === 0) {
-    throw new Error(`Unable to parse HEX: ${hexStr}`);
-  }
-  return Uint8Array.from(intArr);
-};
-
-/**
- * @description Convert a hex or base64 string to Uint8Array
- */
-export const hexOrBase64ToUint8Array = (str: string): Uint8Array => {
-  if (isHex(str)) {
-    return fromHEX(str);
-  } else if (isBase64(str)) {
-    return fromB64(str);
-  } else {
-    throw new Error('The string is not a valid hex or base64 string.');
-  }
-};
-
-const PRIVATE_KEY_SIZE = 32;
-const LEGACY_PRIVATE_KEY_SIZE = 64;
-/**
- * normalize a private key
- * A private key is a 32-byte array.
- * But there are two different formats for private keys:
- * 1. A 32-byte array
- * 2. A 64-byte array with the first 32 bytes being the private key and the last 32 bytes being the public key
- * 3. A 33-byte array with the first byte being 0x00 (sui.keystore key is a Base64 string with scheme flag 0x00 at the beginning)
- */
-export const normalizePrivateKey = (key: Uint8Array): Uint8Array => {
-  if (key.length === LEGACY_PRIVATE_KEY_SIZE) {
-    // This is a legacy secret key, we need to strip the public key bytes and only read the first 32 bytes
-    key = key.slice(0, PRIVATE_KEY_SIZE);
-  } else if (key.length === PRIVATE_KEY_SIZE + 1 && key[0] === 0) {
-    // sui.keystore key is a Base64 string with scheme flag 0x00 at the beginning
-    return key.slice(1);
-  } else if (key.length === PRIVATE_KEY_SIZE) {
-    return key;
-  }
-  throw new Error('invalid secret key');
-};

package/src/libs/suiContractFactory/index.ts

@@ -1,120 +0,0 @@
-import { SuiMoveNormalizedModules} from '@mysten/sui.js';
-import type { ContractFactoryParams, SuiMoveMoudleValueType } from './types';
-export type ApiTypes = 'promise' | 'rxjs';
-
-// export interface ContractQuery {
-//   (origin: AccountId | string | Uint8Array, options: ContractOptions, ...params: unknown[]): SuiTransactionBlockResponse<ApiType, ContractCallOutcome>;
-// }
-
-// export type MapMessageQuery<ApiType extends ApiTypes> = Record<string, ContractQuery<ApiType>>;
-
-// // function createQuery <ApiType extends ApiTypes> (meta: AbiMessage, fn: (origin: string | AccountId | Uint8Array, options: ContractOptions, params: unknown[]) => ContractCallResult<ApiType, ContractCallOutcome>): ContractQuery<ApiType> {
-// //   return withMeta(meta, (origin: string | AccountId | Uint8Array, options: ContractOptions, ...params: unknown[]): ContractCallResult<ApiType, ContractCallOutcome> =>
-// //     fn(origin, options, params)
-// //   );
-// // }
-
-// export type MapMessageTx<ApiType extends ApiTypes> = Record<string, ContractTx<ApiType>>;
-
-// export interface ContractOptions {
-//   gasLimit?: bigint | string | number | BN | WeightV2;
-//   storageDepositLimit?: bigint | string | number | BN | null;
-//   value?: bigint | BN | string | number;
-// }
-
-// export interface ContractTx {
-//   (options: ContractOptions, ...params: unknown[]): SubmittableExtrinsic<ApiType>;
-// }
-export class SuiContractFactory {
-  public packageId: string;
-  public metadata: SuiMoveNormalizedModules | undefined;
-  // readonly #query: MapMessageQuery<ApiTypes> = {};
-  // readonly #tx: MapMessageTx<ApiTypes> = {};
-  /**
-   * Support the following ways to init the SuiToolkit:
-   * 1. mnemonics
-   * 2. secretKey (base64 or hex)
-   * If none of them is provided, will generate a random mnemonics with 24 words.
-   *
-   * @param mnemonics, 12 or 24 mnemonics words, separated by space
-   * @param secretKey, base64 or hex string, when mnemonics is provided, secretKey will be ignored
-   */
-  constructor({ packageId, metadata }: ContractFactoryParams = {}) {
-    // If the mnemonics or secretKey is provided, use it
-    // Otherwise, generate a random mnemonics with 24 words
-    this.packageId = packageId || '';
-    this.metadata = metadata || undefined;
-  }
-
-  getFuncByModuleName(moduleName: string) {
-    Object.values(this.metadata as SuiMoveNormalizedModules).forEach(
-      (value) => {
-        const data = value as SuiMoveMoudleValueType;
-        console.log(`moudle name: ${data.name}`);
-        // console.log(data.exposedFunctions)
-        Object.entries(data.exposedFunctions).forEach(([key, value]) => {
-          console.log(`\tfunc name: ${key}`);
-          Object.values(value.parameters).forEach((values) => {
-            // console.log(values)
-          });
-        });
-      }
-    );
-  }
-
-  getAllFunc() {
-    Object.values(this.metadata as SuiMoveNormalizedModules).forEach(
-      (value) => {
-        const data = value as SuiMoveMoudleValueType;
-        console.log(`moudle name: ${data.name}`);
-        // console.log(data.exposedFunctions)
-        Object.entries(data.exposedFunctions).forEach(([key, value]) => {
-          console.log(`\tfunc name: ${key}`);
-          console.log(`\t\t${value.parameters.length}`);
-          Object.values(value.parameters).forEach((values) => {
-            // console.log(values)
-            console.log(`\t\targs: ${values}`);
-          });
-        });
-      }
-    );
-  }
-
-  getAllModule() {
-    Object.values(this.metadata as SuiMoveNormalizedModules).forEach(
-      (value, index) => {
-        const data = value as SuiMoveMoudleValueType;
-        console.log(`${index}. ${data.name}`);
-      }
-    );
-  }
-
-  //   async call(arguments: ({
-  //     kind: "Input";
-  //     index: number;
-  //     type?: "object" | "pure" | undefined;
-  //     value?: any;
-  // } | {
-  //     kind: "GasCoin";
-  // } | {
-  //     kind: "Result";
-  //     index: number;
-  // } | {
-  //     kind: "NestedResult";
-  //     index: number;
-  //     resultIndex: number;
-  // })[], derivePathParams?: DerivePathParams) {
-  //     const tx = new TransactionBlock();
-  //     tx.moveCall({
-  //       target: `${this.packageId}::${}::${}`,
-  //       arguments,
-  //     })
-  //     return ;
-  //   }
-}
-
-// function createTx <ApiType extends ApiTypes> (meta: AbiMessage, fn: (options: ContractOptions, params: unknown[]) => SubmittableExtrinsic<ApiType>): ContractTx<ApiType> {
-//   return withMeta(meta, (options: ContractOptions, ...params: unknown[]): SubmittableExtrinsic<ApiType> =>
-//     fn(options, params)
-//   );
-// }

package/src/libs/suiContractFactory/types.ts

@@ -1,54 +0,0 @@
-import { SuiMoveNormalizedModules, SuiMoveNormalizedType } from "@mysten/sui.js";
-
-export type ContractFactoryParams = {
-  packageId?: string;
-  metadata?: SuiMoveNormalizedModules;
-};
-
-
-export type SuiMoveMoudleValueType =  {
-    address: string;
-    name: string;
-    fileFormatVersion: number;
-    friends: {
-        address: string;
-        name: string;
-    }[];
-    structs: Record<string, {
-        fields: {
-            type: SuiMoveNormalizedType;
-            name: string;
-        }[];
-        abilities: {
-            abilities: string[];
-        };
-        typeParameters: {
-            constraints: {
-                abilities: string[];
-            };
-            isPhantom: boolean;
-        }[];
-    }>;
-    exposedFunctions: Record<string, {
-        visibility: "Private" | "Public" | "Friend";
-        isEntry: boolean;
-        typeParameters: {
-            abilities: string[];
-        }[];
-        parameters: SuiMoveNormalizedType[];
-        return: SuiMoveNormalizedType[];
-    }>;
-}
-
-
-export type SuiMoveMoudleFuncType = {
-    moudleName: string,
-    funcName: string,
-    visibility: "Private" | "Public" | "Friend";
-    isEntry: boolean;
-    typeParameters: {
-        abilities: string[];
-    }[];
-    parameters: SuiMoveNormalizedType[];
-    return: SuiMoveNormalizedType[];
-}

package/src/libs/suiInteractor/defaultConfig.ts

@@ -1,32 +0,0 @@
-import {
-  localnetConnection,
-  devnetConnection,
-  testnetConnection,
-  mainnetConnection,
-} from '@mysten/sui.js';
-import type { Connection } from '@mysten/sui.js';
-import type { NetworkType } from '../../types';
-export const defaultGasBudget = 10 ** 8; // 0.1 SUI, should be enough for most of the transactions
-export const defaultGasPrice = 1000; // 1000 MIST
-
-/**
- * @description Get the default fullnode url and faucet url for the given network type
- * @param networkType, 'testnet' | 'mainnet' | 'devnet' | 'localnet', default is 'devnet'
- * @returns { fullNode: string, websocket: string, faucet?: string }
- */
-export const getDefaultConnection = (
-  networkType: NetworkType = 'devnet'
-): Connection => {
-  switch (networkType) {
-    case 'localnet':
-      return localnetConnection;
-    case 'devnet':
-      return devnetConnection;
-    case 'testnet':
-      return testnetConnection;
-    case 'mainnet':
-      return mainnetConnection;
-    default:
-      return devnetConnection;
-  }
-};

package/src/libs/suiInteractor/index.ts

@@ -1,2 +0,0 @@
-export { SuiInteractor } from './suiInteractor';
-export { getDefaultConnection } from './defaultConfig';