near-gas

Crates.ionear-gas
lib.rsnear-gas
version0.2.5
sourcesrc
created_at2023-07-11 12:00:56.401918
updated_at2023-11-01 00:11:03.516231
descriptiona small crate to work with NEAR Gas unit values ergonomically and efficiently (NEAR Protocol)
homepage
repositoryhttps://github.com/near/near-gas
max_upload_size
id913740
size49,124
(nearprotocol-ci)

documentation

README

near-gas

Crates.io (downloads) Docs.rs Rust Version

near-gas is crate to ergonomically operate with NEAR Protocol gas unit in Rust projects.

The crate includes NearGas type and constructors for converting data as NearGas and as u64 type values.

near-gas examples

use near_gas::NearGas;

fn main() {
    let data = "12.657 tgas";

    let near_gas: NearGas = data.parse().unwrap();

    // Convert the value to the most precise "gas" unit
    assert_eq!(near_gas.as_gas(), 12657000000000);
    // Convert the value to "gigagas" unit
    assert_eq!(near_gas.as_ggas(), 12657);
    
    // Display Gas. It will print: "Here is 12.7 Tgas"
    println!("Here is {}", near_gas);

    // When `serde` feature is enabled, NearGas can be used in serde-serializable structs.
    // NearGas will be serialized to a gas-precision u64 value encoded as string.
    #[derive(serde::Serialize)]
    struct FunctionCallDetails {
        used_gas: NearGas,
    }

    let details = FunctionCallDetails { used_gas: near_gas };

    assert_eq!(serde_json::to_string(&details).unwrap(), r#"{"used_gas":"12657000000000"}"#);
}

NearGas information

On every transaction you send to the network NEAR charges you a fee (aka gas fee). This fee is used to indirectly pay the people that keep the network infrastructure, and to incentivize developers of smart contracts. For more information.

Gas usage in Near Protocol

Crate Features

License

This project is licensed under the MIT license and Apache-2.0 license.

Commit count: 83

cargo fmt