Type Aliases

The following type aliases are available globally.

Typealiases

  • Array of limbs representing a multi-precision integer in base 2^64.

    Declaration

    Swift

    public typealias Limbs = [UInt64]
  • Single limb component of a multi-precision integer.

    Declaration

    Swift

    public typealias Limb = UInt64
  • Array of digits representing a multi-precision integer in base 10^18 for decimal output.

    Declaration

    Swift

    public typealias Digits = [UInt64]
  • Single digit component in base 10^18 for decimal representation.

    Declaration

    Swift

    public typealias Digit = UInt64
  • Response returned from successfully submitting a transaction to Horizon.

    This is returned when a transaction is successfully submitted and included in a ledger. It contains all transaction details including the result, operations, fees, and metadata.

    For asynchronous transaction submission, see SubmitTransactionAsyncResponse instead.

    See also:

    • Stellar developer docs
    • TransactionResponse for all available properties
    • SubmitTransactionAsyncResponse for async submission

    Declaration

    Swift

    public typealias SubmitTransactionResponse = TransactionResponse
  • Listener invoked for each emitted Smart Account event.

    The closure may throw to signal failure; the emitter catches the error and routes it to the configured error handler so a failing listener never aborts dispatch to its siblings.

    Closures of this type are registered with addListener(_:), on(_:listener:) and once(_:listener:).

    Example:

    let listener: OZSmartAccountEventListener = { event in
        print("Received event: \(event)")
    }
    kit.events.addListener(listener)
    

    Declaration

    Swift

    public typealias OZSmartAccountEventListener = @Sendable (OZSmartAccountEvent) throws -> Void
  • Closure invoked when a registered listener throws while handling an event.

    Receives the event that was being dispatched and the error thrown by the failing listener.

    Declaration

    Swift

    public typealias OZSmartAccountEventErrorHandler = @Sendable (OZSmartAccountEvent, Error) -> Void
  • Closure returned by listener registration; invoke to unsubscribe.

    Declaration

    Swift

    public typealias OZSmartAccountEventUnsubscribe = @Sendable () -> Void
  • Callback that resolves the context rule identifiers to bind into the auth digest for a single authorization entry during the signing loop.

    The callback is invoked once per matching auth entry. The first argument carries the authorization entry being signed; the second is the entry’s index in the simulation-supplied list. The returned identifiers replace the automatic context-rule resolution that otherwise runs against the connected signer set.

    Errors thrown from the callback propagate to the caller of submit(hostFunction:auth:forceMethod:resolveContextRuleIds:).

    Declaration

    Swift

    public typealias OZResolveContextRuleIds = @Sendable (
        _ entry: SorobanAuthorizationEntryXDR,
        _ index: Int
    ) async throws -> [UInt32]
  • Closure type for transaction confirmation callbacks. Returns true to proceed, false to cancel.

    Declaration

    Swift

    public typealias TransactionConfirmationClosure = @Sendable (TransactionXDR) -> (Bool)
  • A convenient shortcut for indicating something is both encodable and decodable.

    Declaration

    Swift

    public typealias XDRCodable = XDREncodable & XDRDecodable