@mcchadwick/fiosdk
Version:
The Foundation for Interwallet Operability (FIO) is a consortium of leading blockchain wallets, exchanges and payments providers that seeks to accelerate blockchain adoption by reducing the risk, complexity, and inconvenience of sending and receiving cryp
780 lines (779 loc) • 127 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FIOSDK | @fioprotocol/fiosdk</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.js" 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">@fioprotocol/fiosdk</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-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a>
</li>
<li>
<a href="fiosdk.html">FIOSDK</a>
</li>
</ul>
<h1>Class FIOSDK</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>
<span class="target">FIOSDK</span>
</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="fiosdk.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="fiosdk.html#privatekey" class="tsd-kind-icon">private<wbr>Key</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="fiosdk.html#publickey" class="tsd-kind-icon">public<wbr>Key</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="fiosdk.html#technologyproviderid" class="tsd-kind-icon">technology<wbr>Provider<wbr>Id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="fiosdk.html#transactions" class="tsd-kind-icon">transactions</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="fiosdk.html#sufunit" class="tsd-kind-icon">SUFUnit</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#addpublicaddress" class="tsd-kind-icon">add<wbr>Public<wbr>Address</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#addpublicaddresses" class="tsd-kind-icon">add<wbr>Public<wbr>Addresses</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#getfee" class="tsd-kind-icon">get<wbr>Fee</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#getfeeforaddpublicaddress" class="tsd-kind-icon">get<wbr>Fee<wbr>For<wbr>Add<wbr>Public<wbr>Address</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#getfeefornewfundsrequest" class="tsd-kind-icon">get<wbr>Fee<wbr>For<wbr>New<wbr>Funds<wbr>Request</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#getfeeforrecordobtdata" class="tsd-kind-icon">get<wbr>Fee<wbr>For<wbr>Record<wbr>Obt<wbr>Data</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#getfeeforrejectfundsrequest" class="tsd-kind-icon">get<wbr>Fee<wbr>For<wbr>Reject<wbr>Funds<wbr>Request</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#getfiobalance" class="tsd-kind-icon">get<wbr>Fio<wbr>Balance</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#getfionames" class="tsd-kind-icon">get<wbr>Fio<wbr>Names</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#getfiopublicaddress" class="tsd-kind-icon">get<wbr>Fio<wbr>Public<wbr>Address</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#getfiopublickey" class="tsd-kind-icon">get<wbr>Fio<wbr>Public<wbr>Key</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#getobtdata" class="tsd-kind-icon">get<wbr>Obt<wbr>Data</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#getpendingfiorequests" class="tsd-kind-icon">get<wbr>Pending<wbr>Fio<wbr>Requests</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#getpublicaddress" class="tsd-kind-icon">get<wbr>Public<wbr>Address</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#getsentfiorequests" class="tsd-kind-icon">get<wbr>Sent<wbr>Fio<wbr>Requests</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#gettechnologyproviderid" class="tsd-kind-icon">get<wbr>Technology<wbr>Provider<wbr>Id</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#isavailable" class="tsd-kind-icon">is<wbr>Available</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#pushtransaction" class="tsd-kind-icon">push<wbr>Transaction</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#recordobtdata" class="tsd-kind-icon">record<wbr>Obt<wbr>Data</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#registerfioaddress" class="tsd-kind-icon">register<wbr>Fio<wbr>Address</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#registerfiodomain" class="tsd-kind-icon">register<wbr>Fio<wbr>Domain</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#registerownerfioaddress" class="tsd-kind-icon">register<wbr>Owner<wbr>Fio<wbr>Address</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#rejectfundsrequest" class="tsd-kind-icon">reject<wbr>Funds<wbr>Request</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#renewfioaddress" class="tsd-kind-icon">renew<wbr>Fio<wbr>Address</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#renewfiodomain" class="tsd-kind-icon">renew<wbr>Fio<wbr>Domain</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#requestfunds" class="tsd-kind-icon">request<wbr>Funds</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#setfiodomainvisibility" class="tsd-kind-icon">set<wbr>Fio<wbr>Domain<wbr>Visibility</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fiosdk.html#transfertokens" class="tsd-kind-icon">transfer<wbr>Tokens</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="fiosdk.html#suftoamount" class="tsd-kind-icon">SUFTo<wbr>Amount</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="fiosdk.html#amounttosuf" class="tsd-kind-icon">amount<wbr>ToSUF</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="fiosdk.html#createprivatekeymnemonic" class="tsd-kind-icon">create<wbr>Private<wbr>Key<wbr>Mnemonic</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="fiosdk.html#derivedpublickey" class="tsd-kind-icon">derived<wbr>Public<wbr>Key</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="fiosdk.html#ischaincodevalid" class="tsd-kind-icon">is<wbr>Chain<wbr>Code<wbr>Valid</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="fiosdk.html#isfioaddressvalid" class="tsd-kind-icon">is<wbr>Fio<wbr>Address<wbr>Valid</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="fiosdk.html#isfiodomainvalid" class="tsd-kind-icon">is<wbr>Fio<wbr>Domain<wbr>Valid</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="fiosdk.html#isfiopublickeyvalid" class="tsd-kind-icon">is<wbr>Fio<wbr>Public<wbr>Key<wbr>Valid</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="fiosdk.html#ispublicaddressvalid" class="tsd-kind-icon">is<wbr>Public<wbr>Address<wbr>Valid</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="fiosdk.html#istokencodevalid" class="tsd-kind-icon">is<wbr>Token<wbr>Code<wbr>Valid</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new FIOSDK<span class="tsd-signature-symbol">(</span>privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, baseUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, fetchjson<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FetchJson</span>, registerMockUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, technologyProviderId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="fiosdk.html" class="tsd-signature-type">FIOSDK</a></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/1f05b60/src/FIOSDK.ts#L247">FIOSDK.ts:247</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>// how to instantiate fetchJson parameter
i.e.
fetch = require('node-fetch')</p>
</div>
<p>const fetchJson = async (uri, opts = {}) => {
return fetch(uri, opts)
}</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>privateKey: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the fio private key of the client sending requests to FIO API.</p>
</div>
</div>
</li>
<li>
<h5>publicKey: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the fio public key of the client sending requests to FIO API.</p>
</div>
</div>
</li>
<li>
<h5>baseUrl: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the url to the FIO API.</p>
</div>
</div>
</li>
<li>
<h5>fetchjson: <span class="tsd-signature-type">FetchJson</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the module to use for HTTP Post/Get calls (see above for example)</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> registerMockUrl: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the url to the mock server</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> technologyProviderId: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Default FIO Address of the wallet which generates transactions.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="fiosdk.html" class="tsd-signature-type">FIOSDK</a></h4>
</li>
</ul>
</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-class">
<a name="privatekey" class="tsd-anchor"></a>
<h3>private<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">private<wbr>Key<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/fioprotocol/fiosdk_typescript/blob/1f05b60/src/FIOSDK.ts#L232">FIOSDK.ts:232</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the fio private key of the client sending requests to FIO API.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="publickey" class="tsd-anchor"></a>
<h3>public<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">public<wbr>Key<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/fioprotocol/fiosdk_typescript/blob/1f05b60/src/FIOSDK.ts#L237">FIOSDK.ts:237</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the fio public key of the client sending requests to FIO API.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="technologyproviderid" class="tsd-anchor"></a>
<h3>technology<wbr>Provider<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">technology<wbr>Provider<wbr>Id<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/fioprotocol/fiosdk_typescript/blob/1f05b60/src/FIOSDK.ts#L242">FIOSDK.ts:242</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Default FIO Address of the wallet which generates transactions.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="transactions" class="tsd-anchor"></a>
<h3>transactions</h3>
<div class="tsd-signature tsd-kind-icon">transactions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Transactions</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/fioprotocol/fiosdk_typescript/blob/1f05b60/src/FIOSDK.ts#L222">FIOSDK.ts:222</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
<a name="sufunit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> SUFUnit</h3>
<div class="tsd-signature tsd-kind-icon">SUFUnit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1000000000</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/fioprotocol/fiosdk_typescript/blob/1f05b60/src/FIOSDK.ts#L247">FIOSDK.ts:247</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>SUFs = Smallest Units of FIO</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="addpublicaddress" class="tsd-anchor"></a>
<h3>add<wbr>Public<wbr>Address</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">add<wbr>Public<wbr>Address<span class="tsd-signature-symbol">(</span>fioAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, chainCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tokenCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, publicAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, maxFee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, technologyProviderId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</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"><</span><span class="tsd-signature-type">AddPublicAddressResponse</span><span class="tsd-signature-symbol">></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/1f05b60/src/FIOSDK.ts#L421">FIOSDK.ts:421</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>This call allows a public address of the specific blockchain type to be added to the FIO Address.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fioAddress: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>FIO Address which will be mapped to public address.</p>
</div>
</li>
<li>
<h5>chainCode: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Blockchain code for blockchain hosting this token.</p>
</div>
</li>
<li>
<h5>tokenCode: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Token code to be used with that public address.</p>
</div>
</li>
<li>
<h5>publicAddress: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The public address to be added to the FIO Address for the specified token.</p>
</div>
</li>
<li>
<h5>maxFee: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by /get_fee for correct value.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> technologyProviderId: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></h5>
<div class="tsd-comment tsd-typography">
<p>FIO Address of the wallet which generates this transaction.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AddPublicAddressResponse</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="addpublicaddresses" class="tsd-anchor"></a>
<h3>add<wbr>Public<wbr>Addresses</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">add<wbr>Public<wbr>Addresses<span class="tsd-signature-symbol">(</span>fioAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, publicAddresses<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicAddress</span><span class="tsd-signature-symbol">[]</span>, maxFee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, technologyProviderId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</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"><</span><span class="tsd-signature-type">AddPublicAddressResponse</span><span class="tsd-signature-symbol">></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/1f05b60/src/FIOSDK.ts#L450">FIOSDK.ts:450</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>This call allows a public addresses of the specific blockchain type to be added to the FIO Address.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fioAddress: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>FIO Address which will be mapped to public addresses.</p>
</div>
</li>
<li>
<h5>publicAddresses: <span class="tsd-signature-type">PublicAddress</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>Array of public addresses to be added to the FIO Address for the specified token.</p>
</div>
</li>
<li>
<h5>maxFee: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Maximum amount of SUFs the user is willing to pay for fee. Should be preceded by /get_fee for correct value.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> technologyProviderId: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></h5>
<div class="tsd-comment tsd-typography">
<p>FIO Address of the wallet which generates this transaction.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AddPublicAddressResponse</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getfee" class="tsd-anchor"></a>
<h3>get<wbr>Fee</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Fee<span class="tsd-signature-symbol">(</span>endPoint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EndPoint</span>, fioAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</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"><</span><span class="tsd-signature-type">FioFeeResponse</span><span class="tsd-signature-symbol">></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/1f05b60/src/FIOSDK.ts#L760">FIOSDK.ts:760</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Compute and return fee amount for specific call and specific user</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>endPoint: <span class="tsd-signature-type">EndPoint</span></h5>
<div class="tsd-comment tsd-typography">
<p>Name of API call end point, e.g. add_pub_address.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> fioAddress: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
<div class="tsd-comment tsd-typography">
<pre><code> <span class="hljs-keyword">if</span> endPointName is RenewFioAddress, FIO<span class="hljs-built_in"> Address </span>incurring the fee <span class="hljs-keyword">and</span> owned by signer.
<span class="hljs-keyword">if</span> endPointName is RenewFioDomain, FIO Domain incurring the fee <span class="hljs-keyword">and</span> owned by signer.
<span class="hljs-keyword">if</span> endPointName is RecordObtData, Payer FIO<span class="hljs-built_in"> Address </span>incurring the fee <span class="hljs-keyword">and</span> owned by signer.
Omit <span class="hljs-keyword">for</span>:
- register_fio_domain
- register_fio_address
- transfer_tokens_pub_key</code></pre>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">FioFeeResponse</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getfeeforaddpublicaddress" class="tsd-anchor"></a>
<h3>get<wbr>Fee<wbr>For<wbr>Add<wbr>Public<wbr>Address</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Fee<wbr>For<wbr>Add<wbr>Public<wbr>Address<span class="tsd-signature-symbol">(</span>fioAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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"><</span><span class="tsd-signature-type">FioFeeResponse</span><span class="tsd-signature-symbol">></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/1f05b60/src/FIOSDK.ts#L797">FIOSDK.ts:797</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Compute and return fee amount for specific call and specific user</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fioAddress: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>FIO Address incurring the fee and owned by signer.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">FioFeeResponse</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getfeefornewfundsrequest" class="tsd-anchor"></a>
<h3>get<wbr>Fee<wbr>For<wbr>New<wbr>Funds<wbr>Request</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Fee<wbr>For<wbr>New<wbr>Funds<wbr>Request<span class="tsd-signature-symbol">(</span>payeeFioAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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"><</span><span class="tsd-signature-type">FioFeeResponse</span><span class="tsd-signature-symbol">></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/1f05b60/src/FIOSDK.ts#L779">FIOSDK.ts:779</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Compute and return fee amount for specific call and specific user</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>payeeFioAddress: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Payee FIO Address incurring the fee and owned by signer.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">FioFeeResponse</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getfeeforrecordobtdata" class="tsd-anchor"></a>
<h3>get<wbr>Fee<wbr>For<wbr>Record<wbr>Obt<wbr>Data</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Fee<wbr>For<wbr>Record<wbr>Obt<wbr>Data<span class="tsd-signature-symbol">(</span>payerFioAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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"><</span><span class="tsd-signature-type">FioFeeResponse</span><span class="tsd-signature-symbol">></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/1f05b60/src/FIOSDK.ts#L770">FIOSDK.ts:770</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Compute and return fee amount for specific call and specific user</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>payerFioAddress: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">FioFeeResponse</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getfeeforrejectfundsrequest" class="tsd-anchor"></a>
<h3>get<wbr>Fee<wbr>For<wbr>Reject<wbr>Funds<wbr>Request</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Fee<wbr>For<wbr>Reject<wbr>Funds<wbr>Request<span class="tsd-signature-symbol">(</span>payerFioAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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"><</span><span class="tsd-signature-type">FioFeeResponse</span><span class="tsd-signature-symbol">></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/1f05b60/src/FIOSDK.ts#L788">FIOSDK.ts:788</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Compute and return fee amount for specific call and specific user</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>payerFioAddress: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Payer FIO Address incurring the fee and owned by signer.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">FioFeeResponse</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getfiobalance" class="tsd-anchor"></a>
<h3>get<wbr>Fio<wbr>Balance</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Fio<wbr>Balance<span class="tsd-signature-symbol">(</span>fioPublicKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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"><</span><span class="tsd-signature-type">BalanceResponse</span><span class="tsd-signature-symbol">></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/1f05b60/src/FIOSDK.ts#L655">FIOSDK.ts:655</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves balance of FIO tokens</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> fioPublicKey: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>FIO public key.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BalanceResponse</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getfionames" class="tsd-anchor"></a>
<h3>get<wbr>Fio<wbr>Names</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Fio<wbr>Names<span class="tsd-signature-symbol">(</span>fioPublicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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"><</span><span class="tsd-signature-type">FioNamesResponse</span><span class="tsd-signature-symbol">></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/1f05b60/src/FIOSDK.ts#L665">FIOSDK.ts:665</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns FIO Addresses and FIO Domains owned by this public key.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fioPublicKey: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>FIO public key of owner.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">FioNamesResponse</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getfiopublicaddress" class="tsd-anchor"></a>
<h3>get<wbr>Fio<wbr>Public<wbr>Address</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Fio<wbr>Public<wbr>Address<span class="tsd-signature-symbol">(</span>fioAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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"><</span><span class="tsd-signature-type">PublicAddressResponse</span><span class="tsd-signature-symbol">></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/1f05b60/src/FIOSDK.ts#L717">FIOSDK.ts:717</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the FIO token public address for specified FIO Address.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fioAddress: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>FIO Address for which fio token public address is to be returned.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PublicAddressResponse</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getfiopublickey" class="tsd-anchor"></a>
<h3>get<wbr>Fio<wbr>Public<wbr>Key</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Fio<wbr>Public<wbr>Key<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/1f05b60/src/FIOSDK.ts#L296">FIOSDK.ts:296</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves the FIO public key assigned to the FIOSDK instance.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getobtdata" class="tsd-anchor"></a>
<h3>get<wbr>Obt<wbr>Data</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Obt<wbr>Data<span class="tsd-signature-symbol">(</span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, offset<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, tokenCode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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"><</span><span class="tsd-signature-type">GetObtDataResponse</span><span class="tsd-signature-symbol">></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/1f05b60/src/FIOSDK.ts#L562">FIOSDK.ts:562</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrives OBT metadata data stored using record send.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Number of request to return. If omitted, all requests will be returned.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> offset: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>First request from list to return. If omitted, 0 is assumed.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> tokenCode: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Code of the token to filter results</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GetObtDataResponse</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getpendingfiorequests" class="tsd-anchor"></a>
<h3>get<wbr>Pending<wbr>Fio<wbr>Requests</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Pending<wbr>Fio<wbr>Requests<span class="tsd-signature-symbol">(</span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, offset<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</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"><</span><span class="tsd-signature-type">PendingFioRequestsResponse</span><span class="tsd-signature-symbol">></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/1f05b60/src/FIOSDK.ts#L676">FIOSDK.ts:676</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Polls for any pending requests sent to public key associated with the FIO SDK instance.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Number of request to return. If omitted, all requests will be returned.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> offset: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>First request from list to return. If omitted, 0 is assumed.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PendingFioRequestsResponse</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getpublicaddress" class="tsd-anchor"></a>
<h3>get<wbr>Public<wbr>Address</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Public<wbr>Address<span class="tsd-signature-symbol">(</span>fioAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, chainCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tokenCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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"><</span><span class="tsd-signature-type">PublicAddressResponse</span><span class="tsd-signature-symbol">></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/1f05b60/src/FIOSDK.ts#L699">FIOSDK.ts:699</a></li>
</ul>
</aside>
<div class="tsd-comment t