Class/Object

org.bitcoins.core.util

Bech32

Related Docs: object Bech32 | package util

Permalink

sealed abstract class Bech32 extends AnyRef

A abstract class representing basic utility functions of Bech32 For more information on Bech32 please seee BIP173 https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Bech32
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def checkDataValidity(data: String): Try[Vector[UInt5]]

    Permalink

    Takes in the data portion of a bech32 address and decodes it to a byte array It also checks the validity of the data portion according to BIP173

  6. def checkHrpValidity(hrp: String): Try[Bech32HumanReadablePart]

    Permalink

    Checks if the possible human readable part follows BIP173 rules

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def createChecksum(u5s: Vector[UInt5]): Vector[UInt5]

    Permalink

    Creates a checksum for the given byte vector according to BIP173

  9. def decodeStringToU5s(str: String): Vector[UInt5]

    Permalink

    Assumes we are given a valid bech32 string

  10. def encode5bitToString(b: Vector[UInt5]): String

    Permalink

    Takes a bech32 5bit array and encodes it to a string

  11. def encode8bitToString(bytes: Vector[UInt8]): String

    Permalink

    Converts a byte vector to 5bit vector and then serializes to bech32

  12. def encode8bitToString(bytes: ByteVector): String

    Permalink

    Converts a byte vector to 5bit vector and then serializes to bech32

  13. def encodeBitVec(bitVec: BitVector): String

    Permalink

    Encodes a bitvector to a bech32 string

  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def from5bitTo8bit(b: Vector[UInt5], pad: Boolean = false): Vector[UInt8]

    Permalink

    Decodes a byte array from 5bits to base 8bits

  18. def from8bitTo5bit(u8s: Vector[UInt8]): Vector[UInt5]

    Permalink

    Converts a byte array from 8bits to base 5 bits

  19. def from8bitTo5bit(bytes: ByteVector): Vector[UInt5]

    Permalink

    Converts a byte vector from 8bits to 5bits

  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  22. def hrpExpand(hrp: Bech32HumanReadablePart): Vector[UInt5]

    Permalink

    Expands the human readable part of a bech32 address as per BIP173

  23. def isInHrpRange(char: Char): Boolean

    Permalink
  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  25. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. def polyMod(bytes: Vector[UInt5]): Long

    Permalink
  29. def splitToHrpAndData(bech32: String): Try[(Bech32HumanReadablePart, Vector[UInt5])]

    Permalink

    Validate a Bech32 string, and determine HRP and data.

    Validate a Bech32 string, and determine HRP and data. Fails if HRP is not LN or BTC compatible.

    See also

    Mimics this function by Sipa

  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  31. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  32. def verifyChecksum(hrp: Bech32HumanReadablePart, u5s: Seq[UInt5]): Boolean

    Permalink
  33. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped