SDK Reference
SDK Changelog
Pre-launch
Section
SDK Reference
Documentation category
Type
Guide
Technical reference
Summary
Version history and release notes for all SwssChain SDKs (JavaScript, Python, and Go) with migration guidance for breaking changes.
SWSS Foundation Notice

This documentation is restricted to authorised members of the SWSS Developer Community. Access is granted exclusively through SWSS DevHub, after KYB and SWSS Foundation approval.

All SwssChain GitHub repositories are private. Significant updates are currently deploying across the full SWSS Ecosystem. SDK and API specifications are subject to change at any time in accordance with security requirements and SwssChain Foundation governance decisions.

Join SWSS DevHub →Have a question? Use the Need Help? button below.
SDK Update Notice

SWSS SDK v2.1 is deploying across the ecosystem. API signatures may change during this period. Ensure your integration uses the latest schema from SWSS DevHub.

Article Content

SDK Changelog

This page records every release of the SwssChain SDK suite across all supported languages. Breaking changes are marked with [BREAKING]. Migration notes are included for every breaking change.

All SDKs follow semantic versioning: MAJOR.MINOR.PATCH. Major versions introduce breaking changes. Minor versions add backward-compatible features. Patch versions contain bug fixes only.

JavaScript / TypeScript SDK: @swsschain/sdk

v1.4.0: 2025-11-01

  • Added client.deed.subscribeToSettlements() for real-time Deed settlement event streaming via WebSocket.
  • Added swssChainMainnet and swssChainTestnet chain definitions for wagmi v2 via @swsschain/sdk/wagmi export path.
  • Added client.estimateGas() for pre-flight gas estimation without submitting a transaction.
  • Improved TypeScript inference on contract.read.* and contract.write.*: no more manual type casting required for common ABI patterns.
  • Fixed: waitForTransaction could resolve prematurely when a block reorganisation occurred at confirmation boundary.
  • Fixed: WebSocket reconnection now uses exponential backoff (max 30 seconds) instead of a fixed 5-second interval.

v1.3.0: 2025-09-15

  • Added DeedType.COMPUTE_DEED support (Compute Deed: Q3 2026 network activation).
  • Added client.deed.getSettlementHistory() for paginated settlement lookup by address.
  • Added client.getCode() for reading deployed contract bytecode.
  • Improved error messages: RpcError now includes the full RPC method name and request ID.

v1.2.0: 2025-07-20

  • Added client.subscribeToAddress() for address-level transaction monitoring.
  • Added EIP-4844 blob transaction support (type: 3 transactions).
  • Added client.getStorageAt() for raw storage slot reads.

v1.1.0: 2025-05-10

  • Added Finality Certificate retrieval via client.deed.getFinalityCertificate().
  • Added client.parseSWSSCoin() and client.formatSWSSCoin() utility helpers.
  • Fixed: batch RPC calls were not honouring the configured timeout.

v1.0.0: 2025-03-01

  • Initial stable release.
  • Core EVM operations: getBlock, getTransaction, getBalance, sendTransaction, waitForTransaction.
  • Contract interaction: getContract, contract.read.*, contract.write.*.
  • Home Deed settlement via client.deed.submit().
  • New block subscriptions via client.subscribeToBlocks().

v0.x Migration Guide: v0.x to v1.0

[BREAKING] SwssChainClient renamed to SwssChain. Update all import and instantiation sites.

[BREAKING] network parameter is now required. Previously defaulted to mainnet implicitly.

[BREAKING] sendTx() renamed to sendTransaction() for consistency with JSON-RPC naming.


Python SDK: swsschain-sdk

v1.4.0: 2025-11-01

  • Added async for block in client.subscribe_to_blocks() async generator for block streaming.
  • Added client.deed.subscribe_to_settlements() async generator for Deed settlement events.
  • Added client.estimate_gas() for pre-flight gas estimation.
  • Added Python 3.13 to CI matrix and confirmed compatibility.
  • Fixed: async client __aenter__ / __aexit__ now correctly closes the underlying aiohttp.ClientSession.
  • Fixed: wait_for_transaction raised AttributeError on timeout instead of TimeoutError.

v1.3.0: 2025-09-15

  • Added DeedType.COMPUTE_DEED.
  • Added client.deed.get_settlement_history().
  • Added client.get_logs() for event log queries with filter support.

v1.2.0: 2025-07-20

  • Added EIP-4844 blob transaction support.
  • Added client.get_storage_at().
  • Improved retry logic: transient HTTP 429 and 503 responses now retry with jittered backoff.

v1.1.0: 2025-05-10

  • Added Finality Certificate retrieval.
  • Added client.parse_swss_coin() and client.format_swss_coin().
  • Added [async] extras group for optional aiohttp dependency.

v1.0.0: 2025-03-01

  • Initial stable release with synchronous and asynchronous client.
  • Core EVM operations: block, transaction, balance, send, wait.
  • Contract interaction via ABI.
  • Home Deed settlement.

v0.x Migration Guide: v0.x to v1.0

[BREAKING] from swsschain import Client changed to from swsschain import SwssChain.

[BREAKING] Snake-case method rename: sendTransaction → send_transaction, getBalance → get_balance, etc.

[BREAKING] network parameter is now required.


Go SDK: github.com/swsschain/go-sdk

v1.3.0: 2025-11-01

  • Added client.Deed.SubscribeToSettlements() returning a channel of settlement events.
  • Added client.EstimateGas().
  • Improved errgroup-based concurrency helpers in the examples package.
  • Fixed: context cancellation during WaitForTransaction was not propagating to the underlying HTTP call.
  • Upgraded internal dependency go-ethereum from v1.13 to v1.14.

v1.2.0: 2025-09-15

  • Added DeedTypeComputeDeed constant.
  • Added client.Deed.GetSettlementHistory().
  • Added client.GetLogs().

v1.1.0: 2025-07-20

  • Added EIP-4844 blob transaction support.
  • Added client.GetStorageAt().

v1.0.0: 2025-05-10

  • Initial stable release.
  • Full context-aware API surface.
  • Core EVM operations, contract interaction, Home Deed settlement, Finality Certificate retrieval.
  • Goroutine-safe client.

v0.x Migration Guide: v0.x to v1.0

[BREAKING] Package import path changed from github.com/swsschain/sdk-go to github.com/swsschain/go-sdk. Update all go.mod and import statements.

[BREAKING] All methods now accept context.Context as the first parameter. Pass context.Background() where no cancellation is needed.

[BREAKING] NewClient() now returns (*Client, error) instead of panicking on configuration errors.


Deprecation Policy

Methods and types marked @deprecated in SDK documentation are removed only in the next major version, with a minimum 60-day notice period. Deprecated items emit a warning log at runtime on first use (debug level). To suppress deprecation warnings, set the environment variable SWSS_SDK_NO_DEPRECATION_WARNINGS=1.

Reporting Issues

SDK issues and feature requests are tracked in the SwssChain developer repository. Include the SDK version, language version, network (mainnet/testnet), and a minimal reproducible example when filing a report.