From 7d90a3813b917a82187c51cf988535177e508bbb Mon Sep 17 00:00:00 2001 From: woodser Date: Thu, 5 May 2022 23:19:12 -0400 Subject: [PATCH] update typedocs --- .gitignore | 5 +- docs/classes/HavenoClient.HavenoClient-1.html | 316 ++++++++++++++++++ ...lient._internal_.ClientReadableStream.html | 1 + .../HavenoClient._internal_.RpcError.html | 6 + .../utils_HavenoUtils.HavenoUtils.html | 12 +- docs/classes/utils_TaskLooper.TaskLooper.html | 6 +- .../HavenoClient._internal_.StatusCode.html | 1 + .../HavenoClient._internal_.CallSite.html | 34 ++ .../HavenoClient._internal_.Metadata.html | 1 + .../HavenoClient._internal_.Status.html | 1 + ...tils_TaskLooper._internal_.RefCounted.html | 1 + .../utils_TaskLooper._internal_.Timeout.html | 13 + .../utils_TaskLooper._internal_.Timer.html | 1 + docs/modules/HavenoClient._internal_.html | 1 + docs/modules/HavenoClient.html | 1 + docs/modules/index.html | 1 + docs/modules/utils_TaskLooper._internal_.html | 1 + 17 files changed, 389 insertions(+), 13 deletions(-) create mode 100644 docs/classes/HavenoClient.HavenoClient-1.html create mode 100644 docs/classes/HavenoClient._internal_.ClientReadableStream.html create mode 100644 docs/classes/HavenoClient._internal_.RpcError.html create mode 100644 docs/enums/HavenoClient._internal_.StatusCode.html create mode 100644 docs/interfaces/HavenoClient._internal_.CallSite.html create mode 100644 docs/interfaces/HavenoClient._internal_.Metadata.html create mode 100644 docs/interfaces/HavenoClient._internal_.Status.html create mode 100644 docs/interfaces/utils_TaskLooper._internal_.RefCounted.html create mode 100644 docs/interfaces/utils_TaskLooper._internal_.Timeout.html create mode 100644 docs/interfaces/utils_TaskLooper._internal_.Timer.html create mode 100644 docs/modules/HavenoClient._internal_.html create mode 100644 docs/modules/HavenoClient.html create mode 100644 docs/modules/index.html create mode 100644 docs/modules/utils_TaskLooper._internal_.html diff --git a/.gitignore b/.gitignore index 0fc6f51f..3a5e5449 100644 --- a/.gitignore +++ b/.gitignore @@ -24,7 +24,4 @@ yarn-debug.log* yarn-error.log* # generated code -/src/protobuf/** - -# generated docs -/docs \ No newline at end of file +/src/protobuf/** \ No newline at end of file diff --git a/docs/classes/HavenoClient.HavenoClient-1.html b/docs/classes/HavenoClient.HavenoClient-1.html new file mode 100644 index 00000000..08887ee2 --- /dev/null +++ b/docs/classes/HavenoClient.HavenoClient-1.html @@ -0,0 +1,316 @@ +HavenoClient | haveno-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HavenoClient

+

Haveno daemon client using gRPC.

+

Hierarchy

  • HavenoClient

Index

Constructors

Properties

Methods

Constructors

constructor

  • new HavenoClient(url: string, password: string): HavenoClient
  • +

    Construct a client connected to a Haveno daemon.

    +

    Parameters

    • url: string
      +

      Haveno daemon url

      +
    • password: string
      +

      Haveno daemon password

      +

    Returns HavenoClient

Properties

_accountClient

_accountClient: AccountClient

_appName

_appName: undefined | string

_disputeAgentsClient

_disputeAgentsClient: DisputeAgentsClient

_disputesClient

_disputesClient: DisputesClient

_getVersionClient

_getVersionClient: GetVersionClient

_keepAliveLooper

_keepAliveLooper: any

_keepAlivePeriodMs

_keepAlivePeriodMs: number = 60000

_moneroConnectionsClient

_moneroConnectionsClient: MoneroConnectionsClient

_moneroNodeClient

_moneroNodeClient: MoneroNodeClient

_notificationListeners

_notificationListeners: ((_notification: NotificationMessage) => void)[] = []

_notificationStream

_notificationStream: undefined | ClientReadableStream<NotificationMessage>

_notificationsClient

_notificationsClient: NotificationsClient

_offersClient

_offersClient: OffersClient

_password

_password: string

_paymentAccountsClient

_paymentAccountsClient: PaymentAccountsClient

_priceClient

_priceClient: PriceClient

_process

_process: any

_processLogging

_processLogging: boolean = false

_registerNotificationListenerCalled

_registerNotificationListenerCalled: boolean = false

_shutdownServerClient

_shutdownServerClient: ShutdownServerClient

_tradesClient

_tradesClient: TradesClient

_url

_url: string

_walletRpcPort

_walletRpcPort: undefined | number

_walletsClient

_walletsClient: WalletsClient

Static Readonly _fullyInitializedMessage

_fullyInitializedMessage: "Application fully initialized" = "Application fully initialized"

Static Readonly _loginRequiredMessage

_loginRequiredMessage: "Interactive login required" = "Interactive login required"

Methods

_isAppInitialized

  • _isAppInitialized(): Promise<boolean>

_updateNotificationListenerRegistration

  • _updateNotificationListenerRegistration(): Promise<void>
  • +

    Update notification listener registration. +Due to the nature of grpc streaming, this method returns a promise +which may be resolved before the listener is actually registered.

    +

    Returns Promise<void>

accountExists

  • accountExists(): Promise<boolean>
  • +

    Indicates if the Haveno account is created.

    +

    Returns Promise<boolean>

    true if the account is created, false otherwise

    +

addMoneroConnection

  • addMoneroConnection(connection: string | UrlConnection): Promise<void>

addNotificationListener

backupAccount

  • backupAccount(stream: any): Promise<number>
  • +

    Backup the account to the given stream. TODO: stream type?

    +

    Parameters

    • stream: any

    Returns Promise<number>

changePassword

  • changePassword(password: string): Promise<void>
  • +

    Change the Haveno account password.

    +

    Parameters

    • password: string
      +

      the new account password

      +

    Returns Promise<void>

checkMoneroConnection

  • +

    Check the current Monero daemon connection.

    +

    If disconnected and auto switch enabled, switch to the best available connection and return its status.

    +

    Returns Promise<undefined | UrlConnection>

    the current daemon connection status, undefined if no current connection

    +

checkMoneroConnections

closeAccount

  • closeAccount(): Promise<void>

confirmPaymentReceived

  • confirmPaymentReceived(tradeId: string): Promise<void>
  • +

    Confirm a payment is received.

    +

    Parameters

    • tradeId: string
      +

      the id of the trade

      +

    Returns Promise<void>

confirmPaymentStarted

  • confirmPaymentStarted(tradeId: string): Promise<void>
  • +

    Confirm a payment is started.

    +

    Parameters

    • tradeId: string
      +

      the id of the trade

      +

    Returns Promise<void>

createAccount

  • createAccount(password: string): Promise<void>
  • +

    Create and open a new Haveno account.

    +

    Parameters

    • password: string
      +

      the password to encrypt the account

      +

    Returns Promise<void>

createCryptoPaymentAccount

  • createCryptoPaymentAccount(accountName: string, assetCode: string, address: string): Promise<PaymentAccount>
  • +

    Create a crypto payment account.

    +

    Parameters

    • accountName: string
      +

      description of the account

      +
    • assetCode: string
      +

      traded asset code

      +
    • address: string
      +

      payment address of the account

      +

    Returns Promise<PaymentAccount>

    the created payment account

    +

createPaymentAccount

  • createPaymentAccount(paymentAccountForm: any): Promise<PaymentAccount>
  • +

    Create a payment account.

    +

    Parameters

    • paymentAccountForm: any
      +

      the completed form as JSON to create the payment account

      +

    Returns Promise<PaymentAccount>

    the created payment account

    +

createXmrTx

deleteAccount

  • deleteAccount(): Promise<void>
  • +

    Permanently delete the Haveno account and shutdown the server. // TODO: possible to not shutdown server?

    +

    Returns Promise<void>

disconnect

  • disconnect(): Promise<void>

getAppName

  • getAppName(): undefined | string

getBalances

getBestAvailableConnection

  • +

    Get the best available connection in order of priority then response time.

    +

    Returns Promise<undefined | UrlConnection>

    the best available connection in order of priority then response time, undefined if no connections available

    +

getChatMessages

  • getChatMessages(tradeId: string): Promise<ChatMessage[]>

getDispute

  • getDispute(tradeId: string): Promise<Dispute>

getDisputes

getMarketDepth

  • +

    Get the market depth of a currency.

    +

    Parameters

    • assetCode: string
      +

      asset to get the market depth of

      +

    Returns Promise<MarketDepthInfo>

    market depth of the given currency

    +

getMoneroConnection

  • +

    Get the current Monero daemon connection.

    +

    Returns Promise<undefined | UrlConnection>

    the current daemon connection, undefined if no current connection

    +

getMoneroConnections

getMoneroNodeSettings

getMyOffer

  • getMyOffer(offerId: string): Promise<OfferInfo>
  • +

    Get my offer by id.

    +

    Parameters

    • offerId: string
      +

      id of the user's created offer

      +

    Returns Promise<OfferInfo>

    the user's created offer

    +

getMyOffers

  • getMyOffers(assetCode: string, direction?: string): Promise<OfferInfo[]>
  • +

    Get the user's posted offers to buy or sell XMR.

    +

    Parameters

    • assetCode: string
      +

      traded asset code

      +
    • Optional direction: string
      +

      "buy" or "sell" XMR (default all)

      +

    Returns Promise<OfferInfo[]>

    the user's created offers

    +

getNewDepositAddress

  • getNewDepositAddress(): Promise<string>
  • +

    Get a new subaddress in the Monero wallet to receive deposits.

    +

    Returns Promise<string>

    the deposit address (a subaddress in the Haveno wallet)

    +

getOffers

  • getOffers(assetCode: string, direction?: string): Promise<OfferInfo[]>
  • +

    Get available offers to buy or sell XMR.

    +

    Parameters

    • assetCode: string
      +

      traded asset code

      +
    • Optional direction: string
      +

      "buy" or "sell" (default all)

      +

    Returns Promise<OfferInfo[]>

    the available offers

    +

getPaymentAccount

  • +

    Get a payment account by id.

    +

    Parameters

    • paymentAccountId: string
      +

      the payment account id to get

      +

    Returns Promise<PaymentAccount>

    the payment account

    +

getPaymentAccountForm

  • getPaymentAccountForm(paymentMethodId: string): Promise<any>
  • +

    Get a form for the given payment method to complete and create a new payment account.

    +

    Parameters

    • paymentMethodId: string

    Returns Promise<any>

    the payment account form as JSON

    +

getPaymentAccounts

getPaymentMethods

getPrice

  • getPrice(currencyCode: string): Promise<number>
  • +

    Get the current market price per 1 XMR in the given currency.

    +

    Parameters

    • currencyCode: string
      +

      currency code (fiat or crypto) to get the price of

      +

    Returns Promise<number>

    the current market price per 1 XMR in the given currency

    +

getPrices

getProcess

  • getProcess(): any
  • +

    Return the process running the haveno daemon.

    +

    Returns any

    the process running the haveno daemon

    +

getTrade

  • getTrade(tradeId: string): Promise<TradeInfo>
  • +

    Get a trade by id.

    +

    Parameters

    • tradeId: string
      +

      the id of the trade and its offer

      +

    Returns Promise<TradeInfo>

    the trade with the given id

    +

getTrades

getUrl

  • getUrl(): string
  • +

    Get the URL of the Haveno daemon.

    +

    Returns string

    the URL of the Haveno daemon

    +

getVersion

  • getVersion(): Promise<string>

getWalletRpcPort

  • getWalletRpcPort(): undefined | number
  • +

    Get the port of the primary wallet rpc instance if known.

    +

    Returns undefined | number

    the port of the primary wallet rpc instance if known

    +

getXmrTx

  • getXmrTx(txHash: string): Promise<XmrTx>
  • +

    Get a transaction by hash in the Monero wallet.

    +

    Parameters

    • txHash: string
      +

      hash of the transaction to get

      +

    Returns Promise<XmrTx>

    the transaction with the hash

    +

getXmrTxs

  • getXmrTxs(): Promise<XmrTx[]>

isAccountOpen

  • isAccountOpen(): Promise<boolean>
  • +

    Indicates if the Haveno account is open and authenticated with the correct password.

    +

    Returns Promise<boolean>

    true if the account is open and authenticated, false otherwise

    +

isConnectedToDaemon

  • isConnectedToDaemon(): Promise<boolean>
  • +

    Indicates if connected and authenticated with the Haveno daemon.

    +

    Returns Promise<boolean>

    true if connected with the Haveno daemon, false otherwise

    +

isConnectedToMonero

  • isConnectedToMonero(): Promise<boolean>
  • +

    Indicates if connected to the Monero network based on last connection check.

    +

    Returns Promise<boolean>

    true if connected to the Monero network, false otherwise

    +

isMoneroNodeRunning

  • isMoneroNodeRunning(): Promise<boolean>
  • +

    Returns whether daemon is running a local monero node.

    +

    Returns Promise<boolean>

openAccount

  • openAccount(password: string): Promise<void>
  • +

    Open existing Haveno account.

    +

    Parameters

    • password: string
      +

      the account password

      +

    Returns Promise<void>

openDispute

  • openDispute(tradeId: string): Promise<void>
  • +

    Open a dispute for a trade.

    +

    Parameters

    • tradeId: string
      +

      the id of the trade

      +

    Returns Promise<void>

postOffer

  • postOffer(direction: string, amount: bigint, assetCode: string, paymentAccountId: string, buyerSecurityDeposit: number, price?: number, marketPriceMargin?: number, triggerPrice?: number, minAmount?: bigint): Promise<OfferInfo>
  • +

    Post an offer.

    +

    Parameters

    • direction: string
      +

      "buy" or "sell" XMR

      +
    • amount: bigint
      +

      amount of XMR to trade

      +
    • assetCode: string
      +

      asset code to trade for XMR

      +
    • paymentAccountId: string
      +

      payment account id

      +
    • buyerSecurityDeposit: number
      +

      buyer security deposit as % of trade amount

      +
    • Optional price: number
      +

      trade price (optional, default to market price)

      +
    • Optional marketPriceMargin: number
      +

      if using market price, % from market price to accept (optional, default 0%)

      +
    • Optional triggerPrice: number
      +

      price to remove offer (optional)

      +
    • Optional minAmount: bigint
      +

      minimum amount to trade (optional, default to fixed amount)

      +

    Returns Promise<OfferInfo>

    the posted offer

    +

registerDisputeAgent

  • registerDisputeAgent(disputeAgentType: string, registrationKey: string): Promise<void>
  • +

    Register as a dispute agent.

    +

    Parameters

    • disputeAgentType: string
      +

      type of dispute agent to register, e.g. mediator, refundagent

      +
    • registrationKey: string
      +

      registration key

      +

    Returns Promise<void>

relayXmrTx

  • relayXmrTx(metadata: string): Promise<string>
  • +

    Relay a previously created transaction to send funds from the Monero wallet.

    +

    Parameters

    • metadata: string

    Returns Promise<string>

    the hash of the relayed transaction

    +

removeMoneroConnection

  • removeMoneroConnection(url: string): Promise<void>
  • +

    Remove a Monero daemon connection.

    +

    Parameters

    • url: string
      +

      url of the daemon connection to remove

      +

    Returns Promise<void>

removeNotificationListener

  • removeNotificationListener(listener: (_notification: NotificationMessage) => void): Promise<void>

removeOffer

  • removeOffer(offerId: string): Promise<void>
  • +

    Remove a posted offer, releasing its reserved funds.

    +

    Parameters

    • offerId: string
      +

      the offer id to cancel

      +

    Returns Promise<void>

resolveDispute

  • resolveDispute(tradeId: string, winner: Winner, reason: Reason, summaryNotes: string, customWinnerAmount?: bigint): Promise<void>
  • +

    Resolve a dispute. By default, the winner receives the trade amount and the security deposits are returned, +but the arbitrator may award a custom amount to the winner.

    +

    Parameters

    • tradeId: string
      +

      the id of the trade

      +
    • winner: Winner
      +

      the winner of the dispute

      +
    • reason: Reason
      +

      the reason for the dispute

      +
    • summaryNotes: string
      +

      summary of the dispute

      +
    • Optional customWinnerAmount: bigint
      +

      custom amount to award the winner (optional)

      +

    Returns Promise<void>

restoreAccount

  • restoreAccount(zipBytes: Uint8Array): Promise<void>
  • +

    Restore the account from zip bytes.

    +

    Sends chunked requests if size over max grpc envelope size (41943404 bytes).

    +

    Parameters

    • zipBytes: Uint8Array
      +

      the bytes of the zipped account to restore

      +

    Returns Promise<void>

sendChatMessage

  • sendChatMessage(tradeId: string, message: string): Promise<void>
  • +

    Send a trade chat message.

    +

    Parameters

    • tradeId: string
      +

      the id of the trade

      +
    • message: string
      +

      the message

      +

    Returns Promise<void>

sendDisputeChatMessage

  • sendDisputeChatMessage(disputeId: string, message: string, attachments: Attachment[]): Promise<void>
  • +

    Send a dispute chat message.

    +

    Parameters

    • disputeId: string
      +

      the id of the dispute

      +
    • message: string
      +

      the message

      +
    • attachments: Attachment[]
      +

      attachments

      +

    Returns Promise<void>

setAutoSwitch

  • setAutoSwitch(autoSwitch: boolean): Promise<void>
  • +

    Automatically switch to the best available connection if current connection is disconnected after being checked.

    +

    Parameters

    • autoSwitch: boolean
      +

      whether auto switch is enabled or disabled

      +

    Returns Promise<void>

setMoneroConnection

  • setMoneroConnection(connection?: string | UrlConnection): Promise<void>
  • +

    Set the current Monero daemon connection.

    +

    Add the connection if not previously seen. +If the connection is provided as string, connect to the URI with any previously set credentials and priority. +If the connection is provided as UrlConnection, overwrite any previously set credentials and priority. +If undefined connection provided, disconnect the client.

    +

    Parameters

    • Optional connection: string | UrlConnection
      +

      connection to set as current

      +

    Returns Promise<void>

setProcessLogging

  • setProcessLogging(enabled: boolean): void
  • +

    Enable or disable process logging.

    +

    Parameters

    • enabled: boolean
      +

      specifies if logging is enabled or disabled

      +

    Returns void

shutdownServer

  • shutdownServer(): Promise<void>
  • +

    Shutdown the Haveno daemon server and stop the process if applicable.

    +

    Returns Promise<void>

startCheckingConnection

  • startCheckingConnection(refreshPeriod: number): Promise<void>
  • +

    Check the connection and start checking the connection periodically.

    +

    Parameters

    • refreshPeriod: number
      +

      time between checks in milliseconds (default 15000 ms or 15 seconds)

      +

    Returns Promise<void>

startMoneroNode

stopCheckingConnection

  • stopCheckingConnection(): Promise<void>

stopMoneroNode

  • stopMoneroNode(): Promise<void>

takeOffer

  • takeOffer(offerId: string, paymentAccountId: string): Promise<TradeInfo>
  • +

    Take an offer.

    +

    Parameters

    • offerId: string
      +

      id of the offer to take

      +
    • paymentAccountId: string
      +

      id of the payment account

      +

    Returns Promise<TradeInfo>

    the initialized trade

    +

Static startProcess

  • startProcess(havenoPath: string, cmd: string[], url: string, enableLogging: boolean): Promise<HavenoClient>
  • +

    Start a new Haveno process.

    +

    Parameters

    • havenoPath: string
      +

      path to Haveno binaries

      +
    • cmd: string[]
      +

      command to start the process

      +
    • url: string
      +

      Haveno daemon url (must proxy to api port)

      +
    • enableLogging: boolean
      +

      specifies if logging is enabled or disabled at log level 3

      +

    Returns Promise<HavenoClient>

    a client connected to the newly started Haveno process

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/HavenoClient._internal_.ClientReadableStream.html b/docs/classes/HavenoClient._internal_.ClientReadableStream.html new file mode 100644 index 00000000..411b1ba4 --- /dev/null +++ b/docs/classes/HavenoClient._internal_.ClientReadableStream.html @@ -0,0 +1 @@ +ClientReadableStream | haveno-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientReadableStream<RESP>

Type parameters

  • RESP

Hierarchy

  • ClientReadableStream

Index

Constructors

Methods

Constructors

constructor

Methods

cancel

  • cancel(): void

  • Returns void

on

  • Parameters

    Returns ClientReadableStream<RESP>

  • Parameters

    • eventType: "status"
    • callback: (status: Status) => void

    Returns ClientReadableStream<RESP>

  • Parameters

    Returns ClientReadableStream<RESP>

  • Parameters

    • eventType: "data"
    • callback: (response: RESP) => void
        • (response: RESP): void

        • Parameters

          • response: RESP

          Returns void

    Returns ClientReadableStream<RESP>

  • Parameters

    • eventType: "end"
    • callback: () => void
        • (): void

        • Returns void

    Returns ClientReadableStream<RESP>

removeListener

  • removeListener(eventType: "error", callback: (err: RpcError) => void): void
  • removeListener(eventType: "status", callback: (status: Status) => void): void
  • removeListener(eventType: "metadata", callback: (status: Metadata) => void): void
  • removeListener(eventType: "data", callback: (response: RESP) => void): void
  • removeListener(eventType: "end", callback: () => void): void

  • Parameters

    Returns void

  • Parameters

    • eventType: "status"
    • callback: (status: Status) => void

    Returns void

  • Parameters

    Returns void

  • Parameters

    • eventType: "data"
    • callback: (response: RESP) => void
        • (response: RESP): void

        • Parameters

          • response: RESP

          Returns void

    Returns void

  • Parameters

    • eventType: "end"
    • callback: () => void
        • (): void

        • Returns void

    Returns void

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/HavenoClient._internal_.RpcError.html b/docs/classes/HavenoClient._internal_.RpcError.html new file mode 100644 index 00000000..ce45eada --- /dev/null +++ b/docs/classes/HavenoClient._internal_.RpcError.html @@ -0,0 +1,6 @@ +RpcError | haveno-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RpcError

Hierarchy

  • Error
    • RpcError

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    Returns RpcError

Properties

Optional cause

cause?: Error

code

code: StatusCode

message

message: string

metadata

metadata: Metadata

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void
  • +

    Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/utils_HavenoUtils.HavenoUtils.html b/docs/classes/utils_HavenoUtils.HavenoUtils.html index fc73078c..b7ea19f2 100644 --- a/docs/classes/utils_HavenoUtils.HavenoUtils.html +++ b/docs/classes/utils_HavenoUtils.HavenoUtils.html @@ -1,32 +1,32 @@ HavenoUtils | haveno-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HavenoUtils

Collection of utilities for working with Haveno.

-

Hierarchy

  • HavenoUtils

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static centinerosToAUMultiplier

centinerosToAUMultiplier: number = 10000

Static lastLogTimeMs

lastLogTimeMs: number = 0

Static logLevel

logLevel: number = 0

Static months

months: string[] = ...

Methods

Static centinerosToAtomicUnits

  • centinerosToAtomicUnits(centineros: number): bigint

Hierarchy

  • HavenoUtils

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static centinerosToAUMultiplier

centinerosToAUMultiplier: number = 10000

Static lastLogTimeMs

lastLogTimeMs: number = 0

Static logLevel

logLevel: number = 0

Static months

months: string[] = ...

Methods

Static centinerosToAtomicUnits

  • centinerosToAtomicUnits(centineros: number): bigint

  • Convert centineros to atomic units.

    Parameters

    • centineros: number

      denominates an amount of XMR in centineros

    Returns bigint

    the amount denominated in atomic units

    -

Static formatTimestamp

  • formatTimestamp(timestamp: number): string

Static formatTimestamp

  • formatTimestamp(timestamp: number): string

  • Format a timestamp as e.g. Jul-07 hh:mm:ss:ms. // TODO: move to GenUtils?

    Parameters

    • timestamp: number

      the timestamp in milliseconds to format

    Returns string

    the formatted timestamp

    -

Static getLogLevel

  • getLogLevel(): number

Static getLogLevel

  • getLogLevel(): number

Static kill

  • kill(process: any, signal?: string): Promise<void>

Static kill

  • kill(process: any, signal?: string): Promise<void>

  • Kill the given process.

    TODO (woodser): move this to monero-javascript GenUtils.js as common utility

    Parameters

    • process: any

      the nodejs child process to child

    • Optional signal: string

      the kill signal, e.g. SIGTERM, SIGKILL, SIGINT (default)

      -

    Returns Promise<void>

Static log

  • log(level: number, msg: string): void

Returns Promise<void>

Static log

  • log(level: number, msg: string): void

  • Log a message. // TODO (woodser): switch to log library?

    Parameters

    • level: number

      log level of the message

    • msg: string

      message to log

      -

    Returns void

Static setLogLevel

  • setLogLevel(level: number): Promise<void>

Returns void

Static setLogLevel

  • setLogLevel(level: number): Promise<void>

Properties

_fn

_fn: () => Promise<void>

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

_isLooping

_isLooping: boolean

_isStarted

_isStarted: boolean

_timeout

_timeout: undefined | Timeout

Methods

_runLoop

  • _runLoop(periodInMs: number): Promise<void>

start

  • start(periodInMs: number): void

  • Start the task loop.

    Parameters

    • periodInMs: number

      the loop period in milliseconds

      -

    Returns void

stop

  • stop(): void

Returns void

stop

  • stop(): void

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/HavenoClient._internal_.StatusCode.html b/docs/enums/HavenoClient._internal_.StatusCode.html new file mode 100644 index 00000000..f9d96b11 --- /dev/null +++ b/docs/enums/HavenoClient._internal_.StatusCode.html @@ -0,0 +1 @@ +StatusCode | haveno-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration StatusCode

Index

Enumeration members

Enumeration members

ABORTED

ABORTED

ALREADY_EXISTS

ALREADY_EXISTS

CANCELLED

CANCELLED

DATA_LOSS

DATA_LOSS

DEADLINE_EXCEEDED

DEADLINE_EXCEEDED

FAILED_PRECONDITION

FAILED_PRECONDITION

INTERNAL

INTERNAL

INVALID_ARGUMENT

INVALID_ARGUMENT

NOT_FOUND

NOT_FOUND

OK

OK

OUT_OF_RANGE

OUT_OF_RANGE

PERMISSION_DENIED

PERMISSION_DENIED

RESOURCE_EXHAUSTED

RESOURCE_EXHAUSTED

UNAUTHENTICATED

UNAUTHENTICATED

UNAVAILABLE

UNAVAILABLE

UNIMPLEMENTED

UNIMPLEMENTED

UNKNOWN

UNKNOWN

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/HavenoClient._internal_.CallSite.html b/docs/interfaces/HavenoClient._internal_.CallSite.html new file mode 100644 index 00000000..c56cae03 --- /dev/null +++ b/docs/interfaces/HavenoClient._internal_.CallSite.html @@ -0,0 +1,34 @@ +CallSite | haveno-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CallSite

Hierarchy

  • CallSite

Index

Methods

Methods

getColumnNumber

  • getColumnNumber(): null | number
  • +

    Current column number [if this function was defined in a script]

    +

    Returns null | number

getEvalOrigin

  • getEvalOrigin(): undefined | string
  • +

    A call site object representing the location where eval was called +[if this function was created using a call to eval]

    +

    Returns undefined | string

getFileName

  • getFileName(): null | string
  • +

    Name of the script [if this function was defined in a script]

    +

    Returns null | string

getFunction

  • getFunction(): undefined | Function
  • +

    Current function

    +

    Returns undefined | Function

getFunctionName

  • getFunctionName(): null | string
  • +

    Name of the current function, typically its name property. +If a name property is not available an attempt will be made to try +to infer a name from the function's context.

    +

    Returns null | string

getLineNumber

  • getLineNumber(): null | number
  • +

    Current line number [if this function was defined in a script]

    +

    Returns null | number

getMethodName

  • getMethodName(): null | string
  • +

    Name of the property [of "this" or one of its prototypes] that holds +the current function

    +

    Returns null | string

getThis

  • getThis(): unknown
  • +

    Value of "this"

    +

    Returns unknown

getTypeName

  • getTypeName(): null | string
  • +

    Type of "this" as a string. +This is the name of the function stored in the constructor field of +"this", if available. Otherwise the object's [[Class]] internal +property.

    +

    Returns null | string

isConstructor

  • isConstructor(): boolean
  • +

    Is this a constructor call?

    +

    Returns boolean

isEval

  • isEval(): boolean
  • +

    Does this call take place in code defined by a call to eval?

    +

    Returns boolean

isNative

  • isNative(): boolean
  • +

    Is this call in native V8 code?

    +

    Returns boolean

isToplevel

  • isToplevel(): boolean
  • +

    Is this a toplevel invocation, that is, is "this" the global object?

    +

    Returns boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/HavenoClient._internal_.Metadata.html b/docs/interfaces/HavenoClient._internal_.Metadata.html new file mode 100644 index 00000000..458965d2 --- /dev/null +++ b/docs/interfaces/HavenoClient._internal_.Metadata.html @@ -0,0 +1 @@ +Metadata | haveno-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Metadata

Hierarchy

  • Metadata

Indexable

[s: string]: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/HavenoClient._internal_.Status.html b/docs/interfaces/HavenoClient._internal_.Status.html new file mode 100644 index 00000000..b4b3e0d2 --- /dev/null +++ b/docs/interfaces/HavenoClient._internal_.Status.html @@ -0,0 +1 @@ +Status | haveno-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Status

Hierarchy

  • Status

Index

Properties

Properties

code

code: number

details

details: string

Optional metadata

metadata?: Metadata

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/utils_TaskLooper._internal_.RefCounted.html b/docs/interfaces/utils_TaskLooper._internal_.RefCounted.html new file mode 100644 index 00000000..dfc34a05 --- /dev/null +++ b/docs/interfaces/utils_TaskLooper._internal_.RefCounted.html @@ -0,0 +1 @@ +RefCounted | haveno-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RefCounted

Hierarchy

Index

Methods

Methods

ref

  • Returns RefCounted

unref

  • Returns RefCounted

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/utils_TaskLooper._internal_.Timeout.html b/docs/interfaces/utils_TaskLooper._internal_.Timeout.html new file mode 100644 index 00000000..eab78290 --- /dev/null +++ b/docs/interfaces/utils_TaskLooper._internal_.Timeout.html @@ -0,0 +1,13 @@ +Timeout | haveno-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Timeout

Hierarchy

Index

Methods

Methods

[toPrimitive]

  • [toPrimitive](): number

  • Returns number

hasRef

  • hasRef(): boolean
  • +

    If true, the Timeout object will keep the Node.js event loop active.

    +
    since

    v11.0.0

    +

    Returns boolean

ref

  • Returns Timeout

refresh

  • +

    Sets the timer's start time to the current time, and reschedules the timer to +call its callback at the previously specified duration adjusted to the current +time. This is useful for refreshing a timer without allocating a new +JavaScript object.

    +

    Using this on a timer that has already called its callback will reactivate the +timer.

    +
    since

    v10.2.0

    +

    Returns Timeout

    a reference to timeout

    +

unref

  • Returns Timeout

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/utils_TaskLooper._internal_.Timer.html b/docs/interfaces/utils_TaskLooper._internal_.Timer.html new file mode 100644 index 00000000..a7c967f8 --- /dev/null +++ b/docs/interfaces/utils_TaskLooper._internal_.Timer.html @@ -0,0 +1 @@ +Timer | haveno-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Timer

Hierarchy

Index

Methods

Methods

[toPrimitive]

  • [toPrimitive](): number

  • Returns number

hasRef

  • hasRef(): boolean

  • Returns boolean

ref

  • Returns Timer

refresh

  • Returns Timer

unref

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/HavenoClient._internal_.html b/docs/modules/HavenoClient._internal_.html new file mode 100644 index 00000000..d639305d --- /dev/null +++ b/docs/modules/HavenoClient._internal_.html @@ -0,0 +1 @@ +<internal> | haveno-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace <internal>

Index

Enumerations

Classes

Interfaces

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/HavenoClient.html b/docs/modules/HavenoClient.html new file mode 100644 index 00000000..98ae45bf --- /dev/null +++ b/docs/modules/HavenoClient.html @@ -0,0 +1 @@ +HavenoClient | haveno-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module HavenoClient

Index

Namespaces

Classes

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html new file mode 100644 index 00000000..d42f78e3 --- /dev/null +++ b/docs/modules/index.html @@ -0,0 +1 @@ +index | haveno-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module index

Index

References

References

HavenoClient

Re-exports HavenoClient

HavenoUtils

Re-exports HavenoUtils

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/utils_TaskLooper._internal_.html b/docs/modules/utils_TaskLooper._internal_.html new file mode 100644 index 00000000..308d53fa --- /dev/null +++ b/docs/modules/utils_TaskLooper._internal_.html @@ -0,0 +1 @@ +<internal> | haveno-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace <internal>

Index

Interfaces

Generated using TypeDoc

\ No newline at end of file