Class MoneroUtils

constructor

• new MoneroUtils(): MoneroUtils

• Returns MoneroUtils

Static AU_PER_XMR

Static NUM_MNEMONIC_WORDS

Static PROXY_TO_WORKER

Static RING_SIZE

Static atomicUnitsToXmr

• atomicUnitsToXmr(amountAtomicUnits): number

• Convert atomic units to XMR.

  Parameters

  • amountAtomicUnits: string | bigint

    amount in atomic units to convert to XMR

  Returns number

  amount in XMR

Static binaryBlocksToJson

• binaryBlocksToJson(uint8arr): Promise<any>

• Convert the binary response from daemon RPC block retrieval to JSON.

  Parameters

  • uint8arr: any

    binary response from daemon RPC when getting blocks

  Returns Promise<any>

  JSON object with the blocks data

Static binaryToJson

• binaryToJson(uint8arr): Promise<any>

• Convert the given portable storage binary to JSON.

  Parameters

  • uint8arr: any

    binary data in Monero's portable storage format

  Returns Promise<any>

  JSON object converted from the binary data

Static getIntegratedAddress

• getIntegratedAddress(networkType, standardAddress, paymentId?): Promise<any>

• Get an integrated address.

  Parameters

  • networkType: MoneroNetworkType

    network type of the integrated address

  • standardAddress: string

    address to derive the integrated address from

  • Optional paymentId: string

    optionally specifies the integrated address's payment id (defaults to random payment id)

  Returns Promise<any>

  the integrated address

Static getLastTxPubKey

• getLastTxPubKey(txExtra): Promise<string>

• Decode tx extra according to https://cryptonote.org/cns/cns005.txt and returns the last tx pub key.

  TODO: use c++ bridge for this

  Parameters

  • txExtra: any

  Returns Promise<string>

  the last pub key as a hexidecimal string

Static getVersion

• getVersion(): string

• Get the version of the monero-ts library.

  Returns string

  the version of this monero-ts library

Static isTimestamp

• isTimestamp(unlockTime): boolean

• Determine if the given unlock time is a timestamp or block height.

  Parameters

  • unlockTime: bigint

    is the unlock time to check

  Returns boolean

  true if the unlock time is a timestamp, false if a block height

Static isValidAddress

• isValidAddress(address, networkType): Promise<boolean>

• Determine if the given address is valid.

  Parameters

  • address: any

    address

  • networkType: any

    network type of the address to validate

  Returns Promise<boolean>

  true if the address is valid, false otherwise

Static isValidPaymentId

• isValidPaymentId(paymentId): Promise<boolean>

• Determine if the given payment id is valid.

  Parameters

  • paymentId: any

    payment id to determine if valid

  Returns Promise<boolean>

  true if the payment id is valid, false otherwise

Static isValidPrivateSpendKey

• isValidPrivateSpendKey(privateSpendKey): Promise<boolean>

• Indicates if a private spend key is valid.

  Parameters

  • privateSpendKey: any

    is the private spend key to validate

  Returns Promise<boolean>

  true if the private spend key is valid, false otherwise

Static isValidPrivateViewKey

• isValidPrivateViewKey(privateViewKey): Promise<boolean>

• Indicates if a private view key is valid.

  Parameters

  • privateViewKey: any

    is the private view key to validate

  Returns Promise<boolean>

  true if the private view key is valid, false otherwise

Static isValidPublicSpendKey

• isValidPublicSpendKey(publicSpendKey): Promise<boolean>

• Indicates if a public spend key is valid.

  Parameters

  • publicSpendKey: any

    is the public spend key to validate

  Returns Promise<boolean>

  true if the public spend key is valid, false otherwise

Static isValidPublicViewKey

• isValidPublicViewKey(publicViewKey): Promise<boolean>

• Indicates if a public view key is valid.

  Parameters

  • publicViewKey: any

    is the public view key to validate

  Returns Promise<boolean>

  true if the public view key is valid, false otherwise

Static jsonToBinary

• jsonToBinary(json): Promise<any>

• Convert the given JSON to a binary Uint8Array using Monero's portable storage format.

  Parameters

  • json: any

    json to convert to binary

  Returns Promise<any>

  the json converted to portable storage binary

Static mergeTx

• mergeTx(txs, tx): void

• Merges a transaction into a list of existing transactions.

  Parameters

  • txs: any

    existing transactions to merge into

  • tx: any

    transaction to merge into the list

  Returns void

Static paymentIdsEqual

• paymentIdsEqual(paymentId1, paymentId2): boolean

• Determines if two payment ids are functionally equal.

  For example, 03284e41c342f032 and 03284e41c342f032000000000000000000000000000000000000000000000000 are considered equal.

  Parameters

  • paymentId1: any

    is a payment id to compare

  • paymentId2: any

    is a payment id to compare

  Returns boolean

  true if the payment ids are equal, false otherwise

Static setProxyToWorker

• setProxyToWorker(proxyToWorker): void

• Enable or disable proxying these utilities to a worker thread.

  Parameters

  • proxyToWorker: any

    specifies if utilities should be proxied to a worker

  Returns void

Static validateAddress

• validateAddress(address, networkType): Promise<any>

• Validate the given address, throw an error if invalid.

  Parameters

  • address: any

    address to validate

  • networkType: any

    network type of the address to validate

  Returns Promise<any>

Static validateMnemonic

• validateMnemonic(mnemonic): Promise<void>

• Validate the given mnemonic, throw an error if invalid.

  TODO: improve validation, use network type

  Parameters

  • mnemonic: any

    mnemonic to validate

  Returns Promise<void>

Static validatePaymentId

• validatePaymentId(paymentId): Promise<void>

• Validate the given payment id, throw an error if invalid.

  TODO: improve validation

  Parameters

  • paymentId: any

    payment id to validate

  Returns Promise<void>

Static validatePrivateSpendKey

• validatePrivateSpendKey(privateSpendKey): Promise<void>

• Validate the given private spend key, throw an error if invalid.

  Parameters

  • privateSpendKey: any

    private spend key to validate

  Returns Promise<void>

Static validatePrivateViewKey

• validatePrivateViewKey(privateViewKey): Promise<void>

• Validate the given private view key, throw an error if invalid.

  Parameters

  • privateViewKey: any

    private view key to validate

  Returns Promise<void>

Static validatePublicSpendKey

• validatePublicSpendKey(publicSpendKey): Promise<void>

• Validate the given public spend key, throw an error if invalid.

  Parameters

  • publicSpendKey: any

    public spend key to validate

  Returns Promise<void>

Static validatePublicViewKey

• validatePublicViewKey(publicViewKey): Promise<void>

• Validate the given public view key, throw an error if invalid.

  Parameters

  • publicViewKey: any

    public view key to validate

  Returns Promise<void>

Static xmrToAtomicUnits

• xmrToAtomicUnits(amountXmr): bigint

• Convert XMR to atomic units.

  Parameters

  • amountXmr: string | number

    amount in XMR to convert to atomic units

  Returns bigint

  amount in atomic units