Struct casper_rust_wasm_sdk::watcher::Watcher

pub struct Watcher { /* private fields */ }

Represents a deploy watcher responsible for monitoring transaction events.

This struct allows clients to subscribe to transaction events, start watching for events, or wait for an event and handle the received deploy event data.

Fields

• events_url - The URL for transaction events.
• subscriptions - Vector containing deploy subscriptions.
• active - Reference-counted cell indicating whether the deploy watcher is active.
• timeout_duration - Duration representing the optional timeout for watching events.

Implementations

impl Watcher

pub fn new(events_url: String, timeout_duration: Option<u64>) -> Self

Creates a new Watcher instance.

Arguments

• events_url - The URL for transaction events.
• timeout_duration - Optional duration in milliseconds for watching events. If not provided, a default timeout of 60,000 milliseconds (1 minute) is used.

Returns

A new Watcher instance.

pub fn unsubscribe(&mut self, target_hash: String)

Unsubscribes from transaction events based on the provided transaction hash.

Arguments

• transaction_hash - The transaction hash to unsubscribe.

This method removes the deploy subscription associated with the provided transaction hash.

pub fn stop(&self)

Stops watching for transaction events.

This method sets the deploy watcher as inactive and stops the event listener if it exists.

impl Watcher

pub async fn start(&self) -> Option<Vec<EventParseResult>>

Asynchronously starts watching for transaction events and execute callback handler functions from deploy subscriptions

Returns

An Option containing the serialized deploy event data or None if no events are received.

pub fn subscribe( &mut self, subscriptions: Vec<Subscription>, ) -> Result<(), String>

Subscribes to transaction events.

Arguments

• subscriptions - Vector of subscriptions to be added.

Returns

Result indicating success or an error message.

Trait Implementations

impl Clone for Watcher

fn clone(&self) -> Watcher

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<Watcher> for JsValue

fn from(value: Watcher) -> Self

Converts to this type from the input type.

impl FromWasmAbi for Watcher

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 Watcher

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 Watcher

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<Watcher>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Watcher

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 Watcher

fn none() -> Self::Abi

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

impl RefFromWasmAbi for Watcher

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<Watcher>

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 Watcher

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<Watcher>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for Watcher

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 Watcher

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

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

impl VectorIntoJsValue for Watcher

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

impl VectorIntoWasmAbi for Watcher

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

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

impl WasmDescribe for Watcher

fn describe()

impl WasmDescribeVector for Watcher

fn describe_vector()