InstallRequest

public final class InstallRequest : Sendable

Request parameters for installing (uploading) contract WebAssembly code.

Installing a contract uploads the compiled WASM bytecode to the Stellar network, making it available for deployment. The same WASM code can be used to deploy multiple contract instances.

Required parameters:

  • Source account keypair (with private key for signing)
  • Contract WASM bytecode
  • Network and RPC endpoint

Example:

// Load contract WASM file
let wasmBytes = try Data(contentsOf: contractWasmUrl)

let installRequest = InstallRequest(
    rpcUrl: "https://soroban-testnet.stellar.org",
    network: Network.testnet,
    sourceAccountKeyPair: sourceKeyPair,
    wasmBytes: wasmBytes,
    enableServerLogging: false
)

let wasmHash = try await SorobanClient.install(installRequest: installRequest)
print("Installed with hash: \(wasmHash)")

See also:

  • [SorobanClient.install] for installing contracts
  • [DeployRequest] for deploying contract instances
Show on GitHub

  • The URL of the RPC instance that will be used to install the contract.

    Declaration

    Swift

    public let rpcUrl: String
    Show on GitHub

  • The Stellar network this contract is to be installed to.

    Declaration

    Swift

    public let network: Network
    Show on GitHub

  • Keypair of the Stellar account that will send this transaction. The keypair must contain the private key for signing.

    Declaration

    Swift

    public let sourceAccountKeyPair: KeyPair
    Show on GitHub

  • The contract code wasm bytes to install.

    Declaration

    Swift

    public let wasmBytes: Data
    Show on GitHub

  • Enable soroban server logging (helpful for debugging). Default: false.

    Declaration

    Swift

    public let enableServerLogging: Bool
    Show on GitHub

  • Constructor

    Declaration

    Swift

    public init(rpcUrl: String, network: Network, sourceAccountKeyPair: KeyPair, wasmBytes: Data, enableServerLogging: Bool)

    Parameters

    rpcUrl

    The URL of the RPC instance that will be used to install the contract.
    network

    The Stellar network this contract is to be installed to.
    sourceAccountKeyPair

    Keypair of the Stellar account that will send this transaction. The keypair must contain the private key for signing.
    wasmBytes

    The contract code wasm bytes to install.
    enableServerLogging

    Enable soroban server logging (helpful for debugging). Default: false.
    Show on GitHub