Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Address

The address structure describes an address with its network

Hierarchy

  • Address

Index

Properties

Methods

Properties

Private Readonly address

address: string

The address value.

Readonly networkType

networkType: NetworkType

Methods

encoded

  • encoded(): string

equals

  • equals(address: Address): boolean

plain

  • plain(): string

pretty

  • pretty(): string

toDTO

  • toDTO(): any

Static createFromEncoded

  • createFromEncoded(encoded: string): Address

  • Create an Address from a given encoded address.

    Parameters

    • encoded: string

      address. Expected format: 9085215E4620D383C2DF70235B9EF7607F6A28EF6D16FD7B9C.

    Returns Address

Static createFromPublicKey

Static createFromRawAddress

  • createFromRawAddress(rawAddress: string): Address

  • Create an Address from a given raw address.

    Parameters

    • rawAddress: string

      Address in string format. ex: SB3KUBHATFCPV7UZQLWAQ2EUR6SIHBSBEOEDDDF3 or SB3KUB-HATFCP-V7UZQL-WAQ2EU-R6SIHB-SBEOED-DDF3

    Returns Address

Static isValidEncodedAddress

  • isValidEncodedAddress(encoded: string): boolean

  • Determines the validity of an encoded address string.

    Parameters

    • encoded: string

      The encoded address string. Expected format: 9085215E4620D383C2DF70235B9EF7607F6A28EF6D16FD7B9C

    Returns boolean

    true if the encoded address string is valid, false otherwise.

Static isValidRawAddress

  • isValidRawAddress(rawAddress: string): boolean

  • Determines the validity of an raw address string.

    Parameters

    • rawAddress: string

      The raw address string. Expected format SCHCZBZ6QVJAHGJTKYVPW5FBSO2IXXJQBPV5XE6P

    Returns boolean

    true if the raw address string is valid, false otherwise.

Generated using TypeDoc