> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qu.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# quais

# Quais Javascript SDK

[![npm (tag)](https://img.shields.io/npm/v/quais)](https://www.npmjs.com/package/quais)
![npm bundle size (version)](https://img.shields.io/bundlephobia/minzip/quais)
![npm (downloads)](https://img.shields.io/npm/dm/quais)

***

**This library is still under development and not ready for production use.**

A complete, compact and simple library for Quai and Qi, written
in [TypeScript](https://www.typescriptlang.org).

**Features**

* Keep your private keys in your client, **safe** and sound
* Import and export BIP 39 **mnemonic phrases** (12 word backup phrases) and **HD Wallets** (English as well as Czech, French, Italian, Japanese, Korean, Simplified Chinese, Spanish, Traditional Chinese)
* Meta-classes create JavaScript objects from any contract ABI, including **ABIv2** and **Human-Readable ABI**
* Connect to Quai nodes over [JSON-RPC](https://qu.ai/docs/develop/apis/json-rpc-api/), [quaiscan](https://quaiscan.io), or [Pelagus](https://pelaguswallet.io)
* **Small** (\~136kb compressed; 460kb uncompressed)
* **Tree-shaking** focused; include only what you need during bundling
* **Complete** functionality for all your Quai desires
* Extensive documentation **coming soon**
* Large collection of **test cases** which are maintained and added to
* Fully written in **TypeScript**, with strict types for security and safety
* **MIT License** (including ALL dependencies); completely open source to do with as you please

**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.5): Full support for Quai Network's Golden Age Testnet.

## Keep Updated

For advisories and important notices, follow [@quainetwork](https://twitter.com/quainetwork)
on Twitter as well as watch this GitHub project.

For more general news, discussions, and feedback, join the
[Quai Developer Discord](https://discord.gg/s8y8asPwNC).

## Installing

**NodeJS**

```
/home/some_project> npm install quais
```

**Browser (ESM)**

The bundled library is available in the `./dist/` folder in this repo.

```
<script type="module">
    import { quais } from "./dist/quais.min.js";
</script>
```

### Using Local Version as Dependency in Other Projects

For developers looking to contribute to quais or integrate it into their projects with local modifications, setting up a local development environment is essential. This section guides you through the process of building quais and linking it to another project on your machine using npm link.

**Prepare quais for Symbolic Linking**

1. Clone the quais repository and navigate into it.

   ```bash theme={null}
   git clone https://github.com/dominant-strategies/quais.js.git
   cd quais.js
   ```

2. Install dependencies.

   ```bash theme={null}
   npm install
   ```

3. Create a global symbolic link for quais. This makes the quais package available to link in any other project. Whenever a local change is made to quais that you want to test in another project, you must run this command again to update the symbolic link.

   ```bash theme={null}
   npm run update-symlink
   ```

   *Caution - The `update-symlink` command updates the globally available symbolic link to the build of the current branch you are on when the command is run. This can potentially lead to incompatible version usage if quais is linked to multiple projects locally.*

**Linking quais to Another Project**

After setting up quais for local development, you can link it to another project to test changes or develop features that depend on quais.

1. Navigate to your project.
   ```bash theme={null}
   cd path/to/your/project
   ```
2. Link the globally linked quais package to your project. This replaces the npm-installed quais package with the symlinked version.
   ```bash theme={null}
   npm link quais
   ```
3. Build your project: Depending on your project's setup, you may need to rebuild it to ensure that the linked quais library is correctly integrated.
   npm run build

**Testing Changes**

With quais linked to your project, any changes made to the quais library can be immediately tested within the context of your project. Remember to rebuild quais (`npm run update-symlink`) after making changes to ensure they are reflected in your project.

**Reverting to the Published Package**

If you need to revert back to the official quais package published on npm, you can unlink quais and reinstall the package.

1. Unlink quais by removing the symlink.

   ```bash theme={null}
   npm unlink quais
   ```

2. Reinstall quais: Install the quais package from npm to use the published version.
   ```bash theme={null}
   npm install quais
   ```

## Documentation

Documentation for the Quais SDK is under heavy development and will be updated often soon. In the meantime, please refer to the reference material below:

* [Quais Javascript SDK Documentation](https://dominantstrategies.mintlify.app/static)
* [Quai Network JSON RPC Docs](https://qu.ai/docs/develop/apis/json-rpc-api/)

## Extension Packages

The `quais` package only includes the most common and most core
functionality to interact with Quai Network. There are many other
packages designed to further enhance the functionality and experience.

* [QuaisPolling](https://npmjs.com/package/quais-polling) - A package to poll Quai Network for events and logs
* [MulticallProvider](https://github.com/ethers-io/ext-provider-multicall) - A Provider which bundles multiple call requests into a single `call` to reduce latency and backend request capacity

## License

MIT License (including **all** dependencies).

## API Index

### Address

* [Addressable](/sdk/content/interfaces/Addressable)
* [AddressLike](/sdk/content/type-aliases/AddressLike)
* [computeAddress](/sdk/content/functions/computeAddress)
* [getAddress](/sdk/content/functions/getAddress)
* [getCreate2Address](/sdk/content/functions/getCreate2Address)
* [getCreateAddress](/sdk/content/functions/getCreateAddress)
* [isAddress](/sdk/content/functions/isAddress)
* [isAddressable](/sdk/content/functions/isAddressable)
* [isQiAddress](/sdk/content/functions/isQiAddress)
* [isQuaiAddress](/sdk/content/functions/isQuaiAddress)
* [recoverAddress](/sdk/content/functions/recoverAddress)
* [resolveAddress](/sdk/content/functions/resolveAddress)
* [validateAddress](/sdk/content/functions/validateAddress)

### Application Binary Interface

* [AbiCoder](/sdk/content/classes/AbiCoder)
* [ConstructorFragment](/sdk/content/classes/ConstructorFragment)
* [ErrorDescription](/sdk/content/classes/ErrorDescription)
* [ErrorFragment](/sdk/content/classes/ErrorFragment)
* [EventFragment](/sdk/content/classes/EventFragment)
* [FallbackFragment](/sdk/content/classes/FallbackFragment)
* [Fragment](/sdk/content/classes/Fragment)
* [FunctionFragment](/sdk/content/classes/FunctionFragment)
* [Indexed](/sdk/content/classes/Indexed)
* [Interface](/sdk/content/classes/Interface)
* [LogDescription](/sdk/content/classes/LogDescription)
* [NamedFragment](/sdk/content/classes/NamedFragment)
* [ParamType](/sdk/content/classes/ParamType)
* [Result](/sdk/content/classes/Result)
* [StructFragment](/sdk/content/classes/StructFragment)
* [TransactionDescription](/sdk/content/classes/TransactionDescription)
* [Typed](/sdk/content/classes/Typed)
* [JsonFragment](/sdk/content/interfaces/JsonFragment)
* [JsonFragmentType](/sdk/content/interfaces/JsonFragmentType)
* [FormatType](/sdk/content/type-aliases/FormatType)
* [FragmentType](/sdk/content/type-aliases/FragmentType)
* [InterfaceAbi](/sdk/content/type-aliases/InterfaceAbi)
* [ParamTypeWalkAsyncFunc](/sdk/content/type-aliases/ParamTypeWalkAsyncFunc)
* [ParamTypeWalkFunc](/sdk/content/type-aliases/ParamTypeWalkFunc)
* [checkResultErrors](/sdk/content/functions/checkResultErrors)

### Constants

* [Shard](/sdk/content/enumerations/Shard)
* [Zone](/sdk/content/enumerations/Zone)
* [AllowedCoinType](/sdk/content/type-aliases/AllowedCoinType)
* [MaxInt256](/sdk/content/variables/MaxInt256)
* [MaxUint256](/sdk/content/variables/MaxUint256)
* [MessagePrefix](/sdk/content/variables/MessagePrefix)
* [MinInt256](/sdk/content/variables/MinInt256)
* [N](/sdk/content/variables/N)
* [WeiPerEther](/sdk/content/variables/WeiPerEther)
* [ZeroAddress](/sdk/content/variables/ZeroAddress)
* [ZeroHash](/sdk/content/variables/ZeroHash)
* [quaisymbol](/sdk/content/variables/quaisymbol)

### Contract

* [BaseContract](/sdk/content/classes/BaseContract)
* [Contract](/sdk/content/classes/Contract)
* [ContractEventPayload](/sdk/content/classes/ContractEventPayload)
* [ContractFactory](/sdk/content/classes/ContractFactory)
* [ContractTransactionReceipt](/sdk/content/classes/ContractTransactionReceipt)
* [ContractTransactionResponse](/sdk/content/classes/ContractTransactionResponse)
* [ContractUnknownEventPayload](/sdk/content/classes/ContractUnknownEventPayload)
* [EventLog](/sdk/content/classes/EventLog)
* [UndecodedEventLog](/sdk/content/classes/UndecodedEventLog)
* [BaseContractMethod](/sdk/content/interfaces/BaseContractMethod)
* [ConstantContractMethod](/sdk/content/interfaces/ConstantContractMethod)
* [ContractDeployTransaction](/sdk/content/interfaces/ContractDeployTransaction)
* [ContractEvent](/sdk/content/interfaces/ContractEvent)
* [ContractInterface](/sdk/content/interfaces/ContractInterface)
* [ContractMethod](/sdk/content/interfaces/ContractMethod)
* [ContractRunner](/sdk/content/interfaces/ContractRunner)
* [ContractTransaction](/sdk/content/interfaces/ContractTransaction)
* [DeferredTopicFilter](/sdk/content/interfaces/DeferredTopicFilter)
* [Overrides](/sdk/content/interfaces/Overrides)
* [WrappedFallback](/sdk/content/interfaces/WrappedFallback)
* [ContractEventName](/sdk/content/type-aliases/ContractEventName)

### Crypto

* [Signature](/sdk/content/classes/Signature)
* [SigningKey](/sdk/content/classes/SigningKey)
* [ProgressCallback](/sdk/content/type-aliases/ProgressCallback)
* [SignatureLike](/sdk/content/type-aliases/SignatureLike)
* [computeHmac](/sdk/content/functions/computeHmac)
* [keccak256](/sdk/content/functions/keccak256)
* [lock](/sdk/content/functions/lock)
* [pbkdf2](/sdk/content/functions/pbkdf2)
* [randomBytes](/sdk/content/functions/randomBytes)
* [ripemd160](/sdk/content/functions/ripemd160)
* [scrypt](/sdk/content/functions/scrypt)
* [scryptSync](/sdk/content/functions/scryptSync)
* [sha256](/sdk/content/functions/sha256)
* [sha512](/sdk/content/functions/sha512)

### Encoding

* [UnicodeNormalizationForm](/sdk/content/type-aliases/UnicodeNormalizationForm)
* [Utf8ErrorFunc](/sdk/content/type-aliases/Utf8ErrorFunc)
* [Utf8ErrorReason](/sdk/content/type-aliases/Utf8ErrorReason)
* [decodeBase58](/sdk/content/functions/decodeBase58)
* [decodeBase64](/sdk/content/functions/decodeBase64)
* [decodeBytes32](/sdk/content/functions/decodeBytes32)
* [encodeBase58](/sdk/content/functions/encodeBase58)
* [encodeBase64](/sdk/content/functions/encodeBase64)
* [encodeBytes32](/sdk/content/functions/encodeBytes32)
* [toUtf8Bytes](/sdk/content/functions/toUtf8Bytes)
* [toUtf8CodePoints](/sdk/content/functions/toUtf8CodePoints)
* [toUtf8String](/sdk/content/functions/toUtf8String)

### Hash

* [TypedDataEncoder](/sdk/content/classes/TypedDataEncoder)
* [TypedDataDomain](/sdk/content/interfaces/TypedDataDomain)
* [TypedDataField](/sdk/content/interfaces/TypedDataField)
* [hashMessage](/sdk/content/functions/hashMessage)
* [id](/sdk/content/functions/id)
* [solidityPacked](/sdk/content/functions/solidityPacked)
* [solidityPackedKeccak256](/sdk/content/functions/solidityPackedKeccak256)
* [solidityPackedSha256](/sdk/content/functions/solidityPackedSha256)
* [verifyMessage](/sdk/content/functions/verifyMessage)
* [verifyTypedData](/sdk/content/functions/verifyTypedData)

### Other

* [AddressStatus](/sdk/content/enumerations/AddressStatus)
* [NeuteredAddressInfo](/sdk/content/interfaces/NeuteredAddressInfo)
* [OutpointInfo](/sdk/content/interfaces/OutpointInfo)
* [QiAddressInfo](/sdk/content/interfaces/QiAddressInfo)
* [SerializedHDWallet](/sdk/content/interfaces/SerializedHDWallet)
* [SerializedQiHDWallet](/sdk/content/interfaces/SerializedQiHDWallet)
* [ErrorCode](/sdk/content/type-aliases/ErrorCode)

### Providers

* [AbstractProvider](/sdk/content/classes/AbstractProvider)
* [Block](/sdk/content/classes/Block)
* [BrowserProvider](/sdk/content/classes/BrowserProvider)
* [FeeData](/sdk/content/classes/FeeData)
* [JsonRpcApiProvider](/sdk/content/classes/JsonRpcApiProvider)
* [JsonRpcProvider](/sdk/content/classes/JsonRpcProvider)
* [JsonRpcSigner](/sdk/content/classes/JsonRpcSigner)
* [Log](/sdk/content/classes/Log)
* [Network](/sdk/content/classes/Network)
* [QiTransactionResponse](/sdk/content/classes/QiTransactionResponse)
* [QuaiTransactionResponse](/sdk/content/classes/QuaiTransactionResponse)
* [SocketBlockSubscriber](/sdk/content/classes/SocketBlockSubscriber)
* [SocketEventSubscriber](/sdk/content/classes/SocketEventSubscriber)
* [SocketPendingSubscriber](/sdk/content/classes/SocketPendingSubscriber)
* [SocketProvider](/sdk/content/classes/SocketProvider)
* [SocketSubscriber](/sdk/content/classes/SocketSubscriber)
* [TransactionReceipt](/sdk/content/classes/TransactionReceipt)
* [UnmanagedSubscriber](/sdk/content/classes/UnmanagedSubscriber)
* [WebSocketProvider](/sdk/content/classes/WebSocketProvider)
* [BlockParams](/sdk/content/interfaces/BlockParams)
* [Eip1193Provider](/sdk/content/interfaces/Eip1193Provider)
* [EventFilter](/sdk/content/interfaces/EventFilter)
* [Filter](/sdk/content/interfaces/Filter)
* [FilterByBlockHash](/sdk/content/interfaces/FilterByBlockHash)
* [LogParams](/sdk/content/interfaces/LogParams)
* [MinedBlock](/sdk/content/interfaces/MinedBlock)
* [Provider](/sdk/content/interfaces/Provider)
* [Subscriber](/sdk/content/interfaces/Subscriber)
* [TransactionReceiptParams](/sdk/content/interfaces/TransactionReceiptParams)
* [WebSocketLike](/sdk/content/interfaces/WebSocketLike)
* [BlockTag](/sdk/content/type-aliases/BlockTag)
* [DebugEventBrowserProvider](/sdk/content/type-aliases/DebugEventBrowserProvider)
* [JsonRpcApiProviderOptions](/sdk/content/type-aliases/JsonRpcApiProviderOptions)
* [JsonRpcError](/sdk/content/type-aliases/JsonRpcError)
* [JsonRpcPayload](/sdk/content/type-aliases/JsonRpcPayload)
* [JsonRpcResult](/sdk/content/type-aliases/JsonRpcResult)
* [MinedTransactionResponse](/sdk/content/type-aliases/MinedTransactionResponse)
* [Networkish](/sdk/content/type-aliases/Networkish)
* [OrphanFilter](/sdk/content/type-aliases/OrphanFilter)
* [PerformActionFilter](/sdk/content/type-aliases/PerformActionFilter)
* [PerformActionRequest](/sdk/content/type-aliases/PerformActionRequest)
* [PerformActionTransaction](/sdk/content/type-aliases/PerformActionTransaction)
* [PreparedTransactionRequest](/sdk/content/type-aliases/PreparedTransactionRequest)
* [ProviderEvent](/sdk/content/type-aliases/ProviderEvent)
* [Subscription](/sdk/content/type-aliases/Subscription)
* [TopicFilter](/sdk/content/type-aliases/TopicFilter)
* [TransactionRequest](/sdk/content/type-aliases/TransactionRequest)
* [TransactionResponse](/sdk/content/type-aliases/TransactionResponse)
* [TransactionResponseParams](/sdk/content/type-aliases/TransactionResponseParams)
* [WebSocketCreator](/sdk/content/type-aliases/WebSocketCreator)
* [copyRequest](/sdk/content/functions/copyRequest)

### Signers

* [AbstractSigner](/sdk/content/classes/AbstractSigner)
* [VoidSigner](/sdk/content/classes/VoidSigner)
* [Signer](/sdk/content/interfaces/Signer)

### Transaction

* [FewestCoinSelector](/sdk/content/classes/FewestCoinSelector)
* [QiTransaction](/sdk/content/classes/QiTransaction)
* [QuaiTransaction](/sdk/content/classes/QuaiTransaction)
* [UTXO](/sdk/content/classes/UTXO)
* [TransactionLike](/sdk/content/interfaces/TransactionLike)
* [AccessList](/sdk/content/type-aliases/AccessList)
* [AccessListEntry](/sdk/content/type-aliases/AccessListEntry)
* [AccessListish](/sdk/content/type-aliases/AccessListish)
* [denominations](/sdk/content/variables/denominations)
* [accessListify](/sdk/content/functions/accessListify)

### Utils

* [EventPayload](/sdk/content/classes/EventPayload)
* [FetchRequest](/sdk/content/classes/FetchRequest)
* [FetchResponse](/sdk/content/classes/FetchResponse)
* [FixedNumber](/sdk/content/classes/FixedNumber)
* [ActionRejectedError](/sdk/content/interfaces/ActionRejectedError)
* [BadDataError](/sdk/content/interfaces/BadDataError)
* [BufferOverrunError](/sdk/content/interfaces/BufferOverrunError)
* [CallExceptionError](/sdk/content/interfaces/CallExceptionError)
* [CancelledError](/sdk/content/interfaces/CancelledError)
* [EventEmitterable](/sdk/content/interfaces/EventEmitterable)
* [InsufficientFundsError](/sdk/content/interfaces/InsufficientFundsError)
* [InvalidArgumentError](/sdk/content/interfaces/InvalidArgumentError)
* [MissingArgumentError](/sdk/content/interfaces/MissingArgumentError)
* [NetworkError](/sdk/content/interfaces/NetworkError)
* [NonceExpiredError](/sdk/content/interfaces/NonceExpiredError)
* [NotImplementedError](/sdk/content/interfaces/NotImplementedError)
* [NumericFaultError](/sdk/content/interfaces/NumericFaultError)
* [ReplacementUnderpricedError](/sdk/content/interfaces/ReplacementUnderpricedError)
* [ServerError](/sdk/content/interfaces/ServerError)
* [TimeoutError](/sdk/content/interfaces/TimeoutError)
* [TransactionReplacedError](/sdk/content/interfaces/TransactionReplacedError)
* [UnexpectedArgumentError](/sdk/content/interfaces/UnexpectedArgumentError)
* [UnknownError](/sdk/content/interfaces/UnknownError)
* [UnsupportedOperationError](/sdk/content/interfaces/UnsupportedOperationError)
* [quaisError](/sdk/content/interfaces/quaisError)
* [BigNumberish](/sdk/content/type-aliases/BigNumberish)
* [BytesLike](/sdk/content/type-aliases/BytesLike)
* [CallExceptionAction](/sdk/content/type-aliases/CallExceptionAction)
* [CallExceptionTransaction](/sdk/content/type-aliases/CallExceptionTransaction)
* [CodedquaisError](/sdk/content/type-aliases/CodedquaisError)
* [FetchGatewayFunc](/sdk/content/type-aliases/FetchGatewayFunc)
* [FetchGetUrlFunc](/sdk/content/type-aliases/FetchGetUrlFunc)
* [FetchPreflightFunc](/sdk/content/type-aliases/FetchPreflightFunc)
* [FetchProcessFunc](/sdk/content/type-aliases/FetchProcessFunc)
* [FetchRetryFunc](/sdk/content/type-aliases/FetchRetryFunc)
* [FixedFormat](/sdk/content/type-aliases/FixedFormat)
* [GetUrlResponse](/sdk/content/type-aliases/GetUrlResponse)
* [Listener](/sdk/content/type-aliases/Listener)
* [Numeric](/sdk/content/type-aliases/Numeric)
* [concat](/sdk/content/functions/concat)
* [dataLength](/sdk/content/functions/dataLength)
* [dataSlice](/sdk/content/functions/dataSlice)
* [formatQi](/sdk/content/functions/formatQi)
* [formatQuai](/sdk/content/functions/formatQuai)
* [formatUnits](/sdk/content/functions/formatUnits)
* [fromTwos](/sdk/content/functions/fromTwos)
* [getAddressDetails](/sdk/content/functions/getAddressDetails)
* [getBigInt](/sdk/content/functions/getBigInt)
* [getBytes](/sdk/content/functions/getBytes)
* [getBytesCopy](/sdk/content/functions/getBytesCopy)
* [getNumber](/sdk/content/functions/getNumber)
* [getTxType](/sdk/content/functions/getTxType)
* [getUint](/sdk/content/functions/getUint)
* [getZoneForAddress](/sdk/content/functions/getZoneForAddress)
* [hexlify](/sdk/content/functions/hexlify)
* [isBytesLike](/sdk/content/functions/isBytesLike)
* [isCallException](/sdk/content/functions/isCallException)
* [isError](/sdk/content/functions/isError)
* [isHexString](/sdk/content/functions/isHexString)
* [makeError](/sdk/content/functions/makeError)
* [mask](/sdk/content/functions/mask)
* [parseQi](/sdk/content/functions/parseQi)
* [parseQuai](/sdk/content/functions/parseQuai)
* [parseUnits](/sdk/content/functions/parseUnits)
* [stripZerosLeft](/sdk/content/functions/stripZerosLeft)
* [toBeArray](/sdk/content/functions/toBeArray)
* [toBeHex](/sdk/content/functions/toBeHex)
* [toBigInt](/sdk/content/functions/toBigInt)
* [toNumber](/sdk/content/functions/toNumber)
* [toQuantity](/sdk/content/functions/toQuantity)
* [toTwos](/sdk/content/functions/toTwos)
* [uuidV4](/sdk/content/functions/uuidV4)
* [zeroPadBytes](/sdk/content/functions/zeroPadBytes)
* [zeroPadValue](/sdk/content/functions/zeroPadValue)

### Wallet

* [Mnemonic](/sdk/content/classes/Mnemonic)
* [QiHDWallet](/sdk/content/classes/QiHDWallet)
* [QuaiHDWallet](/sdk/content/classes/QuaiHDWallet)
* [Wallet](/sdk/content/classes/Wallet)
* [EncryptOptions](/sdk/content/type-aliases/EncryptOptions)
* [KeystoreAccount](/sdk/content/type-aliases/KeystoreAccount)
* [decryptKeystoreJson](/sdk/content/functions/decryptKeystoreJson)
* [decryptKeystoreJsonSync](/sdk/content/functions/decryptKeystoreJsonSync)
* [encryptKeystoreJson](/sdk/content/functions/encryptKeystoreJson)
* [encryptKeystoreJsonSync](/sdk/content/functions/encryptKeystoreJsonSync)
* [isKeystoreJson](/sdk/content/functions/isKeystoreJson)

### Wordlists

* [LangEn](/sdk/content/classes/LangEn)
* [LangEs](/sdk/content/classes/LangEs)
* [Wordlist](/sdk/content/classes/Wordlist)
* [WordlistOwl](/sdk/content/classes/WordlistOwl)
* [WordlistOwlA](/sdk/content/classes/WordlistOwlA)
* [wordlists](/sdk/content/variables/wordlists)