Caravan Documentation
Preparing search index...
caravan-bitcoin/src
Module caravan-bitcoin/src
Enumerations
FeeValidationError
Network
Classes
Braid
ExtendedPublicKey
PsbtV2
PsbtV2Maps
Type Aliases
BitcoinNetwork
KeyPrefix
KeyVersion
MultisigAddressType
Variables
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
Functions
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
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Enumerations
Fee
Validation
Error
Network
Classes
Braid
Extended
Public
Key
Psbt
V2
Psbt
V2
Maps
Type Aliases
Bitcoin
Network
Key
Prefix
Key
Version
Multisig
Address
Type
Variables
EXTENDED_
PUBLIC_
KEY_
VERSIONS
MULTISIG_
ADDRESS_
TYPES
P2
SH
P2
SH_
P2
WSH
P2
WSH
PSBT_
MAGIC_
B64
PSBT_
MAGIC_
BYTES
PSBT_
MAGIC_
HEX
ROOT_
FINGERPRINT
TEST_
FIXTURES
ZERO
Functions
add
Signatures
To
PSBT
auto
Load
PSBT
bip32
Path
To
Sequence
bip32
Sequence
To
Path
bitcoins
To
Satoshis
block
Explorer
Address
URL
block
Explorer
APIURL
block
Explorer
Transaction
URL
block
Explorer
URL
braid
Address
Type
braid
Config
braid
Extended
Public
Keys
braid
Index
braid
Network
braid
Required
Signers
calculate
Base
calculate
Input
Weight
calculate
Total
Witness
Size
check
Fee
Error
check
Fee
Rate
Error
compact
Size
compress
Public
Key
convert
Extended
Public
Key
derive
Child
Extended
Public
Key
derive
Child
Public
Key
derive
Extended
Public
Key
derive
Multisig
By
Index
derive
Multisig
By
Path
estimate
Multisig
P2
SH_
P2
WSH
Transaction
V
Size
estimate
Multisig
P2
SH
Transaction
V
Size
estimate
Multisig
P2
WSH
Transaction
V
Size
estimate
Multisig
Transaction
Fee
estimate
Multisig
Transaction
Fee
Rate
extended
Public
Key
Root
Fingerprint
fingerprint
To
Fixed
Length
Hex
generate
Bip32
Derivation
By
Index
generate
Bip32
Derivation
By
Path
generate
Braid
generate
Multisig
From
Hex
generate
Multisig
From
Public
Keys
generate
Multisig
From
Raw
generate
Public
Keys
At
Index
generate
Public
Keys
At
Path
get
Address
Type
get
Fee
Error
Message
get
Fingerprint
From
Public
Key
get
Masked
Derivation
get
Network
From
Prefix
get
Output
Size
get
P2
SH_
P2
WSH
Input
Size
get
P2
SH_
P2
WSH
Output
Size
get
P2
SH
Input
Size
get
P2
SH
Output
Size
get
P2
WSH
Input
Size
get
P2
WSH
Output
Size
get
Parent
BIP32
Path
get
Psbt
Version
Number
get
Redeem
Script
Size
get
Relative
BIP32
Path
get
Witness
Size
get
Witness
Weight
hardened
BIP32
Index
hash160
is
Key
Compressed
is
Valid
Signature
multisig
Address
multisig
Address
Type
multisig
BIP32
Path
multisig
BIP32
Root
multisig
Braid
Details
multisig
Public
Keys
multisig
Redeem
Script
multisig
Required
Signers
multisig
Script
multisig
Signature
Buffer
multisig
Total
Signers
multisig
Witness
Script
network
Data
network
Label
parse
Signature
Array
From
PSBT
parse
Signatures
From
PSBT
psbt
Input
Formatter
psbt
Output
Formatter
satoshis
To
Bitcoins
script
To
Hex
script
To
Ops
signature
No
Sighash
Type
signed
Multisig
Transaction
sort
Inputs
to
Hex
String
translate
PSBT
unsigned
Multisig
PSBT
unsigned
Multisig
Transaction
unsigned
Transaction
Object
From
PSBT
validate
Address
validate
BIP32
Index
validate
BIP32
Path
validate
Bip32
Path
For
Braid
validate
Extended
Public
Key
validate
Extended
Public
Key
For
Network
validate
Fee
validate
Fee
Rate
validate
Hex
validate
Multisig
Input
validate
Multisig
Inputs
validate
Multisig
Signature
validate
Output
validate
Output
Amount
validate
Outputs
validate
Prefix
validate
Public
Key
validate
Root
Fingerprint
validate
Transaction
ID
validate
Transaction
Index
valid
Base64
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