Skip to content

Commit

Permalink
Rust-SDK 2.0 docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
bartossh committed Jan 24, 2025
1 parent 0882f33 commit 05e5434
Show file tree
Hide file tree
Showing 95 changed files with 1,192 additions and 0 deletions.
1 change: 1 addition & 0 deletions static/rust/redstone/all.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="List of all items in this crate"><title>List of all items in this crate</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-c5d6553a23f1e5a6.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="redstone" data-themes="" data-resource-suffix="" data-rustdoc-version="1.81.0 (eeb90cda1 2024-09-04)" data-channel="1.81.0" data-search-js="search-d234aafac6c221dd.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../static.files/main-d2fab2bf619172d3.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod sys"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../redstone/index.html">redstone</a><span class="version">2.0.0-pre</span></h2></div><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Aliases</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><h1>List of all items</h1><h3 id="structs">Structs</h3><ul class="all-items"><li><a href="struct.Bytes.html">Bytes</a></li><li><a href="struct.FeedId.html">FeedId</a></li><li><a href="struct.RedStoneConfigImpl.html">RedStoneConfigImpl</a></li><li><a href="struct.SignerAddress.html">SignerAddress</a></li><li><a href="struct.TimestampMillis.html">TimestampMillis</a></li><li><a href="struct.Value.html">Value</a></li><li><a href="core/config/struct.Config.html">core::config::Config</a></li><li><a href="core/processor_result/struct.ValidatedPayload.html">core::processor_result::ValidatedPayload</a></li><li><a href="default_ext/struct.DefaultCrypto.html">default_ext::DefaultCrypto</a></li><li><a href="network/struct.StdEnv.html">network::StdEnv</a></li><li><a href="network/error/struct.ContractErrorContent.html">network::error::ContractErrorContent</a></li><li><a href="radix/struct.RadixCrypto.html">radix::RadixCrypto</a></li><li><a href="radix/struct.RadixEnv.html">radix::RadixEnv</a></li></ul><h3 id="enums">Enums</h3><ul class="all-items"><li><a href="enum.CryptoError.html">CryptoError</a></li><li><a href="contract/verification/enum.UpdateTimestampVerifier.html">contract::verification::UpdateTimestampVerifier</a></li><li><a href="network/error/enum.Error.html">network::error::Error</a></li><li><a href="solana/enum.SolanaCrypto.html">solana::SolanaCrypto</a></li></ul><h3 id="traits">Traits</h3><ul class="all-items"><li><a href="trait.Crypto.html">Crypto</a></li><li><a href="trait.RedStoneConfig.html">RedStoneConfig</a></li><li><a href="helpers/iter_into/trait.IterInto.html">helpers::iter_into::IterInto</a></li><li><a href="helpers/iter_into/trait.IterIntoOpt.html">helpers::iter_into::IterIntoOpt</a></li><li><a href="helpers/iter_into/trait.OptIterIntoOpt.html">helpers::iter_into::OptIterIntoOpt</a></li><li><a href="network/trait.Environment.html">network::Environment</a></li><li><a href="network/as_str/trait.AsAsciiStr.html">network::as_str::AsAsciiStr</a></li><li><a href="network/as_str/trait.AsHexStr.html">network::as_str::AsHexStr</a></li></ul><h3 id="functions">Functions</h3><ul class="all-items"><li><a href="contract/verification/fn.verify_package_timestamp.html">contract::verification::verify_package_timestamp</a></li><li><a href="contract/verification/fn.verify_signers_config.html">contract::verification::verify_signers_config</a></li><li><a href="contract/verification/fn.verify_trusted_update.html">contract::verification::verify_trusted_update</a></li><li><a href="contract/verification/fn.verify_untrusted_update.html">contract::verification::verify_untrusted_update</a></li><li><a href="contract/verification/fn.verify_write_timestamp.html">contract::verification::verify_write_timestamp</a></li><li><a href="core/processor/fn.process_payload.html">core::processor::process_payload</a></li><li><a href="helpers/hex/fn.hex_from.html">helpers::hex::hex_from</a></li><li><a href="helpers/hex/fn.hex_to_bytes.html">helpers::hex::hex_to_bytes</a></li><li><a href="helpers/hex/fn.make_bytes.html">helpers::hex::make_bytes</a></li><li><a href="helpers/hex/fn.make_feed_id.html">helpers::hex::make_feed_id</a></li><li><a href="helpers/hex/fn.make_signer_address.html">helpers::hex::make_signer_address</a></li><li><a href="helpers/hex/fn.sample_payload_bytes.html">helpers::hex::sample_payload_bytes</a></li><li><a href="helpers/hex/fn.sample_payload_hex.html">helpers::hex::sample_payload_hex</a></li><li><a href="utils/slice/fn.check_no_duplicates.html">utils::slice::check_no_duplicates</a></li></ul><h3 id="types">Type Aliases</h3><ul class="all-items"><li><a href="casper/type.CasperRedStoneConfig.html">casper::CasperRedStoneConfig</a></li><li><a href="core/processor_result/type.ProcessorResult.html">core::processor_result::ProcessorResult</a></li><li><a href="default_ext/type.StdRedStoneConfig.html">default_ext::StdRedStoneConfig</a></li><li><a href="radix/type.RadixRedStoneConfig.html">radix::RadixRedStoneConfig</a></li><li><a href="solana/type.SolanaEnv.html">solana::SolanaEnv</a></li><li><a href="solana/type.SolanaRedStoneConfig.html">solana::SolanaRedStoneConfig</a></li></ul></section></div></main></body></html>
4 changes: 4 additions & 0 deletions static/rust/redstone/casper/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Casper extension"><title>redstone::casper - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-c5d6553a23f1e5a6.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="redstone" data-themes="" data-resource-suffix="" data-rustdoc-version="1.81.0 (eeb90cda1 2024-09-04)" data-channel="1.81.0" data-search-js="search-d234aafac6c221dd.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-d2fab2bf619172d3.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../redstone/index.html">redstone</a><span class="version">2.0.0-pre</span></h2></div><h2 class="location"><a href="#">Module casper</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In crate redstone</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">redstone</a>::<wbr><a class="mod" href="#">casper</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/redstone/casper/mod.rs.html#1-35">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Casper extension</p>
<p>Contains helper implementations of conversion between types used in Casper and this library.
Implementation of the config suited for the casper network.</p>
</div></details><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.CasperRedStoneConfig.html" title="type redstone::casper::CasperRedStoneConfig">CasperRedStoneConfig</a></div></li></ul></section></div></main></body></html>
1 change: 1 addition & 0 deletions static/rust/redstone/casper/sidebar-items.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"type":["CasperRedStoneConfig"]};
1 change: 1 addition & 0 deletions static/rust/redstone/casper/type.CasperRedStoneConfig.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `CasperRedStoneConfig` type in crate `redstone`."><title>CasperRedStoneConfig in redstone::casper - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-c5d6553a23f1e5a6.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="redstone" data-themes="" data-resource-suffix="" data-rustdoc-version="1.81.0 (eeb90cda1 2024-09-04)" data-channel="1.81.0" data-search-js="search-d234aafac6c221dd.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-d2fab2bf619172d3.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc type"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../redstone/index.html">redstone</a><span class="version">2.0.0-pre</span></h2></div><h2 class="location"><a href="#">CasperRedStoneConfig</a></h2><div class="sidebar-elems"><section><h3><a href="#aliased-type">Aliased type</a></h3></section><h2><a href="index.html">In redstone::casper</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Type Alias <a href="../index.html">redstone</a>::<wbr><a href="index.html">casper</a>::<wbr><a class="type" href="#">CasperRedStoneConfig</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/redstone/casper/mod.rs.html#14">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub type CasperRedStoneConfig = <a class="struct" href="../struct.RedStoneConfigImpl.html" title="struct redstone::RedStoneConfigImpl">RedStoneConfigImpl</a>&lt;<a class="struct" href="../default_ext/struct.DefaultCrypto.html" title="struct redstone::default_ext::DefaultCrypto">DefaultCrypto</a>, <a class="struct" href="../network/struct.StdEnv.html" title="struct redstone::network::StdEnv">StdEnv</a>&gt;;</code></pre><h2 id="aliased-type" class="section-header">Aliased Type<a href="#aliased-type" class="anchor">§</a></h2><pre class="rust item-decl"><code>struct CasperRedStoneConfig { <span class="comment">/* private fields */</span> }</code></pre><script src="../../type.impl/redstone/struct.RedStoneConfigImpl.js" data-self-path="redstone::casper::CasperRedStoneConfig" async></script></section></div></main></body></html>
3 changes: 3 additions & 0 deletions static/rust/redstone/contract/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Contract specific logic."><title>redstone::contract - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-c5d6553a23f1e5a6.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="redstone" data-themes="" data-resource-suffix="" data-rustdoc-version="1.81.0 (eeb90cda1 2024-09-04)" data-channel="1.81.0" data-search-js="search-d234aafac6c221dd.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-d2fab2bf619172d3.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../redstone/index.html">redstone</a><span class="version">2.0.0-pre</span></h2></div><h2 class="location"><a href="#">Module contract</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li></ul></section><h2><a href="../index.html">In crate redstone</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">redstone</a>::<wbr><a class="mod" href="#">contract</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/redstone/contract/mod.rs.html#1-5">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Contract specific logic.</p>
<p>Module contains verification logic to be used by on chains programs.</p>
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="verification/index.html" title="mod redstone::contract::verification">verification</a></div><div class="desc docblock-short">Module containing primitives used for verification of the contract data and logic.</div></li></ul></section></div></main></body></html>
1 change: 1 addition & 0 deletions static/rust/redstone/contract/sidebar-items.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"mod":["verification"]};
Loading

0 comments on commit 05e5434

Please sign in to comment.