#API Documentation

#configuration::fees

#get()

1pub fn get(transaction_type: TransactionType)

Get a fee for a given transaction type

#Parameters

#Return Value

u64

#set()

1pub fn set(transaction_type: TransactionType, value: u64)

Set a fee

#Parameters

#Return Value

Void

#configuration::network

#set()

1pub fn set(network: Network)

Set what network you want to use in the crypto library.

#Parameters

#Return Value

Void

#get()

1pub fn get()

Get settings for a selected network, default network is mainnet.

#Return Value

Network

#enums::networks::Network

#epoch() str

1pub fn epoch(&self)

Get the epoch time of the Network.

#Return Value

&'static str

#version()

1pub fn version(&self)

Get the version of the Network.

#Return Value

u8

#epoch() u8

1pub fn epoch(&self)

Get the epoch time of the Network.

#Return Value

u8

#enums::transaction_types::TransactionType

#fee()

1pub fn fee(self)

Get the fee for a certain type of transaction.

#Return Value

u64

#identities::address

#from_public_key()

1pub fn from_public_key(public_key: &PublicKey, network_version: Option<u8>)

Derive the address from the given public key.

#Parameters

#Return Value

String

#from_private_key()

1pub fn from_private_key(private_key: &PrivateKey, network_version: Option<u8>)

Derive the address from the given private key.

#Parameters

#Return Value

String

#from_passphrase()

1pub fn from_passphrase(passphrase: &str, network_version: Option<u8>)

Derive the address from the given passphrase.

#Parameters

#Return Value

Result<String, Error>

#validate()

1pub fn validate(address: &str, network_version: Option<u8>)

Validate the given address.

#Parameters

#Return Value

bool

#identities::private_key

#from_passphrase()

1pub fn from_passphrase(passphrase: &str)

Derive the private key for the given passphrase.

#Parameters

#Return Value

Result<PrivateKey, Error>

#from_hex()

1pub fn from_hex(private_key: &str)

Create a private key instance from a hex string.

#Parameters

#Return Value

Result<PrivateKey, Error>

#sign()

1pub fn sign(bytes: &[u8], passphrase: &str)

Sign the private key.

#Parameters

#Return Value

String

#identities::public_key

#from_passphrase()

1pub fn from_passphrase(passphrase: &str)

Derive the public from the given passphrase.

#Parameters

#Return Value

Result<PublicKey, Error>

#from_hex()

1pub fn from_hex(public_key: &str)

Create a public key instance from a hex string.

#Parameters

#Return Value

Result<PublicKey, Error>

#from_private_key()

1pub fn from_private_key(private_key: &private_key::PrivateKey)

Create a public key instance from a private key.

#Parameters

#Return Value

PublicKey

#identities::wif

#from_passphrase()

1pub fn from_passphrase(passphrase: &str)

Derive the WIF from the given passphrase.

#Parameters

#Return Value

String

#transactions::builder

#build_transfer()

1pub fn build_transfer(
2    passphrase: &str,
3    second_passphrase: Option<&str>,
4    recipient_id: &str,
5    amount: u64,
6    vendor_field: &str,
7)

Builds a transaction for a transfer.

#Parameters

#Return Value

Result<Transaction, failure::Error>

#build_vote()

1pub fn build_vote(
2    passphrase: &str,
3    second_passphrase: Option<&str>,
4    votes: Vec<String>,
5)

Builds a transaction for a vote registration.

#Parameters

#Return Value

Result<Transaction, failure::Error>

#build_second_signature_registration()

1pub fn build_second_signature_registration(
2    passphrase: &str,
3    second_passphrase: &str,
4)

Builds a transaction for a second signature registration.

#Parameters

#Return Value

Result<Transaction, failure::Error>

#build_delegate_registration()

1pub fn build_delegate_registration(
2    passphrase: &str,
3    second_passphrase: Option<&str>,
4    username: &str,
5)

Builds a transaction for a delegate registration.

#Parameters

#Return Value

Result<Transaction, failure::Error>

#build_multi_signature_registration()

1pub fn build_multi_signature_registration(
2    passphrase: &str,
3    second_passphrase: Option<&str>,
4    min: u8,
5    lifetime: u8,
6    keysgroup: Vec<String>,
7)

Builds a transaction for a multi signature registration.

#Parameters

#Return Value

Result<Transaction, failure::Error>

#transactions::deserializers

#deserialize()

1pub fn deserialize(serialized: &str)

Handle the deserialization of data.

#Parameters

#Return Value

`Transaction

#transactions::serializer

#serialize()

1pub fn serialize(transaction: &Transaction)

Handle the serialization of data.

#Parameters

#Return Value

String

#transactions::transaction::Transaction

#get_id()

1pub fn get_id(&self)

Convert the byte representation to a unique identifier.

#Return Value

String

#sign()

1pub fn sign(&mut self, passphrase: &str)

Sign the transaction using the given passphrase.

#Parameters

#Return Value

&Self

#second_sign()

1pub fn second_sign(&mut self, passphrase: &str)

Sign the transaction using the given second passphrase.

#Parameters

#Return Value

&Self

#verify()

1pub fn verify(&self)

Verify the transaction.

#Return Value

bool

#second_verify()

1pub fn second_verify(&self, sender_public_key: &str)

Verify the transaction with a second public key.

#Parameters

#Return Value

bool

#to_bytes()

1pub fn to_bytes(&self, skip_signature: bool, skip_second_signature: bool)

Convert the transaction to its byte representation.

#Parameters

#Return Value

Vec<u8>

#to_params()

1pub fn to_params(&self)

Convert the transaction to its params representation.

#Return Value

Result<serde_json::Value, serde_json::Error>

#to_json()

1pub fn to_json(&self)

Convert the transaction to its JSON representation.

#Return Value

Result<String, serde_json::Error>

#utils::message::Message

#new()

1pub fn new(public_key: &str, signature: &str, message: &str)

Instantiate new Message.

#Parameters

#Return Value

Message

#sign()

1pub fn sign(message: &str, passphrase: &str)

Sign a message using the given passphrase.

#Parameters

#Return Value

Message

#verify()

1pub fn verify(&self)

Verify the message contents

#Return Value

bool

#to_json()

1pub fn to_json(&self)

Convert the message to its JSON representation

#Return Value

Result<String, serde_json::Error>

#to_map()

1pub fn to_map(&self)

Convert the message to its JSON representation

#Return Value

Result<Value, serde_json::Error>

#utils::mod

#str_from_hex()

1pub fn str_from_hex(string: &str)

Convert the given string from its hex representation.

#Parameters

#Return Value

Result<String, failure::Error>

#str_to_hex()

1pub fn str_to_hex(string: &str)

Convert the given string to its hex representation.

#Parameters

#Return Value

String

#utils::slot

#get_time()

1pub fn get_time()

Get the time diff between now and network start.

#Return Value

u32

#get_epoch()

1pub fn get_epoch()

Get the network start epoch.

#Return Value

u32