@arkade-os/sdk Documentation - v0.5.0-rc.11
    Preparing search index...

      @arkade-os/sdk Documentation - v0.5.0-rc.11

      Namespaces

      arkade
      asset
      Batch
      BIP322
      CLTVMultisigTapscript
      ConditionCSVMultisigTapscript
      ConditionMultisigTapscript
      CSVMultisigTapscript
      DefaultVtxo
      DelegateVtxo
      Intent
      MultisigTapscript
      Unroll
      VHTLC

      Enumerations

      ArkPsbtFieldKey
      BIP21Error
      ChainedTxType
      ChainTxType
      IndexerTxType
      SettlementEventType
      TapscriptType
      TxType

      Classes

      AbortError
      ActivityRegistry
      AmbiguousRouteError
      ArkAddress
      ArkadeCash
      ArkadeCashCreateError
      ArkError
      ArkNote
      AssetManager
      BIP21
      CachingArkProvider
      ConnectionDisposedError
      ContractManager
      ContractWatcher
      DatabaseUpgradeBlockedError
      DelegateManagerImpl
      DelegateNotConfiguredError
      DescriptorIdentity
      DescriptorSigningProviderMissingError
      DigestMismatchError
      DustChangeError
      ElectrumOnchainProvider
      EmulatorPacket
      EsploraProvider
      Estimator
      EventSourceUnavailableError
      Extension
      ExtensionNotFoundError
      FetchError
      ForeignDescriptorError
      HDDescriptorProvider
      IndexedDBContractRepository
      IndexedDBIntentRepository
      IndexedDBVirtualTxRepository
      IndexedDBWalletRepository
      InMemoryContractRepository
      InMemoryIntentRepository
      InMemoryVirtualTxRepository
      InMemoryWalletRepository
      MessageBus
      MessageBusInitializingError
      MessageBusNotInitializedError
      MissingSigningDescriptorError
      MnemonicIdentity
      OnchainWallet
      OversizedChangeError
      PaymentRouter
      PrevTxUnavailableError
      ProviderUnavailableError
      Ramps
      ReadonlyAssetManager
      ReadonlyDescriptorIdentity
      ReadonlySingleKey
      ReadonlyWallet
      ReadonlyWalletError
      RestArkProvider
      RestDelegateProvider
      RestEmulatorProvider
      RestIndexerProvider
      SeedIdentity
      ServerResponseMismatchError
      ServiceWorkerReadonlyWallet
      ServiceWorkerTimeoutError
      ServiceWorkerWallet
      SingleKey
      Transaction
      TxTree
      TxWeightEstimator
      UnannotatableInputError
      UnknownPacket
      VtxoManager
      VtxoScript
      Wallet
      WalletCannotAllocateAddressError
      WalletCannotSignError
      WalletMessageHandler
      WalletNotInitializedError
      WsElectrumChainSource

      Interfaces

      Activity
      ActivityIntent
      ActivityResolver
      AddressAllocationCapable
      AnchorBumper
      ArkadeCashClaimResult
      ArkadeCashUnclaimedVtxo
      ArkadeContractParams
      ArkadeInfo
      ArkIntent
      ArkProvider
      ArkPsbtFieldCoder
      ArkTapscript
      ArkTransaction
      Asset
      BaseWalletConfig
      BatchInfo
      BatchSignableIdentity
      BIP21Params
      BIP21ParseResult
      BoardingUtxoGroup
      BurnParams
      ChainTx
      Coin
      CommitmentTx
      ConnectorTreeNode
      Contract
      ContractBalance
      ContractHandler
      ContractManagerConfig
      ContractRepository
      ContractWatcherConfig
      DefaultContractParams
      DelegateContractParams
      DelegateInfo
      DelegateOptions
      DelegateProvider
      DeprecatedSignerMigrationReport
      DeprecatedSignerReport
      DescriptorIdentityOptions
      DescriptorOptions
      DeterministicSigner
      Discoverable
      DiscoveredContract
      DiscoveryDeps
      EmulatorEntry
      EmulatorInfo
      EmulatorProvider
      EventSourceCapable
      EventSourceLike
      ExecutorOptions
      ExitChainResolver
      ExitDataSource
      ExitFeeWallet
      ExtensionPacket
      FeeAmount
      FeeInfo
      FeeOutput
      GetNewAddressesOptions
      GroupMembership
      HandlerError
      HDAllocationCapable
      HDDeterministicSignCapable
      HDWalletCapable
      IAssetManager
      IContractManager
      IDelegateManager
      Identity
      IndexerProvider
      IntentFeeConfig
      IntentFilter
      IntentRepository
      IReadonlyAssetManager
      IReadonlyWallet
      IssuanceParams
      IssuanceResult
      IVtxoManager
      IWallet
      ManagedConnection
      MessageHandler
      MigrateDeprecatedSignerOptions
      MigrationLegReport
      MigrationVtxoRef
      Network
      NetworkOptions
      NewAddress
      OffchainInput
      OnchainInput
      OnchainProvider
      Outpoint
      PageResponse
      ParsedArkContract
      PartialSig
      PathContext
      PathSelection
      PaymentHandle
      PaymentOption
      PaymentRail
      PaymentRequest
      PrevTxSource
      ProviderClass
      ProvisionedClaimSecret
      ProvisionedKey
      RawTxSource
      ReadonlyIdentity
      ReadonlyWalletConfig
      Recipient
      ReissuanceParams
      RenewVtxosOptions
      RouteQuote
      RouterContext
      RouteResult
      RouterPreferences
      ScanContractsOptions
      ScanResult
      ScheduledSession
      SendBitcoinParams
      SendParams
      SettlementConfig
      SettleParams
      SignedIntent
      SignerClassification
      SignerSession
      SignerSet
      SignRequest
      Status
      SubscriptionEvent
      SubscriptionHeartbeat
      SubscriptionResponse
      SweepTxNotification
      Tx
      TxHistoryRecord
      TxKey
      TxNotification
      TxNotificationEvent
      VerifyServerSignatures
      VHTLCContractParams
      VHTLCV2ContractParams
      VirtualCoin
      VirtualTx
      VirtualTxRepository
      Vtxo
      VtxoBranch
      VtxoChain
      WaitForIncomingFundsOptions
      WalletBalance
      WalletConfig
      WalletRepository
      WalletRestoreHook
      WatchedScript

      Type Aliases

      ArkadeBatchInput
      ArkadeBroadcaster
      ArkadeCashUnclaimedReason
      ArkadeExtendedCoin
      ArkadeExtendedVirtualCoin
      ArkadeReader
      ArkErrorName
      ArkIntentState
      ArkTxInput
      AssetDetails
      AssetMetadata
      BatchExpiryPolicy
      BatchFailedEvent
      BatchFinalizationEvent
      BatchFinalizedEvent
      BatchStartedEvent
      BoardingContractParams
      CandidateDeps
      CheckpointExitDelayPolicy
      ContractEvent
      ContractEventCallback
      ContractState
      ContractSyncState
      ContractVtxo
      ContractVtxoEvent
      ContractWithVtxos
      CreateContractParams
      DescriptorSigner
      ElectrumBlockHeader
      ElectrumTransactionHistory
      ElectrumUnspent
      EncodedVtxoScript
      EventSourceFactory
      ExcludableVtxo
      ExecutorEvent
      ExitCaptureMode
      ExitDelay
      ExitMode
      ExitOptions
      ExitPackage
      ExitQuote
      ExitStep
      ExitTotals
      ExitVtxoInfo
      ExplorerTransaction
      ExtendedCoin
      ExtendedContractVtxo
      ExtendedVirtualCoin
      GetArkadeInfoOptions
      GetVtxosFilter
      GetVtxosOptions
      IncomingFunds
      IntentCoin
      KnownMetadata
      MessageTimeouts
      MigrationGlobalSkipReason
      MigrationLegSkipReason
      MnemonicOptions
      NetworkName
      NewAddressType
      Nonces
      NormalizedExtendedVirtualCoin
      NormalizedVtxoPage
      OffchainTx
      OnExitObserved
      Output
      PaginationOptions
      PaymentStatus
      ProviderConnectionState
      ProviderKind
      RecipientArkadeAddressContext
      RelativeTimelock
      RequestEnvelope
      ResponseEnvelope
      SeedIdentityOptions
      ServerInfoSource
      ServiceWorkerWalletMode
      SettlementEvent
      SignerStatus
      StorageConfig
      TapLeafScript
      TapLeaves
      TimeHeight
      TreeNonces
      TreeNoncesEvent
      TreePartialSigs
      TreeSignatureEvent
      TreeSigningStartedEvent
      TreeTxEvent
      TxTag
      TxTreeNode
      VSize
      VtxoExclusion
      VtxoType
      WalletMode
      WithPrevTx

      Variables

      ARKADE_MAGIC
      ARKADE_SALTED_PREIMAGE_TAG
      ARKADE_SWAP_PREIMAGE_TAG
      ArkadeContractHandler
      ArkErrorName
      ArkPsbtFieldKeyType
      ASSET_CARRIER_SATS
      BITCOIN_EMULATOR_PUBKEY
      BLOCKED_UPGRADE_TIMEOUT_MS
      BoardingContractHandler
      buildVersion
      ConditionWitness
      contractHandlers
      CosignerPublicKey
      DEFAULT_MESSAGE_TIMEOUTS
      DEFAULT_MIN_BATCH_EXPIRY_SECONDS
      DEFAULT_MIN_CHECKPOINT_EXIT_DELAY_SECONDS
      DEFAULT_VTXO_PAGE_SIZE
      DefaultContractHandler
      DelegateContractHandler
      ELECTRUM_TCP_HOST
      ELECTRUM_WS_URL
      ESPLORA_URL
      INTENT_TERMINAL_STATES
      MAX_USED_SIGNING_DESCRIPTORS_LOOK_AHEAD
      MESSAGE_BUS_INITIALIZING
      MESSAGE_BUS_NOT_INITIALIZED
      MUTINYNET_EMULATOR_PUBKEY
      MUTINYNET_MIN_CHECKPOINT_EXIT_DELAY_SECONDS
      networks
      P2A
      PrevArkTxField
      PrevoutTxField
      READ_TIMEOUT_MS
      REGTEST_EMULATOR_PUBKEY
      REGTEST_MIN_BATCH_EXPIRY_SECONDS
      REGTEST_MIN_CHECKPOINT_EXIT_DELAY_SECONDS
      sdkVersion
      SIGNET_MIN_CHECKPOINT_EXIT_DELAY_SECONDS
      TapTreeCoder
      UnilateralExit
      VHTLCContractHandler
      VHTLCV2ContractHandler
      VtxoTaprootTree
      VtxoTreeExpiry

      Functions

      adoptContractDescriptor
      arkAssetRail
      arkRail
      arkTarget
      assembleBtcdTaprootTree
      assertAllowedSighashTypes
      assertFinalCommitmentMatchesValidated
      assertNoAssets
      assertNoSelection
      assertRecipientArkadeAddress
      assertSendableAmount
      assertSubmittedArkTxid
      assertValidBatchExpiry
      assertValidServerUnrollScript
      assetMintResolver
      assetsOf
      attachPrevArkTxs
      attachPrevoutTxs
      awaitTransaction
      boardingResolver
      btcTarget
      buildForfeitTx
      buildOffchainTx
      buildPreimageMessage
      buildSaltedPreimageMessage
      canRecoverOnchain
      canSpendOffchain
      canSweepOnchain
      claimWithPreimageIdentity
      classifyAgainstSignerSet
      classifyContractSigner
      closeDatabase
      collabExitResolver
      combineTapscriptSigs
      configureEventSource
      contractFromArkContract
      contractFromArkContractWithAddress
      contractPreimage
      contractSigner
      createAssetPacket
      createDefaultActivityRegistry
      createDefaultPaymentRouter
      createExitChainResolver
      createManagedConnection
      decodeArkContract
      decodeTapscript
      defaultBatchExpiryPolicy
      defaultCheckpointExitDelayPolicy
      defaultEmulatorPubkey
      deleteByIndex
      deriveDescriptorLeafCompressedPubKey
      deriveDescriptorLeafPubKey
      deserializeExitPackage
      encodeArkContract
      exitObserverFor
      gatedContracts
      gateExclusion
      getAllByIndexValues
      getAllNormalizedVtxos
      getArkPsbtFields
      getConfiguredEventSource
      getNetwork
      getNormalizedVtxos
      getRandomId
      getSequence
      hasBoardingTxExpired
      hasCandidates
      hasTerminalSpend
      identityDescriptor
      invoiceTarget
      isAddressAllocationCapable
      isArkContract
      isArkError
      isBatchSignable
      isBtcAddress
      isCltvSatisfied
      isContractGenericallySpendable
      isContractVtxoEvent
      isCooperativelyMigratable
      isCsvSpendable
      isDeterministicSigner
      isDiscoverable
      isEventSourceUnavailableError
      isHDAllocationCapable
      isHDDeterministicSignCapable
      isHDWalletCapable
      isLightningInvoice
      isLnurl
      isMessageBusInitializingError
      isMessageBusNotInitializedError
      isPastExpiry
      isPerArtifactDescriptor
      isRetryableProviderError
      isSigningIdentity
      isSubdust
      isTerminalIntentState
      isValidArkAddress
      isVirtualCoin
      isVtxoExpiringSoon
      logExcludedVtxos
      makeHandle
      matchServerCheckpoints
      maybeArkError
      networkFromArkadeInfo
      normalizeToDescriptor
      notifyExitObserved
      onchainRail
      openDatabase
      outpointExclusion
      outpointReasons
      parseHDDescriptor
      promisifyRequest
      provisionClaimSecret
      provisionRefundKey
      registerWalletRestoreHook
      resolveAssetAmount
      resolveBatchExpiryPolicy
      resolveCheckpointExitDelayPolicy
      resolveDescriptorSigner
      resolveEmulatorPubkey
      resolveEventSource
      resolvePrevTxs
      resolveSendAmount
      scriptFromTapLeafScript
      selectCoinsWithAsset
      selectionOf
      selectVirtualCoins
      sequenceToTimelock
      serializeExitPackage
      setArkPsbtField
      setupServiceWorker
      signAndSubmitOffchainTx
      signerSetFromInfo
      signingDescriptorIndex
      strictSigningDescriptorIndex
      timelockToSequence
      toXOnly
      toXOnlySignerHex
      tryResolveSendAmount
      validateBatchRecipients
      validateConnectorsTxGraph
      validateVtxoTxGraph
      verifyTapscriptSignatures
      waitForIncomingFunds
      walletFeeSource
      withPrevTxs