Class HavenoClient

Haveno daemon client.

Hierarchy

  • HavenoClient

Constructors

constructor

Methods

accountExists addMoneroConnection addNotificationListener backupAccount changePassword checkMoneroConnection checkMoneroConnections closeAccount completeTrade confirmPaymentReceived confirmPaymentSent createAccount createCryptoPaymentAccount createPaymentAccount createXmrTx deleteAccount deletePaymentAccount disconnect getAppName getAutoSwitch getBalances getBestAvailableConnection getChatMessages getDispute getDisputes getMarketDepth getMoneroConnection getMoneroConnections getMoneroNodeSettings getMyOffer getMyOffers getOffers getPaymentAccount getPaymentAccountForm getPaymentAccountPayloadForm getPaymentAccounts getPaymentMethods getPrice getPricedAssetCodes getPrices getProcess getTrade getTradeStatistics getTrades getUrl getVersion getWalletRpcPort getXmrNewSubaddress getXmrPrimaryAddress getXmrSeed getXmrTx getXmrTxs isAccountOpen isConnectedToDaemon isConnectedToMonero isMoneroNodeOnline openAccount openDispute postOffer registerDisputeAgent relayXmrTx removeMoneroConnection removeNotificationListener removeOffer resolveDispute restoreAccount sendChatMessage sendDisputeChatMessage setAutoSwitch setMoneroConnection setProcessLogging shutdownServer startCheckingConnection startMoneroNode stopCheckingConnection stopMoneroNode takeOffer unregisterDisputeAgent validateFormField startProcess

Constructors

constructor

  • Construct a client connected to a Haveno daemon.

    Parameters

    • url: string

      Haveno daemon url

    • password: string

      Haveno daemon password

    Returns HavenoClient

Methods

accountExists

  • Indicates if the Haveno account is created.

    Returns

    true if the account is created, false otherwise

    Returns Promise<boolean>

addMoneroConnection

addNotificationListener

backupAccount

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

    Parameters

    • stream: any

    Returns Promise<number>

changePassword

  • Change the Haveno account password.

    Parameters

    • oldPassword: string
    • newPassword: string

    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

    the current daemon connection status, undefined if no current connection

    Returns Promise<undefined | UrlConnection>

checkMoneroConnections

closeAccount

  • Close the currently open account.

    Returns Promise<void>

completeTrade

  • Acknowledge that a trade has completed.

    Parameters

    • tradeId: string

      the id of the trade

    Returns Promise<void>

confirmPaymentReceived

  • Confirm a payment is received.

    Parameters

    • tradeId: string

      the id of the trade

    Returns Promise<void>

confirmPaymentSent

  • Confirm a payment is sent.

    Parameters

    • tradeId: string

      the id of the trade

    Returns Promise<void>

createAccount

  • Create and open a new Haveno account.

    Parameters

    • password: string

      the password to encrypt the account

    Returns Promise<void>

createCryptoPaymentAccount

  • Create a crypto payment account.

    Returns

    the created payment account

    Parameters

    • accountName: string

      description of the account

    • assetCode: string

      traded asset code

    • address: string

      payment address of the account

    Returns Promise<PaymentAccount>

createPaymentAccount

createXmrTx

deleteAccount

  • Permanently delete the Haveno account.

    Returns Promise<void>

deletePaymentAccount

  • Delete a payment account.

    Parameters

    • paymentAccountId: string

      the id of the payment account to delete

    Returns Promise<void>

disconnect

  • Disconnect this client from the server.

    Returns Promise<void>

getAppName

  • Get the name of the Haveno application folder.

    Returns undefined | string

getAutoSwitch

  • Get the current auto switch setting.

    Returns

    whether auto switch is enabled or disabled

    Returns Promise<boolean>

getBalances

getBestAvailableConnection

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

    Returns

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

    Returns Promise<undefined | UrlConnection>

getChatMessages

getDispute

getDisputes

getMarketDepth

  • Get the market depth of a currency.

    Returns

    market depth of the given currency

    Parameters

    • assetCode: string

      asset to get the market depth of

    Returns Promise<MarketDepthInfo>

getMoneroConnection

  • Get the current Monero daemon connection.

    Returns

    the current daemon connection, undefined if no current connection

    Returns Promise<undefined | UrlConnection>

getMoneroConnections

getMoneroNodeSettings

getMyOffer

  • Get my offer by id.

    Returns

    the user's created offer

    Parameters

    • offerId: string

      id of the user's created offer

    Returns Promise<OfferInfo>

getMyOffers

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

    Returns

    the user's created offers

    Parameters

    • Optional assetCode: string

      traded asset code

    • Optional direction: OfferDirection

      get offers to buy or sell XMR (default all)

    Returns Promise<OfferInfo[]>

getOffers

getPaymentAccount

  • Get a payment account by id.

    Returns

    the payment account

    Parameters

    • paymentAccountId: string

      the payment account id to get

    Returns Promise<PaymentAccount>

getPaymentAccountForm

getPaymentAccountPayloadForm

getPaymentAccounts

getPaymentMethods

  • Get payment methods.

    Returns

    the payment methods

    Parameters

    • Optional assetCode: string

      get payment methods supporting this asset code (optional)

    Returns Promise<PaymentMethod[]>

getPrice

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

    Returns

    the price of the asset per 1 XMR

    Parameters

    • assetCode: string

      asset code to get the price of

    Returns Promise<number>

getPricedAssetCodes

  • Get all asset codes with price information.

    TODO: replace this with getSupportedAssetCodes(): Promise<TradeCurrency[]>)

    Returns

    all supported trade assets

    Returns Promise<string[]>

getPrices

getProcess

  • Return the process running the haveno daemon.

    Returns

    the process running the haveno daemon

    Returns any

getTrade

  • Get a trade by id.

    Returns

    the trade with the given id

    Parameters

    • tradeId: string

      the id of the trade and its offer

    Returns Promise<TradeInfo>

getTradeStatistics

getTrades

getUrl

  • Get the URL of the Haveno daemon.

    Returns

    the URL of the Haveno daemon

    Returns string

getVersion

  • Get the Haveno version.

    Returns

    the Haveno daemon version

    Returns Promise<string>

getWalletRpcPort

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

    Returns

    the port of the primary wallet rpc instance if known

    Returns undefined | number

getXmrNewSubaddress

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

    Returns

    the deposit address (a subaddress in the Haveno wallet)

    Returns Promise<string>

getXmrPrimaryAddress

  • Get the primary address of the Monero wallet.

    Returns

    the primary address of the Monero wallet

    Returns Promise<string>

getXmrSeed

  • Get the mnemonic seed phrase of the Monero wallet.

    Returns

    the mnemonic seed phrase of the Monero wallet

    Returns Promise<string>

getXmrTx

  • Get a transaction by hash in the Monero wallet.

    Returns

    the transaction with the hash

    Parameters

    • txHash: string

      hash of the transaction to get

    Returns Promise<undefined | XmrTx>

getXmrTxs

isAccountOpen

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

    Returns

    true if the account is open and authenticated, false otherwise

    Returns Promise<boolean>

isConnectedToDaemon

  • Indicates if connected and authenticated with the Haveno daemon.

    Returns

    true if connected with the Haveno daemon, false otherwise

    Returns Promise<boolean>

isConnectedToMonero

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

    Returns

    true if connected to the Monero network, false otherwise

    Returns Promise<boolean>

isMoneroNodeOnline

  • Returns whether daemon is running a local monero node.

    Returns Promise<boolean>

openAccount

  • Open existing Haveno account.

    Parameters

    • password: string

      the account password

    Returns Promise<void>

openDispute

  • Open a dispute for a trade.

    Parameters

    • tradeId: string

      the id of the trade

    Returns Promise<void>

postOffer

  • Post an offer.

    Returns

    the posted offer

    Parameters

    • direction: OfferDirection

      "buy" or "sell" XMR

    • amount: bigint

      amount of XMR to trade

    • assetCode: string

      asset code to trade for XMR

    • paymentAccountId: string

      payment account id

    • securityDepositPct: number

      security deposit as % of trade amount for buyer and seller

    • Optional price: number

      trade price (optional, default to market price)

    • Optional marketPriceMarginPct: 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)

    • Optional reserveExactAmount: boolean

      reserve exact amount needed for offer, incurring on-chain transaction and 10 confirmations before the offer goes live (default = false)

    Returns Promise<OfferInfo>

registerDisputeAgent

  • 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

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

    Returns

    the hash of the relayed transaction

    Parameters

    • metadata: string

    Returns Promise<string>

removeMoneroConnection

  • Remove a Monero daemon connection.

    Parameters

    • url: string

      url of the daemon connection to remove

    Returns Promise<void>

removeNotificationListener

removeOffer

  • Remove a posted offer, releasing its reserved funds.

    Parameters

    • offerId: string

      the offer id to cancel

    Returns Promise<void>

resolveDispute

  • 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 and the loser will get the rest.

    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

  • 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

  • Send a trade chat message.

    Parameters

    • tradeId: string

      the id of the trade

    • message: string

      the message

    Returns Promise<void>

sendDisputeChatMessage

  • Send a dispute chat message.

    Parameters

    • disputeId: string

      the id of the dispute

    • message: string

      the message

    • attachments: Attachment[]

      attachments

    Returns Promise<void>

setAutoSwitch

  • 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

  • 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

  • Enable or disable process logging.

    Parameters

    • enabled: boolean

      specifies if logging is enabled or disabled

    Returns void

shutdownServer

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

    Returns Promise<void>

startCheckingConnection

  • 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

  • Stop checking the connection status periodically.

    Returns Promise<void>

stopMoneroNode

  • Stops the local monero node.

    Returns Promise<void>

takeOffer

  • Take an offer.

    Returns

    the initialized trade

    Parameters

    • offerId: string

      id of the offer to take

    • paymentAccountId: string

      id of the payment account

    • Optional amount: bigint

      amount the taker chooses to buy or sell within the offer range (default is max offer amount)

    Returns Promise<TradeInfo>

unregisterDisputeAgent

  • Unregister as a dispute agent.

    Parameters

    • disputeAgentType: string

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

    Returns Promise<void>

validateFormField

Static startProcess

  • Start a new Haveno process.

    Returns

    a client connected to the newly started 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>

Settings

Member Visibility

Theme

Generated using TypeDoc