From dbe3b7bbca6981f6ad44a0a9f5ffb447842c8843 Mon Sep 17 00:00:00 2001 From: woodser Date: Fri, 20 Sep 2024 20:31:44 -0400 Subject: [PATCH] update typedocs --- docs/classes/HavenoClient.HavenoClient.html | 162 +++++++++--------- .../types_HavenoError.HavenoError.html | 6 +- .../utils_HavenoUtils.HavenoUtils.html | 46 ++--- docs/classes/utils_TaskLooper.TaskLooper.html | 18 +- docs/index.html | 7 +- docs/modules/HavenoClient.html | 2 +- docs/modules/index-1.html | 2 +- docs/modules/index.html | 2 +- docs/modules/types_HavenoError.html | 2 +- docs/modules/utils_HavenoUtils.html | 2 +- docs/modules/utils_TaskLooper.html | 2 +- 11 files changed, 127 insertions(+), 124 deletions(-) diff --git a/docs/classes/HavenoClient.HavenoClient.html b/docs/classes/HavenoClient.HavenoClient.html index 852cdf3b..e2a84119 100644 --- a/docs/classes/HavenoClient.HavenoClient.html +++ b/docs/classes/HavenoClient.HavenoClient.html @@ -24,7 +24,7 @@ +
  • Defined in src/HavenoClient.ts:30
    • @@ -138,7 +138,7 @@

    Returns HavenoClient

    +
  • Defined in src/HavenoClient.ts:72

    • Methods

    @@ -152,7 +152,7 @@

    Returns Promise<boolean>

    +
  • Defined in src/HavenoClient.ts:269

    • addMoneroConnection

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:446

    • addNotificationListener

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:412

    • backupAccount

    Returns Promise<number>

    +
  • Defined in src/HavenoClient.ts:359

    • changePassword

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:323

    • checkMoneroConnection

    +
  • Defined in src/HavenoClient.ts:521

    • checkMoneroConnections

    +
  • Defined in src/HavenoClient.ts:534

    • closeAccount

    +
  • Defined in src/HavenoClient.ts:337

    • completeTrade

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:1176

    • confirmPaymentReceived

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:1163

    • confirmPaymentSent

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:1150

    • createAccount

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:295

    • createCryptoPaymentAccount

    Returns Promise<PaymentAccount>

    +
  • Defined in src/HavenoClient.ts:949

    • createPaymentAccount

    Returns Promise<PaymentAccount>

    +
  • Defined in src/HavenoClient.ts:933

    • createXmrTx

    Returns Promise<XmrTx>

    +
  • Defined in src/HavenoClient.ts:754

    • deleteAccount

    +
  • Defined in src/HavenoClient.ts:348

    • deletePaymentAccount

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:967

    • disconnect

    +
  • Defined in src/HavenoClient.ts:1298

    • getAppName

    +
  • Defined in src/HavenoClient.ts:233

    • getBalances

    +
  • Defined in src/HavenoClient.ts:675

    • getBestAvailableConnection

    +
  • Defined in src/HavenoClient.ts:571

    • getChatMessages

    Returns Promise<ChatMessage[]>

    +
  • Defined in src/HavenoClient.ts:1189

    • getDispute

    Returns Promise<Dispute>

    +
  • Defined in src/HavenoClient.ts:1220

    • getDisputes

    +
  • Defined in src/HavenoClient.ts:1231

    • getMarketDepth

    Returns Promise<MarketDepthInfo>

    +
  • Defined in src/HavenoClient.ts:821

    • getMoneroConnection

    +
  • Defined in src/HavenoClient.ts:472

    • getMoneroConnections

    +
  • Defined in src/HavenoClient.ts:485

    • getMoneroNodeSettings

    +
  • Defined in src/HavenoClient.ts:606

    • getMyOffer

    Returns Promise<OfferInfo>

    +
  • Defined in src/HavenoClient.ts:1015

    • getMyOffers

    Returns Promise<OfferInfo[]>

    +
  • Defined in src/HavenoClient.ts:998

    • getOffers

    Returns Promise<OfferInfo[]>

    +
  • Defined in src/HavenoClient.ts:982

    • getPaymentAccount

    Returns Promise<PaymentAccount>

    +
  • Defined in src/HavenoClient.ts:870

    • getPaymentAccountForm

    Returns Promise<PaymentAccountForm>

    +
  • Defined in src/HavenoClient.ts:885

    • getPaymentAccountPayloadForm

    Returns Promise<PaymentAccountForm>

    +
  • Defined in src/HavenoClient.ts:900

    • getPaymentAccounts

    +
  • Defined in src/HavenoClient.ts:856

    • getPaymentMethods

    Returns Promise<PaymentMethod[]>

    +
  • Defined in src/HavenoClient.ts:835

    • getPrice

    Returns Promise<number>

    +
  • Defined in src/HavenoClient.ts:794

    • getPricedAssetCodes

    +
  • Defined in src/HavenoClient.ts:782

    • getPrices

    +
  • Defined in src/HavenoClient.ts:807

    • getProcess

    +
  • Defined in src/HavenoClient.ts:198

    • getTrade

    Returns Promise<TradeInfo>

    +
  • Defined in src/HavenoClient.ts:1111

    • getTradeStatistics

    +
  • Defined in src/HavenoClient.ts:1124

    • getTrades

    +
  • Defined in src/HavenoClient.ts:1137

    • getUrl

    +
  • Defined in src/HavenoClient.ts:217

    • getVersion

    +
  • Defined in src/HavenoClient.ts:242

    • getWalletRpcPort

    +
  • Defined in src/HavenoClient.ts:226

    • getXmrNewSubaddress

    +
  • Defined in src/HavenoClient.ts:714

    • getXmrPrimaryAddress

    +
  • Defined in src/HavenoClient.ts:701

    • getXmrSeed

    +
  • Defined in src/HavenoClient.ts:688

    • getXmrTx

    Returns Promise<undefined | XmrTx>

    +
  • Defined in src/HavenoClient.ts:741

    • getXmrTxs

    +
  • Defined in src/HavenoClient.ts:727

    • isAccountOpen

    +
  • Defined in src/HavenoClient.ts:282

    • isConnectedToDaemon

    +
  • Defined in src/HavenoClient.ts:255

    • isConnectedToMonero

    +
  • Defined in src/HavenoClient.ts:434

    • isMoneroNodeOnline

    +
  • Defined in src/HavenoClient.ts:595

    • openAccount

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:309

    • openDispute

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:1244

    • postOffer

    Returns Promise<OfferInfo>

    +
  • Defined in src/HavenoClient.ts:1038

    • registerDisputeAgent

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:646

    • relayXmrTx

    Returns Promise<string>

    +
  • Defined in src/HavenoClient.ts:767

    • removeMoneroConnection

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:459

    • removeNotificationListener

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:422

    • removeOffer

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:1073

    • resolveDispute

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:1262

    • restoreAccount

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:388

    • sendChatMessage

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:1204

    • sendDisputeChatMessage

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:1283

    • setAutoSwitch

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:584

    • setMoneroConnection

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:503

    • setProcessLogging

    Returns void

    +
  • Defined in src/HavenoClient.ts:207

    • shutdownServer

    +
  • Defined in src/HavenoClient.ts:1305

    • startCheckingConnection

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:547

    • startMoneroNode

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:620

    • stopCheckingConnection

    +
  • Defined in src/HavenoClient.ts:558

    • stopMoneroNode

    +
  • Defined in src/HavenoClient.ts:632

    • takeOffer

    Returns Promise<TradeInfo>

    +
  • Defined in src/HavenoClient.ts:1089

    • unregisterDisputeAgent

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:662

    • validateFormField

    Returns Promise<void>

    +
  • Defined in src/HavenoClient.ts:915

    • Static startProcess

    Returns Promise<HavenoClient>

    +
  • Defined in src/HavenoClient.ts:103
    • diff --git a/docs/classes/types_HavenoError.HavenoError.html b/docs/classes/types_HavenoError.HavenoError.html index b7c0ce18..57b4c084 100644 --- a/docs/classes/types_HavenoError.HavenoError.html +++ b/docs/classes/types_HavenoError.HavenoError.html @@ -26,7 +26,7 @@
    • HavenoError
    +
  • Defined in src/types/HavenoError.ts:21
    • @@ -71,7 +71,7 @@

    Returns HavenoError

    +
  • Defined in src/types/HavenoError.ts:31

    • Properties

    @@ -84,7 +84,7 @@

    code

    code: undefined | number
    +
  • Defined in src/types/HavenoError.ts:23

    • message

    message: string
    +
  • Defined in src/utils/HavenoUtils.ts:26
    • @@ -76,22 +76,22 @@

    Static AU_PER_XMR

    AU_PER_XMR: bigint = ...
    +
  • Defined in src/utils/HavenoUtils.ts:31

    • Static lastLogTimeMs

    lastLogTimeMs: number = 0
    +
  • Defined in src/utils/HavenoUtils.ts:30

    • Static logLevel

    logLevel: number = 0
    +
  • Defined in src/utils/HavenoUtils.ts:28

    • Static months

    months: string[] = ...
    +
  • Defined in src/utils/HavenoUtils.ts:29

    • Methods

    @@ -112,7 +112,7 @@

    Returns bigint

    +
  • Defined in src/utils/HavenoUtils.ts:163

    • Static atomicUnitsToXmr

    Returns number

    +
  • Defined in src/utils/HavenoUtils.ts:120

    • Static divide

    Returns number

    +
  • Defined in src/utils/HavenoUtils.ts:131

    • Static formToString

    Returns string

    +
  • Defined in src/utils/HavenoUtils.ts:204

    • Static formatTimestamp

    Returns string

    +
  • Defined in src/utils/HavenoUtils.ts:74

    • Static getFormValue

    Returns string

    +
  • Defined in src/utils/HavenoUtils.ts:234

    • Static getLogLevel

    +
  • Defined in src/utils/HavenoUtils.ts:48

    • Static getPaymentMethodId

    Returns string

    +
  • Defined in src/utils/HavenoUtils.ts:186

    • Static hasFormField

    Returns boolean

    +
  • Defined in src/utils/HavenoUtils.ts:219

    • Static kill

    Returns Promise<void>

    +
  • Defined in src/utils/HavenoUtils.ts:87

    • Static log

    Returns void

    +
  • Defined in src/utils/HavenoUtils.ts:58

    • Static max

    Returns bigint

    +
  • Defined in src/utils/HavenoUtils.ts:174

    • Static multiply

    Returns bigint

    +
  • Defined in src/utils/HavenoUtils.ts:142

    • Static percentageDiff

    Returns number

    +
  • Defined in src/utils/HavenoUtils.ts:153

    • Static setFormValue

    Returns void

    +
  • Defined in src/utils/HavenoUtils.ts:249

    • Static setLogLevel

    Returns Promise<void>

    +
  • Defined in src/utils/HavenoUtils.ts:38

    • Static waitFor

    Returns Promise<unknown>

    +
  • Defined in src/utils/HavenoUtils.ts:100

    • Static xmrToAtomicUnits

    Returns bigint

    +
  • Defined in src/utils/HavenoUtils.ts:110
    • diff --git a/docs/classes/utils_TaskLooper.TaskLooper.html b/docs/classes/utils_TaskLooper.TaskLooper.html index 2c463616..6ff69e64 100644 --- a/docs/classes/utils_TaskLooper.TaskLooper.html +++ b/docs/classes/utils_TaskLooper.TaskLooper.html @@ -24,7 +24,7 @@
    • TaskLooper
    +
  • Defined in src/utils/TaskLooper.ts:21
    • @@ -71,7 +71,7 @@

    Returns Promise<void>

    Returns TaskLooper

    +
  • Defined in src/utils/TaskLooper.ts:33

    • Properties

    @@ -86,22 +86,22 @@

  • Returns Promise<void>

    • +
  • Defined in src/utils/TaskLooper.ts:23

    • _isLooping

    _isLooping: boolean
    +
  • Defined in src/utils/TaskLooper.ts:25

    • _isStarted

    _isStarted: boolean
    +
  • Defined in src/utils/TaskLooper.ts:24

    • _timeout

    _timeout: undefined | Timeout
    +
  • Defined in src/utils/TaskLooper.ts:26

    • Methods

    @@ -118,7 +118,7 @@
    targetFixedPeriod: boolean

    Returns Promise<void>

    +
  • Defined in src/utils/TaskLooper.ts:63

    • start

    Returns void

    +
  • Defined in src/utils/TaskLooper.ts:46

    • stop

    +
  • Defined in src/utils/TaskLooper.ts:56
    • diff --git a/docs/index.html b/docs/index.html index 00ed77d1..0a0f739a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -49,17 +49,20 @@

    Start local Haveno network manually

     +

    This workflow is useful for local development of haveno and haveno-ts

    1. Run a local Haveno test network and then shut down the arbitrator, user1, and user2 or run them as daemons, e.g. make user1-daemon-local. You may omit the arbitrator registration steps since it's done automatically in the tests.
    2. Clone this project to the same parent directory as the haveno project: git clone https://github.com/haveno-dex/haveno-ts
      3. -
    3. In a new terminal, start envoy with the config in haveno-ts/config/envoy.test.yaml.
      For example (change absolute path for your system): docker run --network host --rm --add-host host.docker.internal:host-gateway -it -v ~/git/haveno-ts/config/envoy.test.yaml:/envoy.test.yaml -p 8079:8079 -p 8080:8080 -p 8081:8081 -p 8082:8082 -p 8083:8083 -p 8084:8084 -p 8085:8085 -p 8086:8086 envoyproxy/envoy-dev:latest -c /envoy.test.yaml
      4. +
    4. Install envoy proxy from your package manager of choice, for example brew install envoy.
      5. +
    5. In a new terminal, start envoy with the config in haveno-ts/config/envoy.local.yaml: envoy -c config/envoy.local.yaml
    6. In a new terminal, start the funding wallet. This wallet will be funded automatically in order to fund the tests.
      For example: cd ~/git/haveno && make funding-wallet-local.

    Start local Haveno network with docker

     -

    Alternatively, start a local Haveno network with docker:

    +

    Alternatively use this wokflow to develop haveno-ts or run tests with dockerized setup:

    +

    Start a local Haveno network with docker:

    1. cd ~/git/haveno-ts/docker
    2. sudo docker-compose up. This will start docker and initialize the network.
      3. diff --git a/docs/modules/HavenoClient.html b/docs/modules/HavenoClient.html index 82be413d..e428a403 100644 --- a/docs/modules/HavenoClient.html +++ b/docs/modules/HavenoClient.html @@ -16,7 +16,7 @@
    3. HavenoClient

      4. Module HavenoClient

    +
  • Defined in src/HavenoClient.ts:18
    • diff --git a/docs/modules/index-1.html b/docs/modules/index-1.html index 52063c3b..b25c6018 100644 --- a/docs/modules/index-1.html +++ b/docs/modules/index-1.html @@ -16,7 +16,7 @@
  • index

    • Module index

    +
  • Defined in src/index.ts:1
    • diff --git a/docs/modules/index.html b/docs/modules/index.html index 2381a73f..7c62aef1 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -16,7 +16,7 @@
  • index

    • Module index

    +
  • Defined in src/index.ts:1
    • diff --git a/docs/modules/types_HavenoError.html b/docs/modules/types_HavenoError.html index 5e8a78ec..c6fc2139 100644 --- a/docs/modules/types_HavenoError.html +++ b/docs/modules/types_HavenoError.html @@ -16,7 +16,7 @@
  • types/HavenoError

    • Module types/HavenoError

    +
  • Defined in src/types/HavenoError.ts:21
    • diff --git a/docs/modules/utils_HavenoUtils.html b/docs/modules/utils_HavenoUtils.html index 2b666c10..ce08ca2a 100644 --- a/docs/modules/utils_HavenoUtils.html +++ b/docs/modules/utils_HavenoUtils.html @@ -16,7 +16,7 @@
  • utils/HavenoUtils

    • Module utils/HavenoUtils

    +
  • Defined in src/utils/HavenoUtils.ts:18
    • diff --git a/docs/modules/utils_TaskLooper.html b/docs/modules/utils_TaskLooper.html index 59147720..35e96a31 100644 --- a/docs/modules/utils_TaskLooper.html +++ b/docs/modules/utils_TaskLooper.html @@ -16,7 +16,7 @@
  • utils/TaskLooper

    • Module utils/TaskLooper

    +
  • Defined in src/utils/TaskLooper.ts:21