Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
![ES Version](https://img.shields.io/badge/ES-2020-yellow)
![Node Version](https://img.shields.io/badge/node-18.x-green)

Web3.js is a TypeScript implementation of the [Zond JSON RPC API](https://eth.wiki/json-rpc/API) and related tooling maintained by [The QRL Contributors](https://chainsafe.io).
Web3.js is a TypeScript implementation of the [QRL JSON RPC API](https://eth.wiki/json-rpc/API) and related tooling maintained by [The QRL Contributors](https://chainsafe.io).

## Installation

Expand Down Expand Up @@ -55,13 +55,13 @@ These links are for the Web3.js but should be useful pointers in the correct dir
| [web3](https://github.com/theqrl/web3.js/tree/main/packages/web3) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3) | :rotating_light: Entire Web3.js offering (includes all packages) |
| [web3-core](https://github.com/theqrl/web3.js/tree/main/packages/web3-core) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-core%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-core) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-core) | Core functions for web3.js packages |
| [web3-errors](https://github.com/theqrl/web3.js/tree/main/packages/web3-errors) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-errors%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-core) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-errors) | Errors Objects |
| [web3-zond](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-eth%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-eth) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-eth) | Modules to interact with the Zond blockchain and smart contracts |
| [web3-zond-abi](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-abi) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-abi%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-abi) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-abi) | Functions for encoding and decoding ZVM in/output |
| [web3-zond-accounts](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-accounts) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-accounts%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-accounts) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-accounts) | Functions for managing Zond accounts and signing |
| [web3-zond-contract](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-contract) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-contract%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-contract) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-contract) | The contract package contained in [web3-zond](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond) |
| [web3-zond-ens](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-ens) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-ens%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-ens) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-ens) | Functions for interacting with the Ethereum Name Service |
| [web3-zond-iban](https://github.com/theqrl/web3.js/tree/main/packages/web3-zond-iban) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-zond-iban%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-zond-iban) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-zond-iban) | Functionality for converting Zond addressed to IBAN addressed and vice versa |
| [web3-net](https://github.com/theqrl/web3.js/tree/main/packages/web3-net) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-net%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-net) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-net) | Functions to interact with an Zond node's network properties |
| [web3-qrl](https://github.com/theqrl/web3.js/tree/main/packages/web3-qrl) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-eth%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-eth) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-eth) | Modules to interact with the QRL blockchain and smart contracts |
| [web3-qrl-abi](https://github.com/theqrl/web3.js/tree/main/packages/web3-qrl-abi) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-qrl-abi%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-qrl-abi) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-qrl-abi) | Functions for encoding and decoding QRVM in/output |
| [web3-qrl-accounts](https://github.com/theqrl/web3.js/tree/main/packages/web3-qrl-accounts) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-qrl-accounts%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-qrl-accounts) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-qrl-accounts) | Functions for managing QRL accounts and signing |
| [web3-qrl-contract](https://github.com/theqrl/web3.js/tree/main/packages/web3-qrl-contract) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-qrl-contract%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-qrl-contract) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-qrl-contract) | The contract package contained in [web3-qrl](https://github.com/theqrl/web3.js/tree/main/packages/web3-qrl) |
| [web3-qrl-qrns](https://github.com/theqrl/web3.js/tree/main/packages/web3-qrl-qrns) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-qrl-qrns%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-qrl-qrns) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-qrl-qrns) | Functions for interacting with the Quantum Resistant Name Service |
| [web3-qrl-iban](https://github.com/theqrl/web3.js/tree/main/packages/web3-qrl-iban) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-qrl-iban%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-qrl-iban) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-qrl-iban) | Functionality for converting QRL addressed to IBAN addressed and vice versa |
| [web3-net](https://github.com/theqrl/web3.js/tree/main/packages/web3-net) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-net%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-net) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-net) | Functions to interact with a QRL node's network properties |
| [web3-providers-http](https://github.com/theqrl/web3.js/tree/main/packages/web3-providers-http) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-providers-http%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-providers-http) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-providers-http) | Web3.js provider for the HTTP protocol |
| [web3-providers-ipc](https://github.com/theqrl/web3.js/tree/main/packages/web3-providers-ipc) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-providers-ipc%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-providers-ipc) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-providers-ipc) | Web3.js provider for IPC |
| [web3-providers-ws](https://github.com/theqrl/web3.js/tree/main/packages/web3-providers-ws) | [![npm](https://img.shields.io/github/package-json/v/web3/web3.js/main?filename=packages%2Fweb3-providers-ws%2Fpackage.json)](https://www.npmjs.com/package/@theqrl/web3-providers-ws) | [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) | [![documentation](https://img.shields.io/badge/typedoc-blue)](https://docs.theqrl.org/api/web3-providers-ws) | Web3.js provider for the Websocket protocol |
Expand Down
24 changes: 12 additions & 12 deletions codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,24 +27,24 @@ component_management:
- component_id: "@theqrl/web3-errors"
paths:
- /packages/web3-errors/src/
- component_id: "@theqrl/web3-zond"
- component_id: "@theqrl/web3-qrl"
paths:
- /packages/web3-zond/src/
- component_id: "@theqrl/web3-zond-abi"
- /packages/web3-qrl/src/
- component_id: "@theqrl/web3-qrl-abi"
paths:
- /packages/web3-zond-abi/src/
- component_id: "@theqrl/web3-zond-accounts"
- /packages/web3-qrl-abi/src/
- component_id: "@theqrl/web3-qrl-accounts"
paths:
- /packages/web3-zond-accounts/src/
- component_id: "@theqrl/web3-zond-contract"
- /packages/web3-qrl-accounts/src/
- component_id: "@theqrl/web3-qrl-contract"
paths:
- /packages/web3-zond-contract/src/
- component_id: "@theqrl/web3-zond-ens"
- /packages/web3-qrl-contract/src/
- component_id: "@theqrl/web3-qrl-qrns"
paths:
- /packages/web3-zond-ens/src/
- component_id: "@theqrl/web3-zond-iban"
- /packages/web3-qrl-qrns/src/
- component_id: "@theqrl/web3-qrl-iban"
paths:
- /packages/web3-zond-iban/src/
- /packages/web3-qrl-iban/src/
- component_id: "@theqrl/web3-net"
paths:
- /packages/web3-net/src/
Expand Down
2 changes: 1 addition & 1 deletion config/tsconfig.types.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
"emitDeclarationOnly": true
},
"include": ["src/**/*", "index.d.ts"]
}
}
11 changes: 5 additions & 6 deletions docs/docs/glossary/json_interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: JSON Interface
---

The JSON interface is a `JSON` object describing the [Application Binary Interface (ABI)](https://docs.soliditylang.org/en/develop/abi-spec.html) for an Zond smart contract.
The JSON interface is a `JSON` object describing the [Application Binary Interface (ABI)](https://docs.soliditylang.org/en/develop/abi-spec.html) for a QRL smart contract.

Using this JSON interface, web3.js is able to create a JavaScript object representing the smart contract , its methods and events using the `web3.zond.Contract` object.
Using this JSON interface, web3.js is able to create a JavaScript object representing the smart contract , its methods and events using the `web3.qrl.Contract` object.

### Specification

Expand All @@ -13,7 +13,7 @@ Using this JSON interface, web3.js is able to create a JavaScript object represe
- `type`: `"function"`, `"constructor"` (can be omitted, defaulting to `"function"`; `"fallback"` also possible but not relevant in web3.js);
- `name`: the name of the function (only present for function types);
- `constant`: `true` if function is specified to not modify the blockchain state;
- `payable`: `true` if function accepts ether, defaults to false;
- `payable`: `true` if function accepts quanta , defaults to false;
- `stateMutability`: a `string` with one of the following values: `"pure"` (specified to not read blockchain state), `"view"` (same as constant above), `"non-payable"` and `"payable"` (same as payable above);
- `inputs`: an `Array of objects`, each of which contains:
-- `name`: the name of the parameter;
Expand All @@ -37,12 +37,11 @@ Using this JSON interface, web3.js is able to create a JavaScript object represe
#### Example

```hyperion title='Hyperion Contract'
// TODO(now.youtrack.cloud/issue/web3js-11)
pragma hyperion ^0.8.4;
pragma hyperion >=0.1.0;

contract Test {
uint256 a;
address d = ZdCad3a6d3569DF655070DEd06cb7A1b2Ccd1D3AF;
address d = QdCad3a6d3569DF655070DEd06cb7A1b2Ccd1D3AF;

constructor(uint256 testInt) {
a = testInt;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_label: Add custom RPC methods

#### Introduction

Web3.js is a popular library for interacting with the Zond blockchain. It provides a set of APIs to interact with Zond nodes via JSON-RPC calls. For adding new JSON-RPC function calls to the library, you can do so using the plugin feature in web3.js. This allows you to extend the functionality of Web3.js and add support for new JSON-RPC methods.
Web3.js is a popular library for interacting with the QRL blockchain. It provides a set of APIs to interact with QRL nodes via JSON-RPC calls. For adding new JSON-RPC function calls to the library, you can do so using the plugin feature in web3.js. This allows you to extend the functionality of Web3.js and add support for new JSON-RPC methods.

:::caution
`web3.extend()` is available in Web3 with some breaking changes. However it is recommended to use Web3 Plugin feature for extending web3 functionality if you are developing new feature.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ For further information about `sideEffects` see [webpack docs](https://webpack.j

4. Use the specific packages which you need,

For example, if you need `web.zond`:
For example, if you need `web.qrl`:

```ts
import Web3Zond from '@theqrl/web3-zond';
import Web3QRL from '@theqrl/web3-qrl';
```

If you only need a few functions from `@theqrl/web3-utils`:
Expand Down
Loading
Loading