Skip to content

Commit

Permalink
Deploy to GitHub pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] authored Feb 7, 2024
0 parents commit ba41668
Show file tree
Hide file tree
Showing 3,939 changed files with 333,503 additions and 0 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
Empty file added .lock
Empty file.
138 changes: 138 additions & 0 deletions bitcoin/address/enum.AddressType.html

Large diffs are not rendered by default.

159 changes: 159 additions & 0 deletions bitcoin/address/enum.Error.html

Large diffs are not rendered by default.

126 changes: 126 additions & 0 deletions bitcoin/address/enum.NetworkChecked.html

Large diffs are not rendered by default.

126 changes: 126 additions & 0 deletions bitcoin/address/enum.NetworkUnchecked.html

Large diffs are not rendered by default.

151 changes: 151 additions & 0 deletions bitcoin/address/enum.Payload.html

Large diffs are not rendered by default.

208 changes: 208 additions & 0 deletions bitcoin/address/enum.WitnessVersion.html

Large diffs are not rendered by default.

18 changes: 18 additions & 0 deletions bitcoin/address/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!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="Bitcoin addresses."><title>bitcoin::address - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-e5308b57e507db71.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../static.files/light-d59023bfa12059d2.css"><link rel="stylesheet" disabled href="../../static.files/dark-1ca41bb1e10af075.css"><link rel="stylesheet" disabled href="../../static.files/ayu-18b4181a2f3fb862.css"><script src="../../static.files/storage-3891ce972e3a2bf8.js"></script><script defer src="../../static.files/main-98a684e84ae5b08b.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><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">&#9776;</button><a class="logo-container" href="../../bitcoin/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../../bitcoin/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Module address</a></h2><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></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">bitcoin</a>::<wbr><a class="mod" href="#">address</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><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>Bitcoin addresses.</p>
<p>Support for ordinary base58 Bitcoin addresses and private keys.</p>
<h2 id="example-creating-a-new-address-from-a-randomly-generated-key-pair"><a href="#example-creating-a-new-address-from-a-randomly-generated-key-pair">Example: creating a new address from a randomly-generated key pair</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>bitcoin::{Address, PublicKey, Network};
<span class="kw">use </span>bitcoin::secp256k1::{rand, Secp256k1};

<span class="comment">// Generate random key pair.
</span><span class="kw">let </span>s = Secp256k1::new();
<span class="kw">let </span>public_key = PublicKey::new(s.generate_keypair(<span class="kw-2">&amp;mut </span>rand::thread_rng()).<span class="number">1</span>);

<span class="comment">// Generate pay-to-pubkey-hash address.
</span><span class="kw">let </span>address = Address::p2pkh(<span class="kw-2">&amp;</span>public_key, Network::Bitcoin);</code></pre></div>
<h2 id="note-creating-a-new-address-requires-the-rand-std-feature-flag"><a href="#note-creating-a-new-address-requires-the-rand-std-feature-flag">Note: creating a new address requires the rand-std feature flag</a></h2><div class="example-wrap"><pre class="language-toml"><code>bitcoin = { version = &quot;...&quot;, features = [&quot;rand-std&quot;] }
</code></pre></div></div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Address.html" title="struct bitcoin::address::Address">Address</a></div><div class="desc docblock-short">A Bitcoin address.</div></li><li><div class="item-name"><a class="struct" href="struct.AddressEncoding.html" title="struct bitcoin::address::AddressEncoding">AddressEncoding</a></div><div class="desc docblock-short">A utility struct to encode an address payload with the given parameters.
This is a low-level utility struct. Consider using <code>Address</code> instead.</div></li><li><div class="item-name"><a class="struct" href="struct.WitnessProgram.html" title="struct bitcoin::address::WitnessProgram">WitnessProgram</a></div><div class="desc docblock-short">Witness program as defined in BIP141.</div></li></ul><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.AddressType.html" title="enum bitcoin::address::AddressType">AddressType</a></div><div class="desc docblock-short">The different types of addresses.</div></li><li><div class="item-name"><a class="enum" href="enum.Error.html" title="enum bitcoin::address::Error">Error</a></div><div class="desc docblock-short">Address error.</div></li><li><div class="item-name"><a class="enum" href="enum.NetworkChecked.html" title="enum bitcoin::address::NetworkChecked">NetworkChecked</a></div><div class="desc docblock-short">Marker that address’s network has been successfully validated. See section <a href="../struct.Address.html#parsing-addresses" title="struct bitcoin::Address"><em>Parsing addresses</em></a>
on <a href="../struct.Address.html" title="struct bitcoin::Address"><code>Address</code></a> for details.</div></li><li><div class="item-name"><a class="enum" href="enum.NetworkUnchecked.html" title="enum bitcoin::address::NetworkUnchecked">NetworkUnchecked</a></div><div class="desc docblock-short">Marker that address’s network has not yet been validated. See section <a href="../struct.Address.html#parsing-addresses" title="struct bitcoin::Address"><em>Parsing addresses</em></a>
on <a href="../struct.Address.html" title="struct bitcoin::Address"><code>Address</code></a> for details.</div></li><li><div class="item-name"><a class="enum" href="enum.Payload.html" title="enum bitcoin::address::Payload">Payload</a></div><div class="desc docblock-short">The method used to produce an address.</div></li><li><div class="item-name"><a class="enum" href="enum.WitnessVersion.html" title="enum bitcoin::address::WitnessVersion">WitnessVersion</a></div><div class="desc docblock-short">Version of the witness program.</div></li></ul><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.NetworkValidation.html" title="trait bitcoin::address::NetworkValidation">NetworkValidation</a></div><div class="desc docblock-short">Marker of status of address’s network validation. See section <a href="../struct.Address.html#parsing-addresses" title="struct bitcoin::Address"><em>Parsing addresses</em></a>
on <a href="../struct.Address.html" title="struct bitcoin::Address"><code>Address</code></a> for details.</div></li></ul></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bitcoin" data-themes="" data-resource-suffix="" data-rustdoc-version="1.69.0-nightly (31f858d9a 2023-02-28)" data-search-js="search-d5a6cd8418084717.js" data-settings-js="settings-f0c5c39777a9a2f6.js" data-settings-css="settings-0bcba95ff279c1db.css" ></div></body></html>
1 change: 1 addition & 0 deletions bitcoin/address/sidebar-items.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit ba41668

Please sign in to comment.