Skip to content

Commit d972bbd

Browse files
committed
update docs to 1.19
1 parent abe8a4c commit d972bbd

File tree

4 files changed

+150
-133
lines changed

4 files changed

+150
-133
lines changed

ApiBeautifier.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ def adjust(level):
207207
# while len(parents) != level:
208208
# addObj('')
209209

210-
soup = BeautifulSoup(open('NisApi.src.html'))
210+
soup = BeautifulSoup(open('NisApi.src.html'), 'html.parser')
211211
for header in soup.findAll(['h1', 'h2', 'h3']):
212212
c = header.contents[0]
213213
header['id'] = prettyName(c)
@@ -222,7 +222,7 @@ def adjust(level):
222222

223223
e = soup.find(id='toc')
224224
e.clear()
225-
newtoc = BeautifulSoup(printToc(toc['root']))
225+
newtoc = BeautifulSoup(printToc(toc['root']), 'html.parser')
226226
if 'html' in newtoc:
227227
e.contents = newtoc.html.body.contents
228228
else:

ApiBeautifier3.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ def adjust(level):
207207
# while len(parents) != level:
208208
# addObj('')
209209

210-
soup = BeautifulSoup(open('NisApi.src.html'))
210+
soup = BeautifulSoup(open('NisApi.src.html'), 'html.parser')
211211
for header in soup.findAll(['h1', 'h2', 'h3']):
212212
c = header.contents[0]
213213
header['id'] = prettyName(c)
@@ -222,7 +222,7 @@ def adjust(level):
222222

223223
e = soup.find(id='toc')
224224
e.clear()
225-
newtoc = BeautifulSoup(printToc(toc['root']))
225+
newtoc = BeautifulSoup(printToc(toc['root']), 'html.parser')
226226
if 'html' in newtoc:
227227
e.contents = newtoc.html.body.contents
228228
else:

NisApi.src.html

Lines changed: 64 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
<p class=NemTitleText>NEM NIS API Documentation</p>
1717

18-
<p class=NemSubtitle>Version 1.18</p>
18+
<p class=NemSubtitle>Version 1.19</p>
1919

2020
<p class=NemSubtitle>
2121
<time>FILLED AUTOMATICALLY</time>
@@ -35,6 +35,10 @@
3535

3636
<hr/>
3737
<div>
38+
<h4>Changes since 1.18</h4>
39+
<ul>
40+
<li>Updated the fee table.</li>
41+
</ul>
3842
<h4>Changes since 1.17</h4>
3943
<ul>
4044
<li>Corrected the API paths for the namespace and mosaic requests in several places.</li>
@@ -1527,9 +1531,9 @@ <h4>Example of returned JSON object:</h4>
15271531
<resp>
15281532
{
15291533
"data": [{
1530-
"fqn": "makoto.metal.coins",
1531-
"owner": TD3RXTHBLK6J3UD2BH2PXSOFLPWZOTR34WCG4HXH",
1532-
"height": 13465
1534+
"fqn": "makoto.metal.coins",
1535+
"owner": TD3RXTHBLK6J3UD2BH2PXSOFLPWZOTR34WCG4HXH",
1536+
"height": 13465
15331537
}]
15341538
}
15351539
</resp>
@@ -2632,7 +2636,7 @@ <h4>Example of returned JSON <a href="#nodeCollection">NodeCollection</a> object
26322636
{
26332637
"name": "Alice",
26342638
"public-key": "a1aaca6c17a24252e674d155713cdf55996ad00175be4af02a20c67b59f9fe8a"
2635-
},
2639+
}
26362640
]
26372641
}
26382642
</resp>
@@ -2687,7 +2691,7 @@ <h4>Example of returned JSON <a href="#nodeCollection">NodeCollection</a> object
26872691
{
26882692
"name": "Alice",
26892693
"public-key": "a1aaca6c17a24252e674d155713cdf55996ad00175be4af02a20c67b59f9fe8a"
2690-
},
2694+
}
26912695
]
26922696
}
26932697
</resp>
@@ -4728,43 +4732,47 @@ <h2>Transaction fees</h2>
47284732
<p>The fee is the sum of the fee for transferring an amount of
47294733
XEM and the fee for appending a message to the transaction.</p>
47304734

4731-
<p>1) Fees for transferring XEM to another account:<br/>
4732-
a) If the amount transferred is less than 8 XEM then the
4733-
fee is 10 - amount XEM.<br/>
4734-
Example:<br/>
4735-
Transferring 6 XEM costs 4 XEM fee.<br/>
4736-
b) If the amount transferred is greater or equal 8 XEM
4737-
then the fee is<br/>
4738-
max(2, 99 * arctan(amount / 150000)) XEM.<br/>
4739-
Example:<br/>
4740-
Transferring 100000 XEM costs 58 XEM.</p>
4741-
4742-
<p>2) Fees for appending a message to a transaction:<br/>
4743-
Transferring 100000 XEM costs 58 XEM.</p>
4744-
4745-
<p>2) Fees for transferring a mosaic to another account:<br/>
4746-
For each mosaic that is transferred the fee is calculated the following way:<br>
4747-
a) given a mosaic with initial supply s, divisibility d and quantity q, the XEM equivalent is (round to the next smaller integer)<br/>
4748-
xemEquivalent = (8,999,999,999 * q) / (s * 10^d) <br/>
4749-
The fee is then calculated by applying 1) to xemEquivalent and in a final step adding 25% to it:<br>
4750-
fee = (apply 1) to xemEquivalent) * 1.25<br>
4751-
Example:<br/>
4752-
Suppose the transaction has an amount of 3,000,000 micro-xem and the mosaic in the attachment has an initial supply of 1,000,000,
4753-
a divisibility of 3 and a quantity of 5,000. This means that a quantity of 15,000 will be transferred.
4754-
Applying the above formula gives<br>
4755-
xemEquivalent = (8,999,999,999 * 15,000) / (1,000,000 * 1000) = 134999<br>
4756-
The result was rounded to the next smaller integer. Applying 1) to xemEquivalent gives (again after rounding) 72.<br>
4757-
So the fee is 72 * 1.25 XEM = 90 XEM.</p>
4758-
4759-
<p>3) Fees for appending a message to a transaction:<br/>
4760-
If no message or an empty message is append it costs
4761-
0 XEM. Else the fee is calculated as<br/>
4762-
2 * max(1, message length / 16)<br/>
4763-
Example:<br/>
4764-
The unencrypted message &bdquo;The New Economy
4765-
Movement will change the world!!!&ldquo; has a length 49
4766-
characters and thus will cost 2 * 49/16 = 6 XEM.</p>
4767-
</td>
4735+
<ol>
4736+
<li>Fees for transferring XEM to another account:<br>
4737+
1 xem per 10,000 xem transferred, capped at 25 xem<br>
4738+
Example:<br>
4739+
4 xem fee for a 45,000 xem transfer, 25 xem fee for a 500,000 xem transfer.</li>
4740+
4741+
<li>Fees for appending a message to a transaction:<br>
4742+
1 xem per commenced 32 message bytes (messageLength / 32 + 1).<br>
4743+
Example:<br>
4744+
The unencrypted message „The New Economy
4745+
Movement will change the world!!!” has a length 49
4746+
characters and thus will cost 2 xem fee.</li>
4747+
4748+
<li>Fees for transferring a mosaic to another account:
4749+
<ol>
4750+
<li>mosaics with divisibility of 0 and a maximum supply of 10,000 are called small business mosaics.<br>
4751+
1 xem fee for any transfer of a small business mosaic.</li>
4752+
<li> For each mosaic that is transferred the fee is calculated the following way:
4753+
given a mosaic with initial supply s, divisibility d and quantity q, the XEM equivalent is (round to the next smaller integer)<br>
4754+
xemEquivalent = (8,999,999,999 * q) / (s * 10^d) <br>
4755+
To take into account the total quantities for different mosaics, an adjustment term is calculated.<br>
4756+
For a mosaic called m calculate<br>
4757+
maxMosaicQuantity = 9,000,000,000,000,000<br>
4758+
totalMosaicQuantity = mosaic m supply * 10 ^ (mosaic m divisibility)<br>
4759+
supplyRelatedAdjustment = floor(0.8 * ln(maxMosaicQuantity / totalMosaicQuantity)<br>
4760+
Then the fee is calculated as<br>
4761+
fee = max(1L, xemFee - supplyRelatedAdjustment)<br>
4762+
Example:<br>
4763+
Suppose you have a mosaic with 9,000,000 supply and divisibility of 3.<br>
4764+
totalMosaicQuantity = 9,000,000 * 1,000 = 9,000,000,000<br>
4765+
supplyRelatedAdjustment = floor(0.8 * ln(9,000,000,000,000,000 / 9,000,000,000)) = floor(11.052) = 11<br>
4766+
Transferring 150 such mosaics (i.e. a quantity of 150,000 smallest units) has<br>
4767+
xemEquivalent = (8,999,999,999 * 150,000) / (9,000,000 * 10^3) = 149,999<br>
4768+
xemFee = 14 xem<br>
4769+
So the transction will have the following fee:<br>
4770+
fee = 14 xem - 11 xem = 3 xem
4771+
</li>
4772+
</ol>
4773+
</li>
4774+
</ol>
4775+
</td>
47684776
</tr>
47694777
<tr>
47704778
<td>
@@ -4779,12 +4787,12 @@ <h2>Transaction fees</h2>
47794787
<p class=JSON>Aggregate modification transaction</p>
47804788
</td>
47814789
<td>
4782-
<p>10 + 6 * number of modifications + 6 (if a min cosignatory change is involved)<br/>
4783-
Example:<br/>
4784-
Adding 3 cosignatories to an account without changing the min cosignatories will cost<br/>
4785-
10 + 6 * 3 = 28 XEM.<br/>
4786-
Adding 3 cosignatories to an account and changing the min cosignatories will cost<br/>
4787-
10 + 6 * 3 + 6 = 34 XEM.<br/>
4790+
<p>10 + 6 * number of modifications + 6 (if a min cosignatory change is involved)<br>
4791+
Example:<br>
4792+
Adding 3 cosignatories to an account without changing the min cosignatories will cost<br>
4793+
10 + 6 * 3 = 28 XEM.<br>
4794+
Adding 3 cosignatories to an account and changing the min cosignatories will cost<br>
4795+
10 + 6 * 3 + 6 = 34 XEM.<br>
47884796
</p>
47894797
</td>
47904798
</tr>
@@ -4809,23 +4817,23 @@ <h2>Transaction fees</h2>
48094817
<p class=JSON>Provision namespace transaction</p>
48104818
</td>
48114819
<td>
4812-
<p>108 XEM</p>
4820+
<p>20 XEM</p>
48134821
</td>
48144822
</tr>
48154823
<tr>
48164824
<td>
48174825
<p class=JSON>Mosaic definition creation transaction</p>
48184826
</td>
48194827
<td>
4820-
<p>108 XEM</p>
4828+
<p>20 XEM</p>
48214829
</td>
48224830
</tr>
48234831
<tr>
48244832
<td>
48254833
<p class=JSON>Mosaic supply change transaction</p>
48264834
</td>
48274835
<td>
4828-
<p>108 XEM</p>
4836+
<p>20 XEM</p>
48294837
</td>
48304838
</tr>
48314839
</table>
@@ -5415,10 +5423,10 @@ <h4>JSON structure by example:</h4>
54155423
<h2>BlockHeight</h2>
54165424

54175425
<desc>
5418-
<p class=NemNoSpacing>The block height describes the position
5419-
of the block within the block chain. The first block of the chain has height
5420-
one. Each subsequent block has a height which is one higher than the previous
5421-
block.</p>
5426+
<p class=NemNoSpacing>The block height describes the position
5427+
of the block within the block chain. The first block of the chain has height
5428+
one. Each subsequent block has a height which is one higher than the previous
5429+
block.</p>
54225430
</desc>
54235431

54245432
<h4>JSON structure by example:</h4>

0 commit comments

Comments
 (0)