Starter Kit Reference
SafeClientResult

SafeClientResult

The type of the object returned by the following methods from the SafeClient class and its extensions:

  • Transactions: send and confirm.
  • On-chain messages: sendOnChainMessage and confirm.
  • Off-chain messages: sendOffChainMessage and confirmOffChainMessage.
  • Safe operations: sendSafeOperation and confirmSafeOperation.

Properties


_19
type SafeClientResult = {
_19
safeAddress: string
_19
description: string
_19
status: SafeClientTxStatus
_19
transactions?: {
_19
safeTxHash?: string
_19
ethereumTxHash?: string
_19
}
_19
messages?: {
_19
messageHash?: string
_19
}
_19
safeOperations?: {
_19
userOperationHash?: string
_19
safeOperationHash?: string
_19
}
_19
safeAccountDeployment?: {
_19
ethereumTxHash?: string
_19
}
_19
}

safeAddress

  • Type: string

The connected Safe address.

description

  • Type: string

A human-readable description of the result. More details can be found here (opens in a new tab).

status

  • Type: SafeClientTxStatus

The status of the operation.

  • PENDING_SIGNATURES
  • DEPLOYED_AND_PENDING_SIGNATURES
  • EXECUTED
  • DEPLOYED_AND_EXECUTED
  • MESSAGE_PENDING_SIGNATURES
  • DEPLOYED_AND_MESSAGE_PENDING_SIGNATURES
  • MESSAGE_CONFIRMED
  • DEPLOYED_AND_MESSAGE_CONFIRMED
  • SAFE_OPERATION_PENDING_SIGNATURE
  • SAFE_OPERATION_EXECUTED

transactions.safeTxHash (Optional)

  • Type: string

The hash of the transaction stored in the Safe Transaction Service.

transactions.ethereumTxHash (Optional)

  • Type: string

The transaction hash of the transaction once it's executed.

messages.messageHash (Optional)

  • Type: string

The hash of the message stored in the Safe Transaction Service.

safeOperations.safeOperationHash (Optional)

  • Type: string

The hash of the Safe operation stored in the Safe Transaction Service.

safeOperations.userOperationHash (Optional)

  • Type: string

The hash of the user operation sent to the bundler.

safeAccountDeployment.ethereumTxHash (Optional)

  • Type: string

The hash of the transaction that deployed the Safe, if a Safe is deployed during the operation.

Was this page helpful?