solana_sdk/signer/
signers.rs

1#![cfg(feature = "full")]
2
3use crate::{
4    pubkey::Pubkey,
5    signature::{Signature, Signer, SignerError},
6};
7
8/// Convenience trait for working with mixed collections of `Signer`s
9pub trait Signers {
10    fn pubkeys(&self) -> Vec<Pubkey>;
11    fn try_pubkeys(&self) -> Result<Vec<Pubkey>, SignerError>;
12    fn sign_message(&self, message: &[u8]) -> Vec<Signature>;
13    fn try_sign_message(&self, message: &[u8]) -> Result<Vec<Signature>, SignerError>;
14    fn is_interactive(&self) -> bool;
15}
16
17/// Any `T` where `T` impls `IntoIterator` yielding
18/// `Signer`s implements `Signers`.
19///
20/// This includes `[&dyn Signer]`, `[Box<dyn Signer>]`,
21/// `[&dyn Signer; N]`, `Vec<dyn Signer>`, `Vec<Keypair>`, etc.
22///
23/// When used as a generic function param, `&T`
24/// should be used instead of `T` where T: Signers, due to the `?Sized` bounds on T.
25/// E.g. [Signer] implements `Signers`, but `&[Signer]` does not
26impl<T: ?Sized, S: Signer + ?Sized> Signers for T
27where
28    for<'a> &'a T: IntoIterator<Item = &'a S>,
29{
30    fn pubkeys(&self) -> Vec<Pubkey> {
31        self.into_iter().map(|keypair| keypair.pubkey()).collect()
32    }
33
34    fn try_pubkeys(&self) -> Result<Vec<Pubkey>, SignerError> {
35        self.into_iter()
36            .map(|keypair| keypair.try_pubkey())
37            .collect()
38    }
39
40    fn sign_message(&self, message: &[u8]) -> Vec<Signature> {
41        self.into_iter()
42            .map(|keypair| keypair.sign_message(message))
43            .collect()
44    }
45
46    fn try_sign_message(&self, message: &[u8]) -> Result<Vec<Signature>, SignerError> {
47        self.into_iter()
48            .map(|keypair| keypair.try_sign_message(message))
49            .collect()
50    }
51
52    fn is_interactive(&self) -> bool {
53        self.into_iter().any(|s| s.is_interactive())
54    }
55}
56
57#[cfg(test)]
58mod tests {
59    use super::*;
60
61    struct Foo;
62    impl Signer for Foo {
63        fn try_pubkey(&self) -> Result<Pubkey, SignerError> {
64            Ok(Pubkey::default())
65        }
66        fn try_sign_message(&self, _message: &[u8]) -> Result<Signature, SignerError> {
67            Ok(Signature::default())
68        }
69        fn is_interactive(&self) -> bool {
70            false
71        }
72    }
73
74    struct Bar;
75    impl Signer for Bar {
76        fn try_pubkey(&self) -> Result<Pubkey, SignerError> {
77            Ok(Pubkey::default())
78        }
79        fn try_sign_message(&self, _message: &[u8]) -> Result<Signature, SignerError> {
80            Ok(Signature::default())
81        }
82        fn is_interactive(&self) -> bool {
83            false
84        }
85    }
86
87    #[test]
88    fn test_dyn_keypairs_compile() {
89        let xs: Vec<Box<dyn Signer>> = vec![Box::new(Foo {}), Box::new(Bar {})];
90        assert_eq!(
91            xs.sign_message(b""),
92            vec![Signature::default(), Signature::default()],
93        );
94
95        // Same as above, but less compiler magic.
96        let xs_ref: &[Box<dyn Signer>] = &xs;
97        assert_eq!(
98            Signers::sign_message(xs_ref, b""),
99            vec![Signature::default(), Signature::default()],
100        );
101    }
102
103    #[test]
104    fn test_dyn_keypairs_by_ref_compile() {
105        let foo = Foo {};
106        let bar = Bar {};
107        let xs: Vec<&dyn Signer> = vec![&foo, &bar];
108        assert_eq!(
109            xs.sign_message(b""),
110            vec![Signature::default(), Signature::default()],
111        );
112
113        // Same as above, but less compiler magic.
114        let xs_ref: &[&dyn Signer] = &xs;
115        assert_eq!(
116            Signers::sign_message(xs_ref, b""),
117            vec![Signature::default(), Signature::default()],
118        );
119    }
120}
solana_sdk/signer/signers.rs

solana_sdk/signer/
signers.rs
