Caravan Documentation
Preparing search index...
Caravan Documentation
Hierarchy Summary
BtcTxComponent
BtcTxInputTemplate
BtcTxOutputTemplate
KeystoreInteraction
UnsupportedInteraction
DirectKeystoreInteraction
JadeInteraction
JadeGetMetadata
JadeExportPublicKey
JadeExportExtendedPublicKey
JadeRegisterWalletPolicy
JadeConfirmMultisigAddress
JadeSignMultisigTransaction
JadeSignMessage
BitBoxInteraction
BitBoxGetMetadata
BitBoxExportPublicKey
BitBoxExportExtendedPublicKey
BitBoxRegisterWalletPolicy
BitBoxConfirmMultisigAddress
BitBoxSignMultisigTransaction
LedgerInteraction
LedgerDashboardInteraction
LedgerGetMetadata
LedgerBitcoinInteraction
LedgerSignMultisigTransaction
LedgerSignMessage
LedgerBitcoinV2WithRegistrationInteraction
LedgerRegisterWalletPolicy
LedgerConfirmMultisigAddress
LedgerV2SignMultisigTransaction
TrezorInteraction
TrezorGetMetadata
TrezorExportHDNode
TrezorExportPublicKey
TrezorExportExtendedPublicKey
TrezorSignMultisigTransaction
TrezorConfirmMultisigAddress
TrezorSignMessage
IndirectKeystoreInteraction
BCUR2Interaction
BCUR2ExportExtendedPublicKey
BCUR2EncodeTransaction
BCUR2SignMultisigTransaction
ColdcardInteraction
ColdcardSignMultisigTransaction
CustomInteraction
CustomExportExtendedPublicKey
CustomSignMultisigTransaction
HermitInteraction
HermitExportExtendedPublicKey
HermitSignMultisigTransaction
PsbtV2Maps
PsbtV2
TransactionDetails
WalletTransactionDetails
WalletMetrics
PrivacyMetrics
WasteMetrics
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
packages
bip32
src
index.ts
KeyOrigin
combineBip32Paths
ensureXpubAtPath
getBlindedXpub
getMaskedKeyOrigin
getRandomChildXpub
getRelativeBip32Sequence
getUnmaskedPath
isValidChildPubKey
secureSecretPath
setXpubNetwork
build-plugins
src
index.ts
provideNavigator
provideSelf
caravan-bitcoin
src
index.ts
FeeValidationError
Network
Braid
ExtendedPublicKey
PsbtV2
PsbtV2Maps
BitcoinNetwork
KeyPrefix
KeyVersion
MultisigAddressType
EXTENDED_PUBLIC_KEY_VERSIONS
MULTISIG_ADDRESS_TYPES
P2SH
P2SH_P2WSH
P2WSH
PSBT_MAGIC_B64
PSBT_MAGIC_BYTES
PSBT_MAGIC_HEX
ROOT_FINGERPRINT
TEST_FIXTURES
ZERO
addSignaturesToPSBT
autoLoadPSBT
bip32PathToSequence
bip32SequenceToPath
bitcoinsToSatoshis
blockExplorerAddressURL
blockExplorerAPIURL
blockExplorerTransactionURL
blockExplorerURL
braidAddressType
braidConfig
braidExtendedPublicKeys
braidIndex
braidNetwork
braidRequiredSigners
calculateBase
calculateInputWeight
calculateTotalWitnessSize
checkFeeError
checkFeeRateError
compactSize
compressPublicKey
convertExtendedPublicKey
deriveChildExtendedPublicKey
deriveChildPublicKey
deriveExtendedPublicKey
deriveMultisigByIndex
deriveMultisigByPath
estimateMultisigP2SH_P2WSHTransactionVSize
estimateMultisigP2SHTransactionVSize
estimateMultisigP2WSHTransactionVSize
estimateMultisigTransactionFee
estimateMultisigTransactionFeeRate
extendedPublicKeyRootFingerprint
fingerprintToFixedLengthHex
generateBip32DerivationByIndex
generateBip32DerivationByPath
generateBraid
generateMultisigFromHex
generateMultisigFromPublicKeys
generateMultisigFromRaw
generatePublicKeysAtIndex
generatePublicKeysAtPath
getAddressType
getFeeErrorMessage
getFingerprintFromPublicKey
getMaskedDerivation
getNetworkFromPrefix
getOutputSize
getP2SH_P2WSHInputSize
getP2SH_P2WSHOutputSize
getP2SHInputSize
getP2SHOutputSize
getP2WSHInputSize
getP2WSHOutputSize
getParentBIP32Path
getPsbtVersionNumber
getRedeemScriptSize
getRelativeBIP32Path
getWitnessSize
getWitnessWeight
hardenedBIP32Index
hash160
isKeyCompressed
isValidSignature
multisigAddress
multisigAddressType
multisigBIP32Path
multisigBIP32Root
multisigBraidDetails
multisigPublicKeys
multisigRedeemScript
multisigRequiredSigners
multisigScript
multisigSignatureBuffer
multisigTotalSigners
multisigWitnessScript
networkData
networkLabel
parseSignatureArrayFromPSBT
parseSignaturesFromPSBT
psbtInputFormatter
psbtOutputFormatter
satoshisToBitcoins
scriptToHex
scriptToOps
signatureNoSighashType
signedMultisigTransaction
sortInputs
toHexString
translatePSBT
unsignedMultisigPSBT
unsignedMultisigTransaction
unsignedTransactionObjectFromPSBT
validateAddress
validateBIP32Index
validateBIP32Path
validateBip32PathForBraid
validateExtendedPublicKey
validateExtendedPublicKeyForNetwork
validateFee
validateFeeRate
validateHex
validateMultisigInput
validateMultisigInputs
validateMultisigSignature
validateOutput
validateOutputAmount
validateOutputs
validatePrefix
validatePublicKey
validateRootFingerprint
validateTransactionID
validateTransactionIndex
validBase64
caravan-clients
src
index.ts
ClientType
PublicBitcoinProvider
BlockchainClient
FeeRatePercentile
Transaction
TransactionDetails
UTXO
WalletTransactionDetails
bitcoindImportDescriptors
caravan-health
src
index.ts
SpendType
PrivacyMetrics
WalletMetrics
WasteMetrics
AddressUtxos
WasteCalculationParams
calculateWasteMetric
determineSpendType
getSpendTypeScore
FeeRatePercentile
MultisigAddressType
Network
Transaction
UTXO
caravan-psbt
src
index.ts
PsbtV2
LegacyInput
LegacyMultisig
LegacyOutput
PsbtInput
PsbtOutput
PSBT_MAGIC_B64
PSBT_MAGIC_BYTES
PSBT_MAGIC_HEX
addGlobalXpubs
autoLoadPSBT
convertLegacyInput
convertLegacyOutput
getPsbtVersionNumber
getUnsignedMultisigPsbtV0
translatePSBT
validateMultisigPsbtSignature
caravan-wallets
src
index.ts
BCUR2Decoder
BCUR2Encoder
BCUR2EncodeTransaction
BCUR2ExportExtendedPublicKey
BCUR2Interaction
BCUR2SignMultisigTransaction
BCURDecoder
BCUREncoder
BitBoxConfirmMultisigAddress
BitBoxExportExtendedPublicKey
BitBoxExportPublicKey
BitBoxGetMetadata
BitBoxInteraction
BitBoxRegisterWalletPolicy
BitBoxSignMultisigTransaction
ColdcardExportExtendedPublicKey
ColdcardExportPublicKey
ColdcardInteraction
ColdcardMultisigWalletConfig
ColdcardSignMultisigTransaction
CustomExportExtendedPublicKey
CustomInteraction
CustomSignMultisigTransaction
DirectKeystoreInteraction
HermitExportExtendedPublicKey
HermitInteraction
HermitSignMultisigTransaction
IndirectKeystoreInteraction
JadeConfirmMultisigAddress
JadeExportExtendedPublicKey
JadeExportPublicKey
JadeGetMetadata
JadeInteraction
JadeRegisterWalletPolicy
JadeSignMessage
JadeSignMultisigTransaction
KeyOrigin
KeystoreInteraction
LedgerBitcoinInteraction
LedgerBitcoinV2WithRegistrationInteraction
LedgerConfirmMultisigAddress
LedgerDashboardInteraction
LedgerExportExtendedPublicKey
LedgerExportPublicKey
LedgerGetMetadata
LedgerInteraction
LedgerRegisterWalletPolicy
LedgerSignMessage
LedgerSignMultisigTransaction
LedgerV2SignMultisigTransaction
MultisigWalletPolicy
TrezorConfirmMultisigAddress
TrezorExportExtendedPublicKey
TrezorExportHDNode
TrezorExportPublicKey
TrezorGetMetadata
TrezorInteraction
TrezorSignMessage
TrezorSignMultisigTransaction
UnsupportedInteraction
AppAndVersion
DeviceError
ExtendedPublicKeyData
JadeDependencies
LedgerDeviceError
LedgerPolicyHmacs
MultisigWalletConfig
SignMultisigTransactionArgs
Summary
WalletConfigKeyDerivation
BCUR2DecoderFactory
BCUR2EncoderFactory
CryptoPSBTFromCBORFactory
KEYSTORE_TYPES
LedgerSignatures
Message
MultisigScriptType
PolicyHmac
RegistryItemFactory
RootFingerprint
SupportedURType
TShowPairingCode
ACTIVE
BCUR2
BITBOX
COLDCARD
COLDCARD_BASE_BIP32_PATHS
COLDCARD_WALLET_CONFIG_VERSION
CUSTOM
DIRECT_KEYSTORES
ERROR
HERMIT
INDIRECT_KEYSTORES
INFO
JADE
KEYSTORES
LEDGER
LEDGER_BOTH_BUTTONS
LEDGER_LEFT_BUTTON
LEDGER_RIGHT_BUTTON
LEDGER_V2
LEVELS
MULTISIG_ROOT
PENDING
STATES
TREZOR
TREZOR_BOTH_BUTTONS
TREZOR_LEFT_BUTTON
TREZOR_PUSH_AND_HOLD_BUTTON
TREZOR_RIGHT_BUTTON
UNSUPPORTED
VERSION
WARNING
braidDetailsToWalletConfig
ConfigAdapter
ConfirmMultisigAddress
EncodeTransactionForSigning
ExportExtendedPublicKey
ExportPublicKey
fingerprintFromHex
getKeyOriginsFromWalletConfig
GetMetadata
getPolicyTemplateFromWalletConfig
getSignatureArray
getTotalSignerCountFromTemplate
RegisterWalletPolicy
SignMessage
SignMultisigTransaction
trezorCoin
validateMultisigPolicyKeys
validateMultisigPolicyScriptType
validateMultisigPolicyTemplate
variantFromAddressType
walletConfigToJadeDescriptor
multisig
src
index.ts
BraidDetails
DeviceError
LedgerPolicyHmacs
LegacyInput
LegacyMultisig
LegacyOutput
MultisigWalletConfig
WalletConfigKeyDerivation
PolicyHmac
RootFingerprint
braidDetailsToWalletConfig
transactions
src
index.ts
FeeBumpStrategy
BtcTransactionTemplate
BtcTxComponent
BtcTxInputTemplate
BtcTxOutputTemplate
TransactionAnalyzer
AcceleratedRbfOptions
AnalyzerOptions
CancelRbfOptions
CPFPOptions
GlobalXpub
InputDerivation
TransactionInput
TransactionTemplateOptions
TxAnalysis
UTXO
BTC
FeeRateSatsPerVByte
Satoshis
ABSURDLY_HIGH_ABS_FEE
ABSURDLY_HIGH_FEE_RATE
DEFAULT_DUST_THRESHOLD_IN_SATS
RBF_SEQUENCE
calculateTotalInputValue
calculateTotalOutputValue
createAcceleratedRbfTransaction
createCancelRbfTransaction
createCPFPTransaction
createOutputScript
estimateTransactionVsize
getOutputAddress
isCPFPFeeSatisfied
mapCaravanNetworkToBitcoinJS
parseNonWitnessUtxoValue
parseWitnessUtxoValue
reverseHex
validateCPFPPackage
validateNonWitnessUtxo
validateSequence