Skip to content

Commit

Permalink
Deploy sol API reference Merge pull request #187 from oasisprotocol/m…
Browse files Browse the repository at this point in the history 
…atevz/feature/solidity-docgen

contracts: Add solidity API reference bc27209
  • Loading branch information
@github-actions
github-actions[bot] committed Sep 25, 2023
1 parent 07f32cc commit 8db306d
Show file tree
Hide file tree
Showing 38 changed files with 152 additions and 152 deletions.
2 changes: 1 addition & 1 deletion sol/sapphire-contracts/404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@

<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<div class="sidebar-scrollbox">
<ol class="chapter"><li class="chapter-item "><a href="index.html">Home</a></li><li class="chapter-item affix "><li class="part-title">contracts</li><li class="chapter-item "><a href="contracts/opl/index.html">❱ opl</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="contracts/opl/Enclave.sol/contract.Enclave.html">Enclave</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/error.AutoConfigUnavailable.html">AutoConfigUnavailable</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/error.NotMessageBus.html">NotMessageBus</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/error.NotRemoteEndpoint.html">NotRemoteEndpoint</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/error.WrongSeqNum.html">WrongSeqNum</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/error.MissingRemoteAddr.html">MissingRemoteAddr</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/error.MissingRemoteChainId.html">MissingRemoteChainId</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/error.SelfCallDisallowed.html">SelfCallDisallowed</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/error.UnknownEndpoint.html">UnknownEndpoint</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/error.ReceiverError.html">ReceiverError</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/enum.Result.html">Result</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/interface.ICelerMessageBus.html">ICelerMessageBus</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/contract.BaseEndpoint.html">BaseEndpoint</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/contract.Endpoint.html">Endpoint</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/function._getBus.html">_getBus</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/function.autoswitch.html">autoswitch</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/function._getRemoteChainId.html">_getRemoteChainId</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/function._getChainConfig.html">_getChainConfig</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/function._chainName2ChainId.html">_chainName2ChainId</a></li><li class="chapter-item "><a href="contracts/opl/Host.sol/contract.Host.html">Host</a></li></ol></li><li class="chapter-item "><a href="contracts/ConsensusUtils.sol/type.StakingAddress.html">StakingAddress</a></li><li class="chapter-item "><a href="contracts/ConsensusUtils.sol/type.StakingSecretKey.html">StakingSecretKey</a></li><li class="chapter-item "><a href="contracts/ConsensusUtils.sol/library.ConsensusUtils.html">ConsensusUtils</a></li><li class="chapter-item "><a href="contracts/EIP155Signer.sol/library.EIP155Signer.html">EIP155Signer</a></li><li class="chapter-item "><a href="contracts/EthereumUtils.sol/struct.SignatureRSV.html">SignatureRSV</a></li><li class="chapter-item "><a href="contracts/EthereumUtils.sol/library.EthereumUtils.html">EthereumUtils</a></li><li class="chapter-item "><a href="contracts/RLPWriter.sol/library.RLPWriter.html">RLPWriter</a></li><li class="chapter-item "><a href="contracts/Sapphire.sol/library.Sapphire.html">Sapphire</a></li><li class="chapter-item "><a href="contracts/Sapphire.sol/function.sha512_256.html">sha512_256</a></li><li class="chapter-item "><a href="contracts/Sapphire.sol/function.sha512.html">sha512</a></li><li class="chapter-item "><a href="contracts/Subcall.sol/library.Subcall.html">Subcall</a></li><li class="chapter-item "><a href="contracts/WrappedROSE.sol/contract.WrappedROSE.html">WrappedROSE</a></li></ol>
<ol class="chapter"><li class="chapter-item "><a href="index.html">Home</a></li><li class="chapter-item affix "><li class="part-title">contracts</li><li class="chapter-item "><a href="contracts/opl/index.html">❱ opl</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="contracts/opl/Enclave.sol/contract.Enclave.html">Enclave</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/error.AutoConfigUnavailable.html">AutoConfigUnavailable</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/error.NotMessageBus.html">NotMessageBus</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/error.NotRemoteEndpoint.html">NotRemoteEndpoint</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/error.WrongSeqNum.html">WrongSeqNum</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/error.MissingRemoteAddr.html">MissingRemoteAddr</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/error.MissingRemoteChainId.html">MissingRemoteChainId</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/error.SelfCallDisallowed.html">SelfCallDisallowed</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/error.UnknownEndpoint.html">UnknownEndpoint</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/error.ReceiverError.html">ReceiverError</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/enum.Result.html">Result</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/interface.ICelerMessageBus.html">ICelerMessageBus</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/contract.BaseEndpoint.html">BaseEndpoint</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/contract.Endpoint.html">Endpoint</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/function._chainName2ChainId.html">_chainName2ChainId</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/function._getChainConfig.html">_getChainConfig</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/function._getBus.html">_getBus</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/function.autoswitch.html">autoswitch</a></li><li class="chapter-item "><a href="contracts/opl/Endpoint.sol/function._getRemoteChainId.html">_getRemoteChainId</a></li><li class="chapter-item "><a href="contracts/opl/Host.sol/contract.Host.html">Host</a></li></ol></li><li class="chapter-item "><a href="contracts/ConsensusUtils.sol/type.StakingAddress.html">StakingAddress</a></li><li class="chapter-item "><a href="contracts/ConsensusUtils.sol/type.StakingSecretKey.html">StakingSecretKey</a></li><li class="chapter-item "><a href="contracts/ConsensusUtils.sol/library.ConsensusUtils.html">ConsensusUtils</a></li><li class="chapter-item "><a href="contracts/EIP155Signer.sol/library.EIP155Signer.html">EIP155Signer</a></li><li class="chapter-item "><a href="contracts/EthereumUtils.sol/struct.SignatureRSV.html">SignatureRSV</a></li><li class="chapter-item "><a href="contracts/EthereumUtils.sol/library.EthereumUtils.html">EthereumUtils</a></li><li class="chapter-item "><a href="contracts/RLPWriter.sol/library.RLPWriter.html">RLPWriter</a></li><li class="chapter-item "><a href="contracts/Sapphire.sol/library.Sapphire.html">Sapphire</a></li><li class="chapter-item "><a href="contracts/Sapphire.sol/function.sha512.html">sha512</a></li><li class="chapter-item "><a href="contracts/Sapphire.sol/function.sha512_256.html">sha512_256</a></li><li class="chapter-item "><a href="contracts/Subcall.sol/library.Subcall.html">Subcall</a></li><li class="chapter-item "><a href="contracts/WrappedROSE.sol/contract.WrappedROSE.html">WrappedROSE</a></li></ol>
</div>
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
</nav>
Expand Down
4 changes: 2 additions & 2 deletions sol/sapphire-contracts/contracts/ConsensusUtils.sol/library.ConsensusUtils.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@

<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<div class="sidebar-scrollbox">
<ol class="chapter"><li class="chapter-item "><a href="../../index.html">Home</a></li><li class="chapter-item affix "><li class="part-title">contracts</li><li class="chapter-item "><a href="../../contracts/opl/index.html">❱ opl</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="../../contracts/opl/Enclave.sol/contract.Enclave.html">Enclave</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/error.AutoConfigUnavailable.html">AutoConfigUnavailable</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/error.NotMessageBus.html">NotMessageBus</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/error.NotRemoteEndpoint.html">NotRemoteEndpoint</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/error.WrongSeqNum.html">WrongSeqNum</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/error.MissingRemoteAddr.html">MissingRemoteAddr</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/error.MissingRemoteChainId.html">MissingRemoteChainId</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/error.SelfCallDisallowed.html">SelfCallDisallowed</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/error.UnknownEndpoint.html">UnknownEndpoint</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/error.ReceiverError.html">ReceiverError</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/enum.Result.html">Result</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/interface.ICelerMessageBus.html">ICelerMessageBus</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/contract.BaseEndpoint.html">BaseEndpoint</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/contract.Endpoint.html">Endpoint</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/function._getBus.html">_getBus</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/function.autoswitch.html">autoswitch</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/function._getRemoteChainId.html">_getRemoteChainId</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/function._getChainConfig.html">_getChainConfig</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/function._chainName2ChainId.html">_chainName2ChainId</a></li><li class="chapter-item "><a href="../../contracts/opl/Host.sol/contract.Host.html">Host</a></li></ol></li><li class="chapter-item "><a href="../../contracts/ConsensusUtils.sol/type.StakingAddress.html">StakingAddress</a></li><li class="chapter-item "><a href="../../contracts/ConsensusUtils.sol/type.StakingSecretKey.html">StakingSecretKey</a></li><li class="chapter-item expanded "><a href="../../contracts/ConsensusUtils.sol/library.ConsensusUtils.html" class="active">ConsensusUtils</a></li><li class="chapter-item "><a href="../../contracts/EIP155Signer.sol/library.EIP155Signer.html">EIP155Signer</a></li><li class="chapter-item "><a href="../../contracts/EthereumUtils.sol/struct.SignatureRSV.html">SignatureRSV</a></li><li class="chapter-item "><a href="../../contracts/EthereumUtils.sol/library.EthereumUtils.html">EthereumUtils</a></li><li class="chapter-item "><a href="../../contracts/RLPWriter.sol/library.RLPWriter.html">RLPWriter</a></li><li class="chapter-item "><a href="../../contracts/Sapphire.sol/library.Sapphire.html">Sapphire</a></li><li class="chapter-item "><a href="../../contracts/Sapphire.sol/function.sha512_256.html">sha512_256</a></li><li class="chapter-item "><a href="../../contracts/Sapphire.sol/function.sha512.html">sha512</a></li><li class="chapter-item "><a href="../../contracts/Subcall.sol/library.Subcall.html">Subcall</a></li><li class="chapter-item "><a href="../../contracts/WrappedROSE.sol/contract.WrappedROSE.html">WrappedROSE</a></li></ol>
<ol class="chapter"><li class="chapter-item "><a href="../../index.html">Home</a></li><li class="chapter-item affix "><li class="part-title">contracts</li><li class="chapter-item "><a href="../../contracts/opl/index.html">❱ opl</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="../../contracts/opl/Enclave.sol/contract.Enclave.html">Enclave</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/error.AutoConfigUnavailable.html">AutoConfigUnavailable</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/error.NotMessageBus.html">NotMessageBus</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/error.NotRemoteEndpoint.html">NotRemoteEndpoint</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/error.WrongSeqNum.html">WrongSeqNum</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/error.MissingRemoteAddr.html">MissingRemoteAddr</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/error.MissingRemoteChainId.html">MissingRemoteChainId</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/error.SelfCallDisallowed.html">SelfCallDisallowed</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/error.UnknownEndpoint.html">UnknownEndpoint</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/error.ReceiverError.html">ReceiverError</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/enum.Result.html">Result</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/interface.ICelerMessageBus.html">ICelerMessageBus</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/contract.BaseEndpoint.html">BaseEndpoint</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/contract.Endpoint.html">Endpoint</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/function._chainName2ChainId.html">_chainName2ChainId</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/function._getChainConfig.html">_getChainConfig</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/function._getBus.html">_getBus</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/function.autoswitch.html">autoswitch</a></li><li class="chapter-item "><a href="../../contracts/opl/Endpoint.sol/function._getRemoteChainId.html">_getRemoteChainId</a></li><li class="chapter-item "><a href="../../contracts/opl/Host.sol/contract.Host.html">Host</a></li></ol></li><li class="chapter-item "><a href="../../contracts/ConsensusUtils.sol/type.StakingAddress.html">StakingAddress</a></li><li class="chapter-item "><a href="../../contracts/ConsensusUtils.sol/type.StakingSecretKey.html">StakingSecretKey</a></li><li class="chapter-item expanded "><a href="../../contracts/ConsensusUtils.sol/library.ConsensusUtils.html" class="active">ConsensusUtils</a></li><li class="chapter-item "><a href="../../contracts/EIP155Signer.sol/library.EIP155Signer.html">EIP155Signer</a></li><li class="chapter-item "><a href="../../contracts/EthereumUtils.sol/struct.SignatureRSV.html">SignatureRSV</a></li><li class="chapter-item "><a href="../../contracts/EthereumUtils.sol/library.EthereumUtils.html">EthereumUtils</a></li><li class="chapter-item "><a href="../../contracts/RLPWriter.sol/library.RLPWriter.html">RLPWriter</a></li><li class="chapter-item "><a href="../../contracts/Sapphire.sol/library.Sapphire.html">Sapphire</a></li><li class="chapter-item "><a href="../../contracts/Sapphire.sol/function.sha512.html">sha512</a></li><li class="chapter-item "><a href="../../contracts/Sapphire.sol/function.sha512_256.html">sha512_256</a></li><li class="chapter-item "><a href="../../contracts/Subcall.sol/library.Subcall.html">Subcall</a></li><li class="chapter-item "><a href="../../contracts/WrappedROSE.sol/contract.WrappedROSE.html">WrappedROSE</a></li></ol>
</div>
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
</nav>
Expand Down Expand Up @@ -171,7 +171,7 @@ <h1 class="menu-title">Sapphire Contracts Lib</h1>
<div id="content" class="content">
<main>
<h1 id="consensusutils"><a class="header" href="#consensusutils">ConsensusUtils</a></h1>
<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/d1d26cc02512eb35eca61919f235c69644d3af3d/contracts/contracts/ConsensusUtils.sol">Git Source</a></p>
<p><a href="https://github.com/oasisprotocol/sapphire-paratime/blob/bc27209ba4740afa69c5e850eae291971a8788c9/contracts/contracts/ConsensusUtils.sol">Git Source</a></p>
<p><em>Generate Oasis wallets for use with staking at the consensus level</em></p>
<h2 id="state-variables"><a class="header" href="#state-variables">State Variables</a></h2>
<h3 id="address_v0_context_identifier"><a class="header" href="#address_v0_context_identifier">ADDRESS_V0_CONTEXT_IDENTIFIER</a></h3>
Expand Down
Loading

0 comments on commit 8db306d

Please sign in to comment.