@aptos-labs/ts-sdk 0.0.3 → 0.0.5

package/dist/esm/core/hex.d.ts

@@ -0,0 +1,105 @@
+import { ParsingResult } from './common.js';
+import { HexInput } from '../types/index.js';
+import '../utils/apiEndpoints.js';
+import '../types/indexer.js';
+import '../types/generated/operations.js';
+import '../types/generated/types.js';
+
+/**
+ * This enum is used to explain why parsing might have failed.
+ */
+declare enum HexInvalidReason {
+    TOO_SHORT = "too_short",
+    INVALID_LENGTH = "invalid_length",
+    INVALID_HEX_CHARS = "invalid_hex_chars"
+}
+/**
+ * NOTE: Do not use this class when working with account addresses, use AccountAddress.
+ *
+ * NOTE: When accepting hex data as input to a function, prefer to accept HexInput and
+ * then use the static helper methods of this class to convert it into the desired
+ * format. This enables the greatest flexibility for the developer.
+ *
+ * Hex is a helper class for working with hex data. Hex data, when represented as a
+ * string, generally looks like this, for example: 0xaabbcc, 45cd32, etc.
+ *
+ * You might use this class like this:
+ *
+ * ```ts
+ * getTransactionByHash(txnHash: HexInput): Promise<Transaction> {
+ *   const txnHashString = Hex.fromHexInput(txnHash).toString();
+ *   return await getTransactionByHashInner(txnHashString);
+ * }
+ * ```
+ *
+ * This call to `Hex.fromHexInput().toString()` converts the HexInput to a hex string
+ * with a leading 0x prefix, regardless of what the input format was.
+ *
+ * These are some other ways to chain the functions together:
+ * - `Hex.fromString({ hexInput: "0x1f" }).toUint8Array()`
+ * - `new Hex([1, 3]).toStringWithoutPrefix()`
+ */
+declare class Hex {
+    private readonly data;
+    /**
+     * Create a new Hex instance from a Uint8Array.
+     *
+     * @param data Uint8Array
+     */
+    constructor(data: Uint8Array);
+    /**
+     * Get the inner hex data. The inner data is already a Uint8Array so no conversion
+     * is taking place here, it just returns the inner data.
+     *
+     * @returns Hex data as Uint8Array
+     */
+    toUint8Array(): Uint8Array;
+    /**
+     * Get the hex data as a string without the 0x prefix.
+     *
+     * @returns Hex string without 0x prefix
+     */
+    toStringWithoutPrefix(): string;
+    /**
+     * Get the hex data as a string with the 0x prefix.
+     *
+     * @returns Hex string with 0x prefix
+     */
+    toString(): string;
+    /**
+     * Static method to convert a hex string to Hex
+     *
+     * @param str A hex string, with or without the 0x prefix
+     *
+     * @returns Hex
+     */
+    static fromString(str: string): Hex;
+    /**
+     * Static method to convert an instance of HexInput to Hex
+     *
+     * @param hexInput A HexInput (string or Uint8Array)
+     *
+     * @returns Hex
+     */
+    static fromHexInput(hexInput: HexInput): Hex;
+    /**
+     * Check if the string is valid hex.
+     *
+     * @param str A hex string representing byte data.
+     *
+     * @returns valid = true if the string is valid, false if not. If the string is not
+     * valid, invalidReason and invalidReasonMessage will be set explaining why it is
+     * invalid.
+     */
+    static isValid(str: string): ParsingResult<HexInvalidReason>;
+    /**
+     * Return whether Hex instances are equal. Hex instances are considered equal if
+     * their underlying byte data is identical.
+     *
+     * @param other The Hex instance to compare to.
+     * @returns true if the Hex instances are equal, false if not.
+     */
+    equals(other: Hex): boolean;
+}
+
+export { Hex, HexInvalidReason };

package/dist/esm/core/hex.mjs

@@ -0,0 +1,2 @@
+import{a,b}from"../chunk-IZHPCZE3.mjs";import"../chunk-FBPNHF54.mjs";import"../chunk-XNFEUXDS.mjs";export{b as Hex,a as HexInvalidReason};
+//# sourceMappingURL=hex.mjs.map

package/dist/esm/core/hex.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/core/index.d.ts

@@ -0,0 +1,21 @@
+export { Account } from './account.js';
+export { AccountAddress, AccountAddressInput, AddressInvalidReason } from './accountAddress.js';
+export { AuthenticationKey } from './authenticationKey.js';
+export { ParsingError, ParsingResult } from './common.js';
+export { PrivateKey, PublicKey, Signature } from './crypto/asymmetricCrypto.js';
+export { Ed25519PrivateKey, Ed25519PublicKey, Ed25519Signature } from './crypto/ed25519.js';
+export { MultiEd25519PublicKey, MultiEd25519Signature } from './crypto/multiEd25519.js';
+export { Secp256k1PrivateKey, Secp256k1PublicKey, Secp256k1Signature } from './crypto/secp256k1.js';
+export { MultiKey } from './crypto/multiKey.js';
+export { APTOS_BIP44_REGEX, APTOS_HARDENED_REGEX, CKDPriv, DerivedKeys, HARDENED_OFFSET, KeyType, deriveKey, isValidBIP44Path, isValidHardenedPath, mnemonicToSeed, splitPath } from './crypto/hdKey.js';
+export { Hex, HexInvalidReason } from './hex.js';
+import '../types/index.js';
+import '../utils/apiEndpoints.js';
+import '../types/indexer.js';
+import '../types/generated/operations.js';
+import '../types/generated/types.js';
+import '../bcs/serializer.js';
+import '../bcs/deserializer.js';
+import '../transactions/instances/transactionArgument.js';
+import './crypto/anyPublicKey.js';
+import './crypto/anySignature.js';

package/dist/esm/core/index.mjs

@@ -0,0 +1,2 @@
+import"../chunk-E7FWVXGX.mjs";import"../chunk-TCTZCPQ6.mjs";import{a as C}from"../chunk-J3QOSJFP.mjs";import{a as B}from"../chunk-ZXJ5ZBTL.mjs";import{a as v,b as w}from"../chunk-FNB6CFQR.mjs";import{a as A}from"../chunk-CZZJAR3B.mjs";import"../chunk-UVGCVCNG.mjs";import{a as s,b as t,c as u}from"../chunk-BIUGRAMO.mjs";import{a as x,b as y,c as z}from"../chunk-YS2OX7AB.mjs";import{a as f,b as g,c as h}from"../chunk-E72CFUU4.mjs";import{a as i,b as j,c as k,d as l,e as m,f as n,g as o,h as p,i as q,j as r}from"../chunk-LR65XHSF.mjs";import{a as d,b as e}from"../chunk-HH5RSP2H.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-LU6VS7PJ.mjs";import"../chunk-V6AAQLLJ.mjs";import"../chunk-7AQXAH6Q.mjs";import"../chunk-PDLUCVJB.mjs";import"../chunk-BC2NOUYT.mjs";import"../chunk-27P7PELS.mjs";import{a as b,b as c}from"../chunk-IZHPCZE3.mjs";import{a}from"../chunk-FBPNHF54.mjs";import"../chunk-DNDWTM7A.mjs";import"../chunk-GUT3G5CG.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-XNFEUXDS.mjs";export{j as APTOS_BIP44_REGEX,i as APTOS_HARDENED_REGEX,C as Account,e as AccountAddress,d as AddressInvalidReason,B as AuthenticationKey,p as CKDPriv,t as Ed25519PrivateKey,s as Ed25519PublicKey,u as Ed25519Signature,l as HARDENED_OFFSET,c as Hex,b as HexInvalidReason,k as KeyType,v as MultiEd25519PublicKey,w as MultiEd25519Signature,A as MultiKey,a as ParsingError,g as PrivateKey,f as PublicKey,y as Secp256k1PrivateKey,x as Secp256k1PublicKey,z as Secp256k1Signature,h as Signature,o as deriveKey,m as isValidBIP44Path,n as isValidHardenedPath,r as mnemonicToSeed,q as splitPath};
+//# sourceMappingURL=index.mjs.map

package/dist/esm/core/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}