Prepare v0.11.0 for release

[Shaptic]

Release Notes

v0.11.0 (diff)

Fixed

• The SimulateTransactionResponse's error field now has the correct type (that is, string: #123).
• Many irrelevant or unused dependencies have been eliminated (such as eventsource, lodash, and others), lowering overall bundle size (#126).

Added

• A new ContractSpec class to facilitate building native JavaScript structures from custom contract types. Given a specification for the data structure (i.e. xdr.ScSpecEntry[]), it will interpret the values via the specified type (#115).

Breaking Changes

• The minimum supported NodeJS version is now Node 16.
• Server.prepareTransaction now returns a TransactionBuilder instance rather than an immutable Transaction, in order to facilitate modifying your transaction after assembling it alongside the simulation response (#127).
  • The intent is to avoid cloning the transaction again (via TransactionBuilder.cloneFrom) if you need to modify parameters such as the storage access footprint.
  • To migrate your code, just call .build() on the return value.
• The RPC response schemas for simulation (see Server.simulateTransaction()) have been upgraded to parse the base64-encoded XDR automatically. The full interface changes are in the pull request (#127), but succinctly:
  • SimulateTransactionResponse -> RawSimulateTransactionResponse
  • SimulateHostFunctionResult -> RawSimulateHostFunctionResult
  • Now, SimulateTransactionResponse and SimulateHostFunctionResult 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 there will always be exactly zero or one result.
• The GetTransactionStatus is now an enum with actual values rather than a type (#129).
• The RPC response schemas for retrieving transaction details (Server.getTransaction()) have been upgraded to parse the base64-encoded XDR automatically. The full interface changes are in the pull request (#129), but succinctly:
  • GetTransactionResponse -> RawGetTransactionResponse
  • GetTransactionResponse is now one of GetSuccessfulTransactionResponse | GetFailedTransactionResponse | GetMissingTransactionResponse, which gives proper typing to the interface depending on the response's status field.
  • All of the *Xdr properties are now full, decoded XDR structures.
  • There is a new returnValue field which is a decoded xdr.ScVal, present iff the transaction was a successful Soroban function invocation.

Not all schemas have been broken in this manner in order to facilitate user feedback on this approach. Please add your 👍 or 👎 to #128 to vote on whether or not we should do this for the other response schemas.

[socket-security]

Updated and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Packages	Version	New capabilities	Transitives	Size	Publisher
prettier	2.8.8...3.0.2	filesystem, environment	+0/-0	8.46 MB	prettier-bot
eslint-config-prettier	8.10.0...9.0.0	environment	+5/-5	3.68 MB	lydell
@babel/core	7.22.9...7.22.10	None	+10/-13	8.87 MB	nicolo-ribaudo
@babel/preset-env	7.22.9...7.22.10	None	+26/-31	10.2 MB	nicolo-ribaudo
@babel/cli	7.22.9...7.22.10	None	+11/-15	8.99 MB	nicolo-ribaudo
@babel/eslint-plugin	7.22.5...7.22.10	None	+17/-20	12.7 MB	nicolo-ribaudo
eslint	8.46.0...8.47.0	None	+4/-4	3.66 MB	eslintbot
eslint-plugin-prettier	4.2.1...5.0.0	None	+24/-6	12.6 MB	jounqin
@babel/eslint-parser	7.22.9...7.22.10	None	+16/-19	12.7 MB	nicolo-ribaudo
eslint-plugin-import	2.28.0...2.28.1	None	+8/-9	5.05 MB	ljharb

🚮 Removed packages: @definitelytyped/[email protected], @types/[email protected], @types/[email protected], @types/[email protected], @types/[email protected], @types/[email protected], @typescript-eslint/[email protected], [email protected], [email protected], [email protected], [email protected], [email protected]

[Shaptic]

Bundle size changes from v0.10.0:

• soroban-client.js: 1.06 MiB -> 1010 KiB
• soroban-client.min.js 505 KiB -> 499 KiB

[paulbellamy]

bro, why you format everything in a release PR 😩

[sreuland]

does package.json need version=0.11.0 , or maybe that's done at different time of release prep?

[Shaptic]

lol @sreuland I realized this after the fact 🤦 thanks!