bitmessage-js/docs/module-bitmessage_objects.g...

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Namespace: getpubkey</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Namespace: getpubkey</h1>


<section>

<header>

        <h2>
            <span class="ancestors"><a href="module-bitmessage_objects.html">bitmessage/objects</a>.</span>

        getpubkey
        </h2>


</header>

<article>
    <div class="container-overview">


            <div class="description"><p><code>getpubkey</code> object. When a node has the hash of a public key (from an
address) but not the public key itself, it must send out a request
for the public key.</p></div>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line92">line 92</a>
    </li></ul></dd>


    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="https://bitmessage.org/wiki/Protocol_specification#getpubkey">https://bitmessage.org/wiki/Protocol_specification#getpubkey</a></li>
        </ul>
    </dd>


</dl>


    </div>


        <h3 class="subsection-title">Methods</h3>


    <h4 class="name" id=".decodeAsync"><span class="type-signature">(static) </span>decodeAsync<span class="signature">(buf, opts<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;DecodeResult>}</span></h4>


<div class="description">
    <p>Decode <code>getpubkey</code> object message.</p>
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th>Attributes</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>buf</code></td>


            <td class="type">


<span class="param-type">Buffer</span>


            </td>


                <td class="attributes">


                </td>


            <td class="description last"><p>Message</p></td>
        </tr>


        <tr>

                <td class="name"><code>opts</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


                <td class="attributes">

                    &lt;optional><br>


                </td>


            <td class="description last"><p>Any of <a href="module-bitmessage_structs.object.html#.decode">object.decode</a> options</p></td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line119">line 119</a>
    </li></ul></dd>


</dl>


<h5>Returns:</h5>


<div class="param-desc">
    <p>A promise that contains
<a href="module-bitmessage_objects.getpubkey.html#.DecodeResult">decoded <code>getpubkey</code> structure</a> when fulfilled.</p>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;DecodeResult></span>


    </dd>
</dl>


    <h4 class="name" id=".decodePayloadAsync"><span class="type-signature">(static) </span>decodePayloadAsync<span class="signature">()</span><span class="type-signature"></span></h4>


<div class="description">
    <p>Decode <code>getpubkey</code> object message payload.
The same as <a href="module-bitmessage_objects.getpubkey.html#.decodeAsync">decodeAsync</a>.</p>
</div>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line132">line 132</a>
    </li></ul></dd>


</dl>


    <h4 class="name" id=".encodeAsync"><span class="type-signature">(static) </span>encodeAsync<span class="signature">(opts)</span><span class="type-signature"> &rarr; {Promise.&lt;Buffer>}</span></h4>


<div class="description">
    <p>Encode <code>getpubkey</code> object message.</p>
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>opts</code></td>


            <td class="type">


<span class="param-type">Object</span>


            </td>


            <td class="description last"><p><code>getpubkey</code> object options</p>
                <h6>Properties</h6>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th>Attributes</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>ttl</code></td>


            <td class="type">


<span class="param-type">number</span>


            </td>


                <td class="attributes">


                </td>


            <td class="description last"><p>Time to live in seconds</p></td>
        </tr>


        <tr>

                <td class="name"><code>to</code></td>


            <td class="type">


<span class="param-type">Address</span>


            </td>


                <td class="attributes">


                </td>


            <td class="description last"><p>Receiver of the message</p></td>
        </tr>


        <tr>

                <td class="name"><code>skipPow</code></td>


            <td class="type">


<span class="param-type">boolean</span>


            </td>


                <td class="attributes">

                    &lt;optional><br>


                </td>


            <td class="description last"><p>Do not compute POW (false by
default)</p></td>
        </tr>


    </tbody>
</table>

            </td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line162">line 162</a>
    </li></ul></dd>


</dl>


<h5>Returns:</h5>


<div class="param-desc">
    <p>A promise that contains encoded message
when fulfilled.</p>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Promise.&lt;Buffer></span>


    </dd>
</dl>


    <h4 class="name" id=".encodePayloadAsync"><span class="type-signature">(static) </span>encodePayloadAsync<span class="signature">()</span><span class="type-signature"></span></h4>


<div class="description">
    <p>Encode <code>getpubkey</code> object message payload.
The same as
<a href="module-bitmessage_objects.getpubkey.html#.encodeAsync">encodeAsync</a>.</p>
</div>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line173">line 173</a>
    </li></ul></dd>


</dl>


        <h3 class="subsection-title">Type Definitions</h3>


<h4 class="name" id=".DecodeResult">DecodeResult</h4>


    <h5>Type:</h5>
    <ul>
        <li>

<span class="param-type">Object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>


<table class="props">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>nonce</code></td>


            <td class="type">


<span class="param-type">Buffer</span>


            </td>


            <td class="description last"><p>A 8-byte object nonce</p></td>
        </tr>


        <tr>

                <td class="name"><code>ttl</code></td>


            <td class="type">


<span class="param-type">number</span>


            </td>


            <td class="description last"><p>Time to live in seconds</p></td>
        </tr>


        <tr>

                <td class="name"><code>expires</code></td>


            <td class="type">


<span class="param-type">Date</span>


            </td>


            <td class="description last"><p>Object expiration date</p></td>
        </tr>


        <tr>

                <td class="name"><code>type</code></td>


            <td class="type">


<span class="param-type">number</span>


            </td>


            <td class="description last"><p>Object type</p></td>
        </tr>


        <tr>

                <td class="name"><code>version</code></td>


            <td class="type">


<span class="param-type">number</span>


            </td>


            <td class="description last"><p>Object version</p></td>
        </tr>


        <tr>

                <td class="name"><code>stream</code></td>


            <td class="type">


<span class="param-type">number</span>


            </td>


            <td class="description last"><p>Object stream</p></td>
        </tr>


        <tr>

                <td class="name"><code>headerLength</code></td>


            <td class="type">


<span class="param-type">number</span>


            </td>


            <td class="description last"><p>Length of the object header</p></td>
        </tr>


        <tr>

                <td class="name"><code>ripe</code></td>


            <td class="type">


<span class="param-type">Buffer</span>


            </td>


            <td class="description last"><p>The RIPEMD hash of the requested public
keys for address version &lt;= 3</p></td>
        </tr>


        <tr>

                <td class="name"><code>tag</code></td>


            <td class="type">


<span class="param-type">Buffer</span>


            </td>


            <td class="description last"><p>...or tag derived from the address object
for address version &gt;= 4</p></td>
        </tr>


        <tr>

                <td class="name"><code>length</code></td>


            <td class="type">


<span class="param-type">number</span>


            </td>


            <td class="description last"><p>Real data length</p></td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="objects.js.html">objects.js</a>, <a href="objects.js.html#line93">line 93</a>
    </li></ul></dd>


</dl>


</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bitmessage.html">bitmessage</a></li><li><a href="module-bitmessage_address.html">bitmessage/address</a></li><li><a href="module-bitmessage_crypto.html">bitmessage/crypto</a></li><li><a href="module-bitmessage_messages.html">bitmessage/messages</a></li><li><a href="module-bitmessage_objects.html">bitmessage/objects</a></li><li><a href="module-bitmessage_pow.html">bitmessage/pow</a></li><li><a href="module-bitmessage_structs.html">bitmessage/structs</a></li><li><a href="module-bitmessage_user-agent.html">bitmessage/user-agent</a></li><li><a href="module-bitmessage_wif.html">bitmessage/wif</a></li></ul><h3>Classes</h3><ul><li><a href="module-bitmessage_address.Address.html">Address</a></li><li><a href="module-bitmessage_structs.PubkeyBitfield.html">PubkeyBitfield</a></li><li><a href="module-bitmessage_structs.ServicesBitfield.html">ServicesBitfield</a></li></ul><h3>Namespaces</h3><ul><li><a href="module-bitmessage_messages.addr.html">addr</a></li><li><a href="module-bitmessage_messages.error.html">error</a></li><li><a href="module-bitmessage_messages.getdata.html">getdata</a></li><li><a href="module-bitmessage_messages.inv.html">inv</a></li><li><a href="module-bitmessage_messages.version.html">version</a></li><li><a href="module-bitmessage_objects.broadcast.html">broadcast</a></li><li><a href="module-bitmessage_objects.getpubkey.html">getpubkey</a></li><li><a href="module-bitmessage_objects.msg.html">msg</a></li><li><a href="module-bitmessage_objects.pubkey.html">pubkey</a></li><li><a href="module-bitmessage_structs.encrypted.html">encrypted</a></li><li><a href="module-bitmessage_structs.inv_vect.html">inv_vect</a></li><li><a href="module-bitmessage_structs.message.html">message</a></li><li><a href="module-bitmessage_structs.net_addr.html">net_addr</a></li><li><a href="module-bitmessage_structs.object.html">object</a></li><li><a href="module-bitmessage_structs.var_int.html">var_int</a></li><li><a href="module-bitmessage_structs.var_int_list.html">var_int_list</a></li><li><a href="module-bitmessage_structs.var_str.html">var_str</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Mon Mar 16 2015 22:32:51 GMT+0300 (MSK)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>