neo3 1.0.9

Production-ready Rust SDK for Neo N3 blockchain with high-level API, unified error handling, and enterprise features
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

#![allow(dead_code)]

use crate::neo_protocol::NeoBlock;
use futures::stream::Stream;
use std::{error::Error, pin::Pin};

/// The JSON-RPC client event API for Neo.
pub(crate) trait NeoRustRxTrait {
	/// Create a stream that emits newly created blocks on the blockchain.
	///
	/// # Arguments
	///
	/// * `full_transaction_objects` - If true, provides transactions embedded in blocks, otherwise transaction hashes
	///
	/// # Returns
	///
	/// A stream that emits all new blocks as they are added to the blockchain
	fn block_stream(
		&self,
		full_transaction_objects: bool,
	) -> Pin<Box<dyn Stream<Item = Result<NeoBlock, Box<dyn Error>>> + Send>>;

	/// Create a stream that emits all blocks from the blockchain contained within the requested range.
	///
	/// # Arguments
	///
	/// * `start_block` - The block number to commence with
	/// * `end_block` - The block number to finish with
	/// * `full_transaction_objects` - If true, provides transactions embedded in blocks, otherwise transaction hashes
	///
	/// # Returns
	///
	/// A stream to emit these blocks
	fn replay_blocks_stream(
		&self,
		start_block: u32,
		end_block: u32,
		full_transaction_objects: bool,
	) -> Pin<Box<dyn Stream<Item = Result<NeoBlock, Box<dyn Error>>> + Send>>;

	/// Create a stream that emits all blocks from the blockchain contained within the requested range.
	///
	/// # Arguments
	///
	/// * `start_block` - The block number to commence with
	/// * `end_block` - The block number to finish with
	/// * `full_transaction_objects` - If true, provides transactions embedded in blocks, otherwise transaction hashes
	/// * `ascending` - If true, emits blocks in ascending order between range, otherwise, in descending order
	///
	/// # Returns
	///
	/// A stream to emit these blocks
	fn replay_blocks_stream_ordered(
		&self,
		start_block: u32,
		end_block: u32,
		full_transaction_objects: bool,
		ascending: bool,
	) -> Pin<Box<dyn Stream<Item = Result<NeoBlock, Box<dyn Error>>> + Send>>;

	/// Create a stream that emits all transactions from the blockchain starting with a provided block number.
	/// Once it has replayed up to the most current block, the stream completes.
	///
	/// # Arguments
	///
	/// * `start_block` - The block number to commence with
	/// * `full_transaction_objects` - If true, provides transactions embedded in blocks, otherwise transaction hashes
	///
	/// # Returns
	///
	/// A stream to emit all requested blocks
	fn catch_up_to_latest_block_stream(
		&self,
		start_block: u32,
		full_transaction_objects: bool,
	) -> Pin<Box<dyn Stream<Item = Result<NeoBlock, Box<dyn Error>>> + Send>>;

	/// Creates a stream that emits all blocks from the requested block number to the most current.
	/// Once it has emitted the most current block, it starts emitting new blocks as they are created.
	///
	/// # Arguments
	///
	/// * `start_block` - The block number to commence with
	/// * `full_transaction_objects` - If true, provides transactions embedded in blocks, otherwise transaction hashes
	///
	/// # Returns
	///
	/// A stream to emit all requested blocks and future blocks
	fn catch_up_to_latest_and_subscribe_to_new_blocks_stream(
		&self,
		start_block: u32,
		full_transaction_objects: bool,
	) -> Pin<Box<dyn Stream<Item = Result<NeoBlock, Box<dyn Error>>> + Send>>;

	/// Creates a stream that emits new blocks as they are created on the blockchain (starting from the latest block).
	///
	/// # Arguments
	///
	/// * `full_transaction_objects` - If true, provides transactions embedded in blocks, otherwise transaction hashes
	///
	/// # Returns
	///
	/// A stream to emit all future blocks
	fn subscribe_to_new_blocks_stream(
		&self,
		full_transaction_objects: bool,
	) -> Pin<Box<dyn Stream<Item = Result<NeoBlock, Box<dyn Error>>> + Send>>;
}