@stellar/stellar-sdk 12.0.1 → 12.2.0

package/CHANGELOG.md

@@ -7,6 +7,76 @@ A breaking change will get clearly marked in this log.
 ## Unreleased
 
 
+## [v12.2.0](https://github.com/stellar/js-stellar-sdk/compare/v12.1.0...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](https://github.com/stellar/js-stellar-base/releases/tag/v12.1.0) and [v3.1.2](https://github.com/stellar/js-xdr/releases/tag/v3.1.2), respectively) for details ([#1013](https://github.com/stellar/js-stellar-sdk/pull/1013)).
+
+### Added
+- You can now pass custom headers to both `rpc.Server` and `Horizon.Server` ([#1013](https://github.com/stellar/js-stellar-sdk/pull/1013)):
+```typescript
+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](https://github.com/stellar/js-stellar-sdk/pull/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:
+```typescript
+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](https://github.com/stellar/js-stellar-sdk/issues/998)):
+```typescript
+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
+}
+```
+
+
+## [v12.1.0](https://github.com/stellar/js-stellar-sdk/compare/v12.0.1...v12.1.0)
+
+### Added
+- `contract` now exports the `DEFAULT_TIMEOUT` ([#984](https://github.com/stellar/js-stellar-sdk/pull/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.fromJSON`for 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](https://github.com/stellar/js-stellar-sdk/pull/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](https://github.com/stellar/js-stellar-sdk/pull/991)).
+  - separate `sign` and `send` methods so that you can sign a transaction without sending it (`signAndSend` still works as before; [#922](https://github.com/stellar/js-stellar-sdk/pull/992)).
+- `contract.Client` now has a `txFromXDR` method which should be used in place of `txFromJSON` for multi-auth signing ([#977](https://github.com/stellar/js-stellar-sdk/pull/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](https://github.com/stellar/js-stellar-sdk/pull/985)).
+
+
 ## [v12.0.1](https://github.com/stellar/js-stellar-sdk/compare/v11.3.0...v12.0.1)
 
 - This is a re-tag of `v12.0.0-rc.3` with dependency updates and a single new feature.