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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
//! Handler macros for Substreams.
//!
//! This create exports useful macros that you can use to develop
//! Substreams handlers. The goal of these macros is to significantly reduce boilerplate
//! code and ensure that your handler are more readable
/// Marks function to setup substreams map handler WASM boilerplate
///
/// ## Usage with Result<T, ...>
///
///
/// ```rust
/// # mod eth { pub type Block = (); }
/// # mod proto { pub type Custom = (); }
///
/// #[substreams::handlers::map]
/// fn map_handler(blk: eth::Block) -> Result<proto::Custom, substreams::errors::Error> {
/// unimplemented!("do something");
/// }
/// ```
///
/// Equivalent code not using `#[substreams::handlers::map]`
///
/// ```rust
/// # mod eth { pub type Block = (); }
/// # mod proto {
/// # use std::todo;
/// # #[derive(Debug)]
/// # pub struct Custom(u8);
/// # impl prost::Message for Custom {
/// # fn encode_raw(&self, _: &mut impl prost::bytes::BufMut) where Self: Sized { todo!() }
/// # fn merge_field(&mut self, _: u32, _: prost::encoding::WireType, _: &mut impl prost::bytes::Buf, _: prost::encoding::DecodeContext) -> Result<(), prost::DecodeError> where Self: Sized { todo!() }
/// # fn encoded_len(&self) -> usize { todo!() }
/// # fn clear(&mut self) { todo!() }
/// # }
/// # }
///
/// #[no_mangle]
/// pub extern "C" fn map_handler(blk_ptr: *mut u8, blk_len: usize) {
/// substreams::register_panic_hook();
/// let func = || -> Result<proto::Custom, substreams::errors::Error> {
/// let blk: eth::Block = substreams::proto::decode_ptr(blk_ptr, blk_len).unwrap();
/// {
/// unimplemented!("do something");
/// }
/// };
/// let result = func();
/// if result.is_err() {
/// panic!(result.err().unwrap())
/// }
/// substreams::output(substreams::proto::encode(&result.unwrap()).unwrap());
/// }
///
/// ```
///
/// ## Usage with [Option]
///
///
/// ```rust
/// # mod eth { pub type Block = (); }
/// # mod proto { pub type Custom = (); }
///
/// #[substreams::handlers::map]
/// fn map_handler(blk: eth::Block) -> Option<proto::Custom> {
/// unimplemented!("do something");
/// }
/// ```
///
/// Equivalent code not using `#[substreams::handlers::map]`
///
/// ```rust
/// # mod eth { pub type Block = (); }
/// # mod proto {
/// # use std::todo;
/// # #[derive(Debug)]
/// # pub struct Custom(u8);
/// # impl prost::Message for Custom {
/// # fn encode_raw(&self, _: &mut impl prost::bytes::BufMut) where Self: Sized { todo!() }
/// # fn merge_field(&mut self, _: u32, _: prost::encoding::WireType, _: &mut impl prost::bytes::Buf, _: prost::encoding::DecodeContext) -> Result<(), prost::DecodeError> where Self: Sized { todo!() }
/// # fn encoded_len(&self) -> usize { todo!() }
/// # fn clear(&mut self) { todo!() }
/// # }
/// # }
///
/// #[no_mangle]
/// pub extern "C" fn map_handler(blk_ptr: *mut u8, blk_len: usize) {
/// substreams::register_panic_hook();
/// let func = || -> Option<proto::Custom> {
/// let blk: eth::Block = substreams::proto::decode_ptr(blk_ptr, blk_len).unwrap();
/// {
/// unimplemented!("do something");
/// }
/// };
/// let result = func();
/// if result.is_none() {
/// panic!("None returned from map function")
/// }
/// substreams::output(result.unwrap());
/// }
/// ```
///
/// ## Usage with T
///
///
/// ```rust
/// # mod eth { pub type Block = (); }
/// # mod proto { pub type Custom = (); }
///
/// #[substreams::handlers::map]
/// fn map_handler(blk: eth::Block) -> proto::Custom {
/// unimplemented!("do something");
/// }
/// ```
///
/// Equivalent code not using `#[substreams::handlers::map]`
///
/// ```rust
/// # mod eth { pub type Block = (); }
/// # mod proto {
/// # use std::todo;
/// # #[derive(Debug)]
/// # pub struct Custom(u8);
/// # impl prost::Message for Custom {
/// # fn encode_raw(&self, _: &mut impl prost::bytes::BufMut) where Self: Sized { todo!() }
/// # fn merge_field(&mut self, _: u32, _: prost::encoding::WireType, _: &mut impl prost::bytes::Buf, _: prost::encoding::DecodeContext) -> Result<(), prost::DecodeError> where Self: Sized { todo!() }
/// # fn encoded_len(&self) -> usize { todo!() }
/// # fn clear(&mut self) { todo!() }
/// # }
/// # }
///
/// #[no_mangle]
/// pub extern "C" fn map_handler(blk_ptr: *mut u8, blk_len: usize) {
/// substreams::register_panic_hook();
/// let func = || -> proto::Custom {
/// let blk: eth::Block = substreams::proto::decode_ptr(blk_ptr, blk_len).unwrap();
/// {
/// unimplemented!("do something");
/// }
/// };
/// let result = func();
/// substreams::output(result);
/// }
/// ```
pub use map;
/// Marks function to setup substreams store handler WASM boilerplate
/// ## Usage
///
///
/// ```rust
/// use substreams::prelude::{StoreGet, StoreNew};
/// use substreams::{log, store};
/// use substreams::store::{StoreGetProto, StoreAddInt64};
/// # mod proto {
/// # pub type Custom = ();
/// # #[derive(Clone, PartialEq, ::prost::Message)]
/// # pub struct Pairs {}
/// # #[derive(Clone, PartialEq, ::prost::Message)]
/// # pub struct Tokens {}
/// # }
///
/// #[substreams::handlers::store]
/// fn build_nft_state(data: proto::Custom, s: StoreAddInt64, pairs: StoreGetProto<proto::Pairs>, tokens: StoreGetProto<proto::Tokens>) {
/// unimplemented!("do something");
/// }
/// ```
///
/// Equivalent code not using `#[substreams::handlers::store]`
///
/// ```rust
/// use substreams::prelude::StoreNew;
/// use substreams::{log, store};
/// use substreams::store::StoreGetProto;
/// # mod proto {
/// # pub type Custom = ();
/// # #[derive(Clone, PartialEq, ::prost::Message)]
/// # pub struct Pairs {}
/// # #[derive(Clone, PartialEq, ::prost::Message)]
/// # pub struct Tokens {}
/// # }
///
/// #[no_mangle]
/// pub extern "C" fn build_nft_state(data_ptr: *mut u8, data_len: usize, pairs_idx: u32, tokens_idx: u32) {
/// substreams::register_panic_hook();
/// let data: proto::Custom = substreams::proto::decode_ptr(data_ptr, data_len).unwrap();
/// let pairs: StoreGetProto<proto::Pairs> = store::StoreGet::new(pairs_idx);
/// let tokens: StoreGetProto<proto::Tokens> = store::StoreGet::new(tokens_idx);
/// let s: store::StoreAddInt64 = store::StoreAddInt64::new();
/// {
/// unimplemented!("do something");
/// }
/// }
/// ```
pub use store;