quais 0.3.0-pre.3 → 1.0.0-alpha

package/.env.dist

@@ -0,0 +1,6 @@
+#This is only for running tests
+
+CHAIN_ID=
+FAUCET_PRIVATEKEY=
+RPC_URL=
+

package/.eslintrc.js

@@ -0,0 +1,11 @@
+module.exports = {
+    parser: '@typescript-eslint/parser',
+    plugins: ['@typescript-eslint'],
+    extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'],
+    parserOptions: {
+        project: './tsconfig.base.json',
+    },
+    rules: {
+        '@typescript-eslint/no-explicit-any': 'off',
+    },
+};

package/.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

package/.prettierignore

@@ -0,0 +1,16 @@
+# node modules
+node_modules/
+
+# tests
+testcases/
+
+# pre-commit
+.husky/
+
+# output dirs
+dist/
+output/
+misc/
+
+# js
+lib/commonjs/

package/.prettierrc

@@ -0,0 +1,13 @@
+{
+    "printWidth": 120,
+    "useTabs": false,
+    "tabWidth": 4,
+    "singleQuote": true,
+    "plugins": ["prettier-plugin-jsdoc"],
+
+    "jsdocCommentLineStrategy": "multiline",
+    "jsdocSeparateReturnsFromParam": true,
+    "jsdocPreferCodeFences": true,
+    "tsdoc": true,
+    "jsdocPrintWidth": 120
+}

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016-2023 Richard Moore
+Copyright (c) 2016-2023 Dominant Strategies
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,54 +1,49 @@
-# The Quais Project
+# Quais Javascript SDK
 
 [![npm (tag)](https://img.shields.io/npm/v/quais)](https://www.npmjs.com/package/quais)
-[![Node.js CI](https://github.com/dominant-strategies/quais.js/actions/workflows/nodejs.yml/badge.svg)](https://github.com/dominant-strategies/quais.js/actions/workflows/nodejs.yml)
+![npm bundle size (version)](https://img.shields.io/bundlephobia/minzip/quais)
+![npm (downloads)](https://img.shields.io/npm/dm/quais)
 
 ---
 
-A complete Quai wallet implementation and utilities in JavaScript (and TypeScript). Quais is a downstream fork of Ethers v6.3.0. We appreciate all work that has gone into support for Ethers and we encourage the community to donate to the original Ethers authors to support open source technology.
+**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 **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 Ethereum nodes over [JSON-RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC), [INFURA](https://infura.io), [Etherscan](https://etherscan.io), [Alchemy](https://alchemyapi.io), [Ankr](https://ankr.com) or [MetaMask](https://metamask.io)
-- **ENS names** are first-class citizens; they can be used anywhere an Ethereum addresses can be used
-- **Tiny** (~120kb compressed; 400kb uncompressed)
-- **Tree-shaking** focused; include only what you need during bundling
-- **Complete** functionality for all your Ethereum desires
-- Extensive [documentation](https://docs.ethers.org/v6/)
-- Large collection of **test cases** which are maintained and added to
-- Fully written in **TypeScript**, with strict types for security
-- **MIT License** (including ALL dependencies); completely open source to do with as you please
+-   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
 
-## Keep Updated
+**Versions**
 
-For the latest news and advisories, please follow the
-[@quainetwork](https://twitter.com/quainetwork) on Twitter (low-traffic,
-non-marketing, important information only) as well as watch this GitHub project.
+-   [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): Full support for Quai Network's Golden Age Testnet.
 
-For the latest changes, see the
-[CHANGELOG](https://github.com/dominant-strategies/quais.js/blob/master/CHANGELOG.md).
+## Keep Updated
 
-**Summaries**
+For advisories and important notices, follow [@quainetwork](https://twitter.com/quainetwork)
+on Twitter as well as watch this GitHub project.
 
-- [September 2022](https://blog.ricmoo.com/highlights-ethers-js-september-2022-d7bda0fc37ed)
-- [June 2022](https://blog.ricmoo.com/highlights-ethers-js-june-2022-f5328932e35d)
-- [March 2022](https://blog.ricmoo.com/highlights-ethers-js-march-2022-f511fe1e88a1)
-- [December 2021](https://blog.ricmoo.com/highlights-ethers-js-december-2021-dc1adb779d1a)
-- [September 2021](https://blog.ricmoo.com/highlights-ethers-js-september-2021-1bf7cb47d348)
-- [May 2021](https://blog.ricmoo.com/highlights-ethers-js-may-2021-2826e858277d)
-- [March 2021](https://blog.ricmoo.com/highlights-ethers-js-march-2021-173d3a545b8d)
-- [December 2020](https://blog.ricmoo.com/highlights-ethers-js-december-2020-2e2db8bc800a)
+For more general news, discussions, and feedback, join the
+[Quai Developer Discord](https://discord.gg/s8y8asPwNC).
 
 ## Installing
 
 **NodeJS**
 
 ```
-/home/ricmoo/some_project> npm install quais
+/home/some_project> npm install quais
 ```
 
 **Browser (ESM)**
@@ -61,27 +56,82 @@ The bundled library is available in the `./dist/` folder in this repo.
 </script>
 ```
 
-## Documentation
+### 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
+    git clone https://github.com/dominant-strategies/quais.js.git
+    cd quais.js
+    ```
+
+2. Install dependencies.
+
+    ```bash
+    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
+    npm run update-symlink
+    ```
 
-Browse the [documentation](https://docs.ethers.org) online:
+    _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
+    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
+    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
+    npm unlink quais
+    ```
+
+2. Reinstall quais: Install the quais package from npm to use the published version.
+    ```bash
+    npm install quais
+    ```
+
+## Documentation
 
-- [Getting Started](https://docs.ethers.org/v6/getting-started/)
-- [Full API Documentation](https://docs.ethers.org/v6/api/)
-- [Various Ethereum Articles](https://blog.ricmoo.com/)
+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:
 
-## Ancillary Packages
+-   [Quais Javascript SDK Documentation](https://dominantstrategies.mintlify.app/static)
+-   [Quai Network JSON RPC Docs](https://qu.ai/docs/develop/apis/json-rpc-api/)
 
-These are a number of packages not included in the umbrella `quais` npm package, and
-additional packages are always being added. Often these packages are for specific
-use-cases, so rather than adding them to the umbrella package, they are added as
-ancillary packages, which can be included by those who need them, while not bloating
-everyone else with packages they do not need.
+## Extension Packages
 
-We will keep a list of useful packages here.
+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.
 
-- `@quais/experimental` ([documentation](https://docs.ethers.io/v5/api/experimental/))
-- `@quais/cli` ([documentation](https://docs.ethers.io/v5/cli/))
-- `@quais/hardware-wallets` ([documentation](https://docs.ethers.io/v5/api/other/hardware/))
+-   [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
 

package/dist/README.md

@@ -0,0 +1,19 @@
+# Distribution Folder
+
+The contents of this folder are for using `import` in ESM
+browser-base projects.
+
+The `quais.js` (and `quais.min.js`) files only include the
+English wordlist to conserve space.
+
+For additional Wordlist support, the `wordlist-extra.js` (and
+`wordlist-extra.min.js`) should be imported too.
+
+## Notes
+
+The contents are generated via the `npm build dist` target using
+`rollup` and the `/rollup.config.js` configuration.
+
+Do not modify the files in this folder. They are deleted on `build-clean`.
+
+To modify this `README.md`, see the `/output/post-build/dist`.