v10.0.0

This is the stable Protocol 20 release.

v10.0.0: Protocol 20, Soroban!

Breaking Changes

• The package has been renamed to @stellar/stellar-base!
• Node 18 is the new minimum version to use the SDKs.
• The XDR has been massively overhauled to support Soroban, the new smart contract platform on Stellar, and Protocol 20. This means new operations, data structures, and a transaction format as well as new overlay features (#538).

The core data structure of Soroban is a generic type called an ScVal (smart contract value, which is a union of types that can basically represent anything [numbers, strings, arrays, maps, contract bytecode, etc.]). You can refer to the XDR for details, and you can utilize new APIs to make dealing with these complex values easier:

• nativeToScVal helps convert native types to their closest Soroban equivalent
• scValToNative helps find the closest native JavaScript type(s) corresponding to a smart contract value
• scValToBigInt helps convert numeric ScVals into native bigints
• ScInt and XdrLargeInt help convert to and from bigints to other types and form sized integer types for smart contract usage

There are other XDR structures that have abstractions included for building out or certain types of smart contract-related structures:

• buildInvocationTree and walkInvocationTree are both ways to visualize invocation calling trees better
• authorizeEntry and authorizeInvocation help multiple parties sign invocation calling trees
• humanizeEvents helps make diagnostic events more readable

Added

The following are new APIs to deal with new Soroban constructs:

• Address, which helps manage "smart" addresses in the Soroban context. Addresses there (used for auth and identity purposes) can either be contracts (strkey C...) or accounts (strkey G...). This abstraction helps manage them and distinguish between them easily.
• Contract, which helps manage contract identifiers. The primary purpose is to build invocations of its methods via the generic call(...), but it also provides utilities for converting to an Address or calculating its minimum footprint for state expiration.
• Three new operations have been added related to Soroban transactions:
  • invokeHostFunction for calling contract code
  • bumpFootprintExpiration for extending the state lifetime of Soroban data
  • restoreFootprint for restoring expired, off-chain state back onto the ledger
• The TransactionBuilder now takes a sorobanData parameter (and has a corresponding .setSorobanData() builder method) which primarily describes the storage footprint of a Soroban (that is, which parts of the ledger state [in the form of xdr.LedgerKeys] it plans to read and write as part of the transaction).
  • To facilitate building this out, there's a new SorobanDataBuilder factory to set fields individually
  • It also now has a cloneFrom(tx, opts) constructor method to create an instance from an existing transaction, also allowing parameter overrides via opts.
• We've added a GHA to track bundle size changes as PRs are made.

Fixes

• Improves the error messages when passing invalid amounts to deposit and withdraw operations (#679).
• Fixes a TypeScript bug where Memo.hash did not accept a Buffer (#698).
• Dependencies have been updated to their latest versions.

New Contributors

• @sreuland made their first contribution in #604
• @chadoh made their first contribution in #658
• @jeesunikim made their first contribution in #667

Full Changelog: v9.0.0...v10.0.0