@arkade-os/sdk Documentation - v0.4.35
Preparing search index...
@arkade-os/sdk Documentation - v0.4.35
Namespaces
asset
Batch
BIP322
CLTVMultisigTapscript
ConditionCSVMultisigTapscript
ConditionMultisigTapscript
CSVMultisigTapscript
DefaultVtxo
DelegateVtxo
Intent
MultisigTapscript
Unroll
VHTLC
Enumerations
ArkPsbtFieldKey
ChainTxType
IndexerTxType
SettlementEventType
TapscriptType
TxType
Classes
ArkAddress
ArkError
ArkNote
AssetManager
ContractManager
ContractRepositoryImpl
ContractWatcher
DelegateManagerImpl
DelegateNotConfiguredError
DescriptorSigningProviderMissingError
DigestMismatchError
DustChangeError
ElectrumOnchainProvider
EsploraProvider
Estimator
HDDescriptorProvider
IndexedDBContractRepository
IndexedDBWalletRepository
InMemoryContractRepository
InMemoryWalletRepository
MessageBus
MessageBusNotInitializedError
MissingSigningDescriptorError
MnemonicIdentity
OnchainWallet
Ramps
ReadonlyAssetManager
ReadonlyDescriptorIdentity
ReadonlySingleKey
ReadonlyWallet
ReadonlyWalletError
RestArkProvider
RestDelegateProvider
RestIndexerProvider
SeedIdentity
ServiceWorkerReadonlyWallet
ServiceWorkerTimeoutError
ServiceWorkerWallet
SingleKey
Transaction
TxTree
TxWeightEstimator
VtxoManager
VtxoScript
Wallet
WalletMessageHandler
WalletNotInitializedError
WalletRepositoryImpl
WsElectrumChainSource
Interfaces
AnchorBumper
ArkInfo
ArkProvider
ArkPsbtFieldCoder
ArkTapscript
ArkTransaction
Asset
BaseWalletConfig
BatchInfo
BatchSignableIdentity
BoardingUtxoGroup
BurnParams
ChainTx
Coin
CommitmentTx
Contract
ContractBalance
ContractHandler
ContractManagerConfig
ContractRepository
ContractWatcherConfig
DefaultContractParams
DelegateContractParams
DelegateInfo
DelegateOptions
DelegateProvider
DeprecatedSignerMigrationReport
DeprecatedSignerReport
DescriptorOptions
Discoverable
DiscoveredContract
DiscoveryDeps
FeeAmount
FeeInfo
FeeOutput
HandlerError
IAssetManager
IContractManager
IDelegateManager
Identity
IndexerProvider
IntentFeeConfig
IReadonlyAssetManager
IReadonlyWallet
IssuanceParams
IssuanceResult
IVtxoManager
IWallet
MessageHandler
MigrateDeprecatedSignerOptions
MigrationLegReport
MigrationVtxoRef
Network
NetworkOptions
OffchainInput
OnchainInput
OnchainProvider
Outpoint
PageResponse
ParsedArkContract
PartialSig
PathContext
PathSelection
ProviderClass
ReadonlyIdentity
ReadonlyWalletConfig
Recipient
ReissuanceParams
RenewVtxosOptions
ScanContractsOptions
ScanResult
ScheduledSession
SendBitcoinParams
SettlementConfig
SettleParams
SignedIntent
SignerClassification
SignerSession
SignerSet
SignRequest
Status
SubscriptionEvent
SubscriptionHeartbeat
SubscriptionResponse
Tx
TxHistoryRecord
TxKey
TxNotification
VHTLCContractParams
VirtualCoin
VirtualStatus
Vtxo
VtxoChain
WalletBalance
WalletConfig
WalletRepository
Type Aliases
ArkTxInput
AssetDetails
AssetMetadata
BatchFailedEvent
BatchFinalizationEvent
BatchFinalizedEvent
BatchStartedEvent
BoardingContractParams
ContractEvent
ContractEventCallback
ContractState
ContractVtxo
ContractWithVtxos
CreateContractParams
DelegatorManagerImpl
DelegatorNotConfiguredError
DelegatorProvider
ElectrumBlockHeader
ElectrumTransactionHistory
ElectrumUnspent
EncodedVtxoScript
ExplorerTransaction
ExtendedCoin
ExtendedContractVtxo
ExtendedVirtualCoin
GetVtxosFilter
IDelegatorManager
IncomingFunds
KnownMetadata
MessageTimeouts
MigrationGlobalSkipReason
MigrationLegSkipReason
MigrationStatus
MnemonicOptions
NetworkName
Nonces
OffchainTx
Output
PaginationOptions
RelativeTimelock
RequestEnvelope
ResponseEnvelope
RestDelegatorProvider
SeedIdentityOptions
ServiceWorkerWalletMode
SettlementEvent
SignerStatus
StorageConfig
TapLeafScript
TapLeaves
TreeNonces
TreeNoncesEvent
TreePartialSigs
TreeSignatureEvent
TreeSigningStartedEvent
TreeTxEvent
TxTreeNode
VSize
VtxoType
WalletMode
Variables
ArkPsbtFieldKeyType
BoardingContractHandler
ConditionWitness
contractHandlers
CosignerPublicKey
DEFAULT_MESSAGE_TIMEOUTS
DefaultContractHandler
DelegateContractHandler
DelegatorManagerImpl
DelegatorNotConfiguredError
ELECTRUM_TCP_HOST
ELECTRUM_WS_URL
ESPLORA_URL
MESSAGE_BUS_NOT_INITIALIZED
networks
P2A
RestDelegatorProvider
TapTreeCoder
VHTLCContractHandler
VtxoTaprootTree
VtxoTreeExpiry
Functions
assembleBtcdTaprootTree
buildForfeitTx
buildOffchainTx
classifyAgainstSignerSet
classifyContractSigner
closeDatabase
combineTapscriptSigs
contractFromArkContract
contractFromArkContractWithAddress
decodeArkContract
decodeTapscript
encodeArkContract
getArkPsbtFields
getMigrationStatus
getRandomId
getSequence
hasBoardingTxExpired
isArkContract
isBatchSignable
isCltvSatisfied
isCooperativelyMigratable
isCsvSpendable
isDiscoverable
isExpired
isRecoverable
isSpendable
isSubdust
isValidArkAddress
isVtxoExpiringSoon
maybeArkError
migrateWalletRepository
MIGRATION_KEY
openDatabase
requiresMigration
rollbackMigration
sequenceToTimelock
setArkPsbtField
setupServiceWorker
signerSetFromInfo
timelockToSequence
toXOnlySignerHex
validateConnectorsTxGraph
validateVtxoTxGraph
verifyTapscriptSignatures
waitForIncomingFunds
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Namespaces
asset
Batch
BIP322
CLTV
Multisig
Tapscript
Condition
CSV
Multisig
Tapscript
Condition
Multisig
Tapscript
CSV
Multisig
Tapscript
Default
Vtxo
Delegate
Vtxo
Intent
Multisig
Tapscript
Unroll
VHTLC
Enumerations
Ark
Psbt
Field
Key
Chain
Tx
Type
Indexer
Tx
Type
Settlement
Event
Type
Tapscript
Type
Tx
Type
Classes
Ark
Address
Ark
Error
Ark
Note
Asset
Manager
Contract
Manager
Contract
Repository
Impl
Contract
Watcher
Delegate
Manager
Impl
Delegate
Not
Configured
Error
Descriptor
Signing
Provider
Missing
Error
Digest
Mismatch
Error
Dust
Change
Error
Electrum
Onchain
Provider
Esplora
Provider
Estimator
HD
Descriptor
Provider
Indexed
DB
Contract
Repository
Indexed
DB
Wallet
Repository
In
Memory
Contract
Repository
In
Memory
Wallet
Repository
Message
Bus
Message
Bus
Not
Initialized
Error
Missing
Signing
Descriptor
Error
Mnemonic
Identity
Onchain
Wallet
Ramps
Readonly
Asset
Manager
Readonly
Descriptor
Identity
Readonly
Single
Key
Readonly
Wallet
Readonly
Wallet
Error
Rest
Ark
Provider
Rest
Delegate
Provider
Rest
Indexer
Provider
Seed
Identity
Service
Worker
Readonly
Wallet
Service
Worker
Timeout
Error
Service
Worker
Wallet
Single
Key
Transaction
Tx
Tree
Tx
Weight
Estimator
Vtxo
Manager
Vtxo
Script
Wallet
Wallet
Message
Handler
Wallet
Not
Initialized
Error
Wallet
Repository
Impl
Ws
Electrum
Chain
Source
Interfaces
Anchor
Bumper
Ark
Info
Ark
Provider
Ark
Psbt
Field
Coder
Ark
Tapscript
Ark
Transaction
Asset
Base
Wallet
Config
Batch
Info
Batch
Signable
Identity
Boarding
Utxo
Group
Burn
Params
Chain
Tx
Coin
Commitment
Tx
Contract
Contract
Balance
Contract
Handler
Contract
Manager
Config
Contract
Repository
Contract
Watcher
Config
Default
Contract
Params
Delegate
Contract
Params
Delegate
Info
Delegate
Options
Delegate
Provider
Deprecated
Signer
Migration
Report
Deprecated
Signer
Report
Descriptor
Options
Discoverable
Discovered
Contract
Discovery
Deps
Fee
Amount
Fee
Info
Fee
Output
Handler
Error
I
Asset
Manager
I
Contract
Manager
I
Delegate
Manager
Identity
Indexer
Provider
Intent
Fee
Config
I
Readonly
Asset
Manager
I
Readonly
Wallet
Issuance
Params
Issuance
Result
I
Vtxo
Manager
I
Wallet
Message
Handler
Migrate
Deprecated
Signer
Options
Migration
Leg
Report
Migration
Vtxo
Ref
Network
Network
Options
Offchain
Input
Onchain
Input
Onchain
Provider
Outpoint
Page
Response
Parsed
Ark
Contract
Partial
Sig
Path
Context
Path
Selection
Provider
Class
Readonly
Identity
Readonly
Wallet
Config
Recipient
Reissuance
Params
Renew
Vtxos
Options
Scan
Contracts
Options
Scan
Result
Scheduled
Session
Send
Bitcoin
Params
Settlement
Config
Settle
Params
Signed
Intent
Signer
Classification
Signer
Session
Signer
Set
Sign
Request
Status
Subscription
Event
Subscription
Heartbeat
Subscription
Response
Tx
Tx
History
Record
Tx
Key
Tx
Notification
VHTLC
Contract
Params
Virtual
Coin
Virtual
Status
Vtxo
Vtxo
Chain
Wallet
Balance
Wallet
Config
Wallet
Repository
Type Aliases
Ark
Tx
Input
Asset
Details
Asset
Metadata
Batch
Failed
Event
Batch
Finalization
Event
Batch
Finalized
Event
Batch
Started
Event
Boarding
Contract
Params
Contract
Event
Contract
Event
Callback
Contract
State
Contract
Vtxo
Contract
With
Vtxos
Create
Contract
Params
Delegator
Manager
Impl
Delegator
Not
Configured
Error
Delegator
Provider
Electrum
Block
Header
Electrum
Transaction
History
Electrum
Unspent
Encoded
Vtxo
Script
Explorer
Transaction
Extended
Coin
Extended
Contract
Vtxo
Extended
Virtual
Coin
Get
Vtxos
Filter
I
Delegator
Manager
Incoming
Funds
Known
Metadata
Message
Timeouts
Migration
Global
Skip
Reason
Migration
Leg
Skip
Reason
Migration
Status
Mnemonic
Options
Network
Name
Nonces
Offchain
Tx
Output
Pagination
Options
Relative
Timelock
Request
Envelope
Response
Envelope
Rest
Delegator
Provider
Seed
Identity
Options
Service
Worker
Wallet
Mode
Settlement
Event
Signer
Status
Storage
Config
Tap
Leaf
Script
Tap
Leaves
Tree
Nonces
Tree
Nonces
Event
Tree
Partial
Sigs
Tree
Signature
Event
Tree
Signing
Started
Event
Tree
Tx
Event
Tx
Tree
Node
V
Size
Vtxo
Type
Wallet
Mode
Variables
Ark
Psbt
Field
Key
Type
Boarding
Contract
Handler
Condition
Witness
contract
Handlers
Cosigner
Public
Key
DEFAULT_
MESSAGE_
TIMEOUTS
Default
Contract
Handler
Delegate
Contract
Handler
Delegator
Manager
Impl
Delegator
Not
Configured
Error
ELECTRUM_
TCP_
HOST
ELECTRUM_
WS_
URL
ESPLORA_
URL
MESSAGE_
BUS_
NOT_
INITIALIZED
networks
P2
A
Rest
Delegator
Provider
Tap
Tree
Coder
VHTLC
Contract
Handler
Vtxo
Taproot
Tree
Vtxo
Tree
Expiry
Functions
assemble
Btcd
Taproot
Tree
build
Forfeit
Tx
build
Offchain
Tx
classify
Against
Signer
Set
classify
Contract
Signer
close
Database
combine
Tapscript
Sigs
contract
From
Ark
Contract
contract
From
Ark
Contract
With
Address
decode
Ark
Contract
decode
Tapscript
encode
Ark
Contract
get
Ark
Psbt
Fields
get
Migration
Status
get
Random
Id
get
Sequence
has
Boarding
Tx
Expired
is
Ark
Contract
is
Batch
Signable
is
Cltv
Satisfied
is
Cooperatively
Migratable
is
Csv
Spendable
is
Discoverable
is
Expired
is
Recoverable
is
Spendable
is
Subdust
is
Valid
Ark
Address
is
Vtxo
Expiring
Soon
maybe
Ark
Error
migrate
Wallet
Repository
MIGRATION_
KEY
open
Database
requires
Migration
rollback
Migration
sequence
To
Timelock
set
Ark
Psbt
Field
setup
Service
Worker
signer
Set
From
Info
timelock
To
Sequence
to
X
Only
Signer
Hex
validate
Connectors
Tx
Graph
validate
Vtxo
Tx
Graph
verify
Tapscript
Signatures
wait
For
Incoming
Funds
@arkade-os/sdk Documentation - v0.4.35
Loading...