salt-sdk - v0.0.45
    Preparing search index...

      salt-sdk - v0.0.45

      Architecture
      Getting Started
      Fees
      Child accounts

      The SDK's entry point and its construction options.

      Salt
      ConstructorParams
      SDK_VERSION

      Organisations, their collaborators, and invitations to join them.

      InvitationListener
      AccessRole
      Collaborator
      CollaboratorAccessLevel
      CollaboratorStatus
      Invitation
      InvitationListenerEvents
      Organisation

      Salt accounts and the keygen ceremony that creates them.

      AccountCeremony
      HostAccountCeremony
      AccountCeremonyEvents
      AccountCeremonyResult
      AccountSigner
      ChildAccountStatus
      CreateAccountParams
      GasPrice
      HostAccountCeremonyResult
      SaltAccount
      VerifyAccountResult

      Robo signers: automated co-signers that pass policy checks before signing.

      RoboHost
      RoboHostProvisioning
      RoboHostSetup
      RoboSetupListener
      WaitUntilOnlineOptions
      ActivateRoboHostParams
      CreateRoboHostParams
      RoboCloudFormationUrlParams
      RoboHostSecrets
      RoboQuorum
      RoboQuorumParams
      Robos
      RoboSetupListenerEvents
      RoboSetupScriptParams
      RoboSignerStatus
      RoboStatus

      MPC signing ceremonies — on-chain transactions and off-chain message signing — and the records they produce.

      AccountMessage
      AccountTransaction
      EvmSignature
      MessageFailureReason
      SaltCeremony
      SignerConfiguration
      SignMessageHostCeremony
      SignMessageJoinCeremony
      TransactionFailureReason
      TransactionHostCeremony
      TransactionJoinCeremony
      TransactionMetadata
      TransactionObject
      TransactionObjectParams
      MessageFailureCode
      MessageState
      PresenceEvent
      PresenceSnapshot
      SaltTypedData
      SignablePayload
      SignerStatus
      SignMessageCeremonyEvents
      SignMessageCeremonyHostResult
      SignMessageStage
      TransactionCeremonyEvents
      TransactionCeremonyHostResult
      TransactionCeremonyJoinResult
      TransactionFailureCode
      TransactionStage
      TransactionState

      Realtime coordination: nudges that announce a ceremony, and the websocket connection they travel over.

      NudgeListener
      ChildVerifyNudgeReceivedEvent
      KeygenNudgeReceivedEvent
      NudgeListenerEvents
      NudgeReceivedEvent
      SaltSocketConnectionState
      SaltSocketNamespace
      SigningNudgeReceivedEvent
      SignMessageNudgeReceivedEvent
      ValidChildVerifyNudgePayload
      ValidKeygenNudgePayload
      ValidSigningNudgePayload
      ValidSignMessageNudgePayload

      Account policies that constrain which transactions are allowed to sign.

      ApproverEntry
      ContractParamRestriction
      ContractParamRestrictionOperator
      LimitEntry
      Policy
      PolicyParams
      PolicyType
      RecipientEntry

      Key store networks and the destination chains a Salt account can transact on.

      EnvironmentName
      Environment
      EnvironmentConfig
      PreconfiguredEnvironment
      SupportedChainId
      SALT_DOMAINS
      SUPPORTED_CHAINS

      Narrowed viem types used at the SDK's public boundary.

      Address
      AttachedWalletClient
      ViemPublicClientLike
      ViemTypedDataSignerLike
      ViemWalletClientLike

      Request shapes accepted by SDK methods.

      DeployTransactionParams
      SendTransactionParams
      CreateOrganisationCollaborator
      CreateOrganisationParams
      CreatePolicyRequest
      InviteCollaboratorParams
      PolicyBatchOperation
      TransactionParams
      UpdateAccountParams
      UpdateCollaboratorParams
      UpdateOrganisationParams

      Response shapes returned by SDK methods.

      NudgePayload
      RoboSetupUpdate
      CreateOrganisationResponse
      DeclineInvitationResponse
      GetInvitationsResponse
      InvitationInviter
      InvitationOrganisation
      LeaveOrganisationResponse
      OrganisationByIdResponse
      OrganisationsResponse
      PolicyCheck

      Supporting types and functions for building requests.

      TransferType
      BaseTransferParams
      ERC20TransferParams
      NativeTransferParams
      TransferParams
      ACCESS_LEVEL_BY_ROLE
      buildTransferTransaction

      Errors thrown by the SDK, exported for instanceof checks.

      ApiError
      BroadcastRejectedError
      CeremonyHostError
      CeremonyJoinError
      CeremonyTimeoutError
      ChildVerificationTimeoutError
      DuplicatePolicyError
      InsufficientFunds
      InsufficientPermissions
      InvalidAddress
      InvalidAuthToken
      InvalidChain
      InvalidEnvironment
      InvalidHex
      InvalidMessage
      InvalidNudgePayload
      InvalidParams
      InvalidSendingProvider
      InvalidSigner
      InvalidTransitionError
      InvalidTypedData
      InvalidUrl
      InvalidValue
      KeyshareBackupFailedError
      KeyshareBackupUnavailableError
      NotImplemented
      PayloadMismatchError
      PaymentAuthorisationError
      PaymentRequiredError
      PolicyBreachError
      RoboHostTimeoutError
      RoboStatusError
      SaltCeremonyError
      SaltshardError
      SocketConnectError
      SocketError
      TransactionPendingError
      TransactionReplacedError
      TransactionRevertedError
      UnsupportedRuntime
      ValidationError
      WrongChain
      CeremonyTimeoutInfo
      CeremonyHostErrorCode
      CeremonyJoinErrorCode
      CeremonyTimeoutPhase
      InsufficientFundsDetails
      MismatchedTxField
      RuntimeCapability
      TypedDataField
      isInsufficientFundsError

      The fees charged for account creation and transaction submission, and the x402 payment flow that pays them.

      FeePayment
      FeeOption
      FeeOptionSource
      FeePaymentStatus
      FeeQuote
      FeeTerms
      OnPaymentRequired
      PayableOperation
      QuotedRequirement
      SignedPayment
      PolicyBatchResult
      PolicyContent
      PolicySealSummary