mirror of
https://github.com/haveno-dex/haveno-ts.git
synced 2025-05-02 14:46:25 -04:00
update typedocs
This commit is contained in:
woodser
parent
123f544130
commit
dbd6b0e738
21 changed files with 817 additions and 382 deletions
|
|
@ -17,50 +17,52 @@
|
|||
<li><a href="../modules/protobuf_pb_pb.InitTradeRequest.html">InitTradeRequest</a></li>
|
||||
<li><a href="protobuf_pb_pb.InitTradeRequest.AsObject.html">AsObject</a></li></ul>
|
||||
<h1>Type alias AsObject</h1></div>
|
||||
<div class="tsd-signature">As<wbr/>Object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>accountAgeWitnessSignatureOfOfferId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>accountId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>arbitratorNodeAddress<span class="tsd-signature-symbol">?: </span><a href="../modules/protobuf_pb_pb.NodeAddress.html" class="tsd-signature-type" data-tsd-kind="Namespace">NodeAddress</a><span class="tsd-signature-symbol">.</span><a href="protobuf_pb_pb.NodeAddress.AsObject.html" class="tsd-signature-type" data-tsd-kind="Type alias">AsObject</a><span class="tsd-signature-symbol">; </span><br/><span> </span>currentDate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>makerNodeAddress<span class="tsd-signature-symbol">?: </span><a href="../modules/protobuf_pb_pb.NodeAddress.html" class="tsd-signature-type" data-tsd-kind="Namespace">NodeAddress</a><span class="tsd-signature-symbol">.</span><a href="protobuf_pb_pb.NodeAddress.AsObject.html" class="tsd-signature-type" data-tsd-kind="Type alias">AsObject</a><span class="tsd-signature-symbol">; </span><br/><span> </span>makerSignature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>offerId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>paymentAccountId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>paymentMethodId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>payoutAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>pubKeyRing<span class="tsd-signature-symbol">?: </span><a href="../modules/protobuf_pb_pb.PubKeyRing.html" class="tsd-signature-type" data-tsd-kind="Namespace">PubKeyRing</a><span class="tsd-signature-symbol">.</span><a href="protobuf_pb_pb.PubKeyRing.AsObject.html" class="tsd-signature-type" data-tsd-kind="Type alias">AsObject</a><span class="tsd-signature-symbol">; </span><br/><span> </span>reserveTxHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>reserveTxHex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>reserveTxKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>senderNodeAddress<span class="tsd-signature-symbol">?: </span><a href="../modules/protobuf_pb_pb.NodeAddress.html" class="tsd-signature-type" data-tsd-kind="Namespace">NodeAddress</a><span class="tsd-signature-symbol">.</span><a href="protobuf_pb_pb.NodeAddress.AsObject.html" class="tsd-signature-type" data-tsd-kind="Type alias">AsObject</a><span class="tsd-signature-symbol">; </span><br/><span> </span>takerNodeAddress<span class="tsd-signature-symbol">?: </span><a href="../modules/protobuf_pb_pb.NodeAddress.html" class="tsd-signature-type" data-tsd-kind="Namespace">NodeAddress</a><span class="tsd-signature-symbol">.</span><a href="protobuf_pb_pb.NodeAddress.AsObject.html" class="tsd-signature-type" data-tsd-kind="Type alias">AsObject</a><span class="tsd-signature-symbol">; </span><br/><span> </span>tradeAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>tradePrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>uid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
|
||||
<div class="tsd-signature">As<wbr/>Object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>accountAgeWitnessSignatureOfOfferId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>arbitratorNodeAddress<span class="tsd-signature-symbol">?: </span><a href="../modules/protobuf_pb_pb.NodeAddress.html" class="tsd-signature-type" data-tsd-kind="Namespace">NodeAddress</a><span class="tsd-signature-symbol">.</span><a href="protobuf_pb_pb.NodeAddress.AsObject.html" class="tsd-signature-type" data-tsd-kind="Type alias">AsObject</a><span class="tsd-signature-symbol">; </span><br/><span> </span>currentDate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>makerAccountId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>makerNodeAddress<span class="tsd-signature-symbol">?: </span><a href="../modules/protobuf_pb_pb.NodeAddress.html" class="tsd-signature-type" data-tsd-kind="Namespace">NodeAddress</a><span class="tsd-signature-symbol">.</span><a href="protobuf_pb_pb.NodeAddress.AsObject.html" class="tsd-signature-type" data-tsd-kind="Type alias">AsObject</a><span class="tsd-signature-symbol">; </span><br/><span> </span>makerPaymentAccountId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>offerId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>paymentMethodId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>payoutAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>reserveTxHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>reserveTxHex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>reserveTxKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>takerAccountId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>takerNodeAddress<span class="tsd-signature-symbol">?: </span><a href="../modules/protobuf_pb_pb.NodeAddress.html" class="tsd-signature-type" data-tsd-kind="Namespace">NodeAddress</a><span class="tsd-signature-symbol">.</span><a href="protobuf_pb_pb.NodeAddress.AsObject.html" class="tsd-signature-type" data-tsd-kind="Type alias">AsObject</a><span class="tsd-signature-symbol">; </span><br/><span> </span>takerPaymentAccountId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>takerPubKeyRing<span class="tsd-signature-symbol">?: </span><a href="../modules/protobuf_pb_pb.PubKeyRing.html" class="tsd-signature-type" data-tsd-kind="Namespace">PubKeyRing</a><span class="tsd-signature-symbol">.</span><a href="protobuf_pb_pb.PubKeyRing.AsObject.html" class="tsd-signature-type" data-tsd-kind="Type alias">AsObject</a><span class="tsd-signature-symbol">; </span><br/><span> </span>tradeAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>tradePrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>tradeProtocolVersion<span class="tsd-signature-symbol">: </span><a href="../enums/protobuf_pb_pb.TradeProtocolVersion.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TradeProtocolVersion</a><span class="tsd-signature-symbol">; </span><br/><span> </span>uid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>account<wbr/>Age<wbr/>Witness<wbr/>Signature<wbr/>Of<wbr/>Offer<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>account<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> arbitrator<wbr/>Node<wbr/>Address<span class="tsd-signature-symbol">?: </span><a href="../modules/protobuf_pb_pb.NodeAddress.html" class="tsd-signature-type" data-tsd-kind="Namespace">NodeAddress</a><span class="tsd-signature-symbol">.</span><a href="protobuf_pb_pb.NodeAddress.AsObject.html" class="tsd-signature-type" data-tsd-kind="Type alias">AsObject</a></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>current<wbr/>Date<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>maker<wbr/>Account<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> maker<wbr/>Node<wbr/>Address<span class="tsd-signature-symbol">?: </span><a href="../modules/protobuf_pb_pb.NodeAddress.html" class="tsd-signature-type" data-tsd-kind="Namespace">NodeAddress</a><span class="tsd-signature-symbol">.</span><a href="protobuf_pb_pb.NodeAddress.AsObject.html" class="tsd-signature-type" data-tsd-kind="Type alias">AsObject</a></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>maker<wbr/>Signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li>
|
||||
<h5>maker<wbr/>Payment<wbr/>Account<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>offer<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>payment<wbr/>Account<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>payment<wbr/>Method<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>payout<wbr/>Address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> pub<wbr/>Key<wbr/>Ring<span class="tsd-signature-symbol">?: </span><a href="../modules/protobuf_pb_pb.PubKeyRing.html" class="tsd-signature-type" data-tsd-kind="Namespace">PubKeyRing</a><span class="tsd-signature-symbol">.</span><a href="protobuf_pb_pb.PubKeyRing.AsObject.html" class="tsd-signature-type" data-tsd-kind="Type alias">AsObject</a></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>reserve<wbr/>Tx<wbr/>Hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>reserve<wbr/>Tx<wbr/>Hex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>reserve<wbr/>Tx<wbr/>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> sender<wbr/>Node<wbr/>Address<span class="tsd-signature-symbol">?: </span><a href="../modules/protobuf_pb_pb.NodeAddress.html" class="tsd-signature-type" data-tsd-kind="Namespace">NodeAddress</a><span class="tsd-signature-symbol">.</span><a href="protobuf_pb_pb.NodeAddress.AsObject.html" class="tsd-signature-type" data-tsd-kind="Type alias">AsObject</a></h5></li>
|
||||
<h5>taker<wbr/>Account<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> taker<wbr/>Node<wbr/>Address<span class="tsd-signature-symbol">?: </span><a href="../modules/protobuf_pb_pb.NodeAddress.html" class="tsd-signature-type" data-tsd-kind="Namespace">NodeAddress</a><span class="tsd-signature-symbol">.</span><a href="protobuf_pb_pb.NodeAddress.AsObject.html" class="tsd-signature-type" data-tsd-kind="Type alias">AsObject</a></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>taker<wbr/>Payment<wbr/>Account<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> taker<wbr/>Pub<wbr/>Key<wbr/>Ring<span class="tsd-signature-symbol">?: </span><a href="../modules/protobuf_pb_pb.PubKeyRing.html" class="tsd-signature-type" data-tsd-kind="Namespace">PubKeyRing</a><span class="tsd-signature-symbol">.</span><a href="protobuf_pb_pb.PubKeyRing.AsObject.html" class="tsd-signature-type" data-tsd-kind="Type alias">AsObject</a></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>trade<wbr/>Amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>trade<wbr/>Price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>trade<wbr/>Protocol<wbr/>Version<span class="tsd-signature-symbol">: </span><a href="../enums/protobuf_pb_pb.TradeProtocolVersion.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TradeProtocolVersion</a></h5></li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>uid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/protobuf/pb_pb.d.ts:1094</li></ul></aside></div>
|
||||
<li>Defined in src/protobuf/pb_pb.d.ts:1093</li></ul></aside></div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<div class="tsd-navigation settings">
|
||||
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue