From a2c8c1e264e7ff8ad984ac214c536894fe725104 Mon Sep 17 00:00:00 2001 From: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> Date: Fri, 2 Dec 2022 12:44:41 -0800 Subject: [PATCH] Add release notes (#234) --- docs/index.mdx | 2 +- docs/releases.mdx | 156 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 157 insertions(+), 1 deletion(-) create mode 100644 docs/releases.mdx diff --git a/docs/index.mdx b/docs/index.mdx index 2c7b365f..8e331af5 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -11,7 +11,7 @@ Soroban is a pre-release. Breaking changes may occur. While it works well with Stellar, a blockchain that shares its values of scale and sensibility, it doesn't depend on or require Stellar at all, and can be used by any transaction processor, including other blockchains, L2s, and permissioned ledgers. -Currently, Soroban is a preview release that includes initial versions of the smart contracts environment, a Rust SDK, A CLI, and an RPC server. Developers can write and test contracts on their local machine or deploy them to a special test network dubbed FutureNet. +Currently, Soroban is a preview release that includes initial versions of the smart contracts environment, a Rust SDK, A CLI, and an RPC server. Developers can write and test contracts on their local machine or deploy them to a special test network dubbed Futurenet. ## What "preview release" means We’re releasing this very early version of Soroban because we believe it’s important to share the development process, and we want Stellar ecosystem developers and smart contract developers from other ecosystems to have a chance to experiment and provide feedback. diff --git a/docs/releases.mdx b/docs/releases.mdx new file mode 100644 index 00000000..bbdea132 --- /dev/null +++ b/docs/releases.mdx @@ -0,0 +1,156 @@ +--- +sidebar_position: 1 +title: Preview Releases +--- + +The following Soroban releases are preview releases. + +We’re releasing early versions of Soroban because we believe it’s important to +share the development process, and we want Stellar ecosystem developers and +smart contract developers from other ecosystems to have a chance to experiment +and provide feedback. + +:::caution +Preview releases are software releases that are also released to the [Futurenet] +test network. Software releases may occur between Futurenet releases. If you're +interacting with Futurenet the recommended software versions to use in +development are below. Releases to Futurenet may include network resets and +network passphrase changes. +::: + +[Futurenet]: networks/futurenet + +## Preview 5 (December 6th, 2022) + +### Software + +| Software | Version | +| -------- | ------- | +| XDR | https://github.com/stellar/stellar-xdr/tree/026c9cd074bdb28ddde8ee52f2a4502d9e518a09 | +| Soroban Environment | `v0.0.10` | +| Stellar Core | `stellar-core_19.5.1-1137.b3a6bc281.focal~soroban` | +| Soroban Rust SDK | `` | +| Soroban CLI | `` | +| Soroban RPC | `` | +| Stellar Horizon | `stellar-horizon:2.22.0~soroban-318` | +| Stellar Quickstart | `stellar/quickstart:soroban-dev@sha256:...` | +| Futurenet Network Passphrase | `Test SDF Future Network ; October 2022` | + +### Changelog + +#### XDR + +* ... + +#### Soroban Environment + +* ... + +See https://github.com/stellar/rs-soroban-env/releases v... for more details. + +#### Soroban Rust SDK + +* ... + +See https://github.com/stellar/rs-soroban-sdk/releases v... for more details. + +#### Soroban RPC + +* ... + +See https://github.com/stellar/soroban-tools/releases v... for more details. + +#### Soroban CLI + +* ... + +See https://github.com/stellar/soroban-tools/releases v... for more details. + +## Preview 4 (November 15th, 2022) + +### Software + +| Software | Version | +| -------- | ------- | +| XDR | https://github.com/stellar/stellar-xdr-next/tree/48d5e17ae63bba0aa9725cd9d18d7438f44c07b1 | +| Soroban Environment | `v0.0.9` | +| Stellar Core | `19.5.1-1111.eba1d3de9.focal~soroban` | +| Soroban Rust SDK | `v0.2.1` | +| Soroban CLI | `v0.2.1` | +| Soroban RPC | ??? | +| Stellar Horizon | `2.22.0~soroban-304` | +| Stellar Quickstart | `stellar/quickstart:soroban-dev@sha256:0993d3350148af6ffeab5dc8f0b835236b28dade6dcae77ff8a09317162f768d` | +| Futurenet Network Passphrase | `Test SDF Future Network ; October 2022` | + +### Changelog + +#### XDR + +* Trivial whitespace changes + +#### Soroban Environment + +* Vm tuning +* Add token events +* Catch panics from native contracts in try_call +* Improved built-in token error reporting +* Add missing conversion from Status->ScStatus for the ContractError variant +* Capture user panic-strings in native builds, avoid spurious NoContractRunning error +* Few small fixes to error debug events + +See https://github.com/stellar/rs-soroban-env/releases v0.0.7, v0.0.8, v0.0.9 for more details. + +#### Soroban Rust SDK + +* Add Logger::print in testutils +* Add conversion from Address to Identifier +* Remove deprecated functions +* Remove panic-catching and fix tests that use newly-working native try_call +* Reintroduce an optimized aborting unwrap +* Add assert_with_error! macro +* Rename panic_error! to panic_with_error! + +See https://github.com/stellar/rs-soroban-sdk/releases v0.2.0, v0.2.1 for more details. + +#### Soroban RPC + +* Initial Release + +#### Soroban CLI + +* Strings and symbols are rendered as text in JSON output +* Bytes are rendered as hex in JSON output +* Accounts in invocations are created in sandbox +* Add optimize sub-command that optimizes contracts +* Fix the bin name in the completion command +* Fix jsonrpc compliance issue + +See https://github.com/stellar/soroban-cli/releases v0.2.0, v0.2.1 for more details. + +## Preview 3 (October 11th, 2022) + +### Software + +| Software | Version | +| -------- | ------- | +| XDR | https://github.com/stellar/stellar-xdr-next/tree/161e2e5b64425a49f9ccfef7f732ae742ed5eec4 | +| Soroban Environment | `v0.0.6` | +| Stellar Core | `19.4.1-1097.4e813f20e.focal~soroban` | +| Soroban Rust SDK | `v0.1.1` | +| Soroban CLI | `v0.1.2` | +| Soroban RPC | ??? | +| Stellar Horizon | `2.22.0~soroban-304` | +| Stellar Quickstart | `stellar/quickstart:soroban-dev@sha256:e58d83f92a61f43406087f488dd1cba110a92646dca85f14b3a416163609e853` | +| Futurenet Network Passphrase | `Test SDF Future Network ; October 2022` | + +### Changelog + +See https://www.stellar.org/blog/soroban-a-new-smart-contract-standard. + +## Preview 2 (September 13th, 2022) + +See https://www.stellar.org/developers-blog/soroban-preview-release-2. + +## Preview 1 (August 1st, 2022) + +See https://www.stellar.org/blog/project-jump-cannon-soroban-preview-release.