Deploy sol API reference Merge pull request #460 from oasisprotocol/Z…

…igaMr/python-api-docs docs: Add python client ed1e9fc
oasisprotocol · Jan 13, 2025 · be8ed62 · be8ed62
1 parent 7e21455
commit be8ed62
Show file tree

Hide file tree

Showing 67 changed files with 256 additions and 256 deletions.
diff --git a/sol/sapphire-contracts/contracts/CBOR.sol/error.CBOR_Error_BufferOverrun.html b/sol/sapphire-contracts/contracts/CBOR.sol/error.CBOR_Error_BufferOverrun.html
@@ -158,7 +158,7 @@ <h1 class="menu-title">Sapphire Contracts Lib</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="cbor_error_bufferoverrun"><a class="header" href="#cbor_error_bufferoverrun">CBOR_Error_BufferOverrun</a></h1>
-<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/68030791deb833289b30cb824b32367927689ac8/contracts/contracts/CBOR.sol">Git Source</a></p>
+<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/ed1e9fcf15dc9c5ef7afe27a0cf931068f34ccb8/contracts/contracts/CBOR.sol">Git Source</a></p>
 <p>Buffer too short to parse expected value</p>
 <pre><code class="language-solidity">error CBOR_Error_BufferOverrun(uint256 len, uint256 offset, uint256 need);
 </code></pre>

diff --git a/sol/sapphire-contracts/contracts/CBOR.sol/error.CBOR_Error_BytesTooLong.html b/sol/sapphire-contracts/contracts/CBOR.sol/error.CBOR_Error_BytesTooLong.html
@@ -158,7 +158,7 @@ <h1 class="menu-title">Sapphire Contracts Lib</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="cbor_error_bytestoolong"><a class="header" href="#cbor_error_bytestoolong">CBOR_Error_BytesTooLong</a></h1>
-<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/68030791deb833289b30cb824b32367927689ac8/contracts/contracts/CBOR.sol">Git Source</a></p>
+<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/ed1e9fcf15dc9c5ef7afe27a0cf931068f34ccb8/contracts/contracts/CBOR.sol">Git Source</a></p>
 <p>Byte array is too long</p>
 <p><em>Solidity has 256bit length prefixes for byte arrays. We decided for
 a reasonable cutoff point (64kb), so at most a 2-byte uint describing
@@ -174,7 +174,7 @@ <h1 id="cbor_error_bytestoolong"><a class="header" href="#cbor_error_bytestoolon
                                 <i class="fa fa-angle-left"></i>
                             </a>
 
-                            <a rel="next prefetch" href="../../contracts/CBOR.sol/function.encodeUint.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                            <a rel="next prefetch" href="../../contracts/CBOR.sol/function.encodeBytes.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                                 <i class="fa fa-angle-right"></i>
                             </a>
 
@@ -188,7 +188,7 @@ <h1 id="cbor_error_bytestoolong"><a class="header" href="#cbor_error_bytestoolon
                         <i class="fa fa-angle-left"></i>
                     </a>
 
-                    <a rel="next prefetch" href="../../contracts/CBOR.sol/function.encodeUint.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                    <a rel="next prefetch" href="../../contracts/CBOR.sol/function.encodeBytes.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                         <i class="fa fa-angle-right"></i>
                     </a>
             </nav>

diff --git a/sol/sapphire-contracts/contracts/CBOR.sol/error.CBOR_Error_ValueOutOfRange.html b/sol/sapphire-contracts/contracts/CBOR.sol/error.CBOR_Error_ValueOutOfRange.html
@@ -158,7 +158,7 @@ <h1 class="menu-title">Sapphire Contracts Lib</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="cbor_error_valueoutofrange"><a class="header" href="#cbor_error_valueoutofrange">CBOR_Error_ValueOutOfRange</a></h1>
-<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/68030791deb833289b30cb824b32367927689ac8/contracts/contracts/CBOR.sol">Git Source</a></p>
+<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/ed1e9fcf15dc9c5ef7afe27a0cf931068f34ccb8/contracts/contracts/CBOR.sol">Git Source</a></p>
 <p>CBOR parsed value is out of expected range</p>
 <pre><code class="language-solidity">error CBOR_Error_ValueOutOfRange(uint256 value, uint256 maxValue);
 </code></pre>

diff --git a/sol/sapphire-contracts/contracts/CBOR.sol/error.CBOR_InvalidKey.html b/sol/sapphire-contracts/contracts/CBOR.sol/error.CBOR_InvalidKey.html
@@ -158,7 +158,7 @@ <h1 class="menu-title">Sapphire Contracts Lib</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="cbor_invalidkey"><a class="header" href="#cbor_invalidkey">CBOR_InvalidKey</a></h1>
-<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/68030791deb833289b30cb824b32367927689ac8/contracts/contracts/CBOR.sol">Git Source</a></p>
+<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/ed1e9fcf15dc9c5ef7afe27a0cf931068f34ccb8/contracts/contracts/CBOR.sol">Git Source</a></p>
 <p>While parsing CBOR map, unexpected key</p>
 <pre><code class="language-solidity">error CBOR_InvalidKey();
 </code></pre>

diff --git a/sol/sapphire-contracts/contracts/CBOR.sol/error.CBOR_InvalidLength.html b/sol/sapphire-contracts/contracts/CBOR.sol/error.CBOR_InvalidLength.html
@@ -158,7 +158,7 @@ <h1 class="menu-title">Sapphire Contracts Lib</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="cbor_invalidlength"><a class="header" href="#cbor_invalidlength">CBOR_InvalidLength</a></h1>
-<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/68030791deb833289b30cb824b32367927689ac8/contracts/contracts/CBOR.sol">Git Source</a></p>
+<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/ed1e9fcf15dc9c5ef7afe27a0cf931068f34ccb8/contracts/contracts/CBOR.sol">Git Source</a></p>
 <p>While parsing CBOR structure, data length was unexpected</p>
 <pre><code class="language-solidity">error CBOR_InvalidLength(uint256);
 </code></pre>

diff --git a/sol/sapphire-contracts/contracts/CBOR.sol/error.CBOR_InvalidMap.html b/sol/sapphire-contracts/contracts/CBOR.sol/error.CBOR_InvalidMap.html
@@ -158,7 +158,7 @@ <h1 class="menu-title">Sapphire Contracts Lib</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="cbor_invalidmap"><a class="header" href="#cbor_invalidmap">CBOR_InvalidMap</a></h1>
-<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/68030791deb833289b30cb824b32367927689ac8/contracts/contracts/CBOR.sol">Git Source</a></p>
+<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/ed1e9fcf15dc9c5ef7afe27a0cf931068f34ccb8/contracts/contracts/CBOR.sol">Git Source</a></p>
 <p>While parsing CBOR map, length is invalid, or other parse error</p>
 <pre><code class="language-solidity">error CBOR_InvalidMap();
 </code></pre>

diff --git a/sol/sapphire-contracts/contracts/CBOR.sol/error.CBOR_InvalidUintPrefix.html b/sol/sapphire-contracts/contracts/CBOR.sol/error.CBOR_InvalidUintPrefix.html
@@ -158,7 +158,7 @@ <h1 class="menu-title">Sapphire Contracts Lib</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="cbor_invaliduintprefix"><a class="header" href="#cbor_invaliduintprefix">CBOR_InvalidUintPrefix</a></h1>
-<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/68030791deb833289b30cb824b32367927689ac8/contracts/contracts/CBOR.sol">Git Source</a></p>
+<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/ed1e9fcf15dc9c5ef7afe27a0cf931068f34ccb8/contracts/contracts/CBOR.sol">Git Source</a></p>
 <p>Value cannot be parsed as a uint</p>
 <pre><code class="language-solidity">error CBOR_InvalidUintPrefix(uint8);
 </code></pre>

diff --git a/sol/sapphire-contracts/contracts/CBOR.sol/error.CBOR_InvalidUintSize.html b/sol/sapphire-contracts/contracts/CBOR.sol/error.CBOR_InvalidUintSize.html
@@ -158,7 +158,7 @@ <h1 class="menu-title">Sapphire Contracts Lib</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="cbor_invaliduintsize"><a class="header" href="#cbor_invaliduintsize">CBOR_InvalidUintSize</a></h1>
-<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/68030791deb833289b30cb824b32367927689ac8/contracts/contracts/CBOR.sol">Git Source</a></p>
+<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/ed1e9fcf15dc9c5ef7afe27a0cf931068f34ccb8/contracts/contracts/CBOR.sol">Git Source</a></p>
 <p>CBOR spec supports, 1, 2, 4 &amp; 8 byte uints. Caused by parse error.</p>
 <pre><code class="language-solidity">error CBOR_InvalidUintSize(uint8);
 </code></pre>

diff --git a/sol/sapphire-contracts/contracts/CBOR.sol/function.encodeBytes.html b/sol/sapphire-contracts/contracts/CBOR.sol/function.encodeBytes.html
@@ -158,19 +158,19 @@ <h1 class="menu-title">Sapphire Contracts Lib</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="encodebytes"><a class="header" href="#encodebytes">encodeBytes</a></h1>
-<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/68030791deb833289b30cb824b32367927689ac8/contracts/contracts/CBOR.sol">Git Source</a></p>
+<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/ed1e9fcf15dc9c5ef7afe27a0cf931068f34ccb8/contracts/contracts/CBOR.sol">Git Source</a></p>
 <pre><code class="language-solidity">function encodeBytes(bytes memory in_bytes) pure returns (bytes memory out_cbor);
 </code></pre>
 
                     </main>
 
                     <nav class="nav-wrapper" aria-label="Page navigation">
                         <!-- Mobile navigation buttons -->
-                            <a rel="prev" href="../../contracts/CBOR.sol/function.encodeUint.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+                            <a rel="prev" href="../../contracts/CBOR.sol/error.CBOR_Error_BytesTooLong.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                                 <i class="fa fa-angle-left"></i>
                             </a>
 
-                            <a rel="next prefetch" href="../../contracts/CBOR.sol/function.parseUint64.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                            <a rel="next prefetch" href="../../contracts/CBOR.sol/function.parseUint.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                                 <i class="fa fa-angle-right"></i>
                             </a>
 
@@ -180,11 +180,11 @@ <h1 id="encodebytes"><a class="header" href="#encodebytes">encodeBytes</a></h1>
             </div>
 
             <nav class="nav-wide-wrapper" aria-label="Page navigation">
-                    <a rel="prev" href="../../contracts/CBOR.sol/function.encodeUint.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+                    <a rel="prev" href="../../contracts/CBOR.sol/error.CBOR_Error_BytesTooLong.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                         <i class="fa fa-angle-left"></i>
                     </a>
 
-                    <a rel="next prefetch" href="../../contracts/CBOR.sol/function.parseUint64.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                    <a rel="next prefetch" href="../../contracts/CBOR.sol/function.parseUint.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                         <i class="fa fa-angle-right"></i>
                     </a>
             </nav>

diff --git a/sol/sapphire-contracts/contracts/CBOR.sol/function.encodeUint.html b/sol/sapphire-contracts/contracts/CBOR.sol/function.encodeUint.html
@@ -158,7 +158,7 @@ <h1 class="menu-title">Sapphire Contracts Lib</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="encodeuint"><a class="header" href="#encodeuint">encodeUint</a></h1>
-<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/68030791deb833289b30cb824b32367927689ac8/contracts/contracts/CBOR.sol">Git Source</a></p>
+<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/ed1e9fcf15dc9c5ef7afe27a0cf931068f34ccb8/contracts/contracts/CBOR.sol">Git Source</a></p>
 <p><em>we don't follow bignum tagged encoding
 See: https://www.rfc-editor.org/rfc/rfc8949.html#section-3.4.3</em></p>
 <pre><code class="language-solidity">function encodeUint(uint256 value) pure returns (bytes memory);
@@ -168,11 +168,11 @@ <h1 id="encodeuint"><a class="header" href="#encodeuint">encodeUint</a></h1>
 
                     <nav class="nav-wrapper" aria-label="Page navigation">
                         <!-- Mobile navigation buttons -->
-                            <a rel="prev" href="../../contracts/CBOR.sol/error.CBOR_Error_BytesTooLong.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+                            <a rel="prev" href="../../contracts/CBOR.sol/function.parseMapStart.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                                 <i class="fa fa-angle-left"></i>
                             </a>
 
-                            <a rel="next prefetch" href="../../contracts/CBOR.sol/function.encodeBytes.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                            <a rel="next prefetch" href="../../contracts/CBOR.sol/function.parseUint128.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                                 <i class="fa fa-angle-right"></i>
                             </a>
 
@@ -182,11 +182,11 @@ <h1 id="encodeuint"><a class="header" href="#encodeuint">encodeUint</a></h1>
             </div>
 
             <nav class="nav-wide-wrapper" aria-label="Page navigation">
-                    <a rel="prev" href="../../contracts/CBOR.sol/error.CBOR_Error_BytesTooLong.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+                    <a rel="prev" href="../../contracts/CBOR.sol/function.parseMapStart.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                         <i class="fa fa-angle-left"></i>
                     </a>
 
-                    <a rel="next prefetch" href="../../contracts/CBOR.sol/function.encodeBytes.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                    <a rel="next prefetch" href="../../contracts/CBOR.sol/function.parseUint128.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                         <i class="fa fa-angle-right"></i>
                     </a>
             </nav>

diff --git a/sol/sapphire-contracts/contracts/CBOR.sol/function.parseKey.html b/sol/sapphire-contracts/contracts/CBOR.sol/function.parseKey.html
@@ -158,19 +158,19 @@ <h1 class="menu-title">Sapphire Contracts Lib</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="parsekey"><a class="header" href="#parsekey">parseKey</a></h1>
-<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/68030791deb833289b30cb824b32367927689ac8/contracts/contracts/CBOR.sol">Git Source</a></p>
+<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/ed1e9fcf15dc9c5ef7afe27a0cf931068f34ccb8/contracts/contracts/CBOR.sol">Git Source</a></p>
 <pre><code class="language-solidity">function parseKey(bytes memory result, uint256 offset) pure returns (uint256 newOffset, bytes32 keyDigest);
 </code></pre>
 
                     </main>
 
                     <nav class="nav-wrapper" aria-label="Page navigation">
                         <!-- Mobile navigation buttons -->
-                            <a rel="prev" href="../../contracts/CBOR.sol/function.parseUint64.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+                            <a rel="prev" href="../../contracts/CBOR.sol/function.parseUint.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                                 <i class="fa fa-angle-left"></i>
                             </a>
 
-                            <a rel="next prefetch" href="../../contracts/CBOR.sol/function.parseUint128.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                            <a rel="next prefetch" href="../../contracts/CBOR.sol/function.parseUint64.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                                 <i class="fa fa-angle-right"></i>
                             </a>
 
@@ -180,11 +180,11 @@ <h1 id="parsekey"><a class="header" href="#parsekey">parseKey</a></h1>
             </div>
 
             <nav class="nav-wide-wrapper" aria-label="Page navigation">
-                    <a rel="prev" href="../../contracts/CBOR.sol/function.parseUint64.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+                    <a rel="prev" href="../../contracts/CBOR.sol/function.parseUint.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                         <i class="fa fa-angle-left"></i>
                     </a>
 
-                    <a rel="next prefetch" href="../../contracts/CBOR.sol/function.parseUint128.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                    <a rel="next prefetch" href="../../contracts/CBOR.sol/function.parseUint64.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                         <i class="fa fa-angle-right"></i>
                     </a>
             </nav>

diff --git a/sol/sapphire-contracts/contracts/CBOR.sol/function.parseMapStart.html b/sol/sapphire-contracts/contracts/CBOR.sol/function.parseMapStart.html
@@ -158,19 +158,19 @@ <h1 class="menu-title">Sapphire Contracts Lib</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="parsemapstart"><a class="header" href="#parsemapstart">parseMapStart</a></h1>
-<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/68030791deb833289b30cb824b32367927689ac8/contracts/contracts/CBOR.sol">Git Source</a></p>
+<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/ed1e9fcf15dc9c5ef7afe27a0cf931068f34ccb8/contracts/contracts/CBOR.sol">Git Source</a></p>
 <pre><code class="language-solidity">function parseMapStart(bytes memory in_data, uint256 in_offset) pure returns (uint256 n_entries, uint256 out_offset);
 </code></pre>
 
                     </main>
 
                     <nav class="nav-wrapper" aria-label="Page navigation">
                         <!-- Mobile navigation buttons -->
-                            <a rel="prev" href="../../contracts/CBOR.sol/function.parseUint.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+                            <a rel="prev" href="../../contracts/CBOR.sol/function.parseUint64.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                                 <i class="fa fa-angle-left"></i>
                             </a>
 
-                            <a rel="next prefetch" href="../../contracts/CalldataEncryption.sol/function._deriveKey.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                            <a rel="next prefetch" href="../../contracts/CBOR.sol/function.encodeUint.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                                 <i class="fa fa-angle-right"></i>
                             </a>
 
@@ -180,11 +180,11 @@ <h1 id="parsemapstart"><a class="header" href="#parsemapstart">parseMapStart</a>
             </div>
 
             <nav class="nav-wide-wrapper" aria-label="Page navigation">
-                    <a rel="prev" href="../../contracts/CBOR.sol/function.parseUint.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+                    <a rel="prev" href="../../contracts/CBOR.sol/function.parseUint64.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                         <i class="fa fa-angle-left"></i>
                     </a>
 
-                    <a rel="next prefetch" href="../../contracts/CalldataEncryption.sol/function._deriveKey.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                    <a rel="next prefetch" href="../../contracts/CBOR.sol/function.encodeUint.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                         <i class="fa fa-angle-right"></i>
                     </a>
             </nav>