Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Arjan Zijderveld committed Nov 19, 2020
1 parent bf5f9e2 commit c6a8422
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 26 deletions.
52 changes: 29 additions & 23 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ <h1 class="title">Package <code>substrateinterface</code></h1>

Returns
-------

Seed phrase
&#34;&#34;&#34;
return bip39_generate(words)

Expand All @@ -169,7 +169,7 @@ <h1 class="title">Package <code>substrateinterface</code></h1>
mnemonic: Seed phrase
ss58_format: Substrate address format, default = 42
address_type: (deprecated)
crypto_type: Use KeypairType.SR25519 or KeypairType.ED25519 cryptography for generating the Keypair
crypto_type: Use `KeypairType.SR25519` or `KeypairType.ED25519` cryptography for generating the Keypair

Returns
-------
Expand Down Expand Up @@ -330,7 +330,7 @@ <h1 class="title">Package <code>substrateinterface</code></h1>

Parameters
----------
data: data to sign in `Scalebytes`, `bytes` or hex string format
data: data to sign in `Scalebytes`, bytes or hex string format

Returns
-------
Expand Down Expand Up @@ -360,10 +360,11 @@ <h1 class="title">Package <code>substrateinterface</code></h1>
def verify(self, data, signature):
&#34;&#34;&#34;
Verifies data with specified signature

Parameters
----------
data: data to be verified in `Scalebytes`, `bytes` or hex string format
signature: signature in `bytes` or hex string format
data: data to be verified in `Scalebytes`, bytes or hex string format
signature: signature in bytes or hex string format

Returns
-------
Expand Down Expand Up @@ -2383,7 +2384,7 @@ <h2 id="parameters">Parameters</h2>

Returns
-------

Seed phrase
&#34;&#34;&#34;
return bip39_generate(words)

Expand All @@ -2397,7 +2398,7 @@ <h2 id="parameters">Parameters</h2>
mnemonic: Seed phrase
ss58_format: Substrate address format, default = 42
address_type: (deprecated)
crypto_type: Use KeypairType.SR25519 or KeypairType.ED25519 cryptography for generating the Keypair
crypto_type: Use `KeypairType.SR25519` or `KeypairType.ED25519` cryptography for generating the Keypair

Returns
-------
Expand Down Expand Up @@ -2558,7 +2559,7 @@ <h2 id="parameters">Parameters</h2>

Parameters
----------
data: data to sign in `Scalebytes`, `bytes` or hex string format
data: data to sign in `Scalebytes`, bytes or hex string format

Returns
-------
Expand Down Expand Up @@ -2588,10 +2589,11 @@ <h2 id="parameters">Parameters</h2>
def verify(self, data, signature):
&#34;&#34;&#34;
Verifies data with specified signature

Parameters
----------
data: data to be verified in `Scalebytes`, `bytes` or hex string format
signature: signature in `bytes` or hex string format
data: data to be verified in `Scalebytes`, bytes or hex string format
signature: signature in bytes or hex string format

Returns
-------
Expand Down Expand Up @@ -2636,7 +2638,7 @@ <h2 id="parameters">Parameters</h2>
<dd>&nbsp;</dd>
<dt><strong><code>address_type</code></strong> :&ensp;<code>(deprecated)</code></dt>
<dd>&nbsp;</dd>
<dt><strong><code>crypto_type</code></strong> :&ensp;<code>Use <a title="substrateinterface.KeypairType.SR25519" href="#substrateinterface.KeypairType.SR25519">KeypairType.SR25519</a></code> or <code><a title="substrateinterface.KeypairType.ED25519" href="#substrateinterface.KeypairType.ED25519">KeypairType.ED25519</a> cryptography for generating the <a title="substrateinterface.Keypair" href="#substrateinterface.Keypair">Keypair</a></code></dt>
<dt><strong><code>crypto_type</code></strong> :&ensp;<code>Use </code>KeypairType.SR25519<code> or </code>KeypairType.ED25519<code> cryptography for generating the <a title="substrateinterface.Keypair" href="#substrateinterface.Keypair">Keypair</a></code></dt>
<dd>&nbsp;</dd>
</dl>
<h2 id="returns">Returns</h2>
Expand All @@ -2658,7 +2660,7 @@ <h2 id="returns">Returns</h2>
mnemonic: Seed phrase
ss58_format: Substrate address format, default = 42
address_type: (deprecated)
crypto_type: Use KeypairType.SR25519 or KeypairType.ED25519 cryptography for generating the Keypair
crypto_type: Use `KeypairType.SR25519` or `KeypairType.ED25519` cryptography for generating the Keypair

Returns
-------
Expand Down Expand Up @@ -2906,7 +2908,11 @@ <h2 id="parameters">Parameters</h2>
<dt><strong><code>words</code></strong> :&ensp;<code>The amount</code> of <code>words to generate, valid values are 12, 15, 18, 21 and 24</code></dt>
<dd>&nbsp;</dd>
</dl>
<h2 id="returns">Returns</h2></div>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>Seed phrase</code></dt>
<dd>&nbsp;</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
Expand All @@ -2922,7 +2928,7 @@ <h2 id="returns">Returns</h2></div>

Returns
-------

Seed phrase
&#34;&#34;&#34;
return bip39_generate(words)</code></pre>
</details>
Expand All @@ -2937,7 +2943,7 @@ <h3>Methods</h3>
<div class="desc"><p>Creates a signature for given data</p>
<h2 id="parameters">Parameters</h2>
<dl>
<dt><strong><code>data</code></strong> :&ensp;<code>data to sign in </code>Scalebytes<code>, </code>bytes<code><code>or &lt;/code&gt;hex string format</code></dt>
<dt><strong><code>data</code></strong> :&ensp;<code>data to sign in </code>Scalebytes<code>, bytes</code> or <code>hex string format</code></dt>
<dd>&nbsp;</dd>
</dl>
<h2 id="returns">Returns</h2>
Expand All @@ -2955,7 +2961,7 @@ <h2 id="returns">Returns</h2>

Parameters
----------
data: data to sign in `Scalebytes`, `bytes` or hex string format
data: data to sign in `Scalebytes`, bytes or hex string format

Returns
-------
Expand Down Expand Up @@ -2987,13 +2993,12 @@ <h2 id="returns">Returns</h2>
<span>def <span class="ident">verify</span></span>(<span>self, data, signature)</span>
</code></dt>
<dd>
<div class="desc"><p>Verifies data with specified signature
Parameters</p>
<hr>
<div class="desc"><p>Verifies data with specified signature</p>
<h2 id="parameters">Parameters</h2>
<dl>
<dt><strong><code>data</code></strong> :&ensp;<code>data to be verified in </code>Scalebytes<code>, </code>bytes<code><code>or &lt;/code&gt;hex string format</code></dt>
<dt><strong><code>data</code></strong> :&ensp;<code>data to be verified in </code>Scalebytes<code>, bytes</code> or <code>hex string format</code></dt>
<dd>&nbsp;</dd>
<dt><strong><code>signature</code></strong> :&ensp;<code>signature in </code>bytes<code><code>or &lt;/code&gt;hex string format</code></dt>
<dt><strong><code>signature</code></strong> :&ensp;<code>signature in bytes</code> or <code>hex string format</code></dt>
<dd>&nbsp;</dd>
</dl>
<h2 id="returns">Returns</h2>
Expand All @@ -3008,10 +3013,11 @@ <h2 id="returns">Returns</h2>
<pre><code class="python">def verify(self, data, signature):
&#34;&#34;&#34;
Verifies data with specified signature

Parameters
----------
data: data to be verified in `Scalebytes`, `bytes` or hex string format
signature: signature in `bytes` or hex string format
data: data to be verified in `Scalebytes`, bytes or hex string format
signature: signature in bytes or hex string format

Returns
-------
Expand Down
6 changes: 3 additions & 3 deletions substrateinterface/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ def sign(self, data):
Parameters
----------
data: data to sign in `Scalebytes`, `bytes` or hex string format
data: data to sign in `Scalebytes`, bytes or hex string format
Returns
-------
Expand Down Expand Up @@ -335,8 +335,8 @@ def verify(self, data, signature):
Parameters
----------
data: data to be verified in `Scalebytes`, `bytes` or hex string format
signature: signature in `bytes` or hex string format
data: data to be verified in `Scalebytes`, bytes or hex string format
signature: signature in bytes or hex string format
Returns
-------
Expand Down

0 comments on commit c6a8422

Please sign in to comment.