0.1.17 • Published 5 months ago

quais v0.1.17

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

The Quais Project

npm (tag) Node.js CI

A complete Quai wallet implementation and utilities in JavaScript (and TypeScript). Quais is a downstream fork of Ethers v5.7.2. This fork included various Quai related features such as grinding contract addresses and receiving full Quai Network header data.

Features: IMPORTANT: These features are in beta and may not be 1:1 compatible with Quai Network as it stands.

  • Keep your private keys in your client, safe and sound
  • Import and export JSON wallets (Geth, Parity and crowdsale)
  • 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
  • QNS names are first-class citizens; they can be used anywhere an Quai addresses can be used. QNS names are in progress.
  • Tiny (~104kb compressed; 322kb uncompressed)
  • Modular packages; include only what you need
  • Complete functionality for all your Quai desires
  • Starting documentation based on Ethers
  • Fully TypeScript ready, with definition files and full TypeScript source
  • MIT License (including ALL dependencies); completely open source to do with as you please

Keep Updated

For the latest news and advisories, please follow the @quainetwork on Twitter (low-traffic, non-marketing, important information only) as well as watch this GitHub project.

For the latest changes, see the CHANGELOG.

Installing

node.js

/home/user/some-project> npm install --save quais

browser (UMD)

<script src="https://cdn.quais.io/lib/quais-1.0.4.umd.min.js" type="text/javascript">
</script>

browser (ESM)

<script type="module">
    import { quais } from "https://cdn.quais.io/lib/quais-1.0.4.esm.min.js";
</script>

Documentation

Browse the documentation online:

Ancillary Packages

These are a number of packages not included in the umbrella quais package in a similar fashion to ethers. These ethers packages are useful for cli interface and hardware wallet support. While there are not direct modifications for Quai Network in these packages yet, there may be in the future. Hence our reasoning to fork the non-standard packages that live outside of ethers as well.

License

MIT License (including all dependencies).