Type Members

1.  trait AdaptorSign extends Sign with AsyncAdaptorSign
2.  sealed trait AesDecryptionException extends Exception
3.  final case class AesEncryptedData(cipherText: ByteVector, iv: AesIV) extends NetworkElement with Product with Serializable

   Represents a encrypted cipher text with it's accompanying initialization vector (IV).

   Represents a encrypted cipher text with it's accompanying initialization vector (IV). Both the cipher text and the IV is needed to decrypt the cipher text.

4.  final case class AesIV extends AnyVal with NetworkElement with Product with Serializable

   Represents an initialization vector (IV) used in AES encryption.

5.  final case class AesKey extends MaskedToString with NetworkElement with Product with Serializable

   Represents a encryption/decryption key.

   Represents a encryption/decryption key. AES keys can be converted to SecretKeys, and have certain length requirements.

6.  final case class AesPassword extends MaskedToString with Product with Serializable
7.  final case class AesSalt(bytes: ByteVector) extends AnyVal with Product with Serializable

   Represents a salt used to derive a AES key from a human-readable passphrase.

8.  trait AsyncAdaptorSign extends AsyncSign
9.  trait AsyncSign extends AnyRef

   This is meant to be an abstraction for a org.bitcoins.crypto.ECPrivateKey, sometimes we will not have direct access to a private key in memory -- for instance if that key is on a hardware device -- so we need to create an abstraction of the signing process.

   This is meant to be an abstraction for a org.bitcoins.crypto.ECPrivateKey, sometimes we will not have direct access to a private key in memory -- for instance if that key is on a hardware device -- so we need to create an abstraction of the signing process. Fundamentally a private key takes in a scodec.bits.ByteVector and returns a ECDigitalSignature That is what this abstraction is meant to represent. If you have a ECPrivateKey in your application, you can get it's Sign type by doing this:

   val key = ECPrivateKey() val sign: scodec.bits.ByteVector => Future[ECDigitalSignature] = key.signFunction

   If you have a hardware wallet, you will need to implement the protocol to send a message to the hardware device. The type signature of the function you implement must be scodec.bits.ByteVector => Future[ECDigitalSignature]

10.  sealed abstract class BaseECKey extends NetworkElement

    Created by chris on 2/16/16.

    Created by chris on 2/16/16. Represents a fully parsed and validated ECDSA private or public key.

11.  trait BouncycastleCryptoRuntime extends CryptoRuntime

    This is an implementation of CryptoRuntime that defaults to Bouncy Castle (https://bouncycastle.org/) and java.security.

12.  trait CryptoBytesUtil extends AnyRef

    Created by chris on 2/26/16.

13.  sealed trait CryptoContext extends AnyRef
14.  trait CryptoNumberUtil extends AnyRef
15.  sealed abstract class CryptoParams extends AnyRef

    Created by chris on 3/29/16.

    Created by chris on 3/29/16. This trait represents all of the default parameters for our elliptic curve

16.  trait CryptoRuntime extends AnyRef

    Trait that should be extended by specific runtimes like javascript or the JVM to support crypto functions needed for bitcoin-s

17.  sealed trait CryptoRuntimeFactory extends AnyRef

    Attributes

    protected

18.  trait CryptoUtil extends CryptoRuntime

    Utility cryptographic functions This is a proxy for the underlying implementation of CryptoRuntime such as LibSecp256k1CryptoRuntime.

    Utility cryptographic functions This is a proxy for the underlying implementation of CryptoRuntime such as LibSecp256k1CryptoRuntime.

    This is necessary so that the core module doesn't need to be refactored to add support for multiple platforms, it can keep referencing CryptoUtil

19.  case class CurveCoordinate(bytes: ByteVector) extends FiniteFieldMember[CurveCoordinate] with Product with Serializable
20.  sealed abstract class DERSignatureUtil extends AnyRef

    Created by chris on 3/23/16.

21.  case class DoubleSha256Digest(bytes: ByteVector) extends HashDigest with Product with Serializable

    Represents the result of SHA256(SHA256())

22.  case class DoubleSha256DigestBE(bytes: ByteVector) extends HashDigest with Product with Serializable

    The big endian version of DoubleSha256Digest

23.  case class ECAdaptorSignature(bytes: ByteVector) extends NetworkElement with Product with Serializable
24.  sealed abstract class ECDigitalSignature extends NetworkElement

    Created by chris on 2/26/16.

25.  sealed abstract class ECKeyBytes extends NetworkElement

    Represents the raw bytes which are meant to represent an ECKey without deserializing.

26.  case class ECPrivateKey(bytes: ByteVector) extends BaseECKey with AdaptorSign with MaskedToString with Product with Serializable

    Created by chris on 2/16/16.

    Created by chris on 2/16/16. A valid deserialized private key.

    Note that there is no notion of compressed vs. decompressed as there is in Wallet Import Format (WIF), if dealing with external wallets then ECPrivateKeyBytes may be needed.

27.  case class ECPrivateKeyBytes(bytes: ByteVector, isCompressed: Boolean = true) extends ECKeyBytes with MaskedToString with Product with Serializable

    Represents a serialization sensitive ECPrivateKey (such as is used in WIF).

28.  case class ECPublicKey(bytes: ByteVector) extends BaseECKey with ECPublicKeyApi with Product with Serializable

    Created by chris on 2/16/16.

    Created by chris on 2/16/16. A valid deserialized ECDSA public key.

    This class wraps some underlying _bytes but after checking that these _bytes are valid, all serializations (compressed and decompressed) of this public key are (lazily) computed where the decompressed version is used internally for computation and the compressed version is provided by the NetworkElement::bytes member.

    Note that 0x00 is not a valid ECPublicKey but is a valid SecpPoint meaning that if you are doing computations on public key (points) that may have intermediate 0x00 values, then you should convert using toPoint, do computation, and then convert back toPublicKey in the end.

29.  sealed trait ECPublicKeyApi extends PublicKey

    Represents any type which wraps public key bytes which can be used for ECDSA verification.

    Represents any type which wraps public key bytes which can be used for ECDSA verification. Should always be instantiated with class X extends PublicKey[X].

30.  case class ECPublicKeyBytes(bytes: ByteVector) extends ECKeyBytes with ECPublicKeyApi with Product with Serializable

    Wraps raw ECPublicKey bytes without doing any validation or deserialization (may be invalid).

31.  abstract class Factory[+T] extends AnyRef

    Created by chris on 2/26/16.

    Created by chris on 2/26/16. Trait to implement ubiquitous factory functions across our codebase

32.  case class FieldElement(bytes: ByteVector) extends FiniteFieldMember[FieldElement] with Product with Serializable

    Represents integers modulo the secp256k1 field size: pow(2,256) - 0x1000003D1.

    Represents integers modulo the secp256k1 field size: pow(2,256) - 0x1000003D1.

    Supports arithmetic for these elements including +, -, *, and inverses. Supports 32 byte serialization as is needed for ECPrivateKeys.

33.  abstract class FiniteFieldMember[F <: FiniteFieldMember[F]] extends NetworkElement
34.  abstract class FiniteFieldObject[F <: FiniteFieldMember[F]] extends Factory[F]
35.  class HMacDSAKCalculatorWithEntropy extends DSAKCalculator

    Entirely copied from HMacDSAKCalculator with an added entropy parameter as well as two lines added adding the entropy to the hash.

    Entirely copied from HMacDSAKCalculator with an added entropy parameter as well as two lines added adding the entropy to the hash.

    For a reference in secp256k1, see nonce_function_rfc6979 in secp256k1.c For a description of the altered part, see RFC 6979 section 3.2d here https://tools.ietf.org/html/rfc6979#section-3.2

    The added lines are marked below with comments.

36.  sealed trait HashDigest extends NetworkElement
37.  sealed trait HashType extends AnyRef

    Created by chris on 1/18/16.

38.  sealed trait KeyParity extends NetworkElement
39.  trait LibSecp256k1CryptoRuntime extends CryptoRuntime

    This is an implementation of CryptoRuntime that defaults to libsecp256k1 (https://github.com/bitcoin-core/secp256k1) when possible.

    This is an implementation of CryptoRuntime that defaults to libsecp256k1 (https://github.com/bitcoin-core/secp256k1) when possible. All unsupported functions are delegated to BouncycastleCryptoRuntime.

40.  trait MaskedToString extends AnyRef

    Meant to provide a simple trait that masks the default to string for sensitive classes

41.  trait NetworkElement extends Any

    Created by chris on 1/14/16.

    Created by chris on 1/14/16. This represents a element that can be serialized to be sent over the network

42.  trait PublicKey extends NetworkElement
43.  sealed trait RipeMd160Digest extends HashDigest

    Represents the result of RIPEMD160()

44.  sealed trait RipeMd160DigestBE extends HashDigest

    Represents the result of RIPEMD160() big endian

45.  case class SIGHASH_ALL(num: Int) extends HashType with Product with Serializable

    defaultValue is the underlying value of the HashType.

    defaultValue is the underlying value of the HashType. The last byte of a signature determines the HashType. https://en.bitcoin.it/wiki/OP_CHECKSIG

46.  case class SIGHASH_ALL_ANYONECANPAY(num: Int) extends HashType with Product with Serializable
47.  case class SIGHASH_ANYONECANPAY(num: Int) extends HashType with Product with Serializable
48.  case class SIGHASH_NONE(num: Int) extends HashType with Product with Serializable
49.  case class SIGHASH_NONE_ANYONECANPAY(num: Int) extends HashType with Product with Serializable
50.  case class SIGHASH_SINGLE(num: Int) extends HashType with Product with Serializable
51.  case class SIGHASH_SINGLE_ANYONECANPAY(num: Int) extends HashType with Product with Serializable
52.  case class SchnorrDigitalSignature(rx: SchnorrNonce, sig: FieldElement) extends NetworkElement with Product with Serializable
53.  case class SchnorrNonce(bytes: ByteVector) extends NetworkElement with Product with Serializable
54.  case class SchnorrPublicKey(bytes: ByteVector) extends PublicKey with Product with Serializable
55.  sealed trait SecpPoint extends NetworkElement

    Represents a point on the secp256k1 elliptic curve.

56.  case class SecpPointFinite(x: CurveCoordinate, y: CurveCoordinate) extends SecpPoint with Product with Serializable

    A non-identity point, (x, y), on the secp256k1 elliptic curve.

57.  sealed trait Sha1Digest extends HashDigest

    Represents the result of SHA1()

58.  sealed trait Sha1DigestBE extends HashDigest
59.  sealed trait Sha256Digest extends HashDigest

    Represents the result of SHA256()

60.  sealed trait Sha256DigestBE extends HashDigest

    Represents the result of SHA256()

61.  sealed trait Sha256Hash160Digest extends HashDigest

    Represents the result of RIPEMD160(SHA256())

62.  sealed trait Sha256Hash160DigestBE extends HashDigest

    Represents the result of RIPEMD160(SHA256()) big endian

63.  sealed trait Sha3_256Digest extends HashDigest

    Represents the result of SHA3-256()

64.  sealed trait Sha3_256DigestBE extends HashDigest

    Represents the result of SHA3-256()

65.  trait Sign extends AsyncSign
66.  case class SipHashKey(bytes: ByteVector) extends NetworkElement with Product with Serializable
67.  trait StringFactory[+T] extends AnyRef

    A common factory trait that can be re-used to deserialize a string to a type t

68.  case class XOnlyPubKey(bytes: ByteVector) extends PublicKey with Product with Serializable

    Represents the x-coordinate of an ECPublicKey, with undetermined y-coordinate parity