rlp.html

---
layout: page
title: RLP
icon: fa-random
order: 8
---

<section class="row-fluid">
    <div class="">
        <div class="row-fluid">
            <div class="span8 content class">

                <h1>RLP</h1>
                <p><em>It&#039;s a instance for ethereum recursive length encoding.</em></p>
                <p>RLP encode:</p>
<pre><code class="language-php">use Web3p\RLP\RLP;

$rlp = new RLP;
// c483646f67
$encoded = $rlp-&gt;encode(['dog']);

// 83646f67
$encoded = $rlp-&gt;encode('dog');</code></pre>
<p>RLP decode:</p>
<pre><code class="language-php">use Web3p\RLP\RLP;
use Web3p\RLP\Types\Str;

$rlp = new RLP;
$encoded = $rlp-&gt;encode(['dog']);

// only accept 0x prefixed hex string
$decoded = $rlp-&gt;decode('0x' . $encoded);

// show 646f67
echo $decoded[0];

// show dog
echo hex2bin($decoded[0]);

// or you can
echo Str::decodeHex($decoded[0]);</code></pre>
                
                                    
                <section id="summary">
                    <h2>Summary</h2>
                    <section class="row-fluid heading">
                        <section class="span4">
                            <a href="#methods">Methods</a>
                        </section>
                        <section class="span4">
                            <a href="#properties">Properties</a>
                        </section>
                        <section class="span4">
                            <a href="#constants">Constants</a>
                        </section>
                    </section>
                    <section class="row-fluid public">
                        <section class="span4">
                                                                <a href="/rlp.html#method_encode" class="">encode()</a><br />
                                                                <a href="/rlp.html#method_decode" class="">decode()</a><br />
                                                        </section>
                        <section class="span4">
                                                                <em>No public properties found</em>
                                                        </section>
                        <section class="span4">
                                                                <em>No constants found</em>
                                                        </section>
                    </section>
                    <section class="row-fluid protected">
                        <section class="span4">
                                                                <a href="/rlp.html#method_decodeData" class="">decodeData()</a><br />
                                                                <a href="/rlp.html#method_encodeLength" class="">encodeLength()</a><br />
                                                                <a href="/rlp.html#method_intToHex" class="">intToHex()</a><br />
                                                                <a href="/rlp.html#method_padToEven" class="">padToEven()</a><br />
                                                                <a href="/rlp.html#method_encodeInput" class="">encodeInput()</a><br />
                                                        </section>
                        <section class="span4">
                                                                <em>No protected properties found</em>
                                                        </section>
                        <section class="span4">
                            <em>N/A</em>
                        </section>
                    </section>
                    <section class="row-fluid private">
                        <section class="span4">
                                                                <em>No private methods found</em>
                                                        </section>
                        <section class="span4">
                                                                <em>No private properties found</em>
                                                        </section>
                        <section class="span4">
                            <em>N/A</em>
                        </section>
                    </section>
                </section>
            </div>
            <aside class="span4 detailsbar">
                                    
                
                <dl>
                    <dt>File</dt>
                        <dd><a href="rlp.html"><div class="path-wrapper">RLP.php</div></a></dd>
                                            <dt>Package</dt>
                        <dd><div class="namespace-wrapper">Default</div></dd>
                                            <dt>Class hierarchy</dt>
                        <dd class="hierarchy">
                                                                                                                                                                <div class="namespace-wrapper">\Web3p\RLP\RLP</div>
                        </dd>

                    
                    
                    
                                                                        <dt>See also</dt>
                                                                                    <dd><a href="https://www.web3p.xyz"><span class="namespace-wrapper">https://www.web3p.xyz</span></a></dd>
                                                                        
                                                                    </dl>
                <h2>Tags</h2>
                <table class="table table-condensed">
                                        <tr>
                        <th>
                            author
                        </th>
                        <td>
                                                                                                    <p>Peter Lai <a href="mailto:alk03073135@gmail.com">alk03073135@gmail.com</a></p>
                                                        </td>
                    </tr>
                                        <tr>
                        <th>
                            filesource
                        </th>
                        <td>
                                                                                                    <p><a href="https://github.com/web3p/rlp">https://github.com/web3p/rlp</a></p>
                                                        </td>
                    </tr>
                                    </table>
            </aside>
        </div>

                    
                    
                                <a id="methods" name="methods"></a>
        <div class="row-fluid">
            <div class="span8 content class"><h2>Methods</h2></div>
            <aside class="span4 detailsbar"></aside>
        </div>

                                <div class="row-fluid">
    <div class="span8 content class">
        <a id="method_encode" name="method_encode" class="anchor"></a>
        <article class="method">
            <h3 class="public ">encode()</h3>
            
            <pre class="signature" style="margin-right: 54px;">encode(array  <span class="argument">$inputs</span>) : string</pre>
            <p><em>Return RLP encoded of the given inputs.</em></p>
            

                                <h4>Parameters</h4>
                <table class="table table-condensed table-hover">
                                                <tr>
                            <td>array</td>
                            <td>$inputs </td>
                            <td><p>array of data you want to RLP encode</p></td>
                        </tr>
                                        </table>
            
            
                                <h4>Returns</h4>
                string
                                        &mdash; <p>RLP encoded hex string of inputs</p>
                                
                        </article>
    </div>
    <aside class="span4 detailsbar">
        <h1><i class="icon-arrow-down"></i></h1>
                                                        <dl>
                                                <dt>Inherited from</dt>
                <dd><a href="/rlp.html"><div class="path-wrapper">\Web3p\RLP\RLP</div></a></dd>
                                                        </dl>
        <h2>Tags</h2>
        <table class="table table-condensed">
                                <tr><td colspan="2"><em>None found</em></td></tr>
                        </table>
    </aside>
</div>

                                <div class="row-fluid">
    <div class="span8 content class">
        <a id="method_decode" name="method_decode" class="anchor"></a>
        <article class="method">
            <h3 class="public ">decode()</h3>
            
            <pre class="signature" style="margin-right: 54px;">decode(string  <span class="argument">$input</span>) : array</pre>
            <p><em>Return RLP decoded of the given hex encoded data.</em></p>
            

                                <h4>Parameters</h4>
                <table class="table table-condensed table-hover">
                                                <tr>
                            <td>string</td>
                            <td>$input </td>
                            <td><p>hex encoded data</p></td>
                        </tr>
                                        </table>
            
            
                                <h4>Returns</h4>
                array
                                        &mdash; <p>decoded data</p>
                                
                        </article>
    </div>
    <aside class="span4 detailsbar">
        <h1><i class="icon-arrow-down"></i></h1>
                                                        <dl>
                                                <dt>Inherited from</dt>
                <dd><a href="/rlp.html"><div class="path-wrapper">\Web3p\RLP\RLP</div></a></dd>
                                                        </dl>
        <h2>Tags</h2>
        <table class="table table-condensed">
                                <tr><td colspan="2"><em>None found</em></td></tr>
                        </table>
    </aside>
</div>

                                                <div class="row-fluid">
    <div class="span8 content class">
        <a id="method_decodeData" name="method_decodeData" class="anchor"></a>
        <article class="method">
            <h3 class="protected ">decodeData()</h3>
            
            <pre class="signature" style="margin-right: 54px;">decodeData(string  <span class="argument">$input</span>) : array</pre>
            <p><em>Main function of RLP decode.</em></p>
            

                                <h4>Parameters</h4>
                <table class="table table-condensed table-hover">
                                                <tr>
                            <td>string</td>
                            <td>$input </td>
                            <td><p>hex encoded data</p></td>
                        </tr>
                                        </table>
            
            
                                <h4>Returns</h4>
                array
                                        &mdash; <p>decoded data</p>
                                
                        </article>
    </div>
    <aside class="span4 detailsbar">
        <h1><i class="icon-arrow-down"></i></h1>
                                                        <dl>
                                                <dt>Inherited from</dt>
                <dd><a href="/rlp.html"><div class="path-wrapper">\Web3p\RLP\RLP</div></a></dd>
                                                        </dl>
        <h2>Tags</h2>
        <table class="table table-condensed">
                                <tr><td colspan="2"><em>None found</em></td></tr>
                        </table>
    </aside>
</div>

                                <div class="row-fluid">
    <div class="span8 content class">
        <a id="method_encodeLength" name="method_encodeLength" class="anchor"></a>
        <article class="method">
            <h3 class="protected ">encodeLength()</h3>
            
            <pre class="signature" style="margin-right: 54px;">encodeLength(integer  <span class="argument">$length</span>, integer  <span class="argument">$offset</span>) : string</pre>
            <p><em>Return RLP encoded the length of data.</em></p>
            

                                <h4>Parameters</h4>
                <table class="table table-condensed table-hover">
                                                <tr>
                            <td>integer</td>
                            <td>$length </td>
                            <td><p>length of data</p></td>
                        </tr>
                                                <tr>
                            <td>integer</td>
                            <td>$offset </td>
                            <td><p>offset of data</p></td>
                        </tr>
                                        </table>
            
            
                                <h4>Returns</h4>
                string
                                        &mdash; <p>hex encoded of the length</p>
                                
                        </article>
    </div>
    <aside class="span4 detailsbar">
        <h1><i class="icon-arrow-down"></i></h1>
                                                        <dl>
                                                <dt>Inherited from</dt>
                <dd><a href="/rlp.html"><div class="path-wrapper">\Web3p\RLP\RLP</div></a></dd>
                                                        </dl>
        <h2>Tags</h2>
        <table class="table table-condensed">
                                <tr><td colspan="2"><em>None found</em></td></tr>
                        </table>
    </aside>
</div>

                                <div class="row-fluid">
    <div class="span8 content class">
        <a id="method_intToHex" name="method_intToHex" class="anchor"></a>
        <article class="method">
            <h3 class="protected ">intToHex()</h3>
            
            <pre class="signature" style="margin-right: 54px;">intToHex(integer  <span class="argument">$input</span>) : string</pre>
            <p><em>Return hex of the given integer.</em></p>
            

                                <h4>Parameters</h4>
                <table class="table table-condensed table-hover">
                                                <tr>
                            <td>integer</td>
                            <td>$input </td>
                            <td><p>integer</p></td>
                        </tr>
                                        </table>
            
            
                                <h4>Returns</h4>
                string
                                        &mdash; <p>hex encoded of the input</p>
                                
                        </article>
    </div>
    <aside class="span4 detailsbar">
        <h1><i class="icon-arrow-down"></i></h1>
                                                        <dl>
                                                <dt>Inherited from</dt>
                <dd><a href="/rlp.html"><div class="path-wrapper">\Web3p\RLP\RLP</div></a></dd>
                                                        </dl>
        <h2>Tags</h2>
        <table class="table table-condensed">
                                <tr><td colspan="2"><em>None found</em></td></tr>
                        </table>
    </aside>
</div>

                                <div class="row-fluid">
    <div class="span8 content class">
        <a id="method_padToEven" name="method_padToEven" class="anchor"></a>
        <article class="method">
            <h3 class="protected ">padToEven()</h3>
            
            <pre class="signature" style="margin-right: 54px;">padToEven(string  <span class="argument">$input</span>) : string</pre>
            <p><em>Pad hex encoded data to even length (add 0).</em></p>
            

                                <h4>Parameters</h4>
                <table class="table table-condensed table-hover">
                                                <tr>
                            <td>string</td>
                            <td>$input </td>
                            <td><p>hex encoded string</p></td>
                        </tr>
                                        </table>
            
            
                                <h4>Returns</h4>
                string
                                        &mdash; <p>hex encoded string</p>
                                
                        </article>
    </div>
    <aside class="span4 detailsbar">
        <h1><i class="icon-arrow-down"></i></h1>
                                                        <dl>
                                                <dt>Inherited from</dt>
                <dd><a href="/rlp.html"><div class="path-wrapper">\Web3p\RLP\RLP</div></a></dd>
                                                        </dl>
        <h2>Tags</h2>
        <table class="table table-condensed">
                                <tr><td colspan="2"><em>None found</em></td></tr>
                        </table>
    </aside>
</div>

                                <div class="row-fluid">
    <div class="span8 content class">
        <a id="method_encodeInput" name="method_encodeInput" class="anchor"></a>
        <article class="method">
            <h3 class="protected ">encodeInput()</h3>
            
            <pre class="signature" style="margin-right: 54px;">encodeInput(mixed  <span class="argument">$input</span>) : string</pre>
            <p><em>Main encode function to transform data to hex encoded string.</em></p>
            

                                <h4>Parameters</h4>
                <table class="table table-condensed table-hover">
                                                <tr>
                            <td>mixed</td>
                            <td>$input </td>
                            <td><p>data</p></td>
                        </tr>
                                        </table>
            
            
                                <h4>Returns</h4>
                string
                                        &mdash; <p>hex encoded string</p>
                                
                        </article>
    </div>
    <aside class="span4 detailsbar">
        <h1><i class="icon-arrow-down"></i></h1>
                                                        <dl>
                                                <dt>Inherited from</dt>
                <dd><a href="/rlp.html"><div class="path-wrapper">\Web3p\RLP\RLP</div></a></dd>
                                                        </dl>
        <h2>Tags</h2>
        <table class="table table-condensed">
                                <tr><td colspan="2"><em>None found</em></td></tr>
                        </table>
    </aside>
</div>

                                                </div>
</section>