librustzcash/rustdoc/latest/zcash_keys/encoding/fn.encode_payment_address.html

22 lines
6.1 KiB
HTML

<!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="Writes a `PaymentAddress` as a Bech32-encoded string."><title>encode_payment_address in zcash_keys::encoding - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-0ce1a80b.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="zcash_keys" data-themes="" data-resource-suffix="" data-rustdoc-version="1.89.0-nightly (60dabef95 2025-05-19)" data-channel="nightly" data-search-js="search-f7877310.js" data-settings-js="settings-5514c975.js" ><script src="../../static.files/storage-4e99c027.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-7ef8a74a.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[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="../../zcash_keys/index.html">zcash_<wbr>keys</a><span class="version">0.8.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">encode_<wbr>payment_<wbr>address</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In zcash_<wbr>keys::<wbr>encoding</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">zcash_keys</a>::<wbr><a href="index.html">encoding</a></div><h1>Function <span class="fn">encode_payment_address</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/zcash_keys/encoding.rs.html#323-325">Source</a> </span></div><pre class="rust item-decl"><code>pub fn encode_payment_address(hrp: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, addr: &amp;PaymentAddress) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></pre><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>sapling</code></strong> only.</div></span><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Writes a <a href="sapling::PaymentAddress"><code>PaymentAddress</code></a> as a Bech32-encoded string.</p>
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>group::Group;
<span class="kw">use </span>sapling::{Diversifier, PaymentAddress};
<span class="kw">use </span>zcash_keys::{
encoding::encode_payment_address,
};
<span class="kw">use </span>zcash_protocol::constants::testnet::HRP_SAPLING_PAYMENT_ADDRESS;
<span class="kw">let </span>pa = PaymentAddress::from_bytes(<span class="kw-2">&amp;</span>[
<span class="number">0x00</span>, <span class="number">0x00</span>, <span class="number">0x00</span>, <span class="number">0x00</span>, <span class="number">0x00</span>, <span class="number">0x00</span>, <span class="number">0x00</span>, <span class="number">0x00</span>, <span class="number">0x00</span>, <span class="number">0x00</span>, <span class="number">0x00</span>, <span class="number">0x30</span>, <span class="number">0x8e</span>, <span class="number">0x11</span>,
<span class="number">0x9d</span>, <span class="number">0x72</span>, <span class="number">0x99</span>, <span class="number">0x2b</span>, <span class="number">0x56</span>, <span class="number">0x0d</span>, <span class="number">0x26</span>, <span class="number">0x50</span>, <span class="number">0xff</span>, <span class="number">0xe0</span>, <span class="number">0xbe</span>, <span class="number">0x7f</span>, <span class="number">0x35</span>, <span class="number">0x42</span>,
<span class="number">0xfd</span>, <span class="number">0x97</span>, <span class="number">0x00</span>, <span class="number">0x3c</span>, <span class="number">0xb7</span>, <span class="number">0xcc</span>, <span class="number">0x3a</span>, <span class="number">0xbf</span>, <span class="number">0xf8</span>, <span class="number">0x1a</span>, <span class="number">0x7f</span>, <span class="number">0x90</span>, <span class="number">0x37</span>, <span class="number">0xf3</span>,
<span class="number">0xea</span>,
])
.unwrap();
<span class="macro">assert_eq!</span>(
encode_payment_address(HRP_SAPLING_PAYMENT_ADDRESS, <span class="kw-2">&amp;</span>pa),
<span class="string">"ztestsapling1qqqqqqqqqqqqqqqqqqcguyvaw2vjk4sdyeg0lc970u659lvhqq7t0np6hlup5lusxle75ss7jnk"</span>,
);</code></pre></div>
</div></details></section></div></main></body></html>