@scallop-io/sui-kit 2.0.1 → 2.2.0

package/src/libs/suiAccountManager/index.ts

@@ -1,93 +1,93 @@
-import { Ed25519Keypair } from '@mysten/sui/keypairs/ed25519';
-import { getKeyPair } from './keypair.js';
-import { hexOrBase64ToUint8Array, normalizePrivateKey } from './util.js';
-import { generateMnemonic } from './crypto.js';
-import type {
-  AccountManagerParams,
-  DerivePathParams,
-} from '../../types/index.js';
 import {
-  SUI_PRIVATE_KEY_PREFIX,
-  decodeSuiPrivateKey,
-} from '@mysten/sui/cryptography';
+	decodeSuiPrivateKey,
+	SUI_PRIVATE_KEY_PREFIX,
+} from "@mysten/sui/cryptography";
+import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519";
+import type {
+	AccountManagerParams,
+	DerivePathParams,
+} from "../../types/index.js";
+import { generateMnemonic } from "./crypto.js";
+import { getKeyPair } from "./keypair.js";
+import { hexOrBase64ToUint8Array, normalizePrivateKey } from "./util.js";
 
 export class SuiAccountManager {
-  private mnemonics: string;
-  private secretKey: string;
-  public currentKeyPair: Ed25519Keypair;
-  public currentAddress: string;
+	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 or Bech32 string, when mnemonics is provided, secretKey will be ignored
-   */
-  constructor({ mnemonics, secretKey }: AccountManagerParams = {}) {
-    // 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);
-    }
+	/**
+	 * 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 or Bech32 string, when mnemonics is provided, secretKey will be ignored
+	 */
+	constructor({ mnemonics, secretKey }: AccountManagerParams = {}) {
+		// 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
-      ? this.parseSecretKey(this.secretKey)
-      : getKeyPair(this.mnemonics);
-    this.currentAddress = this.currentKeyPair.getPublicKey().toSuiAddress();
-  }
+		// Init the current account
+		this.currentKeyPair = this.secretKey
+			? this.parseSecretKey(this.secretKey)
+			: getKeyPair(this.mnemonics);
+		this.currentAddress = this.currentKeyPair.getPublicKey().toSuiAddress();
+	}
 
-  /**
-   * Check if the secretKey starts with bench32 format
-   */
-  parseSecretKey(secretKey: string) {
-    if (secretKey.startsWith(SUI_PRIVATE_KEY_PREFIX)) {
-      const { secretKey: uint8ArraySecretKey } = decodeSuiPrivateKey(secretKey);
-      return Ed25519Keypair.fromSecretKey(
-        normalizePrivateKey(uint8ArraySecretKey)
-      );
-    }
+	/**
+	 * Check if the secretKey starts with bench32 format
+	 */
+	parseSecretKey(secretKey: string) {
+		if (secretKey.startsWith(SUI_PRIVATE_KEY_PREFIX)) {
+			const { secretKey: uint8ArraySecretKey } = decodeSuiPrivateKey(secretKey);
+			return Ed25519Keypair.fromSecretKey(
+				normalizePrivateKey(uint8ArraySecretKey),
+			);
+		}
 
-    return Ed25519Keypair.fromSecretKey(
-      normalizePrivateKey(hexOrBase64ToUint8Array(secretKey))
-    );
-  }
+		return Ed25519Keypair.fromSecretKey(
+			normalizePrivateKey(hexOrBase64ToUint8Array(secretKey)),
+		);
+	}
 
-  /**
-   * 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 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();
-  }
+	/**
+	 * 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();
-    }
-  }
+	/**
+	 * 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,19 +1,19 @@
-import { Ed25519Keypair } from '@mysten/sui/keypairs/ed25519';
-import type { DerivePathParams } from '../../types/index.js';
+import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519";
+import type { DerivePathParams } from "../../types/index.js";
 
 /**
  * @description Get ed25519 derive path for SUI
  * @param derivePathParams
  */
 export const getDerivePathForSUI = (
-  derivePathParams: DerivePathParams = {}
+	derivePathParams: DerivePathParams = {},
 ) => {
-  const {
-    accountIndex = 0,
-    isExternal = false,
-    addressIndex = 0,
-  } = derivePathParams;
-  return `m/44'/784'/${accountIndex}'/${isExternal ? 1 : 0}'/${addressIndex}'`;
+	const {
+		accountIndex = 0,
+		isExternal = false,
+		addressIndex = 0,
+	} = derivePathParams;
+	return `m/44'/784'/${accountIndex}'/${isExternal ? 1 : 0}'/${addressIndex}'`;
 };
 
 /**
@@ -30,9 +30,9 @@ export const getDerivePathForSUI = (
  * @param derivePathParams
  */
 export const getKeyPair = (
-  mnemonics: string,
-  derivePathParams: DerivePathParams = {}
+	mnemonics: string,
+	derivePathParams: DerivePathParams = {},
 ) => {
-  const derivePath = getDerivePathForSUI(derivePathParams);
-  return Ed25519Keypair.deriveKeypair(mnemonics, derivePath);
+	const derivePath = getDerivePathForSUI(derivePathParams);
+	return Ed25519Keypair.deriveKeypair(mnemonics, derivePath);
 };

package/src/libs/suiAccountManager/util.ts

@@ -1,11 +1,11 @@
-import { fromBase64, fromHex } from '@mysten/bcs';
+import { fromBase64, fromHex } from "@mysten/bcs";
 
 /**
  * @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);
+	/^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, +, /, =).
@@ -19,13 +19,13 @@ export const isBase64 = (str: string) => /^[a-zA-Z0-9+/]+={0,2}$/g.test(str);
  * @description Convert a hex or base64 string to Uint8Array
  */
 export const hexOrBase64ToUint8Array = (str: string): Uint8Array => {
-  if (isHex(str)) {
-    return fromHex(str);
-  }
-  if (isBase64(str)) {
-    return fromBase64(str);
-  }
-  throw new Error('The string is not a valid hex or base64 string.');
+	if (isHex(str)) {
+		return fromHex(str);
+	}
+	if (isBase64(str)) {
+		return fromBase64(str);
+	}
+	throw new Error("The string is not a valid hex or base64 string.");
 };
 
 const PRIVATE_KEY_SIZE = 32;
@@ -39,19 +39,19 @@ const LEGACY_PRIVATE_KEY_SIZE = 64;
  * 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) {
-    return key.slice(0, PRIVATE_KEY_SIZE);
-  }
-  if (key.length === PRIVATE_KEY_SIZE + 1 && key[0] === 0) {
-    return key.slice(1);
-  }
-  if (key.length === PRIVATE_KEY_SIZE) {
-    return key;
-  }
-  throw new Error('invalid secret key');
+	if (key.length === LEGACY_PRIVATE_KEY_SIZE) {
+		return key.slice(0, PRIVATE_KEY_SIZE);
+	}
+	if (key.length === PRIVATE_KEY_SIZE + 1 && key[0] === 0) {
+		return key.slice(1);
+	}
+	if (key.length === PRIVATE_KEY_SIZE) {
+		return key;
+	}
+	throw new Error("invalid secret key");
 };
 
 /**
  * @deprecated Please use fromHex and fromBase64 from '@mysten/bcs' directly.
  */
-export { fromHex, fromBase64 } from '@mysten/bcs';
+export { fromBase64, fromHex } from "@mysten/bcs";

package/src/libs/suiInteractor/index.ts

@@ -1,7 +1,7 @@
 export {
-  SuiInteractor,
-  getFullnodeUrl,
-  type SuiObjectData,
-  type SuiObjectDataOptions,
-  type SimulateTransactionResponse,
-} from './suiInteractor.js';
+	getFullnodeUrl,
+	type SimulateTransactionResponse,
+	SuiInteractor,
+	type SuiObjectData,
+	type SuiObjectDataOptions,
+} from "./suiInteractor.js";