Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vechain/thorify
A web3 adaptor for VeChain Thor RESTful HTTP API.
https://github.com/vechain/thorify
blockchain contracts smart thor vechain web3
Last synced: 3 months ago
JSON representation
A web3 adaptor for VeChain Thor RESTful HTTP API.
- Host: GitHub
- URL: https://github.com/vechain/thorify
- Owner: vechain
- License: mit
- Archived: true
- Created: 2018-04-25T09:59:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-09T15:11:34.000Z (7 months ago)
- Last Synced: 2024-05-09T23:56:15.164Z (6 months ago)
- Topics: blockchain, contracts, smart, thor, vechain, web3
- Language: TypeScript
- Homepage: https://thorify.vecha.in/
- Size: 1.19 MB
- Stars: 73
- Watchers: 22
- Forks: 43
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-vechain - Thorify - A JavaScript web3 adaptor for VeChain Thor RESTful API. (Developer resources / Blockchain development)
README
## Thorify
> [!IMPORTANT]
> This project is discontinued, try out [web3-providers-connex](https://github.com/vechain/web3-providers-connex) or [vechain-sdk-js](https://github.com/vechain/vechain-sdk-js).
[](https://www.npmjs.com/package/thorify)
[](https://travis-ci.org/vechain/thorify)
[](https://coveralls.io/github/vechain/thorify?branch=master)
A web3 adaptor for VeChain [Thor](https://github.com/vechain/thor) RESTful API.
## Table of contents
* [Install](#install)
* [Usage](#usage)
* [Web3 method supported](#web3-method-supported)
* [Send transaction](#send-transaction)
* [Documentation](https://thorify.vecha.in)
* [Play with multi-clause](#play-with-multi-clause)
* [Which Stack Should I Choose Regarding Connex,Thorify And Web3-Gear](#which-stack-should-i-choose-regarding-connexthorify-and-web3-gear)
* [FAQ](#faq)
* [Web3-Gear vs Thorify](#web3-gear-vs-thorify)
* [How do I send VTHO token](#how-do-i-send-vtho-token)
* [Multi party payment protocol or sponsored contract](#multi-party-payment-protocol-or-sponsored-contract)
* [Method not supported](#method-not-supported)
* [Subscriptions support](#subscriptions-support)
* [Notes](#notes)
* [Compatibility](#compatibility)
* [Debugging](#debugging)
* [License](#License)
## Install
``` bash
npm i thorify web3@1.* # Web3 is needed as dependency.
```
Furthermore, if you would like to change web3 version after installation, for example `1.6`, run `npm i [email protected] [email protected]` as `subscriptions` is a peer dependency.
## Usage
``` javascript
// ES6 style
import { thorify } from "thorify";
const Web3 = require("web3"); // Recommend using require() instead of import here
const web3 = thorify(new Web3(), "http://localhost:8669");
web3.eth.getBlock("latest").then(res => console.log(res));
// Best block info will be displayed
```
If you would like to write code in ES5, check below for the initialization code.
``` javascript
// ES5 style
const thorify = require("thorify").thorify;
const Web3 = require("web3");
const web3 = thorify(new Web3(), "http://localhost:8669");
web3.eth.getBlock("latest").then(res => console.log(res));
// Best block info will be displayed
```
## Web3 method supported
```
web3 instance
├── eth
│ ├── getBlockNumber
│ ├── getBalance
│ ├── getStorageAt
│ ├── getCode
│ ├── getBlock
│ ├── getTransaction
│ ├── getTransactionReceipt
│ ├── sendTransaction
│ ├── sendSignedTransaction
│ ├── call
│ ├── estimateGas
│ ├── getPastLogs
│ ├── subscribe
│ ├── clearSubscriptions
│ ├── getEnergy
│ ├── getChainTag
│ ├── getBlockRef
│ ├── accounts
│ └── Contract
│ ├── Constructor(new Contract())
│ ├── clone
│ ├── deploy
│ ├── methods
│ ├── methods.myMethod.call
│ ├── methods.myMethod.send
│ ├── methods.myMethod.estimateGas
│ ├── methods.myMethod.encodeABI
│ ├── events
│ ├── once
│ ├── events.myEvent
│ ├── events.allEvents
│ └── getPastEvents
└── utils
```
## Send Transaction
In Thor official implementation , the client **DOES NOT** neither manage user's private-key/keyStore nor use private key to sign a Transaction. Unfortunately, thorify can not directly perform `eth_sendTransaction` but there is another way to sign a transaction.
In [web3.js accounts](https://web3js.readthedocs.io/en/1.0/web3-eth-accounts.html#eth-accounts), it gives the opportunity to add your private-key, stored in your runtime context (In Node.js context, it's stored in memory while in Browser context, it's stored in memory/local storage), to accounts module. When you are trying to send a transaction, the module will check the private key associated with from field. Once the private key and from have been matched, the module will sign the transaction.
The APIs that follows the mechanism are:
+ `web3.eth.sendTransaction()`
+ `contract.deploy.send()`
+ `contract.methods.myMethod.send()`
## Documentation
[API Reference](https://thorify.vecha.in/#/?id=api-reference)
## Play with multi-clause
1. [thor-devkit.js](https://github.com/vechain/thor-devkit.js) supports multi-clause and sign transaction
2. send signed transaction using [sendSignedTransaction](https://thorify.vecha.in/#/?id=send-signed-transaction)
## FAQ
### How do I send VTHO token
VTHO is a token that compatible with VIP180(ERC-20), you can build a contract instance using `web3` and do what ever you want.
+ [VTHO source code](https://github.com/vechain/thor/blob/master/builtin/gen/energy.sol)
+ Contract Address: `0x0000000000000000000000000000456E65726779`
### Multi party payment protocol or sponsored contract
It's done by calling the functions of prototype contract, check [wiki page](https://github.com/vechain/thor/wiki/Prototype(EN)) for detailed info about prototype contract.
### Method not supported
The RESTful API of Thor is different with Ethereum's JSON-RPC, therefore, there are some methods in web3 are not supported by thorify, feel free to open an issue discuss the features.
## Notes
- There are three special block number in Ethereum: `earliest`,`latest`,`pending`. In VeChain Thor, we introduced `best` block and there is no `pending` block, so they will be replaced with `0` (aka genesis), `best`, `best`
## Compatibility
Currently, `Thorify` is compatible with `web3@1.*`, tested versions are `1.2~1.7.1`.
## Debugging
```shell
DEBUG=thor:* ts-node index.ts
```
`ts-node index.ts` can be replaced with command to run your code, this example is only for Node.js environment. For more detailed info, please refer to [debug](https://www.npmjs.com/package/debug).
## License
This project is licensed under the MIT license, Copyright (c) 2017 VeChain Foundation. For more information see [LICENSE.md](LICENSE.md).