v14.0.0-rc.3

Please refer to the first and second release candidates for a comprehensive changelog in this major version. The following only covers the differences since the second release candidate.

• Fixes a bug in Rpc.Server.getTransaction where either transactionEventsXdr and/or contractEventsXdr may not be present in the new events field (#1186).

Full Changelog: v13.1.0...v14.0.0-rc.2

v14.0.0-rc.2

Please refer to the first release candidate for a comprehensive changelog in this major version. The following only covers the differences since the first release candidate.

Breaking Changes

• The RPC server's getTransaction and getTransactions responses have dropped the events.diagnosticEventsXdr field (#1183):

export interface TransactionEvents {
-  diagnosticEventsXdr: xdr.DiagnosticEvent[];
  transactionEventsXdr: xdr.TransactionEvent[];
}

Fixed

• Fixed type for Horizon streaming endpoints, namely EventSourceOptions.onmessage now extends CollectionPage (#1100).

Full Changelog: v14.0.0-rc.1...v14.0.0-rc.2

v14.0.0-rc.1

Breaking Changes

• This package requires Node 20.
• XDR has been upgraded to support Protocol 23, please refer to the @stellar/stellar-base release notes for details and other breaking changes.
• Deprecated: getTransaction and getTransactions top-level diagnosticEventsXdr field.

Added

• The Horizon API's BalanceChange object for operations now optionally has details about muxed information if the invocation involved a muxed destination address:

export type MuxedIdType = "uint64" | "string" | "bytes";
export interface BalanceChange {
  // ...
  destination_muxed_id_type?: MuxedIdType;
  destination_muxed_id?: string;
}

• The RPC server's getTransaction and getTransactions responses now include a top-level events object containing a disjoint breakdown of the events:

export interface TransactionEvents {
  diagnosticEventsXdr: xdr.DiagnosticEvent[];
  transactionEventsXdr: xdr.TransactionEvent[];
  contractEventsXdr: xdr.ContractEvent[][];
}

• The RPC server's getEvents now includes retention state information:

export interface GetEventsResponse {
  // ...
  oldestLedger: number;
  latestLedgerCloseTime: string;
  oldestLedgerCloseTime: string;
}

• The RPC server's simulateTransaction method now includes an optional authMode parameter to specify the type of authorization to simulate:

export type SimulationAuthMode = "enforce" | "record" | "record_allow_nonroot";

Fixed

• Add muxed payments support for PaymentOperationResponse type (#1149).

New Contributors

• @luchenhan made their first contribution in #1129

Full Changelog: v13.1.0...v14.0.0-rc.1

v13.3.0

Added

• Add includeFailed to PaymentCallBuilder for including failed transactions in calls (#1168).

Fixed

• Ensure that rpc.Api.GetTransactionsResponse.transactions is always a valid array (#1162).

Contributors

@fnando @overcat

Full Changelog: v13.2.0...v13.3.1

v13.2.0

Added

• Support passing in an optional options.address to the contract.Client.deploy method (#1158).

Fixed

• Extend support for parsing contract specifications in environments that don't have WebAssembly compilers (#1157).
• Add missing to_muxed and to_muxed_id to Horizon’s PaymentOperationResponse (#1149).
• Upgrade @stellar/stellar-base dependency to latest version (#1159).

Contributors

@chadoh @kknownymouss @jeesunikim @kalepail @Shaptic

Full Changelog: v13.1.0...v13.2.0

v13.1.0

Added

• Added Horizon.Server.root to obtain information from the Horizon root endpoint (#1122).

Fixed

• When using a friendbot that points to a Horizon instance that has ledger metadata disabled, you can no longer extract the account sequence from the response. Instead, we hit RPC directly (#1107).
• rpc.Server.getEvents() now correctly returns the cursor field at the top-level response (#1124).

Contributors

• @Shaptic, @overcat
• @nnsW3 made their first contribution in #1083

Full Changelog: v13.0.0...v13.1.0

v13.0.0: Protocol 22

This is a direct re-tag of rc.2 with the only change being an upgrade to the stellar-base library to incorporate a patch release. Nonetheless, the entire changelog from the prior major version here is replicated for a comprehensive view on what's broken, added, and fixed.

Breaking Changes

• We stopped supporting Node 18 explicitly a while ago, but now the Babelification of the codebase will transform to Node 18 instead of 16.

TypeScript Bindings: the contract module.

• contract.AssembledTransaction#signAuthEntries now takes an address instead of a publicKey. This brings the API more inline with its actual functionality: It can be used to sign all the auth entries for a particular address, whether that is the address of an account (public key) or a contract. (#1044).
• The ClientOptions.signTransaction type has been updated to reflect the latest SEP-43 protocol, which matches the latest major version of Freighter and other wallets. It now accepts address, submit, and submitUrl options, and it returns a promise containing the signedTxXdr and the signerAddress. It now also returns an Error type if an error occurs during signing.
  • basicNodeSigner has been updated to reflect this new type.
• ClientOptions.signAuthEntry type has been updated to reflect the SEP-43 protocol, which returns a promise containing the signerAddress in addition to the signAuthEntry that was returned previously. It also can return an Error type.
• SentTransaction.init and new SentTransaction now take one (1) argument instead of two (2). The first argument had previously been deprecated and ignored. To update:

-SentTransaction(nonsense, realStuff)
+SentTransaction(realStuff)
-new SentTransaction(nonsense, realStuff)
+new SentTransaction(realStuff)

Server APIs: the rpc and Horizon modules.

• Deprecated RPC APIs have been removed (#1084):
  • simulateTransaction's cost field is removed
  • rpc.Server.getEvents's pagingToken field is deprecated, use cursor instead
• Deprecated Horizon APIs have been removed (deprecated since v10.0.1, ):
  • removed fields transaction_count, base_fee, and base_reserve
  • removed fields num_accounts and amount from assets
• The SorobanRpc import, previously deprecated, has been removed. You can import rpc instead:

-import { SorobanRpc } from '@stellar/stellar-sdk'
+import { rpc } from '@stellar/stellar-sdk'
// alternatively, you can also import from the `rpc` entrypoint:
import { Server } from '@stellar/stellar-sdk/rpc'

Added

TypeScript Bindings: the contract module.

• contract.Client now has a static deploy method that can be used to deploy a contract instance from an existing uploaded/"installed" Wasm hash. The first arguments to this method are the arguments for the contract's __constructor method in accordance with CAP-42 (#1086). For example, using the increment test contract as modified in https://github.com/stellar/soroban-test-examples/pull/2/files#diff-8734809100be3803c3ce38064730b4578074d7c2dc5fb7c05ca802b2248b18afR10-R45:

const tx = await contract.Client.deploy(
  { counter: 42 },
  {
    networkPassphrase,
    rpcUrl,
    wasmHash: uploadedWasmHash,
    publicKey: someKeypair.publicKey(),
    ...basicNodeSigner(someKeypair, networkPassphrase),
  },
);
const { result: client } = await tx.signAndSend();
const t = await client.get();
expect(t.result, 42);

• contract.AssembledTransaction#signAuthEntries now allows you to override authorizeEntry. This can be used to streamline novel workflows using cross-contract auth. (#1044).

Server modules: the rpc, Horizon, and stellartoml modules.

• Horizon.ServerApi now has an EffectType exported so that you can compare and infer effect types directly (#1099).
• Horizon.ServerApi.Trade type now has a type_i field for type inference (#1099).
• All effects now expose their type as an exact string (#947).
• stellartoml.Resolver.resolve now has a allowedRedirects option to configure the number of allowed redirects to follow when resolving a stellar toml file.
• rpc.Server.getEvents now returns a cursor field that matches pagingToken and id
• rpc.Server.getTransactions now returns a txHash field
• rpc.Server has two new methods:
  • pollTransaction to retry transaction retrieval ([#1092]#1092), and
  • getSACBalance to fetch the balance of a built-in Stellar Asset Contract token held by a contract (#1046), returning this schema:

export interface BalanceResponse {
  latestLedger: number;
  /** present only on success, otherwise request malformed or no balance */
  balanceEntry?: {
    /** a 64-bit integer */
    amount: string;
    authorized: boolean;
    clawback: boolean;
    lastModifiedLedgerSeq?: number;
    liveUntilLedgerSeq?: number;
  };
}

New bundles without dependencies

• You can now build the browser bundle without various dependencies:
  • Set USE_AXIOS=false to build without the axios dependency: this will build stellar-sdk-no-axios.js and stellar-sdk-no-axios.min.js in the dist/ directory, or just run yarn build:browser:no-axios to generate these files.
  • You can import Node packages without the axios dependency via @stellar/stellar-sdk/no-axios. For Node environments that don't support modern imports, use @stellar/stellar-sdk/lib/no-axios/index.
  • Set USE_EVENTSOURCE=false to build without the eventsource dependency: this will build stellar-sdk-no-eventsource.js and stellar-sdk-no-eventsource.min.js in the dist/ directory, or just run yarn build:browser:no-eventsource to generate these files.
  • You can import Node packages without the eventsource dependency via @stellar/stellar-sdk/no-eventsource. For Node.js environments that don't support modern imports, use @stellar/stellar-sdk/lib/no-eventsource/index.
  • To use a minimal build without both Axios and EventSource, use stellar-sdk-minimal.js for the browser build and import from @stellar/stellar-sdk/minimal for the Node package.

Fixed

• contract.AssembledTransaction#nonInvokerSigningBy now correctly returns contract addresses, in instances of cross-contract auth, rather than throwing an error. sign will ignore these contract addresses, since auth happens via cross-contract call (#1044).
• buildInvocationTree now correctly handles V2 contract creation and displays constructor args (js-stellar-base#785).

v13.0.0-rc.2

Breaking Changes

• The ClientOptions.signTransaction type has been updated to reflect the latest SEP-43 protocol, which matches the latest major version of Freighter and other wallets. It now accepts address, submit, and submitUrl options, and it returns a promise containing the signedTxXdr and the signerAddress. It now also returns an Error type if an error occurs during signing.
  • basicNodeSigner has been updated to reflect the new type.
• ClientOptions.signAuthEntry type has also been updated to reflect the SEP-43 protocol, which also returns a promise containing the signerAddress in addition to the signAuthEntry that was returned previously. It also can return an Error type.

Added

• contract.Client now has a static deploy method that can be used to deploy a contract instance from an existing uploaded/"installed" Wasm hash. The first arguments to this method are the arguments for the contract's __constructor method in accordance with CAP-42 (#1086).

For example, using the increment test contract as modified in https://github.com/stellar/soroban-test-examples/pull/2/files#diff-8734809100be3803c3ce38064730b4578074d7c2dc5fb7c05ca802b2248b18afR10-R45:

  const tx = await contract.Client.deploy(
    { counter: 42 },
    {
      networkPassphrase,
      rpcUrl,
      wasmHash: uploadedWasmHash,
      publicKey: someKeypair.publicKey(),
      ...basicNodeSigner(someKeypair, networkPassphrase),
    },
  );
  const { result: client } = await tx.signAndSend();
  const t = await client.get();
  expect(t.result, 42);

• Horizon.ServerApi now has an EffectType exported so that you can compare and infer effect types directly (#1099).
• Horizon.ServerApi.Trade type now has a type_i field for type inference.
• All effects now expose their type as an exact string (#947).
• stellartoml-Resolver.resolve now has a allowedRedirects option to configure the number of allowed redirects to follow when resolving a stellar toml file.

v13.0.0-rc.1: Protocol 22

Breaking Changes

• Deprecated RPC APIs have been removed (#1084):

  • simulateTransaction's cost field is removed
  • getEvents returns a cursor field that matches pagingToken and id
  • getTransactions returns a txHash field

• Horizon Server API types: removed fields transaction_count, base_fee, and base_reserve (deprecated since v10.0.1)

• SentTransaction.init and new SentTransaction now take one (1) argument instead of two (2). The first argument had previously been deprecated and ignored. To update:

  -SentTransaction(nonsense, realStuff)
  +SentTransaction(realStuff)
  -new SentTransaction(nonsense, realStuff)
  +new SentTransaction(realStuff)

• SorobanRpc import, previously deprecated, has been removed. You can import rpc instead:

  -import { SorobanRpc } from '@stellar/stellar-sdk'
  +import { rpc } from '@stellar/stellar-sdk'

  As an alternative, you can also import from the rpc entrypoint:

  import { Server } from '@stellar/stellar-sdk/rpc'

Added

• rpc.Server now has a pollTransaction method to retry transaction retrieval (#1092).

Full Changelog: v13.0.0-beta.1...v13.0.0-rc.1

v13.0.0-beta.1

This is the first release that supports Protocol 22. While the network has not upgraded yet, you can start integrating the new features into your codebase if you want a head start. Keep in mind that while the binary XDR is backwards-compatible, the naming and layout of structures is not. In other words, this build will continue to work on Protocol 21, but you may have to update code that references XDR directly.

Breaking Changes

• contract.AssembledTransaction#signAuthEntries now takes an address instead of a publicKey. This brings the API more inline with its actual functionality: It can be used to sign all the auth entries for a particular address, whether that is the address of an account (public key) or a contract. (#1044).
• The Node.js code will now Babelify to Node 18 instead of Node 16, but we stopped supporting Node 16 long ago so this shouldn't be a breaking change.

Added

• You can now build the browser bundle without various dependencies:
  • Set USE_AXIOS=false to build without the axios dependency: this will build stellar-sdk-no-axios.js and stellar-sdk-no-axios.min.js in the dist/ directory, or just run yarn build:browser:no-axios to generate these files.
  • You can import Node packages without the axios dependency via @stellar/stellar-sdk/no-axios. For Node environments that don't support modern imports, use @stellar/stellar-sdk/lib/no-axios/index.
  • Set USE_EVENTSOURCE=false to build without the eventsource dependency: this will build stellar-sdk-no-eventsource.js and stellar-sdk-no-eventsource.min.js in the dist/ directory, or just run yarn build:browser:no-eventsource to generate these files.
  • You can import Node packages without the eventsource dependency via @stellar/stellar-sdk/no-eventsource. For Node.js environments that don't support modern imports, use @stellar/stellar-sdk/lib/no-eventsource/index.
  • To use a minimal build without both Axios and EventSource, use stellar-sdk-minimal.js for the browser build and import from @stellar/stellar-sdk/minimal for the Node package.
• contract.AssembledTransaction#signAuthEntries now allows you to override authorizeEntry. This can be used to streamline novel workflows using cross-contract auth. (#1044)
• rpc.Server now has a getSACBalance helper which lets you fetch the balance of a built-in Stellar Asset Contract token held by a contract (#1046):

export interface BalanceResponse {
  latestLedger: number;
  /** present only on success, otherwise request malformed or no balance */
  balanceEntry?: {
    /** a 64-bit integer */
    amount: string;
    authorized: boolean;
    clawback: boolean;
    lastModifiedLedgerSeq?: number;
    liveUntilLedgerSeq?: number;
  };
}

Fixed

• contract.AssembledTransaction#nonInvokerSigningBy now correctly returns contract addresses, in instances of cross-contract auth, rather than throwing an error. sign will ignore these contract addresses, since auth happens via cross-contract call (#1044).

Contributors

@Shaptic @psheth9 @BlaineHeffron @chadoh

New Contributors

• @ElliotFriend made their first contribution in #965
• @omahs made their first contribution in #1069

Full Changelog: v12.3.0...v13.0.0-beta.1