mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-08 06:45:49 +00:00
327 lines
17 KiB
HTML
327 lines
17 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>OfferCreateTransaction | ripple-lib</title>
|
|
<meta name="description" content="Documentation for ripple-lib">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="../index.html" class="title">ripple-lib</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../modules.html">ripple-lib</a>
|
|
</li>
|
|
<li>
|
|
<a href="OfferCreateTransaction.html">OfferCreateTransaction</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Interface OfferCreateTransaction</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<a href="TransactionJSON.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionJSON</a>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">OfferCreateTransaction</span>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OfferCreateTransaction.html#Account" class="tsd-kind-icon">Account</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateTransaction.html#Expiration" class="tsd-kind-icon">Expiration</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateTransaction.html#Fee" class="tsd-kind-icon">Fee</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OfferCreateTransaction.html#Flags" class="tsd-kind-icon">Flags</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OfferCreateTransaction.html#Fulfillment" class="tsd-kind-icon">Fulfillment</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateTransaction.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OfferCreateTransaction.html#Memos" class="tsd-kind-icon">Memos</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateTransaction.html#OfferSequence" class="tsd-kind-icon">Offer<wbr>Sequence</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateTransaction.html#Sequence" class="tsd-kind-icon">Sequence</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateTransaction.html#TakerGets" class="tsd-kind-icon">Taker<wbr>Gets</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateTransaction.html#TakerPays" class="tsd-kind-icon">Taker<wbr>Pays</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OfferCreateTransaction.html#TransactionType" class="tsd-kind-icon">Transaction<wbr>Type</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
|
<a name="Account" class="tsd-anchor"></a>
|
|
<h3>Account</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Overrides <a href="TransactionJSON.html">TransactionJSON</a>.<a href="TransactionJSON.html#Account">Account</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L53">src/transaction/types.ts:53</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="Expiration" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Expiration</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Expiration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L60">src/transaction/types.ts:60</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="Fee" class="tsd-anchor"></a>
|
|
<h3>Fee</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L54">src/transaction/types.ts:54</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
|
<a name="Flags" class="tsd-anchor"></a>
|
|
<h3>Flags</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Overrides <a href="TransactionJSON.html">TransactionJSON</a>.<a href="TransactionJSON.html#Flags">Flags</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L55">src/transaction/types.ts:55</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="Fulfillment" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Fulfillment</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Fulfillment<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="TransactionJSON.html">TransactionJSON</a>.<a href="TransactionJSON.html#Fulfillment">Fulfillment</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L17">src/transaction/types.ts:17</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="LastLedgerSequence" class="tsd-anchor"></a>
|
|
<h3>Last<wbr>Ledger<wbr>Sequence</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L56">src/transaction/types.ts:56</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
|
<a name="Memos" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Memos</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Memos<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>Memo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ApiMemo</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Overrides <a href="TransactionJSON.html">TransactionJSON</a>.<a href="TransactionJSON.html#Memos">Memos</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L62">src/transaction/types.ts:62</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="OfferSequence" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Offer<wbr>Sequence</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Offer<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L61">src/transaction/types.ts:61</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="Sequence" class="tsd-anchor"></a>
|
|
<h3>Sequence</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L57">src/transaction/types.ts:57</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="TakerGets" class="tsd-anchor"></a>
|
|
<h3>Taker<wbr>Gets</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Taker<wbr>Gets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RippledAmount</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L58">src/transaction/types.ts:58</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="TakerPays" class="tsd-anchor"></a>
|
|
<h3>Taker<wbr>Pays</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Taker<wbr>Pays<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RippledAmount</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L59">src/transaction/types.ts:59</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
|
<a name="TransactionType" class="tsd-anchor"></a>
|
|
<h3>Transaction<wbr>Type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Transaction<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"OfferCreate"</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Overrides <a href="TransactionJSON.html">TransactionJSON</a>.<a href="TransactionJSON.html#TransactionType">TransactionType</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L52">src/transaction/types.ts:52</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="../modules.html">Exports</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-interface">
|
|
<a href="OfferCreateTransaction.html" class="tsd-kind-icon">Offer<wbr>Create<wbr>Transaction</a>
|
|
<ul>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
|
<a href="OfferCreateTransaction.html#Account" class="tsd-kind-icon">Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="OfferCreateTransaction.html#Expiration" class="tsd-kind-icon">Expiration</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="OfferCreateTransaction.html#Fee" class="tsd-kind-icon">Fee</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
|
<a href="OfferCreateTransaction.html#Flags" class="tsd-kind-icon">Flags</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="OfferCreateTransaction.html#Fulfillment" class="tsd-kind-icon">Fulfillment</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="OfferCreateTransaction.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
|
<a href="OfferCreateTransaction.html#Memos" class="tsd-kind-icon">Memos</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="OfferCreateTransaction.html#OfferSequence" class="tsd-kind-icon">Offer<wbr>Sequence</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="OfferCreateTransaction.html#Sequence" class="tsd-kind-icon">Sequence</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="OfferCreateTransaction.html#TakerGets" class="tsd-kind-icon">Taker<wbr>Gets</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="OfferCreateTransaction.html#TakerPays" class="tsd-kind-icon">Taker<wbr>Pays</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
|
<a href="OfferCreateTransaction.html#TransactionType" class="tsd-kind-icon">Transaction<wbr>Type</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |