Skip to content

Commit a98a04f

Browse files
committed
document all burnchain_op supported paylods
1 parent 8caa0aa commit a98a04f

File tree

1 file changed

+38
-3
lines changed

1 file changed

+38
-3
lines changed

docs/event-dispatcher.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ When a transaction in the `/new_block` payload has a `raw_tx` field of `"0x00"`,
222222
More details on burnchain operations can be found in [SIP-007](https://github.com/stacksgov/sips/blob/main/sips/sip-007/sip-007-stacking-consensus.md#stx-operations-on-bitcoin).
223223

224224
#### Example JSON values for `burnchain_op` field:
225-
* **TransferStx:**
225+
* **transfer-stx:**
226226
```json
227227
{
228228
"transfer_stx": {
@@ -246,7 +246,7 @@ More details on burnchain operations can be found in [SIP-007](https://github.co
246246
}
247247
```
248248

249-
* **StackStx:**
249+
* **stack-stx:**
250250
```json
251251
{
252252
"stack_stx": {
@@ -266,7 +266,7 @@ More details on burnchain operations can be found in [SIP-007](https://github.co
266266
}
267267
```
268268

269-
* **DelegateStx:**
269+
* **delegate-stx:**
270270
```json
271271
{
272272
"delegate_stx": {
@@ -291,6 +291,41 @@ More details on burnchain operations can be found in [SIP-007](https://github.co
291291
}
292292
```
293293

294+
* **pre-stx:**
295+
```json
296+
{
297+
"pre_stx": {
298+
"burn_block_height": 10,
299+
"burn_header_hash": "1010101010101010101010101010101010101010101010101010101010101010",
300+
"output": "ST2QKZ4FKHAH1NQKYKYAYZPY440FEPK7GZ1R5HBP2",
301+
"burn_txid": "0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a",
302+
"vtxindex": 10
303+
}
304+
}
305+
```
306+
307+
* **vote-for-aggregate-key:**
308+
```json
309+
{
310+
"vote_for_aggregate_key": {
311+
"burn_block_height": 10,
312+
"burn_header_hash": "1010101010101010101010101010101010101010101010101010101010101010",
313+
"aggregate_key": "0x0000000000000000000000000000000000000000000000000000000000000000",
314+
"reward_cycle": 10,
315+
"round": 10,
316+
"sender": {
317+
"address": "ST2QKZ4FKHAH1NQKYKYAYZPY440FEPK7GZ1R5HBP2",
318+
"address_hash_bytes": "0xaf3f91f38aa21ade7e9f95efdbc4201eeb4cf0f8",
319+
"address_version": 26
320+
},
321+
"signer_index": 10,
322+
"signer_key": "0x0000000000000000000000000000000000000000000000000000000000000000",
323+
"burn_txid": "0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a",
324+
"vtxindex": 10
325+
}
326+
}
327+
```
328+
294329
### `POST /new_burn_block`
295330

296331
Delivers information about burnchain blocks as their sortitions are processed.

0 commit comments

Comments
 (0)