From 1c2564fc0896035d5b7b520516abe805859b9932 Mon Sep 17 00:00:00 2001
From: Jeff Barg <jeffbarg94@gmail.com>
Date: Sat, 29 Sep 2018 17:00:37 -0400
Subject: [PATCH] Added example for creating an address from a public key

Added an example to the address rustdoc (addresses https://github.com/rust-bitcoin/rust-bitcoin/issues/160)
---
 src/util/address.rs | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/src/util/address.rs b/src/util/address.rs
index ee6f6d74..5834280c 100644
--- a/src/util/address.rs
+++ b/src/util/address.rs
@@ -15,6 +15,37 @@
 //!
 //! Support for ordinary base58 Bitcoin addresses and private keys
 //!
+//! # Example: creating a new address from a randomly-generated key pair
+//!
+//! ```rust
+//! extern crate rand;
+//! extern crate secp256k1;
+//! extern crate bitcoin;
+//! 
+//! use bitcoin::network::constants::Network;
+//! use bitcoin::util::address::Payload;
+//! use bitcoin::util::address::Address;
+//! use secp256k1::Secp256k1;
+//! use secp256k1::key::PublicKey;
+//! use rand::thread_rng;
+//! 
+//! fn main() {
+//!     let network = Network::Bitcoin;
+//! 
+//!     // Generate random key pair
+//!     let s = Secp256k1::new();
+//!     let (secret_key, public_key) = s.generate_keypair(&mut thread_rng());
+//! 
+//!     // Generate pay-to-pubkey address
+//!     let address = Address::p2pk(&public_key, network);
+//! 
+//!     // Check address payload is public key given
+//!     assert_eq!(address.payload, Payload::Pubkey(public_key));
+//! 
+//!     // Check address can be unlocked by secret_key
+//!     assert_eq!(address.payload, Payload::Pubkey(PublicKey::from_secret_key(&s, &secret_key)));
+//! }
+//! ```
 
 use std::fmt::{self, Display, Formatter};
 use std::str::FromStr;