NodeUpdateTransaction

Type Alias NodeUpdateTransaction 

Source
pub type NodeUpdateTransaction = Transaction<NodeUpdateTransactionData>;
Expand description

Transaction body to modify address book node attributes.

  • This transaction SHALL enable the node operator, as identified by the admin_key, to modify operational attributes of the node.
  • This transaction MUST be signed by the active admin_key for the node.
  • If this transaction sets a new value for the admin_key, then both the current admin_key, and the new admin_key MUST sign this transaction.
  • This transaction SHALL NOT change any field that is not set (is null) in this transaction body.
  • This SHALL create a pending update to the node, but the change SHALL NOT be immediately applied to the active configuration.
  • All pending node updates SHALL be applied to the active network configuration during the next freeze transaction with the field freeze_type set to PREPARE_UPGRADE.

§Record Stream Effects

Upon completion the node_id for the updated entry SHALL be in the transaction receipt.

Aliased Type§

pub struct NodeUpdateTransaction { /* private fields */ }

Implementations§

Source§

impl NodeUpdateTransaction

Source

pub fn get_node_id(&self) -> u64

Returns the account associated with the new node.

Source

pub fn node_id(&mut self, node_id: u64) -> &mut Self

Sets the account associated with the new node.

Source

pub fn get_account_id(&self) -> Option<AccountId>

Returns the account associated with the new node.

Source

pub fn account_id(&mut self, account_id: AccountId) -> &mut Self

Sets the account associated with the new node.

Source

pub fn get_description(&self) -> Option<&str>

Returns the description of the new node.

Source

pub fn description(&mut self, description: impl Into<String>) -> &mut Self

Sets the description of the new node.

Source

pub fn get_gossip_endpoints(&self) -> Vec<ServiceEndpoint>

Returns the list of service endpoints for gossip.

Source

pub fn gossip_endpoints( &mut self, gossip_endpoint: impl IntoIterator<Item = ServiceEndpoint>, ) -> &mut Self

Sets the list of service endpoints for gossip.

Source

pub fn add_gossip_endpoint( &mut self, gossip_endpoint: ServiceEndpoint, ) -> &mut Self

Adds a service endpoint for gossip to the list of service endpoints.

Source

pub fn get_service_endpoints(&self) -> Vec<ServiceEndpoint>

Returns the updated list of service endpoints for gRPC calls.

Source

pub fn service_endpoints( &mut self, service_endpoint: impl IntoIterator<Item = ServiceEndpoint>, ) -> &mut Self

Sets the updated list of service endpoints for gRPC calls.

Source

pub fn add_service_endpoint( &mut self, service_endpoint: ServiceEndpoint, ) -> &mut Self

Adds a service endpoint to the list of service endpoints for gRPC calls.

Source

pub fn get_gossip_ca_certificate(&self) -> Option<Vec<u8>>

Returns the updated certificate used to sign gossip events.

Source

pub fn gossip_ca_certificate( &mut self, gossip_ca_certificate: impl Into<Vec<u8>>, ) -> &mut Self

Updates the certificate used to sign gossip events.

Source

pub fn get_grpc_certificate_hash(&self) -> Option<Vec<u8>>

Returns the updated hash of the node gRPC TLS certificate.

Source

pub fn grpc_certificate_hash( &mut self, grpc_certificate_hash: impl Into<Vec<u8>>, ) -> &mut Self

Updates the hash of the node gRPC TLS certificate.

Source

pub fn get_admin_key(&self) -> Option<&Key>

Returns the updated admin key.

Source

pub fn admin_key(&mut self, key: impl Into<Key>) -> &mut Self

Updated the admin key.

Source

pub fn get_decline_reward(&self) -> Option<bool>

Returns the decline reward.

Source

pub fn decline_reward(&mut self, decline_reward: bool) -> &mut Self

Sets the decline reward.

Source

pub fn get_grpc_proxy_endpoint(&self) -> Option<&ServiceEndpoint>

Returns the grpc proxy endpoint.

Source

pub fn grpc_proxy_endpoint( &mut self, grpc_proxy_endpoint: ServiceEndpoint, ) -> &mut Self

Sets the grpc proxy endpoint.

Source

pub fn delete_grpc_proxy_endpoint(&mut self) -> &mut Self

Deletes the gRPC proxy endpoint and sets it to null.

This clears the gRPC proxy endpoint field, effectively removing it from the node update.