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

Add optional flag to parseLogs to throw an error on decoding failure #2043

Merged
merged 3 commits into from
Dec 5, 2022
Merged

Add optional flag to parseLogs to throw an error on decoding failure #2043

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2660422
Add optional flag to parseLogs to throw an error on decoding failure
nicholasgodfreyclarke Jul 7, 2022
38d9f7b
Merge branch 'clarkeni/parseLogs_error' of github.com:nicholasgodfrey…
Nov 28, 2022
9648625
update changelog
Nov 28, 2022
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ The minor version will be incremented upon a breaking change and the patch versi
- lang: Updates `AccountsClose` to make it safe to call manually ([#2209](https://github.com/coral-xyz/anchor/pull/2209))
- lang: Update rust used in the repo version 1.62 ([#2272](https://github.com/coral-xyz/anchor/pull/2272))
- cli: Allow custom cluster config ([#2271](https://github.com/coral-xyz/anchor/pull/2271)).
- ts: Add optional flag to parseLogs to throw an error on decoding failure ([#2043](https://github.com/coral-xyz/anchor/pull/2043))

### Fixes

Expand Down
20 changes: 15 additions & 5 deletions ts/packages/anchor/src/program/event.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,12 +176,16 @@ export class EventParser {
// its emission, thereby allowing us to know if a given log event was
// emitted by *this* program. If it was, then we parse the raw string and
// emit the event if the string matches the event being subscribed to.
public *parseLogs(logs: string[]) {
public *parseLogs(logs: string[], errorOnDecodeFailure: boolean = false) {
const logScanner = new LogScanner(logs);
const execution = new ExecutionContext();
let log = logScanner.next();
while (log !== null) {
let [event, newProgram, didPop] = this.handleLog(execution, log);
let [event, newProgram, didPop] = this.handleLog(
execution,
log,
errorOnDecodeFailure
);
if (event) {
yield event;
}
Expand All @@ -201,14 +205,15 @@ export class EventParser {
// execution stack).
private handleLog(
execution: ExecutionContext,
log: string
log: string,
errorOnDecodeFailure: boolean
): [Event | null, string | null, boolean] {
// Executing program is this program.
if (
execution.stack.length > 0 &&
execution.program() === this.programId.toString()
) {
return this.handleProgramLog(log);
return this.handleProgramLog(log, errorOnDecodeFailure);
}
// Executing program is not this program.
else {
Expand All @@ -218,14 +223,19 @@ export class EventParser {

// Handles logs from *this* program.
private handleProgramLog(
log: string
log: string,
errorOnDecodeFailure: boolean
): [Event | null, string | null, boolean] {
// This is a `msg!` log or a `sol_log_data` log.
if (log.startsWith(PROGRAM_LOG) || log.startsWith(PROGRAM_DATA)) {
const logStr = log.startsWith(PROGRAM_LOG)
? log.slice(PROGRAM_LOG_START_INDEX)
: log.slice(PROGRAM_DATA_START_INDEX);
const event = this.coder.events.decode(logStr);

if (errorOnDecodeFailure && event === null) {
throw new Error(`Unable to decode event ${logStr}`);
}
return [event, null, false];
}
// System log.
Expand Down