quais 1.0.0-alpha.4 → 1.2.0-pre

package/README.md

@@ -28,7 +28,7 @@ in [TypeScript](https://www.typescriptlang.org).
 **Versions**
 
 -   [0.1.17](https://www.npmjs.com/package/quais/v/0.1.17): Full support for Quai Network's Iron Age Testnet.
--   [1.0.0-alpha](https://www.npmjs.com/package/quais/v/1.0.0-alpha.4): Full support for Quai Network's Golden Age Testnet.
+-   [1.0.0-alpha](https://www.npmjs.com/package/quais/v/1.0.0-alpha.5): Full support for Quai Network's Golden Age Testnet.
 
 ## Keep Updated
 

package/dist/quais.js

@@ -7,7 +7,7 @@ import * as pb_1 from 'google-protobuf';
  *
  * @ignore
  */
-const version = '1.0.0-alpha.4';
+const version = '1.0.0-alpha.5';
 
 /**
  * Property helper functions.
@@ -11571,6 +11571,15 @@ const MaxInt256 = BigInt('0x7fffffffffffffffffffffffffffffffffffffffffffffffffff
  * @category Constants
  */
 const quaisymbol = '\u039e'; // "\uD835\uDF63";
+/**
+ * A constant for the Quai Network equivalent of the [EIP-191](https://eips.ethereum.org/EIPS/eip-191) personal message
+ * prefix.
+ *
+ * (**i.e.** `"\\x19Quai Signed Message:\\n"`)
+ *
+ * @category Constants
+ */
+const MessagePrefix = '\x19Quai Signed Message:\n';
 /**
  * A constant for the [EIP-191](https://eips.ethereum.org/EIPS/eip-191) personal message prefix.
  *
@@ -11578,7 +11587,7 @@ const quaisymbol = '\u039e'; // "\uD835\uDF63";
  *
  * @category Constants
  */
-const MessagePrefix = '\x19Quai Signed Message:\n';
+const EthMessagePrefix = '\x19Ethereum Signed Message:\n';
 
 /**
  * A shard represents a chain within the Quai network hierarchy. A shard refer to the Prime chain, a region under the
@@ -14512,7 +14521,8 @@ function id(value) {
 }
 
 /**
- * Computes the [EIP-191](https://eips.ethereum.org/EIPS/eip-191) personal-sign message digest to sign.
+ * Computes the Quai Network equivalent of the [EIP-191](https://eips.ethereum.org/EIPS/eip-191) personal-sign message
+ * digest to sign.
  *
  * This prefixes the message with {@link MessagePrefix | **MessagePrefix**} and the decimal length of `message` and
  * computes the {@link keccak256 | **keccak256**} digest.
@@ -14542,7 +14552,6 @@ function id(value) {
  * ```
  *
  * @param {Uint8Array | string} message - The message to hash.
- *
  * @returns {string} The message digest.
  */
 function hashMessage(message) {
@@ -14557,13 +14566,49 @@ function hashMessage(message) {
  * @category Hash
  * @param {Uint8Array | string} message - The message that was signed.
  * @param {SignatureLike} sig - The signature to verify.
- *
  * @returns {string} The address of the signer.
  */
 function verifyMessage(message, sig) {
     const digest = hashMessage(message);
     return recoverAddress(digest, sig);
 }
+/**
+ * Computes the [EIP-191](https://eips.ethereum.org/EIPS/eip-191) personal-sign message digest to sign.
+ *
+ * This prefixes the message with {@link EthMessagePrefix | **EthMessagePrefix**} and the decimal length of `message` and
+ * computes the {@link keccak256 | **keccak256**} digest.
+ *
+ * If `message` is a string, it is converted to its UTF-8 bytes first. To compute the digest of a
+ * [**DataHexString**](../types-aliases/DataHex), it must be converted to [**bytes**](../functions/getBytes).
+ *
+ * This is the same as `hashMessage` except it uses `EthMessagePrefix` instead of `MessagePrefix` and is available for
+ * broader compatibility with EVM signing practices.
+ *
+ * @category Hash
+ * @param message
+ * @returns
+ */
+function ethHashMessage(message) {
+    if (typeof message === 'string') {
+        message = toUtf8Bytes(message);
+    }
+    return keccak256(concat([toUtf8Bytes(EthMessagePrefix), toUtf8Bytes(String(message.length)), message]));
+}
+/**
+ * Return the address of the private key that produced the signature `sig` during signing for `message`.
+ *
+ * This is the same as `verifyMessage` except it uses `EthMessagePrefix` instead of `MessagePrefix` and is available for
+ * broader compatibility with EVM signing practices.
+ *
+ * @category Hash
+ * @param message - The message that was signed.
+ * @param sig - The signature to verify.
+ * @returns {string} The address of the signer.
+ */
+function ethVerifyMessage(message, sig) {
+    const digest = ethHashMessage(message);
+    return recoverAddress(digest, sig);
+}
 
 const regexBytes = new RegExp('^bytes([0-9]+)$');
 const regexNumber = new RegExp('^(u?int)([0-9]*)$');
@@ -18726,7 +18771,7 @@ function formatTransactionResponse(value) {
             gasLimit: allowNull((value) => (value ? BigInt(value) : null), null),
             to: allowNull(getAddress, null),
             value: allowNull((value) => (value ? BigInt(value) : null), null),
-            nonce: allowNull((value) => (value ? parseInt(value, 16) : null), null),
+            nonce: allowNull((value) => (value ? parseInt(value, 10) : null), null),
             creates: allowNull(getAddress, null),
             chainId: allowNull((value) => (value ? BigInt(value) : null), null),
             data: (value) => value,
@@ -24715,6 +24760,14 @@ class AbstractHDWallet {
     coinType() {
         return this.constructor._coinType;
     }
+    /**
+     * Returns the extended public key of the root node of the HD wallet.
+     *
+     * @returns {string} The extended public key.
+     */
+    get xPub() {
+        return this._root.extendedKey;
+    }
     /**
      * Derives the next valid address node for a specified account, starting index, and zone. The method ensures the
      * derived address belongs to the correct shard and ledger, as defined by the Quai blockchain specifications.
@@ -24824,6 +24877,17 @@ class AbstractHDWallet {
         }
         return addressInfo;
     }
+    /**
+     * Returns the private key for a given address. This method should be used with caution as it exposes the private
+     * key to the user.
+     *
+     * @param {string} address - The address associated with the desired private key.
+     * @returns {string} The private key.
+     */
+    getPrivateKey(address) {
+        const hdNode = this._getHDNodeForAddress(address);
+        return hdNode.privateKey;
+    }
     /**
      * Gets the addresses for a given account.
      *
@@ -30406,6 +30470,8 @@ var quais = /*#__PURE__*/Object.freeze({
     encodeBytes32: encodeBytes32,
     encryptKeystoreJson: encryptKeystoreJson,
     encryptKeystoreJsonSync: encryptKeystoreJsonSync,
+    ethHashMessage: ethHashMessage,
+    ethVerifyMessage: ethVerifyMessage,
     formatMixedCaseChecksumAddress: formatMixedCaseChecksumAddress,
     formatQuai: formatQuai,
     formatUnits: formatUnits,
@@ -30472,5 +30538,5 @@ var quais = /*#__PURE__*/Object.freeze({
     zeroPadValue: zeroPadValue
 });
 
-export { AbiCoder, AbstractProvider, AbstractSigner, BaseContract, Block, BrowserProvider, ConstructorFragment, Contract, ContractEventPayload, ContractFactory, ContractTransactionReceipt, ContractTransactionResponse, ContractUnknownEventPayload, ErrorDescription, ErrorFragment, EventFragment, EventLog, EventPayload, FallbackFragment, FeeData, FetchCancelSignal, FetchRequest, FetchResponse, FewestCoinSelector, FixedNumber, Fragment, FunctionFragment, Indexed, Interface, JsonRpcApiProvider, JsonRpcProvider, JsonRpcSigner, LangEn, LangEs, Log, LogDescription, MaxInt256, MaxUint256, MessagePrefix, MinInt256, Mnemonic, N$1 as N, NamedFragment, Network, ParamType, QiHDWallet, QiTransaction, QuaiHDWallet, QuaiTransaction, Result, Shard, Signature, SigningKey, SocketBlockSubscriber, SocketEventSubscriber, SocketPendingSubscriber, SocketProvider, SocketSubscriber, StructFragment, TransactionDescription, TransactionReceipt, Typed, TypedDataEncoder, UndecodedEventLog, UnmanagedSubscriber, VoidSigner, Wallet, WebSocketProvider, WeiPerEther, Wordlist, WordlistOwl, WordlistOwlA, ZeroAddress, ZeroHash, Zone, accessListify, checkResultErrors, computeAddress, computeHmac, concat, copyRequest, dataLength, dataSlice, decodeBase58, decodeBase64, decodeBytes32, decryptKeystoreJson, decryptKeystoreJsonSync, encodeBase58, encodeBase64, encodeBytes32, encryptKeystoreJson, encryptKeystoreJsonSync, formatMixedCaseChecksumAddress, formatQuai, formatUnits, fromTwos, getAddress, getAddressDetails, getBigInt, getBytes, getBytesCopy, getCreate2Address, getCreateAddress, getNumber, getTxType, getUint, getZoneForAddress, hashMessage, hexlify, id, isAddress, isAddressable, isBytesLike, isCallException, isError, isHexString, isKeystoreJson, isQiAddress, isQuaiAddress, keccak256, lock, mask, musigCrypto, parseQuai, parseUnits, pbkdf2, quais, quaisymbol, randomBytes, recoverAddress, resolveAddress, ripemd160, scrypt, scryptSync, sha256, sha512, solidityPacked, solidityPackedKeccak256, solidityPackedSha256, stripZerosLeft, toBeArray, toBeHex, toBigInt, toNumber, toQuantity, toTwos, toUtf8Bytes, toUtf8CodePoints, toUtf8String, uuidV4, validateAddress, verifyMessage, verifyTypedData, version, wordlists, zeroPadBytes, zeroPadValue };
+export { AbiCoder, AbstractProvider, AbstractSigner, BaseContract, Block, BrowserProvider, ConstructorFragment, Contract, ContractEventPayload, ContractFactory, ContractTransactionReceipt, ContractTransactionResponse, ContractUnknownEventPayload, ErrorDescription, ErrorFragment, EventFragment, EventLog, EventPayload, FallbackFragment, FeeData, FetchCancelSignal, FetchRequest, FetchResponse, FewestCoinSelector, FixedNumber, Fragment, FunctionFragment, Indexed, Interface, JsonRpcApiProvider, JsonRpcProvider, JsonRpcSigner, LangEn, LangEs, Log, LogDescription, MaxInt256, MaxUint256, MessagePrefix, MinInt256, Mnemonic, N$1 as N, NamedFragment, Network, ParamType, QiHDWallet, QiTransaction, QuaiHDWallet, QuaiTransaction, Result, Shard, Signature, SigningKey, SocketBlockSubscriber, SocketEventSubscriber, SocketPendingSubscriber, SocketProvider, SocketSubscriber, StructFragment, TransactionDescription, TransactionReceipt, Typed, TypedDataEncoder, UndecodedEventLog, UnmanagedSubscriber, VoidSigner, Wallet, WebSocketProvider, WeiPerEther, Wordlist, WordlistOwl, WordlistOwlA, ZeroAddress, ZeroHash, Zone, accessListify, checkResultErrors, computeAddress, computeHmac, concat, copyRequest, dataLength, dataSlice, decodeBase58, decodeBase64, decodeBytes32, decryptKeystoreJson, decryptKeystoreJsonSync, encodeBase58, encodeBase64, encodeBytes32, encryptKeystoreJson, encryptKeystoreJsonSync, ethHashMessage, ethVerifyMessage, formatMixedCaseChecksumAddress, formatQuai, formatUnits, fromTwos, getAddress, getAddressDetails, getBigInt, getBytes, getBytesCopy, getCreate2Address, getCreateAddress, getNumber, getTxType, getUint, getZoneForAddress, hashMessage, hexlify, id, isAddress, isAddressable, isBytesLike, isCallException, isError, isHexString, isKeystoreJson, isQiAddress, isQuaiAddress, keccak256, lock, mask, musigCrypto, parseQuai, parseUnits, pbkdf2, quais, quaisymbol, randomBytes, recoverAddress, resolveAddress, ripemd160, scrypt, scryptSync, sha256, sha512, solidityPacked, solidityPackedKeccak256, solidityPackedSha256, stripZerosLeft, toBeArray, toBeHex, toBigInt, toNumber, toQuantity, toTwos, toUtf8Bytes, toUtf8CodePoints, toUtf8String, uuidV4, validateAddress, verifyMessage, verifyTypedData, version, wordlists, zeroPadBytes, zeroPadValue };
 //# sourceMappingURL=quais.js.map