Options
All
  • Public
  • Public/Protected
  • All
Menu

symbol-sdk

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AccountInfoResolvedMosaic

AccountInfoResolvedMosaic: AccountInfo & { resolvedMosaics?: ResolvedMosaic[] }

Account info with resolved mosaic

AddressResolutionStatement

AddressResolutionStatement: ResolutionStatement<UnresolvedAddress, Address>

ResolutionStatement alias for Addresses receipts.

BlockInfo

BlockInfo: NormalBlockInfo | NemesisImportanceBlockInfo

InnerTransaction

InnerTransaction: Transaction & { signer?: PublicAccount }

Transaction with signer included, used when adding signer to transactions included in an aggregate transaction.

MosaicIdResolutionStatement

MosaicIdResolutionStatement: ResolutionStatement<UnresolvedMosaicId, MosaicId>

ResolutionStatement alias for Mosaic ids receipts.

MosaicRestriction

MosaicRestriction: MosaicAddressRestriction | MosaicGlobalRestriction

A mosaic restriction could be global or targeted to an address.

MultisigChildrenTreeObject

MultisigChildrenTreeObject: { address: string; children: [] }

MultisigGraph utilities

Type declaration

  • address: string
  • children: []

Namespace

Namespace: NamespaceInfo & { name: string }

NamespaceInfoWithName

NamespaceInfoWithName: NamespaceInfo & { namespaceName?: string }

Resolved mosaic model with namespace name

NemesisImportanceBlockInfo

NemesisImportanceBlockInfo: NormalBlockInfo & { harvestingEligibleAccountsCount?: UInt64; previousImportanceBlockHash?: string; totalVotingBalance?: UInt64; votingEligibleAccountsCount?: number }

OnWsCloseCallback

OnWsCloseCallback: (event: { client: string; code: any; reason: any }) => void

Type declaration

    • (event: { client: string; code: any; reason: any }): void

    • Parameters

      • event: { client: string; code: any; reason: any }
        • client: string
        • code: any
        • reason: any

      Returns void

ResolvedMosaic

ResolvedMosaic: Mosaic & { namespaceName?: NamespaceName }

Resolved mosaic model with namespace name

UnresolvedAddress

UnresolvedAddress: (Address | NamespaceId) & { isAddress: any; isNamespaceId: any }

Custom type for unresolved address

UnresolvedMosaicId

UnresolvedMosaicId: (MosaicId | NamespaceId) & { isMosaicId: any; isNamespaceId: any }

Custom type for unresolved mosaicId

Variables

Alphabet

Alphabet: "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567" = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567'

Decoded_Block_Size

Decoded_Block_Size: 5 = 5

EmptyMessage

EmptyMessage: Message = ...

Raw message containing an empty string without any type or prefix.

Encoded_Block_Size

Encoded_Block_Size: 8 = 8

Half_Hash_Size

Half_Hash_Size: number = ...

Half_Signature_Size

Half_Signature_Size: number = ...

Hash_Size

Hash_Size: 64 = 64

Key_Size

Key_Size: 32 = 32

Nibble_To_Char_Map

Nibble_To_Char_Map: string[] = ...

Signature_Size

Signature_Size: 64 = 64

catapult_crypto

catapult_crypto: any = ...

defaultChronoUnit

defaultChronoUnit: ChronoUnit = ChronoUnit.HOURS

defaultDeadline

defaultDeadline: 2 = 2

idGeneratorConst

idGeneratorConst: { name_pattern: RegExp; namespace_base_id: number[] } = ...

Type declaration

  • name_pattern: RegExp
  • namespace_base_id: number[]

Functions

Const Char_To_Decoded_Char_Map

  • Char_To_Decoded_Char_Map(): any

Const CreateReceiptFromDTO

  • CreateReceiptFromDTO(receiptDTO: any): Receipt

LockHashAlgorithmLengthValidator

  • LockHashAlgorithmLengthValidator(hashAlgorithm: LockHashAlgorithm, input: string): boolean

Const add

  • add(p: any, q: any): void

Const append

  • append(path: any, id: any): any

Const createBuilder

  • createBuilder(): any

Const crypto_verify_32

  • crypto_verify_32(x: any, xi: any, y: any, yi: any): number

Const decodeBlock

  • decodeBlock(input: any, inputOffset: number, output: any, outputOffset: number): any

Const decodeChar

  • decodeChar(c: any): any

Const encodeBlock

  • encodeBlock(input: any, inputOffset: number, output: any, outputOffset: number): any

Const extractMosaics

  • extractMosaics(mosaics: any): Mosaic[]

  • Extract mosaics from encoded UInt64 notation.

    If most significant bit of byte 0 is set, then it is a namespaceId. If most significant bit of byte 0 is not set, then it is a mosaicId.

    Parameters

    • mosaics: any

      The DTO array of mosaics (with UInt64 Id notation)

    Returns Mosaic[]

Const extractPartName

  • extractPartName(name: string, start: number, size: number): string

Const extractRecipient

  • Extract recipientAddress value from encoded hexadecimal notation.

    If bit 0 of byte 0 is not set (e.g. 0x90), then it is a regular address. Else (e.g. 0x91) it represents a namespace id which starts at byte 1.

    Parameters

    • recipientAddress: any

      Encoded hexadecimal recipientAddress notation

    Returns Address | NamespaceId

Const generateNamespaceId

  • generateNamespaceId(parentId: number[], name: string): number[]

Const gf

  • gf(init?: any): Float64Array

Const pack

  • pack(r: any, p: any): void

Const parseObjectProperties

  • parseObjectProperties(obj: [], parse: any): any

Const scalarmult

  • scalarmult(p: any, q: any, s: any): void

Const split

  • split(name: string, processor: any): any

Const throwInvalidFqn

  • throwInvalidFqn(reason: any, name: any): void

Const tryParseByte

  • tryParseByte(char1: any, char2: any): any

Const tryParseUint

  • tryParseUint(str: string): undefined | number

  • Tries to parse a string representing an unsigned integer.

    Parameters

    • str: string

      The string to parse.

    Returns undefined | number

    The number represented by the input or undefined.

Const ua2words

  • ua2words(ua: any, uaLength: any): WordArray

  • Convert an Uint8Array to WordArray

    Parameters

    • ua: any

      An Uint8Array

    • uaLength: any

      The Uint8Array length

    Returns WordArray

Const unpack

  • unpack(r: any, p: any): 0 | -1

Const words2ua

  • words2ua(destUa: any, cryptoWords: any): Uint8Array

  • Convert a wordArray to Uint8Array

    Parameters

    • destUa: any

      A destination Uint8Array

    • cryptoWords: any

      A wordArray

    Returns Uint8Array

Generated using TypeDoc