Skip to content

Commit

Permalink
DASH-628 Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
trukhilio committed May 12, 2023
1 parent 6acaa20 commit 4d75588
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,11 @@ This is the expected Private Key:
This is the expected Public Key:
"FIO5kJKNHwctcfUM5XZyiWSqSTM5HTzznJP9F3ZdbhaQAHEVq575o"

## Version 1.9.0
### Breaking changes:
- Set new parameter `authPermission` for sign and push transactions
- `pushTransaction` receives object params instead of multiple arguments

## Version 1.0.2
Bug Fix to method: addPublicAddresses - TechnologyProviderId (i.e. TPID), was not being set correctly for this method.

Expand Down
16 changes: 14 additions & 2 deletions documentation/classes/fiosdk.html
Original file line number Diff line number Diff line change
Expand Up @@ -937,13 +937,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<a name="pushtransaction" class="tsd-anchor"></a>
<h3>push<wbr>Transaction</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">push<wbr>Transaction<span class="tsd-signature-symbol">(</span>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, action<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">push<wbr>Transaction<span class="tsd-signature-symbol">({</span>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, action<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, authPermission<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string | undefined</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, encryptOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EncryptOptions</span><span class="tsd-signature-symbol">})</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/fioprotocol/fiosdk_typescript/blob/650dec4/src/FIOSDK.ts#L828">FIOSDK.ts:828</a></li>
<li>Defined in <a href="https://github.com/fioprotocol/fiosdk_typescript/blob/6acaa206ed8d0ccd402665088d142ef6b92f60fd/src/FIOSDK.ts#L1393">FIOSDK.ts:L1393</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -965,12 +965,24 @@ <h5>action: <span class="tsd-signature-type">string</span></h5>
<p>Name of action</p>
</div>
</li>
<li>
<h5>authPermission: <span class="tsd-signature-type">string | undefined</span></h5>
<div class="tsd-comment tsd-typography">
<p>Auth permision parameter</p>
</div>
</li>
<li>
<h5>data: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>JSON object with params for action</p>
</div>
</li>
<li>
<h5>encryptOptions: <span class="tsd-signature-type">EncryptOptions</span></h5>
<div class="tsd-comment tsd-typography">
<p>Parameters for encryption</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
Expand Down

0 comments on commit 4d75588

Please sign in to comment.