Skip to main content

Versions, installation and compatibility

Protocol, SDK packages, ABI, proof resources and service APIs are released independently. Compilation, a shared version number, passing tests and actual deployment are different facts.

Example scope​

SDK examples use the 1.3.2 API. Choose a distribution that exports the required methods and has matching ABI and proof resources. A documented API version does not establish publication of every package.

Earlier 1.3.1 packages may not include the newer capabilities used here. Do not select solely by latest or infer that equivalent Go/Rust tags exist. Use the exports and release notes of your selected package.

Install a verified compatible release​

First set SDK_VERSION to an existing package version that includes your required APIs. Do not substitute the documentation version automatically.

: "${SDK_VERSION:?Set an available, compatible SDK version}"
npm install "@invisi-labs/sdk@$SDK_VERSION" "@invisi-labs/prover@$SDK_VERSION" "@invisi-labs/session@$SDK_VERSION" ethers

For unpublished interfaces, obtain a trusted distribution providing those APIs and matching proof resources first. The command above does not provide unpublished functionality. Go modules and Rust crates likewise require actual available tags/packages.

Compatibility checklist​

ComponentIdentity and configuration
CoreChain ID, address, runtime code identity, deployment block and ABI
SDKActual language-specific versions and required exports
Local proverNoir/BB toolchain, authenticated Core catalog, VK and circuit identity
ProvenanceSeparate catalog, trusted issuer/key and Source capabilities
Protocol RPCAPI, indexed deployment and native finality support
BroadcasterSigned quote, execution mode, fees, scheduling and cancellation
IPP / FacilitatorMessage version, authentication, methods and credit capabilities

Current proving resources pair Noir/Noir JS 1.0.0 with BB 6.0.0. Core and Provenance have independent authenticated sets; check publication, downloads and compatibility separately. Stop on missing or hash-mismatched resources rather than accepting unknown replacements.

Upgrade checks​

Retain deployment identities, Stores, operation journals and pending task identifiers. In a test environment, validate history reads, original-operation recovery, event decoding, proof generation and confirmation. Decode historical deployments with their matching ABI, not a newer event layout.

Upgrading an SDK or service does not automatically upgrade Core contracts. Service version labels do not replace deployment identity and runtime code checks.