Struct JsHydraTxBuilder

pub struct JsHydraTxBuilder { /* private fields */ }

Builder for core Hydra transactions on a given network.

Implementations

impl JsHydraTxBuilder

pub fn new(network_name: &str) -> Result<JsHydraTxBuilder, JsValue>

Creates a transaction builder on the given network.

@see allNetworkNames, validateNetworkName

pub fn transfer( &self, recipient_id: &JsSecpKeyId, sender_pubkey: &JsSecpPublicKey, amount_flake: u64, nonce: u64, vendor_field: Option<String>, manual_fee: Option<u64>, ) -> Result<JsValue, JsValue>

Creates a token transfer transaction that moves amount of flakes (smallest denomination on the chain) from the balance that belongs to the sender {@SecpPublicKey} to the one that has the recipient address {@SecpKeyId}.

The nonce of the sender needs to be known in advance and the next transaction must be 1 above the one of the last transaction made by the sender on-chain.

Vendor field is a public memo attached to the transaction. The fee can be manually overriden, or the defaults will be calculated based on the size of the serialized transaction size and some offset based on the transaction type.

@see SecpKeyId.fromAddress

pub fn vote( &self, delegate: &JsSecpPublicKey, sender_pubkey: &JsSecpPublicKey, nonce: u64, vendor_field: Option<String>, manual_fee: Option<u64>, ) -> Result<JsValue, JsValue>

Creates a vote transaction that empowers a delegate {@SecpPublicKey} to validate blocks and earn rewards for doing so.

The nonce of the sender needs to be known in advance and the next transaction must be 1 above the one of the last transaction made by the sender on-chain.

Vendor field is a public memo attached to the transaction. The fee can be manually overriden, or the defaults will be calculated based on the size of the serialized transaction size and some offset based on the transaction type.

pub fn unvote( &self, delegate: &JsSecpPublicKey, sender_pubkey: &JsSecpPublicKey, nonce: u64, vendor_field: Option<String>, manual_fee: Option<u64>, ) -> Result<JsValue, JsValue>

Creates an unvote transaction that revokes empowerment from a delegate {@SecpPublicKey} to validate blocks.

The nonce of the sender needs to be known in advance and the next transaction must be 1 above the one of the last transaction made by the sender on-chain.

Vendor field is a public memo attached to the transaction. The fee can be manually overriden, or the defaults will be calculated based on the size of the serialized transaction size and some offset based on the transaction type.

pub fn register_delegate( &self, sender_pubkey: &JsSecpPublicKey, delegate_name: &str, nonce: u64, vendor_field: Option<String>, manual_fee: Option<u64>, ) -> Result<JsValue, JsValue>

Creates a transaction that registers a delegate so it can validate blocks and earn rewards for doing so. If there is not enough balance on the delegate’s address, other addresses can vote for the delegate with their own balance and if the sum of these are in the top 53 (or the limit on the actual network), they can validate blocks in the coming rounds.

The nonce of the sender needs to be known in advance and the next transaction must be 1 above the one of the last transaction made by the sender on-chain.

Vendor field is a public memo attached to the transaction. The fee can be manually overriden, or the defaults will be calculated based on the size of the serialized transaction size and some offset based on the transaction type.

Trait Implementations

impl From<JsHydraTxBuilder> for JsValue

fn from(value: JsHydraTxBuilder) -> Self

Converts to this type from the input type.

impl FromWasmAbi for JsHydraTxBuilder

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for JsHydraTxBuilder

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for JsHydraTxBuilder

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<JsHydraTxBuilder>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for JsHydraTxBuilder

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for JsHydraTxBuilder

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for JsHydraTxBuilder

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<JsHydraTxBuilder>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for JsHydraTxBuilder

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<JsHydraTxBuilder>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for JsHydraTxBuilder

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl VectorFromWasmAbi for JsHydraTxBuilder

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[JsHydraTxBuilder]>

impl VectorIntoJsValue for JsHydraTxBuilder

fn vector_into_jsvalue(vector: Box<[JsHydraTxBuilder]>) -> JsValue

impl VectorIntoWasmAbi for JsHydraTxBuilder

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[JsHydraTxBuilder]>) -> Self::Abi

impl WasmDescribe for JsHydraTxBuilder

fn describe()

impl WasmDescribeVector for JsHydraTxBuilder

fn describe_vector()

impl SupportsConstructor for JsHydraTxBuilder

impl SupportsInstanceProperty for JsHydraTxBuilder

impl SupportsStaticProperty for JsHydraTxBuilder