Bump version to 0.3.0 (#779)

.github/workflows/rust.yml

@@ -77,5 +77,5 @@ jobs:
     uses: stellar/actions/.github/workflows/rust-publish-dry-run.yml@main
     with:
       runs-on: ${{ matrix.sys.os }}
-      target: ${ matrix.sys.target }}
+      target: ${{ matrix.sys.target }}
       cargo-hack-feature-options: ${{ matrix.sys.cargo-hack-feature-options }}

Cargo.toml

@@ -22,40 +22,40 @@ members = [
 ]
 
 [workspace.package]
-version = "0.2.1"
+version = "0.3.0"
 
 [workspace.dependencies]
-soroban-sdk = { version = "0.2.1", path = "soroban-sdk" }
-soroban-sdk-macros = { version = "0.2.1", path = "soroban-sdk-macros" }
-soroban-auth = { version = "0.2.1", path = "soroban-auth" }
-soroban-spec = { version = "0.2.1", path = "soroban-spec" }
-soroban-ledger-snapshot = { version = "0.2.1", path = "soroban-ledger-snapshot" }
-soroban-token-spec = { version = "0.2.1", path = "soroban-token-spec" }
+soroban-sdk = { version = "0.3.0", path = "soroban-sdk" }
+soroban-sdk-macros = { version = "0.3.0", path = "soroban-sdk-macros" }
+soroban-auth = { version = "0.3.0", path = "soroban-auth" }
+soroban-spec = { version = "0.3.0", path = "soroban-spec" }
+soroban-ledger-snapshot = { version = "0.3.0", path = "soroban-ledger-snapshot" }
+soroban-token-spec = { version = "0.3.0", path = "soroban-token-spec" }
 
 [workspace.dependencies.soroban-env-common]
-version = "0.0.9"
+version = "0.0.10"
 git = "https://github.com/stellar/rs-soroban-env"
-rev = "eda2ab70"
+rev = "c1480516"
 
 [workspace.dependencies.soroban-env-guest]
-version = "0.0.9"
+version = "0.0.10"
 git = "https://github.com/stellar/rs-soroban-env"
-rev = "eda2ab70"
+rev = "c1480516"
 
 [workspace.dependencies.soroban-env-host]
-version = "0.0.9"
+version = "0.0.10"
 git = "https://github.com/stellar/rs-soroban-env"
-rev = "eda2ab70"
+rev = "c1480516"
 
 [workspace.dependencies.stellar-strkey]
 version = "0.0.6"
 git = "https://github.com/stellar/rs-stellar-strkey"
 rev = "5e582a8b"
 
 [workspace.dependencies.stellar-xdr]
-version = "0.0.7"
+version = "0.0.9"
 git = "https://github.com/stellar/rs-stellar-xdr"
-rev = "2775f4b6"
+rev = "1309e3de"
 default-features = false
 
 # [patch."https://github.com/stellar/rs-soroban-env"]

Makefile

@@ -38,6 +38,18 @@ check: build fmt
 	cargo hack --feature-powerset --exclude-features docs check
 	cargo hack check --release --target wasm32-unknown-unknown
 
+readme:
+	cd soroban-sdk \
+		&& cargo +nightly rustdoc -- -Zunstable-options -wjson \
+		&& cat ../target/doc/soroban_sdk.json \
+		| jq -r '.index[.root].docs' \
+		> README.md
+	cd soroban-auth \
+		&& cargo +nightly rustdoc -- -Zunstable-options -wjson \
+		&& cat ../target/doc/soroban_auth.json \
+		| jq -r '.index[.root].docs' \
+		> README.md
+
 watch:
 	cargo watch --clear --watch-when-idle --shell '$(MAKE)'
 

soroban-auth/Cargo.toml

@@ -4,7 +4,7 @@ description = "Soroban authorization sdk"
 homepage = "https://github.com/stellar/rs-soroban-sdk"
 repository = "https://github.com/stellar/rs-soroban-sdk"
 authors = ["Stellar Development Foundation <[email protected]>"]
-readme = "../README.md"
+readme = "README.md"
 license = "Apache-2.0"
 version.workspace = true
 edition = "2021"

soroban-auth/README.md

@@ -0,0 +1,15 @@
+Soroban auth provides basic authentication capabilities to Soroban
+contracts.
+
+For contracts that require basic authentication capabilities this crate may
+do some of the heavy lifting for supporting authentication by Stellar
+accounts, ed25519 signatures, or other contracts. For contracts that require
+more bespoke authentication this crate may not be suitable.
+
+See [`verify`] for how to use.
+
+See [`testutils`] for test utilities.
+
+**The utilities in this crate provide no replay protection. Contracts must
+provide their own mechanism suitable for replay prevention that prevents
+contract invocations to be replayable if it is important they are not.**

soroban-sdk/Cargo.toml

@@ -4,7 +4,7 @@ description = "Soroban SDK."
 homepage = "https://github.com/stellar/rs-soroban-sdk"
 repository = "https://github.com/stellar/rs-soroban-sdk"
 authors = ["Stellar Development Foundation <[email protected]>"]
-readme = "../README.md"
+readme = "README.md"
 license = "Apache-2.0"
 version.workspace = true
 edition = "2021"

soroban-sdk/README.md

@@ -0,0 +1,34 @@
+Soroban SDK supports writing programs for the Soroban smart contract
+platform.
+
+### Docs
+
+See [soroban.stellar.org](https://soroban.stellar.org) for documentation.
+
+### Examples
+
+```rust
+use soroban_sdk::{contractimpl, symbol, vec, BytesN, Env, Symbol, Vec};
+
+pub struct HelloContract;
+
+#[contractimpl]
+impl HelloContract {
+    pub fn hello(env: Env, to: Symbol) -> Vec<Symbol> {
+        vec![&env, symbol!("Hello"), to]
+    }
+}
+
+#[test]
+fn test() {
+    let env = Env::default();
+    let contract_id = env.register_contract(None, HelloContract);
+    let client = HelloContractClient::new(&env, &contract_id);
+
+    let words = client.hello(&symbol!("Dev"));
+
+    assert_eq!(words, vec![&env, symbol!("Hello"), symbol!("Dev"),]);
+}
+```
+
+More examples are available at <https://soroban.stellar.org/docs/category/examples>.

soroban-sdk/src/lib.rs

@@ -7,7 +7,7 @@
 //!
 //! ### Examples
 //!
-//! ```
+//! ```rust
 //! use soroban_sdk::{contractimpl, symbol, vec, BytesN, Env, Symbol, Vec};
 //!
 //! pub struct HelloContract;

tests/add_i128/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "test_add_i128"
-version = "0.2.1"
+version.workspace = true
 authors = ["Stellar Development Foundation <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

tests/add_u128/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "test_add_u128"
-version = "0.2.1"
+version.workspace = true
 authors = ["Stellar Development Foundation <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"

tests/add_u64/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "test_add_u64"
-version = "0.2.1"
+version.workspace = true
 authors = ["Stellar Development Foundation <[email protected]>"]
 license = "Apache-2.0"
 edition = "2021"