bip/bip/bip library
The 'bip' library serves as a comprehensive collection of libraries for working with various Bitcoin Improvement Proposals (BIPs) in the realm of cryptocurrency.
Classes
- Bip32Base
- An abstract base class for BIP-32 hierarchical deterministic key management.
- Bip32ChainCode
- BIP32 chaincode class. It represents a BIP32 chaincode.
- Bip32Const
-
The
Bip32Constclass defines constants for different Bip32KeyNetVersions. - Bip32Depth
- BIP32 depth class. It represents a BIP32 depth.
- Bip32DeserializedKey
- BIP32 deserialized key class. It represents a key deserialized with the Bip32KeyDeserializer.
- Bip32FingerPrint
- BIP32 fingerprint class. It represents a BIP32 fingerprint.
- Bip32KeyBase
- An abstract base class for BIP32 keys. It provides common properties and methods for BIP32 keys, including the elliptic curve type, key data, and key network versions.
- Bip32KeyData
- BIP32 key data class. It contains all additional data related to a BIP32 key (e.g. depth, chain code, etc...).
- Bip32KeyDataConst
- Class container for BIP32 key data constants.
- Bip32KeyDeserializer
- BIP32 key deserializer class. It deserializes an extended key.
- Bip32KeyIndex
- BIP32 key index class. It represents a BIP32 key index.
- Bip32KeyNetVersions
- Bip32KeyNetVersionsConst
- Contains constants related to BIP32 key network versions.
- Bip32KeySerConst
-
The
Bip32KeySerConstclass contains constants related to the serialization of Bip32 keys. These constants specify the length of serialized public and private keys in bytes. It provides a convenient way to access these values in your code. - Bip32KholawEd25519
- A class representing Bip32 hierarchical deterministic keys using the Kholaw elliptic curve with Ed25519 keys.
- Bip32KholawEd25519KeyDerivator
- Define a class, 'Bip32KholawEd25519KeyDerivator', that extends 'Bip32KholawEd25519KeyDerivatorBase' for Ed25519 key derivation.
- Bip32KholawEd25519KeyDerivatorBase
- Define an abstract class 'Bip32KholawEd25519KeyDerivatorBase' that implements the 'IBip32KeyDerivator' interface. This class provides a base for deriving Ed25519 keys with the Kholaw scheme.
- Bip32KholawEd25519MstKeyGenerator
- Bip32KholawMstKeyGeneratorConst
- Constants for generating master keys for Bip32KholawEd25519 keys.
- Bip32Path
- Represents a BIP32 derivation path, a sequence of key indices.
- Bip32PathConst
- Constants related to the BIP32 derivation path components.
- Bip32PathParser
- A utility class for parsing BIP32 derivation paths and converting them to Bip32Path objects.
- Bip32PrivateKey
- Represents a BIP32 private key with associated data such as the elliptic curve type, key data, and key network versions.
- Bip32PrivateKeySerializer
- BIP32 private key serializer class. It serializes private keys.
- Bip32PublicKey
- Represents a BIP32 public key with associated data such as the elliptic curve type, key data, and key network versions.
- Bip32PublicKeySerializer
- It serializes public keys.
- Bip32Slip10DerivatorConst
- Constants related to the Bip32 Slip10 Derivator.
- Bip32Slip10EcdsaDerivator
-
A class implementing the
IBip32KeyDerivatorinterface for Bip32 Slip10 key derivation with the ECDSA curve. - Bip32Slip10Ed25519
- Represents a Bip32Slip10Ed25519 hierarchical deterministic key for Ed25519 curve.
- Bip32Slip10Ed25519Blake2b
- Represents a Bip32Slip10Ed25519Blake2b hierarchical deterministic key for Ed25519-Blake2b curve.
- Bip32Slip10Ed25519Derivator
-
A class that implements the
IBip32KeyDerivatorinterface for Bip32 Slip10 derivation using the Ed25519 elliptic curve. - Bip32Slip10Ed25519MstKeyGenerator
-
A class implementing the
IBip32MstKeyGeneratorinterface to generate master keys for the Ed25519 elliptic curve using Slip-10. - Bip32Slip10MstKeyGeneratorConst
- Constants used by the Slip-10-based master key generator.
- Bip32Slip10Nist256p1
- Represents a Bip32Slip10Nist256p1 hierarchical deterministic key for NIST256P1 curve.
- Bip32Slip10Nist256p1MstKeyGenerator
-
A class implementing the
IBip32MstKeyGeneratorinterface to generate master keys for the Nist256p1 elliptic curve using Slip-10. - Bip32Slip10Secp256k1
- Represents a Bip32Slip10Secp256k1 hierarchical deterministic key for SECP256K1 curve.
- Bip32Slip10Secp256k1MstKeyGenerator
-
A class implementing the
IBip32MstKeyGeneratorinterface to generate master keys for the secp256k1 elliptic curve using Slip-10. - Bip38Addr
- bip38 address class
- Bip38AddrConst
- This class defines a constant value for the length of the address hash.
- Bip38Decrypter
- Helper class for BIP38 decryption operations.
- Bip38EcConst
- Constants for BIP38 encryption and decryption operations.
- Bip38EcDecrypter
- Helper class for decrypting BIP38-encrypted private keys.
- Bip38EcKeysGenerator
- Helper class for generating BIP38-encrypted keys.
- Bip38EcUtils
- Utility class for BIP38 encryption and decryption operations.
- Bip38Encrypter
- Helper class for BIP38 encryption and decryption operations.
- Bip38NoEcConst
- Constants for BIP38 encryption and decryption without ECDSA.
- Bip38NoEcDecrypter
- Helper class for decrypting BIP38-encrypted Bitcoin private keys without ECDSA.
- Bip38NoEcEncrypter
- Helper class for encrypting Bitcoin private keys without using ECDSA.
- Bip38NoEcUtils
- Utility class for BIP38 encryption and decryption without ECDSA.
- Bip39EntropyBitLen
- Enum representing the bit lengths for BIP39 entropy values.
- Bip39EntropyGenerator
- BIP39 entropy generator class.
- Bip39EntropyGeneratorConst
- Constants related to BIP39 entropy generation.
- Bip39Languages
- Enumeration representing the supported languages for BIP-39 mnemonic phrases.
- Bip39Mnemonic
- BIP-39 mnemonic phrase representation.
- Bip39MnemonicConst
- Constants related to BIP-39 mnemonics, including word counts and word list properties.
- Bip39MnemonicDecoder
- BIP39 (Bitcoin Improvement Proposal 39) mnemonic decoder class.
- Bip39MnemonicEncoder
- BIP39 Mnemonic Encoder for generating mnemonic phrases.
- Bip39MnemonicGenerator
- BIP39 Mnemonic Generator for generating mnemonic phrases.
- Bip39MnemonicValidator
- Validates BIP39 mnemonics based on a specified language.
- Bip39SeedGenerator
- Generates a seed from a Bip39 mnemonic.
- Bip39SeedGeneratorConst
- Constants related to Bip39 seed generation.
- Bip39WordsListFinder
- Finds the language of a BIP39 mnemonic based on the words used.
- Bip39WordsListGetter
- Retrieves a list of BIP39 words based on the specified language.
- Bip39WordsNum
- Enumeration representing the number of words in a BIP-39 mnemonic phrase.
- Bip44
- Bip44Base
- Abstract base class for BIP-44 hierarchical deterministic wallets.
- Bip44Changes
- Enumeration of BIP-44 changes (external and internal).
- Bip44Coins
- An enumeration of supported cryptocurrencies for BIP44. It includes both main networks and test networks of various cryptocurrencies.
- Bip44Conf
- A configuration class for BIP44 coins that defines the key network versions and maps each supported BIP44Coin to its corresponding BipCoinConfig.
- Bip44Const
- Constants related to BIP-44 (Bitcoin Improvement Proposal 44).
- Bip44Levels
- Enumeration of BIP-44 levels in hierarchical deterministic wallets.
- Bip44PrivateKey
- Represents a BIP44 private key for a specific cryptocurrency coin. This class ensures that the elliptic curve type of the private key matches the coin's configuration, and provides various utility methods for working with the private key.
- Bip44PublicKey
- Represents a BIP44 public key for a specific cryptocurrency coin. This class ensures that the elliptic curve type of the public key matches the coin's configuration, and provides various utility methods for working with the public key.
- Bip49
- Bip49Coins
- An enumeration of supported cryptocurrencies for BIP49. It includes both main networks and test networks of various cryptocurrencies.
- Bip49Conf
- A configuration class for BIP49 that defines the key network versions and maps each supported BIP49Coin to its corresponding BipCoinConfig.
- Bip49Const
- Constants related to BIP-49 (Bitcoin Improvement Proposal 44).
- Bip84
- Bip84Coins
- An enumeration of supported cryptocurrencies for BIP84. It includes both main networks and test networks of various cryptocurrencies.
- Bip84Conf
- A configuration class for BIP84 that defines the key network versions and maps each supported BIP84Coin to its corresponding BipCoinConfig.
- Bip84Const
- Constants related to BIP-84 (Bitcoin Improvement Proposal 84).
- Bip86
- Bip86Coins
- An enumeration of supported cryptocurrencies for BIP86. It includes both main networks and test networks of various cryptocurrencies.
- Bip86Conf
- A configuration class for BIP86 that defines the key network versions and maps each supported BIP86Coin to its corresponding BipCoinConfig.
- Bip86Const
- Constants related to BIP-86 (Bitcoin Improvement Proposal 86).
- BipBitcoinCashConf
- A class representing the configuration for Bitcoin Cash (BCH) based on the BIP framework.
- BipCoinConfig
- A base class representing configuration parameters for a cryptocurrency coin.
- BipCoins
- BipLitecoinConf
- A class representing the configuration for Litecoin (LTC) based on the BIP framework.
- BipProposal
- Enum representing different BIP proposals.
- CoinConfig
- A base class representing configuration parameters for a cryptocurrency coin.
- CoinProposal
-
CryptoCoins<
T extends CoinConfig> - An abstract class representing a collection of cryptocurrency coins.
- IBip32KeyDerivator
- An abstract class that defines methods for BIP-32 key derivation.
- IBip32MstKeyGenerator
- An abstract class that defines a method for generating master keys from a seed.
Constants
- derPathHardenedFull → const String
- derPathHardenedShort → const String
- derPathNonHardenedFull → const String
Functions
-
bip39WordList(
Bip39Languages language) → List< String> - Returns the BIP-39 word list for the specified language.
Typedefs
- AddrEncoder = BlockchainAddressEncoder Function([dynamic kwargs])
- A typedef for the address encoder function that takes optional dynamic parameters.
Exceptions / Errors
- Bip44DepthError
- Custom exception for errors related to BIP-44 depth.