Rpc: Add getCirculatingSupply endpoint, redux (#9953)

* Add Bank.clock() helper

* Add non-circulating calculations

* Plumb getSupply rpc endpoint

* Add docs for getSupply, and remove getTotalSupply from docs

* Add pubkeys! procedural macro

* Use procedural macro in non_circulating_supply

sdk/macro/src/lib.rs

@@ -9,8 +9,12 @@ use proc_macro2::Span;
 use quote::{quote, ToTokens};
 use std::convert::TryFrom;
 use syn::{
+    bracketed,
     parse::{Parse, ParseStream, Result},
-    parse_macro_input, Expr, LitByte, LitStr,
+    parse_macro_input,
+    punctuated::Punctuated,
+    token::Bracket,
+    Expr, Ident, LitByte, LitStr, Token,
 };
 
 struct Id(proc_macro2::TokenStream);
@@ -18,21 +22,7 @@ impl Parse for Id {
     fn parse(input: ParseStream) -> Result<Self> {
         let token_stream = if input.peek(syn::LitStr) {
             let id_literal: LitStr = input.parse()?;
-            let id_vec = bs58::decode(id_literal.value())
-                .into_vec()
-                .map_err(|_| syn::Error::new_spanned(&id_literal, "failed to decode base58 id"))?;
-            let id_array = <[u8; 32]>::try_from(<&[u8]>::clone(&&id_vec[..])).map_err(|_| {
-                syn::Error::new_spanned(
-                    &id_literal,
-                    format!("id is not 32 bytes long: len={}", id_vec.len()),
-                )
-            })?;
-            let bytes = id_array.iter().map(|b| LitByte::new(*b, Span::call_site()));
-            quote! {
-                ::solana_sdk::pubkey::Pubkey::new_from_array(
-                    [#(#bytes,)*]
-                )
-            }
+            parse_pubkey(&id_literal)?
         } else {
             let expr: Expr = input.parse()?;
             quote! { #expr }
@@ -75,3 +65,85 @@ pub fn declare_id(input: TokenStream) -> TokenStream {
     let id = parse_macro_input!(input as Id);
     TokenStream::from(quote! {#id})
 }
+
+fn parse_pubkey(id_literal: &LitStr) -> Result<proc_macro2::TokenStream> {
+    let id_vec = bs58::decode(id_literal.value())
+        .into_vec()
+        .map_err(|_| syn::Error::new_spanned(&id_literal, "failed to decode base58 string"))?;
+    let id_array = <[u8; 32]>::try_from(<&[u8]>::clone(&&id_vec[..])).map_err(|_| {
+        syn::Error::new_spanned(
+            &id_literal,
+            format!("pubkey array is not 32 bytes long: len={}", id_vec.len()),
+        )
+    })?;
+    let bytes = id_array.iter().map(|b| LitByte::new(*b, Span::call_site()));
+    Ok(quote! {
+        ::solana_sdk::pubkey::Pubkey::new_from_array(
+            [#(#bytes,)*]
+        )
+    })
+}
+
+struct Pubkeys {
+    method: Ident,
+    num: usize,
+    pubkeys: proc_macro2::TokenStream,
+}
+impl Parse for Pubkeys {
+    fn parse(input: ParseStream) -> Result<Self> {
+        let method = input.parse()?;
+        let _comma: Token![,] = input.parse()?;
+        let (num, pubkeys) = if input.peek(syn::LitStr) {
+            let id_literal: LitStr = input.parse()?;
+            (1, parse_pubkey(&id_literal)?)
+        } else if input.peek(Bracket) {
+            let pubkey_strings;
+            bracketed!(pubkey_strings in input);
+            let punctuated: Punctuated<LitStr, Token![,]> =
+                Punctuated::parse_terminated(&pubkey_strings)?;
+            let mut pubkeys: Punctuated<proc_macro2::TokenStream, Token![,]> = Punctuated::new();
+            for string in punctuated.iter() {
+                pubkeys.push(parse_pubkey(string)?);
+            }
+            (pubkeys.len(), quote! {#pubkeys})
+        } else {
+            let stream: proc_macro2::TokenStream = input.parse()?;
+            return Err(syn::Error::new_spanned(stream, "unexpected token"));
+        };
+
+        Ok(Pubkeys {
+            method,
+            num,
+            pubkeys,
+        })
+    }
+}
+
+impl ToTokens for Pubkeys {
+    fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {
+        let Pubkeys {
+            method,
+            num,
+            pubkeys,
+        } = self;
+        if *num == 1 {
+            tokens.extend(quote! {
+                pub fn #method() -> ::solana_sdk::pubkey::Pubkey {
+                    #pubkeys
+                }
+            });
+        } else {
+            tokens.extend(quote! {
+                pub fn #method() -> ::std::vec::Vec<::solana_sdk::pubkey::Pubkey> {
+                    vec![#pubkeys]
+                }
+            });
+        }
+    }
+}
+
+#[proc_macro]
+pub fn pubkeys(input: TokenStream) -> TokenStream {
+    let pubkeys = parse_macro_input!(input as Pubkeys);
+    TokenStream::from(quote! {#pubkeys})
+}

sdk/src/lib.rs

@@ -57,6 +57,7 @@ pub mod timing;
 /// assert_eq!(id(), my_id);
 /// ```
 pub use solana_sdk_macro::declare_id;
+pub use solana_sdk_macro::pubkeys;
 
 // On-chain program specific modules
 pub mod account_info;