stellar-base - npm Package Versions

v11.0.0

Note: This version is (still) compatible with Protocol 20. Most people should be unaffected by the technically-breaking changes below and can treat this more like a v10.0.3 patch release.

Breaking Changes

• Starting from v10.0.0-beta.0, we set BigNumber.DEBUG in bignumber.js to true internally, which affects all code using BigNumber. This behavior has been fixed and only affects this library: globally, BigNumber.DEBUG now remains at its default setting (i.e. disabled). This is technically a breaking behavior change and is released as such (#729).

Fixed

• Dependencies have been updated to their latest compatible versions (#726, #730).

v10.0.2

Fixed

• The contractId field is correctly omitted from humanized events when it wasn't present in the structure (#721).
• Misc. outdated or incorrect documentation has been updated (#723, #720).
• Dependencies have been updated (#724).

v10.0.1

Fixed

• The TypeScript definition for Asset.contractId() now includes a missing parameter (the networkPassphrase changes the ID for a contract; #718).

v10.0.0: Protocol 20 Stable Release

Breaking Changes

• The new minimum supported Node version is Node 18.
• XDR has been upgraded to the latest stable version (stellar-xdr@6a620d1). This is mostly renames, but it includes the following relevant breaking changes (#704):
  • Operation.bumpFootprintExpiration is now extendFootprintTtl and its ledgersToExpire field is now named extendTo, but it serves the same purpose.
  • In TypeScript, the Operation.BumpFootprintExpiration is now Operation.ExtendFootprintTTL
  • xdr.ContractExecutable.contractExecutableToken is now contractExecutableStellarAsset
  • xdr.SorobanTransactionData.refundableFee is now resourceFee
  • In turn, SorobanDataBuilder.setRefundableFee is now setResourceFee
  • This new fee encompasses the entirety of the Soroban-related resource fees. Note that this is distinct from the "network-inclusion" fee that you would set on your transaction (i.e. TransactionBuilder(..., { fee: ... })).

• Contract.getFootprint() now only returns a single result: the ledger key of the deployed instance for the given ID, because the key for the code entry was incorrect (it should not be the ID but rather the WASM hash, which is not calculatable w/o network access) (#709).

v10.0.0-beta.4

Fixed

• You can now correctly clone transactions (TransactionBuilder.cloneFrom) with large sequence numbers (#711).

v10.0.0-beta.3

Fixed

• Fixes a bug where authorizeEntry might perform a no-op when it shouldn't (#701).
• Fixes a TypeScript bug where Memo.hash did not accept a Buffer (#698).
• Upgrades a transient dependency for security (#296).

v10.0.0-beta.2

Breaking Changes

• The wrappers around multi-party authorization have changed (#678):

• authorizeEntry has been added to help sign auth entries in-place
• the signature for authorizeInvocation has changed: it now offers a callback approach by default and requires slightly different parameters
• buildAuthEntry, buildAuthEnvelope, and authorizeInvocationCallback have been removed

Fixed

• The TypeScript definitions for XDR schemas now point to the current protocol rather than vNext (#694).
• Misc. dependencies have been updated to their latest versions (#694).

v10.0.0-beta.1

Fixed

• nativeToScVal now allows anything to be passed to the opts.type specifier. Previously, it was only integer types (#691).
• Contract.call() now produces valid Operation XDR (#692).

v10.0.0-beta.0: Protocol 20

Breaking Changes

• Node 16 is the new minimum version to use the SDKs.
• The XDR has been massively overhauled to support Soroban in Protocol 20, which 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

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
• The TransactionBuilder now has a cloneFrom(tx, opts) constructor method to create an instance from an existing transaction, also allowing parameter overrides via opts.
• The following are convenience methods for building out certain types of smart contract-related structures:
  • buildInvocationTree and walkInvocationTree are both ways to visualize invocation calling trees better
  • authorizeInvocation helps multiple parties sign invocation calling trees
  • humanizeEvents helps make diagnostic events more readable
• We've added a GHA to track bundle size changes as PRs are made. This protocol upgrade adds +18% to the final, minified bundle size which is significant but acceptable given the size of the upgrade.

Fixes

• Improves the error messages when passing invalid amounts to deposit and withdraw operations (#679).