Crate thor_devkit

Expand description

Rust library to aid coding with VeChain: wallets, transactions signing, encoding and verification, smart contract ABI interfacing, etc.

This library acts primary as a proxy to several underlying libraries, with the addition of some VeChain-specific toolchain components.

§Usage

One of possible use cases can be transaction creation and signing.

Here is how you may approach it. Let’s transfer a few VET to another account.

To do so, we need to create a transaction and encode it into broadcastable bytes.

use thor_devkit::transactions::{Transaction, Clause};
use thor_devkit::hdnode::{Mnemonic, Language, HDNode};

let transaction = Transaction {
    chain_tag: 1,
    block_ref: 0xaabbccdd,
    expiration: 32,
    clauses: vec![
        Clause {
            to: Some(
                "0x7567d83b7b8d80addcb281a71d54fc7b3364ffed"
                    .parse()
                    .unwrap(),
            ),
            value: 10000.into(),
            data: b"\x00\x00\x00\x60\x60\x60".to_vec().into(),
        },
    ],
    gas_price_coef: 128,
    gas: 21000,
    depends_on: None,
    nonce: 0xbc614e,
    reserved: None,
    signature: None,
};
let mnemonic = Mnemonic::from_phrase(
    "ignore empty bird silly journey junior ripple have guard waste between tenant",
    Language::English
).expect("Must be correct");
let wallet = HDNode::build().mnemonic(mnemonic).build().expect("Builds");
let signed = transaction.sign(&wallet.private_key().expect("Must be non-restricted").private_key());
println!("{:02x?}", signed.to_broadcastable_bytes());

§Examples

You can check out sample usage of this crate in the examples/ folder in the project repo on GitHub.

§Readme Docs

You can find the crate’s readme documentation on the crates.io page, or alternatively in the README.md file on the GitHub project repo.

§MSRV

thor-devkit promises to maintain a reasonable MSRV policy. MSRV will not be bumped unless necessary, and such MSRV bumps will only happen in minor or major releases as soon as the first non-beta release goes live. The required version will never be newer than 6 months.

Currently it requires rust 1.81.0 or higher to build.

§Contributing

Contributions are welcome! Open a pull request to fix a bug, or open an issue to discuss a new feature or change.

Check out the Contributing section in the docs for more info.

§License

This project is proudly licensed under the Lesser GNU General Public License v3 (LICENSE).

thor-devkit can be distributed according to the Lesser GNU General Public License v3. Contributions will be accepted under the same license.

Modules§

hdnode: VeChain-tailored hierarchically deterministic nodes support
network: Module for interacting with node HTTP APIs.
rlp: This module enables RLP encoding of high-level objects.
transactions: VeChain transactions support.

Macros§

rlp_encodable: Create an RLP-encodable struct by specifying types to cast to.

Structs§

Address: VeChain address.
PrivateKey: Secret 256-bit key used as x in an ECDSA signature.
PublicKey: A Secp256k1 public key, used for verification of signatures.
U256: Little-endian large integer type 256-bit unsigned integer.

Enums§

AddressValidationError: Errors that can occur when decoding a hex encoded string

Traits§

AddressConvertible: A trait for objects that can generate an on-chain address.

Functions§

blake2_256: Compute blake2b hash with 32-byte digest.
keccak: Compute a keccak hash with 32-byte digest.

Crate thor_devkitCopy item path