stellar-sdk - npm Package Versions

published 13.0.0 • 3 months ago

Changelog

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]https://github.com/stellar/js-stellar-sdk/pull/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).

13.0.0-rc.2

published 13.0.0-rc.2 • 3 months ago

Changelog

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.

13.0.0-rc.1

published 13.0.0-rc.1 • 3 months ago

Changelog

v13.0.0-rc.1

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]https://github.com/stellar/js-stellar-sdk/pull/1092).

13.0.0-beta.1

published 13.0.0-beta.1 • 4 months ago

Changelog

v13.0.0-beta.1

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).

12.3.0

published 12.3.0 • 5 months ago

Changelog

v12.3.0

Added

rpc.Server now has a getTransactions, which has the same response schema as getTransactions except with bundles of transactions (#1037).
rpc.Server now has a getVersionInfo method which reports version information of the RPC instance it is connected to (#1028):

export interface GetVersionInfoResponse {
  version: string;
  commit_hash: string;
  build_time_stamp: string;
  captive_core_version: string;
  protocol_version: number;
}

Fixed

Lower authorization entry's default signature expiration to ~8min for security reasons (#1023).
Remove statusText error check to broaden compatibility (#1001).
Upgraded stellar-base which includes various fixes (release notes, #1045).

12.2.0

published 12.2.0 • 7 months ago

Changelog

v12.2.0

Fixed

@stellar/stellar-base and its underlying dependency @stellar/js-xdr have been upgraded to their latest versions; reference their release notes (v12.1.0 and v3.1.2, respectively) for details (#1013).

Added

You can now pass custom headers to both rpc.Server and Horizon.Server (#1013):

import { Server } from "@stellar/stellar-sdk/rpc";

const s = new Server("<some URL>", { headers: { "X-Custom-Header": "hello" }})

Horizon.Server now supports the new POST /transactions_async endpoint via the submitAsyncTransaction method (#989). Its purpose is to provide an immediate response to the submission rather than waiting for Horizon to determine its status. The response schema is as follows:

interface SubmitAsyncTransactionResponse {
  // the submitted transaction hash
  hash: string;
  // one of "PENDING", "DUPLICATE", "TRY_AGAIN_LATER", or "ERROR"
  tx_status: string;
  // a base64-encoded xdr.TransactionResult iff `tx_status` is "ERROR"
  error_result_xdr: string;
}

rpc.Server now has a getFeeStats method which retrieves fee statistics for a previous chunk of ledgers to provide users with a way to provide informed decisions about getting their transactions included in the following ledgers (#998):

export interface GetFeeStatsResponse {
  sorobanInclusionFee: FeeDistribution;
  inclusionFee: FeeDistribution;
  latestLedger: number; // uint32
}

interface FeeDistribution {
  max: string;  // uint64
  min: string;  // uint64
  mode: string; // uint64
  p10: string;  // uint64
  p20: string;  // uint64
  p30: string;  // uint64
  p40: string;  // uint64
  p50: string;  // uint64
  p60: string;  // uint64
  p70: string;  // uint64
  p80: string;  // uint64
  p90: string;  // uint64
  p95: string;  // uint64
  p99: string;  // uint64
  transactionCount: string; // uint32
  ledgerCount: number;      // uint32
}

12.1.0

published 12.1.0 • 8 months ago

Changelog

v12.1.0

Added

contract now exports the DEFAULT_TIMEOUT (#984).
contract.AssembledTransaction now has:
- toXDR and fromXDR methods for serializing the transaction to and from XDR. These methods should be used in place of AssembledTransaction.toJSON and AssembledTransaction.fromJSONfor multi-auth signing. The JSON methods are now deprecated. Note: you must now call simulate on the transaction before the final signAndSend call after all required signatures are gathered when using the XDR methods (#977).
- a restoreFootprint method which accepts the restorePreamble returned when a simulation call fails due to some contract state that has expired. When invoking a contract function, one can now set restore to true in the MethodOptions. When enabled, a restoreFootprint transaction will be created and await signing when required (#991).
- separate sign and send methods so that you can sign a transaction without sending it (signAndSend still works as before; #922).
contract.Client now has a txFromXDR method which should be used in place of txFromJSON for multi-auth signing (#977).

Deprecated

In contract.AssembledTransaction, toJSON and fromJSON should be replaced with toXDR and fromXDR.
In contract.Client, txFromJSON should be replaced with txFromXDR.

Fixed

If you edit an AssembledTransaction with tx.raw = cloneFrom(tx.build), the tx.simulationData will now be updated correctly (#985).

12.0.1

published 12.0.1 • 9 months ago

Changelog

v12.0.1

This is a re-tag of v12.0.0-rc.3 with dependency updates and a single new feature.

Added

rpc.server.simulateTransaction now supports an optional stateChanges?: LedgerEntryChange[] field (#963):
- If Before is omitted, it constitutes a creation, if After is omitted, it constitutes a deletions, note that Before and After cannot be omitted at the same time. Each item follows this schema:

interface LedgerEntryChange {
  type: number;
  key: xdr.LedgerKey;
  before: xdr.LedgerEntry | null;
  after: xdr.LedgerEntry | null;
}

12.0.0-rc.3

published 12.0.0-rc.3 • 9 months ago

Changelog