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 @@ +
Construct a client connected to a Haveno daemon.
+Haveno daemon url
+Haveno daemon password
+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.
+Indicates if the Haveno account is created.
+true if the account is created, false otherwise
+Add a Monero daemon connection.
+daemon url or connection to add
+Add a listener to receive notifications from the Haveno daemon.
+the notification listener to add
+Backup the account to the given stream. TODO: stream type?
+Change the Haveno account password.
+the new account password
+Check the current Monero daemon connection.
+If disconnected and auto switch enabled, switch to the best available connection and return its status.
+the current daemon connection status, undefined if no current connection
+Check all Monero daemon connections.
+status of all managed connections.
+Close the currently open account.
+Confirm a payment is received.
+the id of the trade
+Confirm a payment is started.
+the id of the trade
+Create and open a new Haveno account.
+the password to encrypt the account
+Create a crypto payment account.
+description of the account
+traded asset code
+payment address of the account
+the created payment account
+Create a payment account.
+the completed form as JSON to create the payment account
+the created payment account
+Create but do not relay a transaction to send funds from the Monero wallet.
+the created transaction
+Permanently delete the Haveno account and shutdown the server. // TODO: possible to not shutdown server?
+Disconnect this client from the server.
+Get the name of the Haveno application folder.
+Get the user's balances.
+the user's balances
+Get the best available connection in order of priority then response time.
+the best available connection in order of priority then response time, undefined if no connections available
+Get all chat messages for a trade.
+the id of the trade
+Get a dispute by trade id.
+the id of the trade
+Get all disputes.
+Get the market depth of a currency.
+asset to get the market depth of
+market depth of the given currency
+Get the current Monero daemon connection.
+the current daemon connection, undefined if no current connection
+Get all Monero daemon connections.
+all daemon connections
+Gets the current local monero node settings.
+Get my offer by id.
+id of the user's created offer
+the user's created offer
+Get the user's posted offers to buy or sell XMR.
+traded asset code
+"buy" or "sell" XMR (default all)
+the user's created offers
+Get a new subaddress in the Monero wallet to receive deposits.
+the deposit address (a subaddress in the Haveno wallet)
+Get available offers to buy or sell XMR.
+traded asset code
+"buy" or "sell" (default all)
+the available offers
+Get a payment account by id.
+the payment account id to get
+the payment account
+Get a form for the given payment method to complete and create a new payment account.
+the payment account form as JSON
+Get payment accounts.
+the payment accounts
+Get payment methods.
+the payment methods
+Get the current market price per 1 XMR in the given currency.
+currency code (fiat or crypto) to get the price of
+the current market price per 1 XMR in the given currency
+Get the current market prices of all currencies.
+price per 1 XMR in all supported currencies (fiat & crypto)
+Return the process running the haveno daemon.
+the process running the haveno daemon
+Get a trade by id.
+the id of the trade and its offer
+the trade with the given id
+Get all trades.
+all user trades
+Get the URL of the Haveno daemon.
+the URL of the Haveno daemon
+Get the Haveno version.
+the Haveno daemon version
+Get the port of the primary wallet rpc instance if known.
+the port of the primary wallet rpc instance if known
+Get a transaction by hash in the Monero wallet.
+hash of the transaction to get
+the transaction with the hash
+Get all transactions in the Monero wallet.
+the transactions
+Indicates if the Haveno account is open and authenticated with the correct password.
+true if the account is open and authenticated, false otherwise
+Indicates if connected and authenticated with the Haveno daemon.
+true if connected with the Haveno daemon, false otherwise
+Indicates if connected to the Monero network based on last connection check.
+true if connected to the Monero network, false otherwise
+Returns whether daemon is running a local monero node.
+Open existing Haveno account.
+the account password
+Open a dispute for a trade.
+the id of the trade
+Post an offer.
+"buy" or "sell" XMR
+amount of XMR to trade
+asset code to trade for XMR
+payment account id
+buyer security deposit as % of trade amount
+trade price (optional, default to market price)
+if using market price, % from market price to accept (optional, default 0%)
+price to remove offer (optional)
+minimum amount to trade (optional, default to fixed amount)
+the posted offer
+Register as a dispute agent.
+type of dispute agent to register, e.g. mediator, refundagent
+registration key
+Relay a previously created transaction to send funds from the Monero wallet.
+the hash of the relayed transaction
+Remove a Monero daemon connection.
+url of the daemon connection to remove
+Remove a notification listener.
+the notification listener to remove
+Remove a posted offer, releasing its reserved funds.
+the offer id to cancel
+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.
+the id of the trade
+the winner of the dispute
+the reason for the dispute
+summary of the dispute
+custom amount to award the winner (optional)
+Restore the account from zip bytes.
+Sends chunked requests if size over max grpc envelope size (41943404 bytes).
+the bytes of the zipped account to restore
+Send a trade chat message.
+the id of the trade
+the message
+Send a dispute chat message.
+the id of the dispute
+the message
+attachments
+Automatically switch to the best available connection if current connection is disconnected after being checked.
+whether auto switch is enabled or disabled
+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.
+connection to set as current
+Enable or disable process logging.
+specifies if logging is enabled or disabled
+Shutdown the Haveno daemon server and stop the process if applicable.
+Check the connection and start checking the connection periodically.
+time between checks in milliseconds (default 15000 ms or 15 seconds)
+Starts the local monero node.
+the settings to start the local node with
+Stop checking the connection status periodically.
+Stops the local monero node.
+Take an offer.
+id of the offer to take
+id of the payment account
+the initialized trade
+Start a new Haveno process.
+path to Haveno binaries
+command to start the process
+Haveno daemon url (must proxy to api port)
+specifies if logging is enabled or disabled at log level 3
+a client connected to the newly started Haveno process
+Generated using TypeDoc
Generated using TypeDoc
Optional override for formatting stack traces
+Create .stack property on a target object
+Generated using TypeDoc
Collection of utilities for working with Haveno.
-Convert centineros to atomic units.
denominates an amount of XMR in centineros
the amount denominated in atomic units
-Format a timestamp as e.g. Jul-07 hh:mm:ss:ms. // TODO: move to GenUtils?
the timestamp in milliseconds to format
the formatted timestamp
-Get the log level.
the current log level
-Kill the given process.
TODO (woodser): move this to monero-javascript GenUtils.js as common utility
the nodejs child process to child
the kill signal, e.g. SIGTERM, SIGKILL, SIGINT (default)
-Log a message. // TODO (woodser): switch to log library?
log level of the message
message to log
-Set the log level with 0 being least verbose.
the log level
diff --git a/docs/classes/utils_TaskLooper.TaskLooper.html b/docs/classes/utils_TaskLooper.TaskLooper.html index a4cb14b2..64e6d6ef 100644 --- a/docs/classes/utils_TaskLooper.TaskLooper.html +++ b/docs/classes/utils_TaskLooper.TaskLooper.html @@ -1,13 +1,13 @@Run a task in a fixed period loop.
-Build the looper with a function to invoke on a fixed period loop.
the async function to invoke
-Start the task loop.
the loop period in milliseconds
-Stop the task loop.
Generated using TypeDoc
Generated using TypeDoc
Current column number [if this function was defined in a script]
+A call site object representing the location where eval was called +[if this function was created using a call to eval]
+Name of the script [if this function was defined in a script]
+Current function
+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.
+Current line number [if this function was defined in a script]
+Name of the property [of "this" or one of its prototypes] that holds +the current function
+Value of "this"
+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.
+Is this a constructor call?
+Does this call take place in code defined by a call to eval?
+Is this call in native V8 code?
+Is this a toplevel invocation, that is, is "this" the global object?
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
If true, the Timeout
object will keep the Node.js event loop active.
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.
+a reference to timeout
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Haveno daemon client using gRPC.
+