Code Monkey home page Code Monkey logo

quais-5.js's Introduction

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.

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 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 or Pelagus
  • General overview of package functionality can be found in the Quai Network Javascript API docs
  • QNS functionality is under development
  • Tiny (~104kb compressed; 322kb uncompressed)
  • Modular packages; include only what you need
  • Complete functionality for all your Quai desires
  • Documentation based on: ethers-v5. Quai specific documentation is under development
  • Large collection of test cases which are maintained and added to
  • 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/ricmoo/some_project> npm install --save quais

browser (ESM)

<script type="module">
    import { quais } from "quais";
</script>

Documentation

Browse the ethers based documentation online:

Ancillary Packages

Polling Disabled in Quais: In an effort to optimize performance, polling has been disabled in the Quais project. For users who require polling functionality, the quais-polling npm package is available. This package acts as a shim, reintroducing polling capabilities in a manner that is easy to integrate for those who need it. You can find more information and installation instructions for quais-polling in the package repository

License

MIT License (including all dependencies).

quais-5.js's People

Contributors

alanorwick avatar robschleusner avatar denisivanov26 avatar mechanikalk avatar jdowning100 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.