QRL Web3.js is a TypeScript implementation of QRL JSON-RPC client tooling maintained by The QRL Contributors.
This fork is being prepared for audit and first release under the @theqrl npm organization. Until that release is cut, treat main as unreleased.
Published releases will be available from npm. Local development uses pnpm.
After the first audited release:
npm install @theqrl/web3pnpm add @theqrl/web3- If you have questions submit an issue or join us on Discord.
Package names follow the repository policy in
docs/package-naming.md; @theqrl/abi is the
documented foundational ABI-coder exception to the @theqrl/web3-* runtime
package pattern.
| Package | npm | Docs | Description |
|---|---|---|---|
@theqrl/abi |
npm | API | ABI encoding and decoding helpers. |
@theqrl/web3 |
npm | API | Main QRL Web3.js package. |
@theqrl/web3-core |
npm | API | Shared core classes, request management, subscriptions, and plugin infrastructure. |
@theqrl/web3-errors |
npm | API | Shared error types. |
@theqrl/web3-net |
npm | API | Network metadata helpers for QRL JSON-RPC providers. |
@theqrl/web3-providers-http |
npm | API | HTTP provider. |
@theqrl/web3-providers-ipc |
npm | API | IPC provider. |
@theqrl/web3-providers-ws |
npm | API | WebSocket provider. |
@theqrl/web3-qrl |
npm | API | QRL blockchain and smart-contract APIs. |
@theqrl/web3-qrl-abi |
npm | API | QRVM ABI helpers. |
@theqrl/web3-qrl-accounts |
npm | API | QRL account and signing helpers. |
@theqrl/web3-qrl-contract |
npm | API | Contract wrappers and method/event helpers. |
@theqrl/web3-qrl-iban |
npm | API | QRL address and IBAN conversion helpers. |
@theqrl/web3-qrl-qrns |
npm | API | Quantum Resistant Name Service helpers. |
@theqrl/web3-rpc-methods |
npm | API | Low-level RPC method wrappers. |
@theqrl/web3-types |
npm | API | Shared TypeScript types. |
@theqrl/web3-utils |
npm | API | Utility functions for QRL applications. |
@theqrl/web3-validator |
npm | API | Runtime validation helpers. |
@theqrl/web3-packagetemplate |
npm | - | Package template for maintainers. |
@theqrl/web3-plugin-example |
npm | - | Example plugin package. |
| Script | Description |
|---|---|
| clean | Uses rimraf to remove dist/ |
| build | Uses tsc to build all packages |
| lint | Uses eslint to lint all packages |
| lint:fix | Uses eslint to check and fix any warnings |
| format | Uses prettier to format the code |
| test | Uses jest to run unit tests in each package |
| test:integration | Uses jest to run tests under /test/integration in each package |
| test:unit | Uses jest to run tests under /test/unit in each package |