Skip to content

Update docs for soroban-sdk v28 - #2863

Merged
leighmcculloch merged 3 commits into
mainfrom
upgrade-docs-soroban-sdk-28
Sep 24, 2026
Merged

leighmcculloch merged 3 commits into
mainfrom
upgrade-docs-soroban-sdk-28

Conversation

@leighmcculloch

@leighmcculloch leighmcculloch commented Sep 18, 2026 •

Copy link
Copy Markdown
Member

What

Update existing examples and docs to match the soroban-examples and soroban-sdk v28.

Why

Keep the docs updated.

Dependent on:

Known Limitations

This change does not introduce new docs about new features.

@github-actions github-actions Bot added the preview Preview builds for PRs by SDF employees. label Sep 18, 2026
@github-actions

Copy link
Copy Markdown
Contributor

@leighmcculloch
leighmcculloch marked this pull request as ready for review September 18, 2026 07:08
Copilot AI balanced review requested due to automatic review settings September 18, 2026 07:08

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Recommendation: NEEDS-CHANGES — Version pins and source references must be aligned with v28, and the companion examples PR must land first.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Updates Rust contract examples for soroban-sdk v28 APIs and records the SDK release.

Changes:

  • Migrates deployment and upgrade examples to ContractExecutable.
  • Renames the token approval event field.
  • Records Rust SDK v28 in the Protocol 28 table.

Some examples remain pinned to SDK/source v23 or v27, and main-branch examples depend on unmerged soroban-examples#421.

File summaries
File Description
docs/networks/software-versions.mdx Records Rust SDK v28.
docs/learn/migrate/evm/smart-contract-deployment.mdx Updates contract deployment syntax.
docs/learn/fundamentals/contract-development/contract-interactions/cross-contract.mdx Updates constructor deployment example.
docs/build/smart-contracts/example-contracts/tokens.mdx Renames the approval event field.
docs/build/smart-contracts/example-contracts/deployer.mdx Migrates deployer examples.
docs/build/guides/conventions/upgrading-contracts.mdx Migrates contract upgrade examples.
docs/build/guides/conventions/deploy-contract.mdx Updates deployment guidance.
docs/build/guides/auth/check-auth-tutorials.mdx Updates wallet upgrade examples.
Review details
  • Files reviewed: 8/8 changed files
  • Comments generated: 6
  • Review effort level: Balanced

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/build/guides/conventions/deploy-contract.mdx
Comment thread docs/build/guides/conventions/upgrading-contracts.mdx
Comment thread docs/build/smart-contracts/example-contracts/deployer.mdx
Comment thread docs/build/smart-contracts/example-contracts/tokens.mdx
Comment thread docs/learn/migrate/evm/smart-contract-deployment.mdx
Comment thread docs/build/guides/conventions/upgrading-contracts.mdx Outdated
Copilot AI review requested due to automatic review settings September 18, 2026 07:14
@github-actions github-actions Bot removed the preview Preview builds for PRs by SDF employees. label Sep 18, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

Recommendation: NEEDS-CHANGES — Four runnable examples use v28 syntax while their documented sources remain pinned to v23/v27.

Review details

Suppressed comments (4)

docs/build/smart-contracts/example-contracts/deployer.mdx:107

  • This page still tells readers to clone and follow soroban-examples v23.0.0, but that tag depends on soroban-sdk 23.0.1 and its implementation calls deploy_v2. The new v28-only call therefore neither matches the cited source nor compiles in the documented checkout. Please coordinate/pin a v28 example source (including its ContractExecutable import) before switching this snippet.
            .deploy_contract(ContractExecutable::Wasm(wasm_hash), constructor_args);

docs/build/guides/conventions/deploy-contract.mdx:105

  • The setup links and clones soroban-examples main, but current main pins soroban-sdk 27.0.0 and the referenced deployer still calls deploy_v2. This v28-only snippet does not match or compile with the project readers are instructed to use. Update the example source to v28 and pin the guide to that revision before changing the call.
            .deploy_contract(ContractExecutable::Wasm(wasm_hash), constructor_args);

docs/build/guides/conventions/upgrading-contracts.mdx:77

  • This guide cites the v23.0.0 upgradeable contract, whose Cargo file pins soroban-sdk 23.0.1 and whose source uses update_current_contract_wasm. Replacing only the displayed call makes the guide diverge from its runnable source and documented setup. Please first provide and pin a v28 example revision, then update the snippet and source links together.
        env.deployer()
            .update_current_contract(ContractExecutable::Wasm(new_wasm_hash));

docs/build/smart-contracts/example-contracts/tokens.mdx:345

  • The page instructs readers to clone soroban-examples main, but that token currently pins soroban-token-sdk 27.0.0 and constructs Approve with expiration_ledger: live_until_ledger. Field shorthand for live_until_ledger is valid in v28 but fails in the documented checkout, so this no longer reproduces the linked example. Coordinate/pin the token example's v28 dependency update before changing this line.
            live_until_ledger,
  • Files reviewed: 8/8 changed files
  • Comments generated: 0 new
  • Review effort level: Balanced

@github-actions github-actions Bot added the preview Preview builds for PRs by SDF employees. label Sep 18, 2026
@github-actions

Copy link
Copy Markdown
Contributor

@leighmcculloch
leighmcculloch marked this pull request as draft September 18, 2026 07:43
jayz22 pushed a commit to stellar/rs-soroban-poseidon that referenced this pull request Sep 21, 2026
> [!NOTE]
> Part of a series of related and connected PRs:
>
> - #18 ← this PR
> - stellar/soroban-examples#420
> - stellar/stellar-docs#2863

### What
Bump the workspace to soroban-sdk v28.

### Why
Keep it updated.

### Known Limitations
The `stellar contract build` is because the soroban-sdk has to be built
with the cli now, unfortunately even for libs that aren't intended to be
cdylibs. The reason is that the soroban-sdk can't detect when building a
lib vs targeting a .wasm file and it errors to prevent people
accidentally building contracts with `cargo build`.
@github-actions github-actions Bot removed the preview Preview builds for PRs by SDF employees. label Sep 22, 2026
@leighmcculloch
leighmcculloch marked this pull request as ready for review September 22, 2026 02:01
Copilot AI review requested due to automatic review settings September 22, 2026 02:01
@github-actions github-actions Bot added the preview Preview builds for PRs by SDF employees. label Sep 22, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🔵 Needs a closer look

Another EVM example and the linked event documentation still describe pre-v28 behavior.

Review effort: Balanced
Findings: None

Resolved since last review (5)
Previously missed (2)

In code that hasn't changed since last review

Low severity Document event emission from both executable update paths

docs/​build/​guides/​conventions/​upgrading-contracts.mdx:113

The linked event reference is still stale: docs/learn/fundamentals/stellar-data-structures/events.mdx:141 says this event is emitted only by update_current_contract_wasm. In v28, update_current_contract_executable_ref emits the same event as well, so readers following this link receive incomplete behavior documentation. Please update that page to cover both executable update paths.

Low severity Update EVM migration examples to soroban-sdk 28

docs/​learn/​migrate/​evm/​smart-contract-deployment.mdx:261

The v28 dependency update is incomplete: docs/learn/migrate/evm/solidity-and-rust-basics.mdx:576-579 is another current EVM migration example and still instructs readers to use soroban-sdk 27. Please bump both of those declarations to 28 so the docs consistently satisfy this PR's stated v28 update.

@leighmcculloch
leighmcculloch merged commit 3b77f5c into main Sep 24, 2026
10 checks passed
@leighmcculloch
leighmcculloch deleted the upgrade-docs-soroban-sdk-28 branch September 24, 2026 06:46
@github-actions github-actions Bot removed the preview Preview builds for PRs by SDF employees. label Sep 24, 2026
@github-actions

Copy link
Copy Markdown
Contributor

PR Preview: torn down

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants