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

Automatically decode XDR structures in simulation responses #127

Merged
merged 9 commits into from
Aug 16, 2023
Merged

Automatically decode XDR structures in simulation responses #127

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0f996a5
WIP: structs instead of base64
Shaptic Aug 14, 2023
e2e86ec
Add changelog, fixup usage bug
Shaptic Aug 14, 2023
ec361ca
Add changelog entry
Shaptic Aug 14, 2023
6657f00
Refactor code to do conversion separately
Shaptic Aug 14, 2023
4d635a2
Add test cases for new behavior
Shaptic Aug 14, 2023
a928cd8
Add shorthand and run linter
Shaptic Aug 14, 2023
5734c75
Progress on fixing tests to match new signatures
Shaptic Aug 15, 2023
c552cfc
Fixup cloning so that tests pass
Shaptic Aug 16, 2023
14ed94e
Linting fixup
Shaptic Aug 16, 2023
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
Prev Previous commit
Next Next commit
Add changelog entry
  • Loading branch information
@Shaptic
Shaptic committed Aug 14, 2023
commit ec361caae6e5eab2f7b66b23c719d59d884bdfe6
5 changes: 4 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,15 @@ A breaking change should be clearly marked in this log.


### Breaking Changes
* The RPC response schemas for simulation have been upgraded to parse the base64-encoded XDR automatically. Succinctly:
* The RPC response schemas for simulation have been upgraded to parse the base64-encoded XDR automatically. The full interface changes are in the pull request ([https://github.com/stellar/js-soroban-client/pull/127](#127)), but succinctly:
- `SimulateTransactionResponse` -> `RawSimulateTransactionResponse`
- `SimulateHostFunctionResult` -> `RawSimulateHostFunctionResult`
- Now, `SimulateTransactionResponse` and `SimulateHostFunctionResult` now include the full, decoded XDR structures instead of raw, base64-encoded strings for the relevant fields (e.g. `SimulateTransactionResponse.transactionData` is now an instance of `SorobanDataBuilder`, `events` is now an `xdr.DiagnosticEvent[]` [try out `humanizeEvents` for a friendlier representation of this field])
- The `SimulateTransactionResponse.results[]` field has been moved to `SimulateTransactionResponse.result?`, since it will always be exactly zero or one result.

Not all schemas have been broken in this manner in order to facilitate user feedback on this approach. Please add your :+1: or :-1: to [#128](https://github.com/stellar/js-soroban-client/issues/128) to provide your perspective on whether or not we should do this for the other response schemas.


## v0.10.1

### Fixed
Expand Down