From 58e6a5c2810117e464984418d1f0a664a78e3f7d Mon Sep 17 00:00:00 2001 From: Tyera Eulberg Date: Wed, 17 Jun 2020 19:19:06 -0600 Subject: [PATCH] Add docs to declare_id macro (#10673) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- sdk/macro/src/lib.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/sdk/macro/src/lib.rs b/sdk/macro/src/lib.rs index d1e71165cf..e58d9b4319 100644 --- a/sdk/macro/src/lib.rs +++ b/sdk/macro/src/lib.rs @@ -41,12 +41,15 @@ impl ToTokens for Id { fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) { let id = &self.0; tokens.extend(quote! { + /// The static program ID pub static ID: ::solana_sdk::pubkey::Pubkey = #id; + /// Confirms that a given pubkey is equivalent to the program ID pub fn check_id(id: &::solana_sdk::pubkey::Pubkey) -> bool { id == &ID } + /// Returns the program ID pub fn id() -> ::solana_sdk::pubkey::Pubkey { ID }