Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ligo events example #262

Merged
merged 3 commits into from
Jan 19, 2024
Merged

Ligo events example #262

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d529da4
adding Ligo example for events
zamrokk Jan 11, 2024
7e05763
Capitalize JsLIGO
timothymcmackin Jan 12, 2024
e209c69
correct language annotation for ligo
timothymcmackin Jan 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 59 additions & 42 deletions docs/smart-contracts/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,27 @@ The event can also include these optional fields:
Each high-level language has its own way of creating events.
The compiled Michelson code uses the `EMIT` command to emit the event.

For example, this SmartPy contract stores a number and emits events when that amount changes:
For example, this contract stores a number and emits events when that amount changes:

JsLIGO

```ligolang
type storage = int;

@entry
const add = (addAmount: int, s: storage): [list<operation>, storage] =>
[list([Tezos.emit("%add",{ source: Tezos.get_source(), addAmount: addAmount })]),
s + addAmount
];

@entry
const reset = (_: unit, s: storage): [list<operation>, storage] =>
[list([Tezos.emit("%reset",{ source: Tezos.get_source(), previousValue: s })]),
0
];
```

SmartPy

```python
import smartpy as sp
Expand Down Expand Up @@ -82,7 +102,7 @@ Tezos.setStreamProvider(
Tezos.getFactory(PollingSubscribeProvider)({
shouldObservableSubscriptionRetry: true,
pollingIntervalMilliseconds: 1500,
}),
})
);

try {
Expand All @@ -91,7 +111,7 @@ try {
address: contractAddress,
});

sub.on("data", console.log);
sub.on('data', console.log);
} catch (e) {
console.log(e);
}
Expand All @@ -103,50 +123,47 @@ The event data is in Michelson format, so an event from the `reset` entrypoint o

```json
{
"opHash": "onw8EwWVnZbx2yBHhL72ECRdCPBbw7z1d5hVCJxp7vzihVELM2m",
"blockHash": "BM1avumf2rXSFYKf4JS7YJePAL3gutRJwmazvqcSAoaqVBPAmTf",
"level": 4908983,
"kind": "event",
"source": "KT1AJ6EjaJHmH6WiExCGc3PgHo3JB5hBMhEx",
"nonce": 0,
"type": {
"prim": "pair",
"args": [
{
"prim": "int",
"annots": [
"%previousValue"
]
},
{
"prim": "address",
"annots": [
"%source"
]
}
]
},
"tag": "reset",
"payload": {
"prim": "Pair",
"args": [
{
"int": "17"
},
{
"bytes": "000032041dca76bac940b478aae673e362bd15847ed8"
}
]
},
"result": {
"status": "applied",
"consumed_milligas": "100000"
}
"opHash": "onw8EwWVnZbx2yBHhL72ECRdCPBbw7z1d5hVCJxp7vzihVELM2m",
"blockHash": "BM1avumf2rXSFYKf4JS7YJePAL3gutRJwmazvqcSAoaqVBPAmTf",
"level": 4908983,
"kind": "event",
"source": "KT1AJ6EjaJHmH6WiExCGc3PgHo3JB5hBMhEx",
"nonce": 0,
"type": {
"prim": "pair",
"args": [
{
"prim": "int",
"annots": ["%previousValue"]
},
{
"prim": "address",
"annots": ["%source"]
}
]
},
"tag": "reset",
"payload": {
"prim": "Pair",
"args": [
{
"int": "17"
},
{
"bytes": "000032041dca76bac940b478aae673e362bd15847ed8"
}
]
},
"result": {
"status": "applied",
"consumed_milligas": "100000"
}
}
```

Note that the address field is returned as a byte value.
To convert the bytes to an address, use the `encodePubKey` function in `@taquito/utils`.

<!-- I reported this to the Taquito people and they are asking the core team if the RPC node could return the address as an address instead of as bytes. -->

You can see the complete content of the event operation by looking up the operation hash in a block explorer.
Expand Down
Loading