OZContextRuleType

public enum OZContextRuleType : Sendable, Hashable

Type of context rule that determines which operations it applies to.

Context rules use pattern matching to determine when signers and policies should be enforced. Three types of context matching are supported:

  • Default: Matches any operation (fallback rule)
  • CallContract: Matches invocations to a specific contract address
  • CreateContract: Matches contract deployments using a specific WASM hash

Example:

// Default rule applies to all operations
let defaultRule = OZContextRuleType.defaultRule

// Rule for calling a specific token contract
let tokenRule = OZContextRuleType.callContract(contractAddress: "CBCD1234...")

// Rule for deploying contracts with a specific WASM hash
let deployRule = OZContextRuleType.createContract(wasmHash: wasmHashData)
Show on GitHub

  • Matches any operation (fallback / default rule).

    Declaration

    Swift

    case defaultRule
    Show on GitHub

  • Matches invocations to a specific contract address (C…, 56 characters).

    Declaration

    Swift

    case callContract(contractAddress: String)
    Show on GitHub

  • Matches contract deployments using a specific 32-byte WASM hash.

    Declaration

    Swift

    case createContract(wasmHash: Data)
    Show on GitHub

  • Declaration

    Swift

    public static func == (lhs: OZContextRuleType, rhs: OZContextRuleType) -> Bool
    Show on GitHub

  • Declaration

    Swift

    public func hash(into hasher: inout Hasher)
    Show on GitHub

  • Converts the context rule type to its on-chain SCValXDR representation.

    The on-chain representation is:

    • Default: SCValXDR.vec([Symbol("Default")])
    • CallContract: SCValXDR.vec([Symbol("CallContract"), Address(contractAddress)])

    • CreateContract: SCValXDR.vec([Symbol("CreateContract"), Bytes(wasmHash)])

    Throws

    InvalidAddress when the call-contract address cannot be converted to an SCAddressXDR.

    Declaration

    Swift

    public func toScVal() throws -> SCValXDR

    Return Value

    The SCValXDR representation of this context rule type.

    Show on GitHub