8000 GitHub - theQRL/web3.js · GitHub
[go: up one dir, main page]

Skip to content
theQRLPublic

About

No description, website, or topics provided.

Resources

Security policy

Stars

1 star

Watchers

1 watching

Forks

Latest commit

 

History

342 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

web3.js

QRL Web3.js

CI Actionlint npm downloads Commit Activity Contributors

ES Version Node Version

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.

Installation

Published releases will be available from npm. Local development uses pnpm.

After the first audited release:

npm install @theqrl/web3
pnpm add @theqrl/web3

Getting Started

Prerequisites

Useful links

Architecture Overview

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-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.

Package.json Scripts

Root scripts (run with pnpm run <script>):

Script Description
bootstrap pnpm install --frozen-lockfile
build / build:cjs / build:esm / build:types Turbo-driven tsc builds of every package and tool (build cleans first via prebuild)
build:web / build:web:analyze webpack browser bundles for @theqrl/web3 and @theqrl/web3-validator (:analyze adds the bundle report)
build:docs Docusaurus/TypeDoc documentation build (docs/)
clean scripts/clean.sh: removes generated output — every package's lib/, dist/ and coverage directories, *.tsbuildinfo, the root tmp/, .coverage/, .nyc_output/ and the docs build output (docs/build, docs/.docusaurus, generated API docs); never node_modules and never the developer-owned .secrets.json
doctor Toolchain, lockfile, override/allowBuilds inventory, .trivyignore and package-dependency checks (scripts/doctor.js)
check:dependencies Declared-vs-imported dependency cross-check of every package (scripts/check-package-dependencies.js)
hygiene Repository hygiene checks (scripts/check-repo-hygiene.js), also the pre-commit hook
lint / lint:fix / lint:budget ESLint across packages and tools; lint:budget enforces the per-package warning budget
format Prettier across packages, tools and scripts
test / test:unit Jest unit suites of every package plus the script tests under scripts/test
test:integration / test:coverage:unit / test:coverage:integration Integration suites (need a node) and coverage variants
test:e2e:gqrl:http / test:e2e:gqrl:ws / test:e2e:testnet:* / test:e2e:mainnet:* / test:e2e:coverage scripts/test-runner.sh wrappers for a local gqrl node or the public networks
pos:start / pos:stop Start and stop the local test network (scripts/local_testnet)
compile:contracts Compiles the Hyperion test fixtures with the pinned @theqrl/hypc
audit:supply-chain Pinned Trivy scan of pnpm-lock.yaml (HIGH/CRITICAL, production and development dependencies)
release:* Release helpers (packages, inspect-packages, pack-packages, smoke-tarballs, published-versions, publish-tarballs, touch-packages, dry-run); see RELEASE.md
changelog Changelog tooling under scripts/changelog
husky:install / husky:uninstall Install the git hooks (.husky/pre-commit runs hygiene, .husky/pre-push runs lint) or detach them again; husky 9 has no uninstall command, so husky:uninstall runs git config --unset core.hooksPath

About

No description, website, or topics provided.

Resources

Security policy

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

0