1
- # snek
1
+ # Adder
2
2
3
3
<div align =" center " >
4
- <img src="./assets/snek -logo-with-text-horizontal.png" alt="snek Logo" width="640">
4
+ <img src="./assets/adder -logo-with-text-horizontal.png" alt="Adder Logo" width="640">
5
5
</div >
6
6
7
- snek is a tool for tailing the Cardano blockchain and emitting events for each
7
+ Adder is a tool for tailing the Cardano blockchain and emitting events for each
8
8
block and transaction that it sees.
9
9
10
10
## How it works
@@ -101,14 +101,14 @@ using Uber's `Zap` logging library.
101
101
102
102
## Configuration
103
103
104
- snek supports multiple configuration methods for versatility: commandline arguments, YAML config file,
104
+ Adder supports multiple configuration methods for versatility: commandline arguments, YAML config file,
105
105
and environment variables (in that order).
106
106
107
107
You can get a list of all available commandline arguments by using the ` -h ` /` -help ` flag.
108
108
109
109
``` bash
110
- $ ./snek -h
111
- Usage of snek :
110
+ $ ./adder -h
111
+ Usage of adder :
112
112
-config string
113
113
path to config file to load
114
114
-input string
@@ -149,15 +149,15 @@ plugins:
149
149
150
150
## Filtering
151
151
152
- snek supports filtering events before they are output using multiple criteria. An event must match all configured filters to be emitted.
152
+ Adder supports filtering events before they are output using multiple criteria. An event must match all configured filters to be emitted.
153
153
Each filter supports specifying multiple possible values separated by commas. When specifying multiple values for a filter, only one of
154
154
the values specified must match an event.
155
155
156
156
You can get a list of all available filter options by using the ` -h`/`-help` flag.
157
157
158
158
` ` ` bash
159
- $ ./snek -h
160
- Usage of snek :
159
+ $ ./adder -h
160
+ Usage of adder :
161
161
...
162
162
-filter-address string
163
163
specifies address to filter on
@@ -178,13 +178,13 @@ Multiple filter options can be used together, and only events matching all filte
178
178
179
179
` ` ` bash
180
180
export INPUT_CHAINSYNC_NETWORK=preview
181
- ./snek
181
+ ./adder
182
182
` ` `
183
183
184
184
Alternatively using equivalent commandline options :
185
185
186
186
` ` ` bash
187
- ./snek \
187
+ ./adder \
188
188
-input-chainsync-network preview
189
189
` ` `
190
190
@@ -197,7 +197,7 @@ in Docker.
197
197
` ` ` bash
198
198
docker run --rm -ti \
199
199
-v node-ipc:/node-ipc \
200
- ghcr.io/blinklabs-io/snek :main
200
+ ghcr.io/blinklabs-io/adder :main
201
201
` ` `
202
202
203
203
# ## Filtering
@@ -207,59 +207,59 @@ docker run --rm -ti \
207
207
Only output `chainsync.transaction` event types
208
208
209
209
` ` ` bash
210
- $ snek -filter-type chainsync.transaction
210
+ $ adder -filter-type chainsync.transaction
211
211
` ` `
212
212
213
213
Only output `chainsync.rollback` and `chainsync.block` event types
214
214
215
215
` ` ` bash
216
- $ snek -filter-type chainsync.transaction,chainsync.block
216
+ $ adder -filter-type chainsync.transaction,chainsync.block
217
217
` ` `
218
218
219
219
# ### Filtering on asset policy
220
220
221
221
Only output transactions involving an asset with a particular policy ID
222
222
223
223
` ` ` bash
224
- $ snek -filter-type chainsync.transaction -filter-policy 13aa2accf2e1561723aa26871e071fdf32c867cff7e7d50ad470d62f
224
+ $ adder -filter-type chainsync.transaction -filter-policy 13aa2accf2e1561723aa26871e071fdf32c867cff7e7d50ad470d62f
225
225
` ` `
226
226
227
227
# ### Filtering on asset fingerprint
228
228
229
229
Only output transactions involving a particular asset
230
230
231
231
` ` ` bash
232
- $ snek -filter-type chainsync.transaction -filter-asset asset108xu02ckwrfc8qs9d97mgyh4kn8gdu9w8f5sxk
232
+ $ adder -filter-type chainsync.transaction -filter-asset asset108xu02ckwrfc8qs9d97mgyh4kn8gdu9w8f5sxk
233
233
` ` `
234
234
235
235
# ### Filtering on a policy ID and asset fingerprint
236
236
237
237
Only output transactions involving both a particular policy ID and a particular asset (which do not need to be related)
238
238
239
239
` ` ` bash
240
- $ snek -filter-type chainsync.transaction -filter-asset asset108xu02ckwrfc8qs9d97mgyh4kn8gdu9w8f5sxk -filter-policy 13aa2accf2e1561723aa26871e071fdf32c867cff7e7d50ad470d62f
240
+ $ adder -filter-type chainsync.transaction -filter-asset asset108xu02ckwrfc8qs9d97mgyh4kn8gdu9w8f5sxk -filter-policy 13aa2accf2e1561723aa26871e071fdf32c867cff7e7d50ad470d62f
241
241
` ` `
242
242
243
243
# ### Filtering on an address
244
244
245
245
Only output transactions with outputs matching a particular address
246
246
247
247
` ` ` bash
248
- $ snek -filter-type chainsync.transaction -filter-address addr1qyht4ja0zcn45qvyx477qlyp6j5ftu5ng0prt9608dxp6l2j2c79gy9l76sdg0xwhd7r0c0kna0tycz4y5s6mlenh8pq4jxtdy
248
+ $ adder -filter-type chainsync.transaction -filter-address addr1qyht4ja0zcn45qvyx477qlyp6j5ftu5ng0prt9608dxp6l2j2c79gy9l76sdg0xwhd7r0c0kna0tycz4y5s6mlenh8pq4jxtdy
249
249
` ` `
250
250
251
251
# ### Filtering on a stake address
252
252
253
253
Only output transactions with outputs matching a particular stake address
254
254
255
255
` ` ` bash
256
- $ snek -filter-type chainsync.transaction -filter-address stake1u9f9v0z5zzlldgx58n8tklphu8mf7h4jvp2j2gddluemnssjfnkzz
256
+ $ adder -filter-type chainsync.transaction -filter-address stake1u9f9v0z5zzlldgx58n8tklphu8mf7h4jvp2j2gddluemnssjfnkzz
257
257
` ` `
258
258
259
259
# ## Push notifications
260
260
261
- The example shows how push notification output can be used with filtering options. In this example, push notifications will be sent to the block events. Push notifications will be sent to the specified project_id in the serviceAccount.json file. Please refer to https://github.com/blinklabs-io/snek -mobile for more details on how to send push notifications to snek -mobile.
261
+ The example shows how push notification output can be used with filtering options. In this example, push notifications will be sent to the block events. Push notifications will be sent to the specified project_id in the serviceAccount.json file. Please refer to https://github.com/blinklabs-io/adder -mobile for more details on how to send push notifications to adder -mobile.
262
262
263
263
` ` ` bash
264
- $ snek -filter-type chainsync.block -output push -output-push-serviceAccountFilePath /path/to/serviceAccount.json
264
+ $ adder -filter-type chainsync.block -output push -output-push-serviceAccountFilePath /path/to/serviceAccount.json
265
265
` ` `
0 commit comments