1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
#![doc(html_root_url = "https://docs.rs/thor-devkit/0.1.0-beta.1")]
#![warn(rust_2018_idioms, missing_docs)]
#![deny(dead_code, unused_imports, unused_mut)]
//! 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.
//!
//! ```rust
//! 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/](https://github.com/sterliakov/thor-devkit.rs/tree/master/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.
//!
//! [crates.io]: https://crates.io/crates/thor-devkit
//! [`README.md`]: https://github.com/sterliakov/thor-devkit.rs
//!
//!
//! ## 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.
//!
//! [Contributing]: CONTRIBUTING.md
//! [open an issue]: https://github.com/sterliakov/thor-devkit.rs/issues
//!
//! ## License
//!
//! This project is proudly licensed under the Lesser GNU General Public License v3 ([LICENSE](https://github.com/sterliakov/thor-devkit.rs/blob/master/LICENSE)).
//!
//! `thor-devkit` can be distributed according to the Lesser GNU General Public License v3. Contributions
//! will be accepted under the same license.
mod address;
pub use address::{Address, AddressConvertible, PrivateKey, PublicKey};
pub mod hdnode;
#[cfg(feature = "http")]
pub mod network;
pub mod rlp;
pub mod transactions;
mod utils;
pub use ethereum_types::U256;
pub use rustc_hex::FromHexError as AddressValidationError;
pub use utils::{blake2_256, keccak};