forked from Lilly-Protocol/lily-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.MoneyAmount.html
More file actions
104 lines (103 loc) · 15.2 KB
/
Copy pathindex.MoneyAmount.html
File metadata and controls
104 lines (103 loc) · 15.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MoneyAmount | @lily-protocol/sdk</title><meta name="description" content="Documentation for @lily-protocol/sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@lily-protocol/sdk</a>
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
<ul role="listbox" id="tsd-search-results"></ul>
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
<div class="container container-main">
<div class="col-content">
<div class="tsd-page-title">
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
<li><a href="../modules/index.html">index</a></li>
<li><a href="" aria-current="page">MoneyAmount</a></li></ul>
<h1>Interface MoneyAmount</h1></div>
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography"><p>Represents a monetary amount and currency/asset identifier within Lily Protocol
and the underlying Stellar network.</p>
<p>All amounts must be formatted as base-10 decimal strings (e.g. <code>'10.50'</code>) rather than
JavaScript numbers to prevent floating-point precision loss and truncation errors.</p>
<h3 id="stellar-asset-semantics" class="tsd-anchor-link">Stellar Asset Semantics:<a href="#stellar-asset-semantics" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
<ul>
<li><strong>Native Asset (<code>XLM</code>):</strong> Omit <code>assetIssuer</code> (or set to <code>undefined</code>). Native Stellar Lumens
have no issuing account.</li>
<li><strong>Issued Assets (e.g. <code>USDC</code>, <code>EURC</code>):</strong> Specify <code>assetCode</code> (1-12 alphanumeric chars) and
<code>assetIssuer</code> (56-character Stellar public key / G-address).</li>
<li><strong>Precision:</strong> Stellar supports up to 7 decimal places (1 stroop = <code>0.0000001</code>).</li>
</ul>
</div>
<div class="tsd-comment tsd-typography">
<div class="tsd-tag-example">
<h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">// Native Stellar Lumens</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">nativeAmount</span><span class="hl-2">: </span><span class="hl-9">MoneyAmount</span><span class="hl-2"> = {</span><br/><span class="hl-2"> </span><span class="hl-3">assetCode:</span><span class="hl-2"> </span><span class="hl-4">'XLM'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-3">amount:</span><span class="hl-2"> </span><span class="hl-4">'25.5000000'</span><span class="hl-2">,</span><br/><span class="hl-2">};</span><br/><br/><span class="hl-0">// Issued asset with issuer public key</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">usdcAmount</span><span class="hl-2">: </span><span class="hl-9">MoneyAmount</span><span class="hl-2"> = {</span><br/><span class="hl-2"> </span><span class="hl-3">assetCode:</span><span class="hl-2"> </span><span class="hl-4">'USDC'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-3">assetIssuer:</span><span class="hl-2"> </span><span class="hl-4">'GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-3">amount:</span><span class="hl-2"> </span><span class="hl-4">'100.00'</span><span class="hl-2">,</span><br/><span class="hl-2">};</span>
</code><button type="button">Copy</button></pre>
</div></div></section>
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">MoneyAmount</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#amount">amount</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#assetcode">assetCode</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#assetissuer">assetIssuer</a><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><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Lilly-Protocol/lily-sdk/blob/684beb03593f5c1117b12b58cc8cec5b55cf495e/src/models/common.ts#L41">src/models/common.ts:41</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
<div class="tsd-accordion-details">
<section class="tsd-index-section">
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
<div class="tsd-index-list"><a href="#amount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a>
<a href="#assetcode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset<wbr/>Code</span></a>
<a href="#assetissuer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset<wbr/>Issuer?</span></a>
</div></section></div></details></section></section>
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
<section>
<section class="tsd-panel tsd-member">
<h3 class="tsd-anchor-link" id="amount"><span>amount</span><a href="#amount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">amount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>The monetary quantity formatted strictly as a base-10 decimal string (e.g., <code>'10.50'</code>, <code>'0.0000001'</code>).</p>
<p>Floating-point numbers (<code>number</code>) and exponential notation (e.g., <code>'1e-5'</code>) are prohibited
to avoid floating-point rounding/truncation bugs. Precision should match the asset's scale,
up to Stellar's maximum 7 decimal places (1 stroop = 0.0000001).</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Lilly-Protocol/lily-sdk/blob/684beb03593f5c1117b12b58cc8cec5b55cf495e/src/models/common.ts#L66">src/models/common.ts:66</a></li></ul></aside></section>
<section class="tsd-panel tsd-member">
<h3 class="tsd-anchor-link" id="assetcode"><span>asset<wbr/>Code</span><a href="#assetcode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">assetCode</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>The asset code representing the currency or token.</p>
<p>For the native network asset, use <code>'XLM'</code>. For credit/issued assets, use a 1-to-12 character
alphanumeric code (Alpha4: 1-4 chars like <code>'USDC'</code>; Alpha12: 5-12 chars).</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Lilly-Protocol/lily-sdk/blob/684beb03593f5c1117b12b58cc8cec5b55cf495e/src/models/common.ts#L48">src/models/common.ts:48</a></li></ul></aside></section>
<section class="tsd-panel tsd-member">
<h3 class="tsd-anchor-link" id="assetissuer"><code class="tsd-tag">Optional</code><span>asset<wbr/>Issuer</span><a href="#assetissuer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">assetIssuer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>The 56-character Stellar public key (G-address) of the issuing account.</p>
<ul>
<li><strong>Native asset (<code>XLM</code>):</strong> Must be omitted or <code>undefined</code>.</li>
<li><strong>Issued assets:</strong> Required to uniquely identify the asset on Stellar (alongside <code>assetCode</code>),
linking to the issuer's account and home domain SEP-1 metadata.</li>
</ul>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Lilly-Protocol/lily-sdk/blob/684beb03593f5c1117b12b58cc8cec5b55cf495e/src/models/common.ts#L57">src/models/common.ts:57</a></li></ul></aside></section></section></details></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
<h3>Settings</h3></summary>
<div class="tsd-accordion-details">
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
<ul id="tsd-filter-options">
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
<h3>On This Page</h3></summary>
<div class="tsd-accordion-details"><a href="#stellar-asset-semantics"><span>Stellar <wbr/>Asset <wbr/>Semantics:</span></a>
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
<div><a href="#amount"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>amount</span></a><a href="#assetcode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset<wbr/>Code</span></a><a href="#assetissuer"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>asset<wbr/>Issuer</span></a></div></details></div></details></div>
<div class="site-menu">
<nav class="tsd-navigation"><a href="../modules.html">@lily-protocol/sdk</a>
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
<li>Loading...</li></ul></nav></div></div></div><footer>
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
<div class="overlay"></div></body></html>