2019-12-16 13:05:17 -08:00
|
|
|
//! The `faucet` module provides an object for launching a Solana Faucet,
|
2019-03-05 16:28:14 -08:00
|
|
|
//! which is the custodian of any remaining lamports in a mint.
|
2021-04-06 00:01:05 -07:00
|
|
|
//! The Solana Faucet builds and sends airdrop transactions,
|
|
|
|
//! checking requests against a single-request cap and a per-IP limit
|
|
|
|
//! for a given time time_slice.
|
|
|
|
|
|
|
|
use {
|
|
|
|
bincode::{deserialize, serialize, serialized_size},
|
|
|
|
byteorder::{ByteOrder, LittleEndian},
|
2022-01-11 02:44:46 -08:00
|
|
|
crossbeam_channel::{unbounded, Sender},
|
2021-04-06 00:01:05 -07:00
|
|
|
log::*,
|
|
|
|
serde_derive::{Deserialize, Serialize},
|
|
|
|
solana_metrics::datapoint_info,
|
|
|
|
solana_sdk::{
|
|
|
|
hash::Hash,
|
|
|
|
instruction::Instruction,
|
|
|
|
message::Message,
|
|
|
|
native_token::lamports_to_sol,
|
|
|
|
packet::PACKET_DATA_SIZE,
|
|
|
|
pubkey::Pubkey,
|
|
|
|
signature::{Keypair, Signer},
|
|
|
|
system_instruction,
|
|
|
|
transaction::Transaction,
|
|
|
|
},
|
|
|
|
std::{
|
2021-04-27 18:31:32 -07:00
|
|
|
collections::{HashMap, HashSet},
|
2021-04-06 00:01:05 -07:00
|
|
|
io::{Read, Write},
|
|
|
|
net::{IpAddr, Ipv4Addr, SocketAddr, TcpStream},
|
2022-01-11 02:44:46 -08:00
|
|
|
sync::{Arc, Mutex},
|
2021-04-06 00:01:05 -07:00
|
|
|
thread,
|
|
|
|
time::Duration,
|
|
|
|
},
|
|
|
|
thiserror::Error,
|
|
|
|
tokio::{
|
|
|
|
io::{AsyncReadExt, AsyncWriteExt},
|
|
|
|
net::{TcpListener, TcpStream as TokioTcpStream},
|
|
|
|
runtime::Runtime,
|
|
|
|
},
|
2019-12-16 13:05:17 -08:00
|
|
|
};
|
2018-11-16 08:04:46 -08:00
|
|
|
|
|
|
|
#[macro_export]
|
|
|
|
macro_rules! socketaddr {
|
|
|
|
($ip:expr, $port:expr) => {
|
|
|
|
SocketAddr::from((Ipv4Addr::from($ip), $port))
|
|
|
|
};
|
|
|
|
($str:expr) => {{
|
|
|
|
let a: SocketAddr = $str.parse().unwrap();
|
|
|
|
a
|
|
|
|
}};
|
|
|
|
}
|
2018-06-19 21:39:53 -07:00
|
|
|
|
2021-04-06 00:01:05 -07:00
|
|
|
const ERROR_RESPONSE: [u8; 2] = 0u16.to_le_bytes();
|
|
|
|
|
2018-06-19 23:51:04 -07:00
|
|
|
pub const TIME_SLICE: u64 = 60;
|
2019-12-16 13:05:17 -08:00
|
|
|
pub const FAUCET_PORT: u16 = 9900;
|
|
|
|
pub const FAUCET_PORT_STR: &str = "9900";
|
2018-06-19 21:39:53 -07:00
|
|
|
|
2021-04-06 00:01:05 -07:00
|
|
|
#[derive(Error, Debug)]
|
|
|
|
pub enum FaucetError {
|
|
|
|
#[error("IO Error: {0}")]
|
|
|
|
IoError(#[from] std::io::Error),
|
|
|
|
|
|
|
|
#[error("serialization error: {0}")]
|
|
|
|
Serialize(#[from] bincode::Error),
|
|
|
|
|
|
|
|
#[error("transaction_length from faucet exceeds limit: {0}")]
|
|
|
|
TransactionDataTooLarge(usize),
|
|
|
|
|
|
|
|
#[error("transaction_length from faucet: 0")]
|
|
|
|
NoDataReceived,
|
|
|
|
|
|
|
|
#[error("request too large; req: ◎{0}, cap: ◎{1}")]
|
|
|
|
PerRequestCapExceeded(f64, f64),
|
|
|
|
|
2021-04-12 12:59:38 -07:00
|
|
|
#[error("limit reached; req: ◎{0}, to: {1}, current: ◎{2}, cap: ◎{3}")]
|
|
|
|
PerTimeCapExceeded(f64, String, f64, f64),
|
2021-04-06 00:01:05 -07:00
|
|
|
}
|
|
|
|
|
2018-07-11 20:10:25 -07:00
|
|
|
#[derive(Serialize, Deserialize, Debug, Clone, Copy)]
|
2019-12-16 13:05:17 -08:00
|
|
|
pub enum FaucetRequest {
|
2018-06-19 23:51:04 -07:00
|
|
|
GetAirdrop {
|
2019-03-05 16:28:14 -08:00
|
|
|
lamports: u64,
|
2018-11-14 18:57:34 -08:00
|
|
|
to: Pubkey,
|
2019-03-02 10:25:16 -08:00
|
|
|
blockhash: Hash,
|
2018-06-19 23:51:04 -07:00
|
|
|
},
|
2018-06-19 21:39:53 -07:00
|
|
|
}
|
|
|
|
|
2021-04-06 00:01:05 -07:00
|
|
|
pub enum FaucetTransaction {
|
|
|
|
Airdrop(Transaction),
|
|
|
|
Memo((Transaction, String)),
|
|
|
|
}
|
|
|
|
|
2019-12-16 13:05:17 -08:00
|
|
|
pub struct Faucet {
|
2020-11-16 08:43:07 -08:00
|
|
|
faucet_keypair: Keypair,
|
2021-04-06 00:01:05 -07:00
|
|
|
ip_cache: HashMap<IpAddr, u64>,
|
2021-04-12 12:59:38 -07:00
|
|
|
address_cache: HashMap<Pubkey, u64>,
|
2018-06-19 23:51:04 -07:00
|
|
|
pub time_slice: Duration,
|
2021-04-06 00:01:05 -07:00
|
|
|
per_time_cap: Option<u64>,
|
2020-08-17 16:33:14 -07:00
|
|
|
per_request_cap: Option<u64>,
|
2021-04-27 18:31:32 -07:00
|
|
|
allowed_ips: HashSet<IpAddr>,
|
2018-06-19 21:39:53 -07:00
|
|
|
}
|
|
|
|
|
2019-12-16 13:05:17 -08:00
|
|
|
impl Faucet {
|
2018-06-19 21:39:53 -07:00
|
|
|
pub fn new(
|
2020-11-16 08:43:07 -08:00
|
|
|
faucet_keypair: Keypair,
|
2018-06-19 21:39:53 -07:00
|
|
|
time_input: Option<u64>,
|
2020-08-17 16:33:14 -07:00
|
|
|
per_time_cap: Option<u64>,
|
|
|
|
per_request_cap: Option<u64>,
|
2021-04-27 18:31:32 -07:00
|
|
|
) -> Self {
|
|
|
|
Self::new_with_allowed_ips(
|
|
|
|
faucet_keypair,
|
|
|
|
time_input,
|
|
|
|
per_time_cap,
|
|
|
|
per_request_cap,
|
|
|
|
HashSet::new(),
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn new_with_allowed_ips(
|
|
|
|
faucet_keypair: Keypair,
|
|
|
|
time_input: Option<u64>,
|
|
|
|
per_time_cap: Option<u64>,
|
|
|
|
per_request_cap: Option<u64>,
|
|
|
|
allowed_ips: HashSet<IpAddr>,
|
|
|
|
) -> Self {
|
2020-08-17 16:33:14 -07:00
|
|
|
let time_slice = Duration::new(time_input.unwrap_or(TIME_SLICE), 0);
|
2021-04-06 00:01:05 -07:00
|
|
|
if let Some((per_request_cap, per_time_cap)) = per_request_cap.zip(per_time_cap) {
|
|
|
|
if per_time_cap < per_request_cap {
|
|
|
|
warn!(
|
2021-04-12 12:59:38 -07:00
|
|
|
"per_time_cap {} SOL < per_request_cap {} SOL; \
|
2021-04-06 00:01:05 -07:00
|
|
|
maximum single requests will fail",
|
|
|
|
lamports_to_sol(per_time_cap),
|
|
|
|
lamports_to_sol(per_request_cap),
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|
2021-04-27 18:31:32 -07:00
|
|
|
Self {
|
2020-11-16 08:43:07 -08:00
|
|
|
faucet_keypair,
|
2021-04-06 00:01:05 -07:00
|
|
|
ip_cache: HashMap::new(),
|
2021-04-12 12:59:38 -07:00
|
|
|
address_cache: HashMap::new(),
|
2018-06-19 21:39:53 -07:00
|
|
|
time_slice,
|
2020-08-17 16:33:14 -07:00
|
|
|
per_time_cap,
|
|
|
|
per_request_cap,
|
2021-04-27 18:31:32 -07:00
|
|
|
allowed_ips,
|
2018-06-19 21:39:53 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-04-12 12:59:38 -07:00
|
|
|
pub fn check_time_request_limit<T: LimitByTime + std::fmt::Display>(
|
2021-04-06 00:01:05 -07:00
|
|
|
&mut self,
|
|
|
|
request_amount: u64,
|
2021-04-12 12:59:38 -07:00
|
|
|
to: T,
|
2021-04-06 00:01:05 -07:00
|
|
|
) -> Result<(), FaucetError> {
|
2021-04-12 12:59:38 -07:00
|
|
|
let new_total = to.check_cache(self, request_amount);
|
|
|
|
to.datapoint_info(request_amount, new_total);
|
2021-04-06 00:01:05 -07:00
|
|
|
if let Some(cap) = self.per_time_cap {
|
2021-04-12 12:59:38 -07:00
|
|
|
if new_total > cap {
|
2021-04-06 00:01:05 -07:00
|
|
|
return Err(FaucetError::PerTimeCapExceeded(
|
|
|
|
lamports_to_sol(request_amount),
|
2021-04-12 12:59:38 -07:00
|
|
|
to.to_string(),
|
|
|
|
lamports_to_sol(new_total),
|
2021-04-06 00:01:05 -07:00
|
|
|
lamports_to_sol(cap),
|
|
|
|
));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
Ok(())
|
2018-06-19 21:39:53 -07:00
|
|
|
}
|
|
|
|
|
2021-04-12 12:59:38 -07:00
|
|
|
pub fn clear_caches(&mut self) {
|
2018-06-19 21:39:53 -07:00
|
|
|
self.ip_cache.clear();
|
2021-04-12 12:59:38 -07:00
|
|
|
self.address_cache.clear();
|
2018-06-19 21:39:53 -07:00
|
|
|
}
|
|
|
|
|
2021-04-06 00:01:05 -07:00
|
|
|
/// Checks per-request and per-time-ip limits; if both pass, this method returns a signed
|
|
|
|
/// SystemProgram::Transfer transaction from the faucet keypair to the requested recipient. If
|
|
|
|
/// the request exceeds this per-request limit, this method returns a signed SPL Memo
|
|
|
|
/// transaction with the memo: "request too large; req: <REQUEST> SOL cap: <CAP> SOL"
|
2018-11-14 18:57:34 -08:00
|
|
|
pub fn build_airdrop_transaction(
|
|
|
|
&mut self,
|
2019-12-16 13:05:17 -08:00
|
|
|
req: FaucetRequest,
|
2021-04-06 00:01:05 -07:00
|
|
|
ip: IpAddr,
|
|
|
|
) -> Result<FaucetTransaction, FaucetError> {
|
2018-11-14 18:57:34 -08:00
|
|
|
trace!("build_airdrop_transaction: {:?}", req);
|
|
|
|
match req {
|
2019-12-16 13:05:17 -08:00
|
|
|
FaucetRequest::GetAirdrop {
|
2019-03-05 16:28:14 -08:00
|
|
|
lamports,
|
2018-11-14 18:57:34 -08:00
|
|
|
to,
|
2019-03-02 10:25:16 -08:00
|
|
|
blockhash,
|
2018-06-21 22:11:24 -07:00
|
|
|
} => {
|
2021-04-06 00:01:05 -07:00
|
|
|
let mint_pubkey = self.faucet_keypair.pubkey();
|
|
|
|
info!(
|
|
|
|
"Requesting airdrop of {} SOL to {:?}",
|
|
|
|
lamports_to_sol(lamports),
|
|
|
|
to
|
|
|
|
);
|
|
|
|
|
2020-08-17 16:33:14 -07:00
|
|
|
if let Some(cap) = self.per_request_cap {
|
|
|
|
if lamports > cap {
|
2021-04-06 00:01:05 -07:00
|
|
|
let memo = format!(
|
|
|
|
"{}",
|
|
|
|
FaucetError::PerRequestCapExceeded(
|
|
|
|
lamports_to_sol(lamports),
|
|
|
|
lamports_to_sol(cap),
|
|
|
|
)
|
|
|
|
);
|
|
|
|
let memo_instruction = Instruction {
|
|
|
|
program_id: Pubkey::new(&spl_memo::id().to_bytes()),
|
|
|
|
accounts: vec![],
|
|
|
|
data: memo.as_bytes().to_vec(),
|
|
|
|
};
|
|
|
|
let message = Message::new(&[memo_instruction], Some(&mint_pubkey));
|
|
|
|
return Ok(FaucetTransaction::Memo((
|
|
|
|
Transaction::new(&[&self.faucet_keypair], message, blockhash),
|
|
|
|
memo,
|
|
|
|
)));
|
2020-08-17 16:33:14 -07:00
|
|
|
}
|
|
|
|
}
|
2021-04-27 18:31:32 -07:00
|
|
|
if !ip.is_loopback() && !self.allowed_ips.contains(&ip) {
|
2021-04-12 12:59:38 -07:00
|
|
|
self.check_time_request_limit(lamports, ip)?;
|
|
|
|
}
|
|
|
|
self.check_time_request_limit(lamports, to)?;
|
2021-04-06 00:01:05 -07:00
|
|
|
|
|
|
|
let transfer_instruction =
|
|
|
|
system_instruction::transfer(&mint_pubkey, &to, lamports);
|
|
|
|
let message = Message::new(&[transfer_instruction], Some(&mint_pubkey));
|
|
|
|
Ok(FaucetTransaction::Airdrop(Transaction::new(
|
|
|
|
&[&self.faucet_keypair],
|
|
|
|
message,
|
|
|
|
blockhash,
|
|
|
|
)))
|
2018-06-19 21:39:53 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2021-04-06 00:01:05 -07:00
|
|
|
|
|
|
|
/// Deserializes a received airdrop request, and returns a serialized transaction
|
|
|
|
pub fn process_faucet_request(
|
|
|
|
&mut self,
|
|
|
|
bytes: &[u8],
|
|
|
|
ip: IpAddr,
|
|
|
|
) -> Result<Vec<u8>, FaucetError> {
|
|
|
|
let req: FaucetRequest = deserialize(bytes)?;
|
2019-01-17 14:18:20 -08:00
|
|
|
|
|
|
|
info!("Airdrop transaction requested...{:?}", req);
|
2021-04-06 00:01:05 -07:00
|
|
|
let res = self.build_airdrop_transaction(req, ip);
|
2019-01-17 14:18:20 -08:00
|
|
|
match res {
|
|
|
|
Ok(tx) => {
|
2021-04-06 00:01:05 -07:00
|
|
|
let tx = match tx {
|
|
|
|
FaucetTransaction::Airdrop(tx) => {
|
|
|
|
info!("Airdrop transaction granted");
|
|
|
|
tx
|
|
|
|
}
|
|
|
|
FaucetTransaction::Memo((tx, memo)) => {
|
|
|
|
warn!("Memo transaction returned: {}", memo);
|
|
|
|
tx
|
|
|
|
}
|
|
|
|
};
|
|
|
|
let response_vec = bincode::serialize(&tx)?;
|
2019-01-17 14:18:20 -08:00
|
|
|
|
|
|
|
let mut response_vec_with_length = vec![0; 2];
|
|
|
|
LittleEndian::write_u16(&mut response_vec_with_length, response_vec.len() as u16);
|
|
|
|
response_vec_with_length.extend_from_slice(&response_vec);
|
|
|
|
|
2020-12-29 19:51:01 -08:00
|
|
|
Ok(response_vec_with_length)
|
2019-01-17 14:18:20 -08:00
|
|
|
}
|
|
|
|
Err(err) => {
|
2021-04-06 00:01:05 -07:00
|
|
|
warn!("Airdrop transaction failed: {}", err);
|
2019-01-17 14:18:20 -08:00
|
|
|
Err(err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2018-06-19 21:39:53 -07:00
|
|
|
}
|
|
|
|
|
2019-12-16 13:05:17 -08:00
|
|
|
impl Drop for Faucet {
|
2018-07-05 21:40:09 -07:00
|
|
|
fn drop(&mut self) {
|
2018-11-16 08:45:59 -08:00
|
|
|
solana_metrics::flush();
|
2018-07-05 21:40:09 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-11-14 18:57:34 -08:00
|
|
|
pub fn request_airdrop_transaction(
|
2019-12-16 13:05:17 -08:00
|
|
|
faucet_addr: &SocketAddr,
|
2018-11-14 18:57:34 -08:00
|
|
|
id: &Pubkey,
|
2019-03-05 16:28:14 -08:00
|
|
|
lamports: u64,
|
2019-03-02 10:25:16 -08:00
|
|
|
blockhash: Hash,
|
2021-04-06 00:01:05 -07:00
|
|
|
) -> Result<Transaction, FaucetError> {
|
2019-01-04 17:20:51 -08:00
|
|
|
info!(
|
2019-12-16 13:05:17 -08:00
|
|
|
"request_airdrop_transaction: faucet_addr={} id={} lamports={} blockhash={}",
|
|
|
|
faucet_addr, id, lamports, blockhash
|
2019-01-04 17:20:51 -08:00
|
|
|
);
|
2019-11-13 08:43:15 -08:00
|
|
|
|
2019-12-16 13:05:17 -08:00
|
|
|
let mut stream = TcpStream::connect_timeout(faucet_addr, Duration::new(3, 0))?;
|
2018-11-14 18:57:34 -08:00
|
|
|
stream.set_read_timeout(Some(Duration::new(10, 0)))?;
|
2019-12-16 13:05:17 -08:00
|
|
|
let req = FaucetRequest::GetAirdrop {
|
2019-03-05 16:28:14 -08:00
|
|
|
lamports,
|
2019-03-02 10:25:16 -08:00
|
|
|
blockhash,
|
2018-11-14 18:57:34 -08:00
|
|
|
to: *id,
|
|
|
|
};
|
2019-12-16 13:05:17 -08:00
|
|
|
let req = serialize(&req).expect("serialize faucet request");
|
2018-11-14 18:57:34 -08:00
|
|
|
stream.write_all(&req)?;
|
|
|
|
|
|
|
|
// Read length of transaction
|
|
|
|
let mut buffer = [0; 2];
|
2020-09-14 16:19:28 -07:00
|
|
|
stream.read_exact(&mut buffer).map_err(|err| {
|
2018-11-14 18:57:34 -08:00
|
|
|
info!(
|
|
|
|
"request_airdrop_transaction: buffer length read_exact error: {:?}",
|
|
|
|
err
|
|
|
|
);
|
2021-04-06 00:01:05 -07:00
|
|
|
err
|
2018-11-14 18:57:34 -08:00
|
|
|
})?;
|
|
|
|
let transaction_length = LittleEndian::read_u16(&buffer) as usize;
|
2021-04-06 00:01:05 -07:00
|
|
|
if transaction_length > PACKET_DATA_SIZE {
|
|
|
|
return Err(FaucetError::TransactionDataTooLarge(transaction_length));
|
|
|
|
} else if transaction_length == 0 {
|
|
|
|
return Err(FaucetError::NoDataReceived);
|
2018-11-14 18:57:34 -08:00
|
|
|
}
|
|
|
|
|
|
|
|
// Read the transaction
|
|
|
|
let mut buffer = Vec::new();
|
|
|
|
buffer.resize(transaction_length, 0);
|
2020-06-08 17:38:14 -07:00
|
|
|
stream.read_exact(&mut buffer).map_err(|err| {
|
2018-11-14 18:57:34 -08:00
|
|
|
info!(
|
|
|
|
"request_airdrop_transaction: buffer read_exact error: {:?}",
|
|
|
|
err
|
|
|
|
);
|
2021-04-06 00:01:05 -07:00
|
|
|
err
|
2018-11-14 18:57:34 -08:00
|
|
|
})?;
|
|
|
|
|
2021-04-06 00:01:05 -07:00
|
|
|
let transaction: Transaction = deserialize(&buffer)?;
|
2018-11-14 18:57:34 -08:00
|
|
|
Ok(transaction)
|
|
|
|
}
|
|
|
|
|
2020-12-11 20:03:15 -08:00
|
|
|
pub fn run_local_faucet_with_port(
|
2020-11-16 08:43:07 -08:00
|
|
|
faucet_keypair: Keypair,
|
2021-01-28 12:11:53 -08:00
|
|
|
sender: Sender<Result<SocketAddr, String>>,
|
2020-08-17 16:33:14 -07:00
|
|
|
per_time_cap: Option<u64>,
|
2021-01-28 12:11:53 -08:00
|
|
|
port: u16, // 0 => auto assign
|
2019-04-08 12:37:01 -07:00
|
|
|
) {
|
2018-09-14 01:58:59 -07:00
|
|
|
thread::spawn(move || {
|
2020-12-11 20:03:15 -08:00
|
|
|
let faucet_addr = socketaddr!(0, port);
|
2019-12-16 13:05:17 -08:00
|
|
|
let faucet = Arc::new(Mutex::new(Faucet::new(
|
2020-11-16 08:43:07 -08:00
|
|
|
faucet_keypair,
|
2019-04-08 12:37:01 -07:00
|
|
|
None,
|
2020-08-17 16:33:14 -07:00
|
|
|
per_time_cap,
|
|
|
|
None,
|
2019-04-08 12:37:01 -07:00
|
|
|
)));
|
2020-12-29 19:51:01 -08:00
|
|
|
let runtime = Runtime::new().unwrap();
|
|
|
|
runtime.block_on(run_faucet(faucet, faucet_addr, Some(sender)));
|
2019-04-18 18:06:56 -07:00
|
|
|
});
|
|
|
|
}
|
|
|
|
|
2020-12-11 20:03:15 -08:00
|
|
|
// For integration tests. Listens on random open port and reports port to Sender.
|
2021-01-28 12:11:53 -08:00
|
|
|
pub fn run_local_faucet(faucet_keypair: Keypair, per_time_cap: Option<u64>) -> SocketAddr {
|
2022-01-11 02:44:46 -08:00
|
|
|
let (sender, receiver) = unbounded();
|
2021-01-28 12:11:53 -08:00
|
|
|
run_local_faucet_with_port(faucet_keypair, sender, per_time_cap, 0);
|
|
|
|
receiver
|
|
|
|
.recv()
|
|
|
|
.expect("run_local_faucet")
|
|
|
|
.expect("faucet_addr")
|
2020-12-11 20:03:15 -08:00
|
|
|
}
|
|
|
|
|
2020-12-29 19:51:01 -08:00
|
|
|
pub async fn run_faucet(
|
2019-12-16 13:05:17 -08:00
|
|
|
faucet: Arc<Mutex<Faucet>>,
|
|
|
|
faucet_addr: SocketAddr,
|
2021-01-28 12:11:53 -08:00
|
|
|
sender: Option<Sender<Result<SocketAddr, String>>>,
|
2019-04-18 18:06:56 -07:00
|
|
|
) {
|
2021-01-28 12:11:53 -08:00
|
|
|
let listener = TcpListener::bind(&faucet_addr).await;
|
|
|
|
if let Some(sender) = sender {
|
|
|
|
sender.send(
|
|
|
|
listener.as_ref().map(|listener| listener.local_addr().unwrap())
|
|
|
|
.map_err(|err| {
|
|
|
|
format!(
|
|
|
|
"Unable to bind faucet to {:?}, check the address is not already in use: {}",
|
|
|
|
faucet_addr, err
|
|
|
|
)
|
|
|
|
})
|
|
|
|
)
|
|
|
|
.unwrap();
|
2019-04-18 18:06:56 -07:00
|
|
|
}
|
2021-01-28 12:11:53 -08:00
|
|
|
|
|
|
|
let listener = match listener {
|
|
|
|
Err(err) => {
|
|
|
|
error!("Faucet failed to start: {}", err);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
Ok(listener) => listener,
|
|
|
|
};
|
2019-12-16 13:05:17 -08:00
|
|
|
info!("Faucet started. Listening on: {}", faucet_addr);
|
2020-11-16 08:43:07 -08:00
|
|
|
info!(
|
|
|
|
"Faucet account address: {}",
|
|
|
|
faucet.lock().unwrap().faucet_keypair.pubkey()
|
|
|
|
);
|
|
|
|
|
2020-12-29 19:51:01 -08:00
|
|
|
loop {
|
|
|
|
let _faucet = faucet.clone();
|
|
|
|
match listener.accept().await {
|
|
|
|
Ok((stream, _)) => {
|
|
|
|
tokio::spawn(async move {
|
|
|
|
if let Err(e) = process(stream, _faucet).await {
|
|
|
|
info!("failed to process request; error = {:?}", e);
|
2019-04-18 12:18:31 -07:00
|
|
|
}
|
2020-12-29 19:51:01 -08:00
|
|
|
});
|
|
|
|
}
|
|
|
|
Err(e) => debug!("failed to accept socket; error = {:?}", e),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
async fn process(
|
|
|
|
mut stream: TokioTcpStream,
|
|
|
|
faucet: Arc<Mutex<Faucet>>,
|
|
|
|
) -> Result<(), Box<dyn std::error::Error>> {
|
2021-10-05 22:24:48 -07:00
|
|
|
let mut request = vec![
|
|
|
|
0u8;
|
|
|
|
serialized_size(&FaucetRequest::GetAirdrop {
|
|
|
|
lamports: u64::default(),
|
|
|
|
to: Pubkey::default(),
|
|
|
|
blockhash: Hash::default(),
|
|
|
|
})
|
|
|
|
.unwrap() as usize
|
|
|
|
];
|
2020-12-29 19:51:01 -08:00
|
|
|
while stream.read_exact(&mut request).await.is_ok() {
|
|
|
|
trace!("{:?}", request);
|
|
|
|
|
2021-04-06 00:01:05 -07:00
|
|
|
let response = {
|
|
|
|
match stream.peer_addr() {
|
|
|
|
Err(e) => {
|
|
|
|
info!("{:?}", e.into_inner());
|
|
|
|
ERROR_RESPONSE.to_vec()
|
|
|
|
}
|
|
|
|
Ok(peer_addr) => {
|
|
|
|
let ip = peer_addr.ip();
|
|
|
|
info!("Request IP: {:?}", ip);
|
|
|
|
|
|
|
|
match faucet.lock().unwrap().process_faucet_request(&request, ip) {
|
|
|
|
Ok(response_bytes) => {
|
|
|
|
trace!("Airdrop response_bytes: {:?}", response_bytes);
|
|
|
|
response_bytes
|
|
|
|
}
|
|
|
|
Err(e) => {
|
|
|
|
info!("Error in request: {}", e);
|
|
|
|
ERROR_RESPONSE.to_vec()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2020-12-29 19:51:01 -08:00
|
|
|
}
|
|
|
|
};
|
|
|
|
stream.write_all(&response).await?;
|
|
|
|
}
|
|
|
|
|
|
|
|
Ok(())
|
2018-09-14 01:58:59 -07:00
|
|
|
}
|
|
|
|
|
2021-04-12 12:59:38 -07:00
|
|
|
pub trait LimitByTime {
|
|
|
|
fn check_cache(&self, faucet: &mut Faucet, request_amount: u64) -> u64;
|
|
|
|
fn datapoint_info(&self, request_amount: u64, new_total: u64);
|
|
|
|
}
|
|
|
|
|
|
|
|
impl LimitByTime for IpAddr {
|
|
|
|
fn check_cache(&self, faucet: &mut Faucet, request_amount: u64) -> u64 {
|
|
|
|
*faucet
|
|
|
|
.ip_cache
|
|
|
|
.entry(*self)
|
|
|
|
.and_modify(|total| *total = total.saturating_add(request_amount))
|
|
|
|
.or_insert(request_amount)
|
|
|
|
}
|
|
|
|
|
|
|
|
fn datapoint_info(&self, request_amount: u64, new_total: u64) {
|
|
|
|
datapoint_info!(
|
|
|
|
"faucet-airdrop",
|
|
|
|
("request_amount", request_amount, i64),
|
|
|
|
("ip", self.to_string(), String),
|
|
|
|
("new_total", new_total, i64)
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl LimitByTime for Pubkey {
|
|
|
|
fn check_cache(&self, faucet: &mut Faucet, request_amount: u64) -> u64 {
|
|
|
|
*faucet
|
|
|
|
.address_cache
|
|
|
|
.entry(*self)
|
|
|
|
.and_modify(|total| *total = total.saturating_add(request_amount))
|
|
|
|
.or_insert(request_amount)
|
|
|
|
}
|
|
|
|
|
|
|
|
fn datapoint_info(&self, request_amount: u64, new_total: u64) {
|
|
|
|
datapoint_info!(
|
|
|
|
"faucet-airdrop",
|
|
|
|
("request_amount", request_amount, i64),
|
|
|
|
("address", self.to_string(), String),
|
|
|
|
("new_total", new_total, i64)
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-06-19 21:39:53 -07:00
|
|
|
#[cfg(test)]
|
|
|
|
mod tests {
|
2021-12-03 09:00:31 -08:00
|
|
|
use {super::*, solana_sdk::system_instruction::SystemInstruction, std::time::Duration};
|
2018-06-19 21:39:53 -07:00
|
|
|
|
2018-06-19 23:51:04 -07:00
|
|
|
#[test]
|
2021-04-12 12:59:38 -07:00
|
|
|
fn test_check_time_request_limit() {
|
2018-08-09 07:56:04 -07:00
|
|
|
let keypair = Keypair::new();
|
2021-04-06 00:01:05 -07:00
|
|
|
let mut faucet = Faucet::new(keypair, None, Some(2), None);
|
|
|
|
let ip = socketaddr!([203, 0, 113, 1], 1234).ip();
|
2021-04-12 12:59:38 -07:00
|
|
|
assert!(faucet.check_time_request_limit(1, ip).is_ok());
|
|
|
|
assert!(faucet.check_time_request_limit(1, ip).is_ok());
|
|
|
|
assert!(faucet.check_time_request_limit(1, ip).is_err());
|
|
|
|
|
|
|
|
let address = Pubkey::new_unique();
|
|
|
|
assert!(faucet.check_time_request_limit(1, address).is_ok());
|
|
|
|
assert!(faucet.check_time_request_limit(1, address).is_ok());
|
|
|
|
assert!(faucet.check_time_request_limit(1, address).is_err());
|
2018-06-19 21:39:53 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
2021-04-12 12:59:38 -07:00
|
|
|
fn test_clear_caches() {
|
2018-08-09 07:56:04 -07:00
|
|
|
let keypair = Keypair::new();
|
2020-08-17 16:33:14 -07:00
|
|
|
let mut faucet = Faucet::new(keypair, None, None, None);
|
2021-04-12 12:59:38 -07:00
|
|
|
let ip = socketaddr!([127, 0, 0, 1], 0).ip();
|
2019-12-16 13:05:17 -08:00
|
|
|
assert_eq!(faucet.ip_cache.len(), 0);
|
2021-04-12 12:59:38 -07:00
|
|
|
faucet.check_time_request_limit(1, ip).unwrap();
|
2019-12-16 13:05:17 -08:00
|
|
|
assert_eq!(faucet.ip_cache.len(), 1);
|
2021-04-12 12:59:38 -07:00
|
|
|
faucet.clear_caches();
|
2019-12-16 13:05:17 -08:00
|
|
|
assert_eq!(faucet.ip_cache.len(), 0);
|
|
|
|
assert!(faucet.ip_cache.is_empty());
|
2021-04-12 12:59:38 -07:00
|
|
|
|
|
|
|
let address = Pubkey::new_unique();
|
|
|
|
assert_eq!(faucet.address_cache.len(), 0);
|
|
|
|
faucet.check_time_request_limit(1, address).unwrap();
|
|
|
|
assert_eq!(faucet.address_cache.len(), 1);
|
|
|
|
faucet.clear_caches();
|
|
|
|
assert_eq!(faucet.address_cache.len(), 0);
|
|
|
|
assert!(faucet.address_cache.is_empty());
|
2018-06-19 21:39:53 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
2019-12-16 13:05:17 -08:00
|
|
|
fn test_faucet_default_init() {
|
2018-08-09 07:56:04 -07:00
|
|
|
let keypair = Keypair::new();
|
2018-06-19 21:39:53 -07:00
|
|
|
let time_slice: Option<u64> = None;
|
2021-04-06 00:01:05 -07:00
|
|
|
let per_time_cap: Option<u64> = Some(200);
|
|
|
|
let per_request_cap: Option<u64> = Some(100);
|
|
|
|
let faucet = Faucet::new(keypair, time_slice, per_time_cap, per_request_cap);
|
2019-12-16 13:05:17 -08:00
|
|
|
assert_eq!(faucet.time_slice, Duration::new(TIME_SLICE, 0));
|
2021-04-06 00:01:05 -07:00
|
|
|
assert_eq!(faucet.per_time_cap, per_time_cap);
|
|
|
|
assert_eq!(faucet.per_request_cap, per_request_cap);
|
2018-06-19 21:39:53 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
2019-12-16 13:05:17 -08:00
|
|
|
fn test_faucet_build_airdrop_transaction() {
|
2021-04-12 12:59:38 -07:00
|
|
|
let to = Pubkey::new_unique();
|
2019-03-02 10:25:16 -08:00
|
|
|
let blockhash = Hash::default();
|
2019-12-16 13:05:17 -08:00
|
|
|
let request = FaucetRequest::GetAirdrop {
|
2019-03-05 16:28:14 -08:00
|
|
|
lamports: 2,
|
2019-01-14 17:21:42 -08:00
|
|
|
to,
|
2019-03-02 10:25:16 -08:00
|
|
|
blockhash,
|
2018-07-20 16:19:00 -07:00
|
|
|
};
|
2021-04-06 00:01:05 -07:00
|
|
|
let ip = socketaddr!([203, 0, 113, 1], 1234).ip();
|
2018-09-10 20:25:14 -07:00
|
|
|
|
2019-01-14 17:21:42 -08:00
|
|
|
let mint = Keypair::new();
|
|
|
|
let mint_pubkey = mint.pubkey();
|
2020-08-17 16:33:14 -07:00
|
|
|
let mut faucet = Faucet::new(mint, None, None, None);
|
2019-01-14 17:21:42 -08:00
|
|
|
|
2021-04-06 00:01:05 -07:00
|
|
|
if let FaucetTransaction::Airdrop(tx) =
|
|
|
|
faucet.build_airdrop_transaction(request, ip).unwrap()
|
|
|
|
{
|
|
|
|
let message = tx.message();
|
|
|
|
|
|
|
|
assert_eq!(tx.signatures.len(), 1);
|
|
|
|
assert_eq!(
|
|
|
|
message.account_keys,
|
|
|
|
vec![mint_pubkey, to, Pubkey::default()]
|
|
|
|
);
|
|
|
|
assert_eq!(message.recent_blockhash, blockhash);
|
|
|
|
|
|
|
|
assert_eq!(message.instructions.len(), 1);
|
|
|
|
let instruction: SystemInstruction =
|
|
|
|
deserialize(&message.instructions[0].data).unwrap();
|
|
|
|
assert_eq!(instruction, SystemInstruction::Transfer { lamports: 2 });
|
|
|
|
} else {
|
|
|
|
panic!("airdrop should succeed");
|
|
|
|
}
|
2018-06-19 21:39:53 -07:00
|
|
|
|
2020-08-17 16:33:14 -07:00
|
|
|
// Test per-time request cap
|
|
|
|
let mint = Keypair::new();
|
2021-04-12 12:59:38 -07:00
|
|
|
faucet = Faucet::new(mint, None, Some(2), None);
|
|
|
|
let _tx = faucet.build_airdrop_transaction(request, ip).unwrap(); // first request succeeds
|
2021-04-06 00:01:05 -07:00
|
|
|
let tx = faucet.build_airdrop_transaction(request, ip);
|
2020-08-17 16:33:14 -07:00
|
|
|
assert!(tx.is_err());
|
|
|
|
|
2021-04-12 12:59:38 -07:00
|
|
|
// Test multiple requests from loopback with different addresses succeed
|
|
|
|
let mint = Keypair::new();
|
|
|
|
faucet = Faucet::new(mint, None, Some(2), None);
|
|
|
|
let ip = socketaddr!([127, 0, 0, 1], 0).ip();
|
|
|
|
let other = Pubkey::new_unique();
|
|
|
|
let _tx0 = faucet.build_airdrop_transaction(request, ip).unwrap(); // first request succeeds
|
|
|
|
let request1 = FaucetRequest::GetAirdrop {
|
|
|
|
lamports: 2,
|
|
|
|
to: other,
|
|
|
|
blockhash,
|
|
|
|
};
|
|
|
|
let _tx1 = faucet.build_airdrop_transaction(request1, ip).unwrap(); // first request succeeds
|
|
|
|
let tx0 = faucet.build_airdrop_transaction(request, ip);
|
|
|
|
assert!(tx0.is_err());
|
|
|
|
let tx1 = faucet.build_airdrop_transaction(request1, ip);
|
|
|
|
assert!(tx1.is_err());
|
|
|
|
|
2021-04-27 18:31:32 -07:00
|
|
|
// Test multiple requests from allowed ip with different addresses succeed
|
|
|
|
let mint = Keypair::new();
|
|
|
|
let ip = socketaddr!([203, 0, 113, 1], 0).ip();
|
|
|
|
let mut allowed_ips = HashSet::new();
|
|
|
|
allowed_ips.insert(ip);
|
|
|
|
faucet = Faucet::new_with_allowed_ips(mint, None, Some(2), None, allowed_ips);
|
|
|
|
let other = Pubkey::new_unique();
|
|
|
|
let _tx0 = faucet.build_airdrop_transaction(request, ip).unwrap(); // first request succeeds
|
|
|
|
let request1 = FaucetRequest::GetAirdrop {
|
|
|
|
lamports: 2,
|
|
|
|
to: other,
|
|
|
|
blockhash,
|
|
|
|
};
|
|
|
|
let _tx1 = faucet.build_airdrop_transaction(request1, ip).unwrap(); // first request succeeds
|
|
|
|
let tx0 = faucet.build_airdrop_transaction(request, ip);
|
|
|
|
assert!(tx0.is_err());
|
|
|
|
let tx1 = faucet.build_airdrop_transaction(request1, ip);
|
|
|
|
assert!(tx1.is_err());
|
|
|
|
|
2020-08-17 16:33:14 -07:00
|
|
|
// Test per-request cap
|
2019-01-14 17:21:42 -08:00
|
|
|
let mint = Keypair::new();
|
2021-04-06 00:01:05 -07:00
|
|
|
let mint_pubkey = mint.pubkey();
|
|
|
|
let mut faucet = Faucet::new(mint, None, None, Some(1));
|
|
|
|
|
|
|
|
if let FaucetTransaction::Memo((tx, memo)) =
|
|
|
|
faucet.build_airdrop_transaction(request, ip).unwrap()
|
|
|
|
{
|
|
|
|
let message = tx.message();
|
|
|
|
|
|
|
|
assert_eq!(tx.signatures.len(), 1);
|
|
|
|
assert_eq!(
|
|
|
|
message.account_keys,
|
|
|
|
vec![mint_pubkey, Pubkey::new(&spl_memo::id().to_bytes())]
|
|
|
|
);
|
|
|
|
assert_eq!(message.recent_blockhash, blockhash);
|
|
|
|
|
|
|
|
assert_eq!(message.instructions.len(), 1);
|
|
|
|
let parsed_memo = std::str::from_utf8(&message.instructions[0].data).unwrap();
|
|
|
|
let expected_memo = "request too large; req: ◎0.000000002, cap: ◎0.000000001";
|
|
|
|
assert_eq!(parsed_memo, expected_memo);
|
|
|
|
assert_eq!(memo, expected_memo);
|
|
|
|
} else {
|
|
|
|
panic!("airdrop attempt should result in memo tx");
|
|
|
|
}
|
2018-06-19 21:39:53 -07:00
|
|
|
}
|
2019-01-17 14:18:20 -08:00
|
|
|
|
|
|
|
#[test]
|
2019-12-16 13:05:17 -08:00
|
|
|
fn test_process_faucet_request() {
|
2020-10-19 12:12:08 -07:00
|
|
|
let to = solana_sdk::pubkey::new_rand();
|
2021-06-18 06:34:46 -07:00
|
|
|
let blockhash = Hash::new(to.as_ref());
|
2019-03-05 16:28:14 -08:00
|
|
|
let lamports = 50;
|
2019-12-16 13:05:17 -08:00
|
|
|
let req = FaucetRequest::GetAirdrop {
|
2019-03-05 16:28:14 -08:00
|
|
|
lamports,
|
2019-03-02 10:25:16 -08:00
|
|
|
blockhash,
|
2019-01-17 14:18:20 -08:00
|
|
|
to,
|
|
|
|
};
|
2021-04-06 00:01:05 -07:00
|
|
|
let ip = socketaddr!([203, 0, 113, 1], 1234).ip();
|
2019-01-17 14:18:20 -08:00
|
|
|
let req = serialize(&req).unwrap();
|
|
|
|
|
|
|
|
let keypair = Keypair::new();
|
2019-10-23 22:01:22 -07:00
|
|
|
let expected_instruction = system_instruction::transfer(&keypair.pubkey(), &to, lamports);
|
2020-06-24 13:52:38 -07:00
|
|
|
let message = Message::new(&[expected_instruction], Some(&keypair.pubkey()));
|
2019-03-26 19:31:14 -07:00
|
|
|
let expected_tx = Transaction::new(&[&keypair], message, blockhash);
|
2019-01-17 14:18:20 -08:00
|
|
|
let expected_bytes = serialize(&expected_tx).unwrap();
|
|
|
|
let mut expected_vec_with_length = vec![0; 2];
|
|
|
|
LittleEndian::write_u16(&mut expected_vec_with_length, expected_bytes.len() as u16);
|
|
|
|
expected_vec_with_length.extend_from_slice(&expected_bytes);
|
|
|
|
|
2020-08-17 16:33:14 -07:00
|
|
|
let mut faucet = Faucet::new(keypair, None, None, None);
|
2021-04-06 00:01:05 -07:00
|
|
|
let response = faucet.process_faucet_request(&req, ip);
|
2019-01-17 14:18:20 -08:00
|
|
|
let response_vec = response.unwrap().to_vec();
|
|
|
|
assert_eq!(expected_vec_with_length, response_vec);
|
|
|
|
|
2020-12-29 19:51:01 -08:00
|
|
|
let bad_bytes = "bad bytes".as_bytes();
|
2021-06-18 06:34:46 -07:00
|
|
|
assert!(faucet.process_faucet_request(bad_bytes, ip).is_err());
|
2019-01-17 14:18:20 -08:00
|
|
|
}
|
2018-06-19 21:39:53 -07:00
|
|
|
}
|