Skip to content

Latest commit

 

History

History
267 lines (169 loc) · 17.4 KB

CHANGELOG.md

File metadata and controls

267 lines (169 loc) · 17.4 KB
Raw

Changelog

This repository has been deprecated in favor of the stellar-sdk package. Please read the migration guide for how to upgrade to that package. Future changes will only be made there.

v1.0.1

Fixed

  • The package is now correctly marked in npm as deprecated.

v1.0.0

Breaking Changes

  • See the new deprecation warning at the top of this document and in the README.
  • XDR has been upgraded to the latest stellar-base release, supporting the current stable XDR for Protocol 20 (#167).

Fixed

  • The Server.getEvents method now correctly parses responses without a contractId field set: the events[i].contractId field on an event will be omitted if there was no ID in the event (e.g. for system events; (#172)).
  • The Server.getEvents() method will correctly parse the event value as an xdr.ScVal rather than an xdr.DiagnosticEvent (#172).
  • The Server.getEvents() method will correctly set startLedger to be a number rather than a string (#174).

v1.0.0-beta.4

Fixed

  • The stellar-base dependency has been upgraded to v10.0.0-beta.4 which contains a bugfix related to large sequence numbers (#170).

v1.0.0-beta.3

Added

  • Responses for Server.getContractData and Server.getLedgerEntries now include an expirationLedgerSeq attribute on ledger data entries that have expiry information (#153).
  • The new Server._simulateTransaction method will return the raw response directly from the RPC server rather than parsing XDR fields (#160).

Breaking Changes

  • The stellar-base dependency has been upgraded to v10.0.0-beta.3 which contains breaking changes related to auth helpers and some bugfixes (#158).
  • All endpoints will now automatically decode XDR structures whenever possible. In particular,
    • For the Server.getLedgerEntries response (#154), we parse:
      • entries is now guaranteed to exist, but it may be empty
      • entries[i].key is an instance of xdr.LedgerKey
      • the entries[i].xdr field is now val, instead
      • entries[i].val is an instance of xdr.LedgerEntryData
    • For the Server.sendTransaction response (#157), we parse:
      • errorResultXdr is renamed to errorResult
      • If it's present, it's an instance of xdr.TransactionResult
    • For the Server.getEvents response (#156), we parse:
      • events[i].contractId is now an instance of Contract
      • events[i].topic is now a list of decoded xdr.ScVal instances
      • events[i].value.xdr is now remapped directly to events.value
      • events[i].value is a decoded xdr.ScVal instance
    • For the Server.sendTransaction response (#157), we parse:
      • errorResultXdr is now errorResult, a parsed instance of xdr.TransactionResult
  • If you want to continue to use the raw RPC responses, you can use the _-prefixed methods which will return the response directly:
    • Server._getLedgerEntries
    • Server._sendTransaction
    • Server._getEvents
    • Server._simulateTransaction
    • Server._getTransaction

v1.0.0-beta.2

Fixed

  • The variations of responses from simulateTransaction were not always being parsed correctly (#146).

v1.0.0-beta.1

Fixed

  • This upgrades stellar-base which has a critical bugfix for Contract.call() not generating valid operations (#145, stellar-base#692).

v1.0.0-beta.0

Note: This version is currently only compatible with Stellar networks running [email protected], which corresponds to Preview 11, the final Protocol 20 preview (using stellar/stellar-xdr@9ac0264).

Breaking Changes

  • The XDR has been upgraded to the final testnet version via the stellar-base dependency (v10.0.0-beta.0, #135).
  • The simulateTransaction endpoint will now return a restorePreamble structure containing the recommended footprint and minimum resource fee for an Operation.restoreFootprint which would have made the simulation succeed (#132).

Fixed

  • Result types are now handled correctly by ContractSpec (#138).

v0.11.2

Fixed

  • The stellar-base dependency has been updated to v10.0.0-soroban.8, fixing some bugs and adding some small things. Refer to its release notes (stellar/js-stellar-base#687) for details.

v0.11.1

Fixed

  • This adds sensible defaults Server.simulateTransaction's response when the RPC server omits certain fields in an unexpected way (#131).

v0.11.0

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.

v0.10.1

Fixed

  • The stellar-base dependency has been upgraded to fix a TypeScript bug (js-stellar-base#665).
  • Decreased bundle size by refactoring assembleTransaction to use new abstractions from stellar-base (#120).

v0.10.0

Breaking Changes

You should use the well-supported C... strkey format, instead. To migrate, you can do something like

let contractId = StrKey.encodeContract(Buffer.from(hexContractId, 'hex'));

Added

  • Updated stellar-base dependency to v10.0.0-soroban.5 which introduces many helpful Soroban abstractions (see full release notes):
    • Use an existing, immutable Transaction as a template for a new one via TransactionBuilder.cloneFrom(tx, opts = {}) and use opts to override fields (#656).
    • Use the new SorobanDataBuilder class to easily prepare Soroban transaction footprints #660.
    • Use humanizeEvents to create human-readable versions of xdr.ContractEvents and xdr.DiagnosticEvents that come out of transaction meta (#659).
    • Use several helpers to reliably build Soroban authorization entries for complex, multi-party signing scenarios (#663). These are each at various levels of granularity/complexity:
      • authorizeInvocation
      • authorizeInvocationCallback
      • buildAuthEnvelope
      • buildAuthEntry

Fixed

  • assembleTransaction() (and Server.prepareTransaction() by proxy) will now override the authorization portion of simulation if you provide a transaction with existing authorization entries. This is because, in complex auth scenarios, you may have signed entries that would be overwritten by simulation, so this just uses your existing entries (#114).
  • Added a missing type field to the EventResponse interface (#118).

v0.9.2

Updated

  • Updated stellar-base dependency to fix the way scValToNative converts string and symbol values: they will always decode strings when possible (#112 for #645).

v0.9.1

Updated

  • Updated stellar-base dependency to fix an issue when building & invoking contract transactions.

v0.9.0

Updated

  • Server.getContractData has an additional, optional parameter: expirationType?: string which should be set to either 'temporary' or 'persistent' depending on the type of ledger key. By default, it will attempt to fetch both, returning whichever one it finds (#103).
  • assembleTransaction now accepts simulation results for the new BumpFootprintExpirationOps and RestoreFootprintOps (#108).
  • The XDR library (stellar-base) has been upgraded to Preview 10's protocol format. This includes the following changes:

Breaking Changes

  • Many XDR structures have changed, please refer to the types/next.d.ts diff for details (#633).
  • We have returned to the world in which one transaction contains one operation which contains one host function invocation. This means Operation.invokeHostFunctions is gone and Operation.invokeHostFunction has changed to accept { func, auth }, where func is the correct xdr.HostFunction and auth is a list of xdr.SorobanAuthorizationEntry items that outline the authorization tree for the call stack (#633). Better abstractions for creating an xdr.HostFunction are forthcoming, though you can still refer to Contract.call() for help.

Added

  • A new abstraction for dealing with large integers and ScVals: see ScInt, XdrLargeInt, and scValToBigInt (#620).
  • A new abstraction for converting between native JavaScript types and complex ScVals: see nativeToScVal and scValToNative (#630).
  • We have added two new operations related to state expiration in Soroban: BumpFootprintExpiration and RestoreFootprint. Please refer to their docstrings for details (#633).

v0.8.1

Fix

  • The stellar-base library is pinned to a specific version so that a fresh installation (via e.g. npm i soroban-client) does not pull the latest major version (without Soroban support) (#100).

v0.8.0

Added

  • Server.getContractId() now accepts a contract strkey (#97).

Updated

  • The XDR library (stellar-base) has been upgraded to handle contract strkeys (C... addresses) better (see #612 and #614 of stellar-base) (#98).

  • Misc. dependencies have been upgraded and the buffer polyfill is now a primary dependency (#98).

v0.7.2

Fixed

  • Downstream dependencies are transpiled to target the same older JS environments as the main library (#96).

v0.7.1

Fixed

  • The module was not being exported correctly in browser environments; the following should now work in your project (#95):
import * as SorobanClient from 'soroban-client';
  • The browser bundles compatibility has increased, supporting older JS environments and undoing #90 from v0.7.0 (#95).

v0.7.0

Breaking

  • Replaced the deprecated getLedgerEntry with getLedgerEntries (#66).

Fixed

  • Transaction simulation parses correctly when there is no auth (#89).
  • TypeScript types are packaged correctly (#86).
  • Documentation is packaged correctly (#87, #88).

Updated

  • Published bundles support modern JS features (ES6ish) (#90).

v0.6.1

This version was tagged solely to trigger a documentation build.

Fixed

  • Removed extraneous reference to gulp in docs building step (#80).

v0.6.0

Breaking

  • Updated Server.prepareTransaction() for new Soroban simulation results and fees. Note the change in behavior now, where transaction fee will be increased by the resource fee estimates received from simulation (#76).

Updated

  • SDK Modernization, refreshing the build system to use the latest in JS build pipelines (#69).

v0.5.1

  • remove params from jsonrpc post payload if empty. #70

  • add server method for rpc getLatestLedger endpoint. #67

  • remove phantomjs from dev dependencies. #68