pub struct Cheatcodes<'a> { /* private fields */ }Expand description
Direct state manipulation helpers for a running Surfnet.
These bypass normal transaction flow to instantly set account state — perfect for test setup (funding wallets, minting tokens, etc.).
use surfpool_sdk::{Pubkey, Surfnet};
use surfpool_sdk::cheatcodes::builders::SetAccount;
let surfnet = Surfnet::start().await.unwrap();
let cheats = surfnet.cheatcodes();
// Fund an account with 5 SOL
let alice: Pubkey = "...".parse().unwrap();
cheats.fund_sol(&alice, 5_000_000_000).unwrap();
// Fund a token account with 1000 USDC
let usdc_mint: Pubkey = "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v".parse().unwrap();
cheats.fund_token(&alice, &usdc_mint, 1_000_000_000, None).unwrap();
// Or build a typed cheatcode request:
let custom = Pubkey::new_unique();
let owner = Pubkey::new_unique();
cheats
.execute(
SetAccount::new(custom)
.lamports(42)
.owner(owner)
.data(vec![1, 2, 3]),
)
.unwrap();Implementations§
Source§impl<'a> Cheatcodes<'a>
impl<'a> Cheatcodes<'a>
Sourcepub fn fund_sol(&self, address: &Pubkey, lamports: u64) -> SurfnetResult<()>
pub fn fund_sol(&self, address: &Pubkey, lamports: u64) -> SurfnetResult<()>
Set the SOL balance for an account in lamports.
use surfpool_sdk::{Pubkey, Surfnet};
let surfnet = Surfnet::start().await.unwrap();
let cheats = surfnet.cheatcodes();
let recipient = Pubkey::new_unique();
cheats.fund_sol(&recipient, 1_000_000_000).unwrap();Sourcepub fn set_account(
&self,
address: &Pubkey,
lamports: u64,
data: &[u8],
owner: &Pubkey,
) -> SurfnetResult<()>
pub fn set_account( &self, address: &Pubkey, lamports: u64, data: &[u8], owner: &Pubkey, ) -> SurfnetResult<()>
Set arbitrary account state for a single account.
This helper updates lamports, owner, and raw account data in one RPC call.
use surfpool_sdk::{Pubkey, Surfnet};
let surfnet = Surfnet::start().await.unwrap();
let cheats = surfnet.cheatcodes();
let address = Pubkey::new_unique();
let owner = Pubkey::new_unique();
cheats.set_account(&address, 500, &[1, 2, 3], &owner).unwrap();Sourcepub fn fund_token(
&self,
owner: &Pubkey,
mint: &Pubkey,
amount: u64,
token_program: Option<&Pubkey>,
) -> SurfnetResult<()>
pub fn fund_token( &self, owner: &Pubkey, mint: &Pubkey, amount: u64, token_program: Option<&Pubkey>, ) -> SurfnetResult<()>
Fund a token account (creates the ATA if needed).
Uses spl_token program by default. Pass token_program to use Token-2022.
use surfpool_sdk::{Pubkey, Surfnet};
let surfnet = Surfnet::start().await.unwrap();
let cheats = surfnet.cheatcodes();
let owner = Pubkey::new_unique();
let mint = Pubkey::new_unique();
cheats.fund_token(&owner, &mint, 1_000, None).unwrap();Sourcepub fn set_token_balance(
&self,
owner: &Pubkey,
mint: &Pubkey,
amount: u64,
token_program: Option<&Pubkey>,
) -> SurfnetResult<()>
pub fn set_token_balance( &self, owner: &Pubkey, mint: &Pubkey, amount: u64, token_program: Option<&Pubkey>, ) -> SurfnetResult<()>
Set the token balance for a wallet/mint pair.
This is an alias for Self::fund_token.
use surfpool_sdk::{Pubkey, Surfnet};
let surfnet = Surfnet::start().await.unwrap();
let cheats = surfnet.cheatcodes();
let owner = Pubkey::new_unique();
let mint = Pubkey::new_unique();
cheats.set_token_balance(&owner, &mint, 5_000, None).unwrap();Sourcepub fn get_ata(
&self,
owner: &Pubkey,
mint: &Pubkey,
token_program: Option<&Pubkey>,
) -> Pubkey
pub fn get_ata( &self, owner: &Pubkey, mint: &Pubkey, token_program: Option<&Pubkey>, ) -> Pubkey
Get the associated token address for a wallet/mint pair.
use surfpool_sdk::{Pubkey, Surfnet};
let surfnet = Surfnet::start().await.unwrap();
let cheats = surfnet.cheatcodes();
let owner = Pubkey::new_unique();
let mint = Pubkey::new_unique();
let ata = cheats.get_ata(&owner, &mint, None);
println!("{ata}");Sourcepub fn fund_sol_many(&self, accounts: &[(&Pubkey, u64)]) -> SurfnetResult<()>
pub fn fund_sol_many(&self, accounts: &[(&Pubkey, u64)]) -> SurfnetResult<()>
Fund multiple accounts with SOL using repeated surfnet_setAccount calls.
use surfpool_sdk::{Pubkey, Surfnet};
let surfnet = Surfnet::start().await.unwrap();
let cheats = surfnet.cheatcodes();
let alice = Pubkey::new_unique();
let bob = Pubkey::new_unique();
cheats
.fund_sol_many(&[(&alice, 1_000_000), (&bob, 2_000_000)])
.unwrap();Sourcepub fn fund_token_many(
&self,
owners: &[&Pubkey],
mint: &Pubkey,
amount: u64,
token_program: Option<&Pubkey>,
) -> SurfnetResult<()>
pub fn fund_token_many( &self, owners: &[&Pubkey], mint: &Pubkey, amount: u64, token_program: Option<&Pubkey>, ) -> SurfnetResult<()>
Fund multiple wallets with the same token and amount.
use surfpool_sdk::{Pubkey, Surfnet};
let surfnet = Surfnet::start().await.unwrap();
let cheats = surfnet.cheatcodes();
let alice = Pubkey::new_unique();
let bob = Pubkey::new_unique();
let mint = Pubkey::new_unique();
cheats
.fund_token_many(&[&alice, &bob], &mint, 1_000, None)
.unwrap();Sourcepub fn time_travel_to_epoch(&self, epoch: u64) -> SurfnetResult<EpochInfo>
pub fn time_travel_to_epoch(&self, epoch: u64) -> SurfnetResult<EpochInfo>
Move Surfnet time forward to an absolute epoch.
use surfpool_sdk::Surfnet;
let surfnet = Surfnet::start().await.unwrap();
let cheats = surfnet.cheatcodes();
let epoch_info = cheats.time_travel_to_epoch(10).unwrap();
assert!(epoch_info.epoch >= 10);Sourcepub fn time_travel_to_slot(&self, slot: u64) -> SurfnetResult<EpochInfo>
pub fn time_travel_to_slot(&self, slot: u64) -> SurfnetResult<EpochInfo>
Move Surfnet time forward to an absolute slot.
use surfpool_sdk::Surfnet;
let surfnet = Surfnet::start().await.unwrap();
let cheats = surfnet.cheatcodes();
let epoch_info = cheats.time_travel_to_slot(1_000).unwrap();
assert!(epoch_info.absolute_slot >= 1_000);Sourcepub fn time_travel_to_timestamp(
&self,
timestamp: u64,
) -> SurfnetResult<EpochInfo>
pub fn time_travel_to_timestamp( &self, timestamp: u64, ) -> SurfnetResult<EpochInfo>
Move Surfnet time forward to an absolute Unix timestamp in milliseconds.
use surfpool_sdk::Surfnet;
let surfnet = Surfnet::start().await.unwrap();
let cheats = surfnet.cheatcodes();
let epoch_info = cheats.time_travel_to_timestamp(1_700_000_000_000).unwrap();
assert!(epoch_info.absolute_slot > 0);Sourcepub fn deploy_program(&self, program_name: &str) -> SurfnetResult<Pubkey>
pub fn deploy_program(&self, program_name: &str) -> SurfnetResult<Pubkey>
Deploy a program from local workspace artifacts.
This looks for:
target/deploy/{program_name}.sotarget/deploy/{program_name}-keypair.jsontarget/idl/{program_name}.json(optional)
If an IDL file exists, it is registered after the program bytes are written.
use surfpool_sdk::Surfnet;
let surfnet = Surfnet::start().await.unwrap();
let cheats = surfnet.cheatcodes();
let program_id = cheats.deploy_program("my_program").unwrap();
println!("{program_id}");Sourcepub fn deploy(&self, builder: DeployProgram) -> SurfnetResult<Pubkey>
pub fn deploy(&self, builder: DeployProgram) -> SurfnetResult<Pubkey>
Deploy a program described by a DeployProgram builder.
This writes the program bytes with surfnet_writeProgram and, when present,
registers the parsed IDL with surfnet_registerIdl.
use surfpool_sdk::{Pubkey, Surfnet};
use surfpool_sdk::cheatcodes::builders::DeployProgram;
let surfnet = Surfnet::start().await.unwrap();
let cheats = surfnet.cheatcodes();
let program_id = Pubkey::new_unique();
let deployed_program = cheats
.deploy(
DeployProgram::new(program_id)
.so_path("target/deploy/my_program.so")
.idl_path("target/idl/my_program.json"),
)
.unwrap();
assert_eq!(deployed_program, program_id);Sourcepub fn execute<B: CheatcodeBuilder>(&self, builder: B) -> SurfnetResult<()>
pub fn execute<B: CheatcodeBuilder>(&self, builder: B) -> SurfnetResult<()>
Execute a typed cheatcode builder.
use surfpool_sdk::{Pubkey, Surfnet};
use surfpool_sdk::cheatcodes::builders::ResetAccount;
let surfnet = Surfnet::start().await.unwrap();
let cheats = surfnet.cheatcodes();
let address = Pubkey::new_unique();
cheats.execute(ResetAccount::new(address)).unwrap();Auto Trait Implementations§
impl<'a> Freeze for Cheatcodes<'a>
impl<'a> RefUnwindSafe for Cheatcodes<'a>
impl<'a> Send for Cheatcodes<'a>
impl<'a> Sync for Cheatcodes<'a>
impl<'a> Unpin for Cheatcodes<'a>
impl<'a> UnsafeUnpin for Cheatcodes<'a>
impl<'a> UnwindSafe for Cheatcodes<'a>
Blanket Implementations§
Source§impl<T> AggregateExpressionMethods for T
impl<T> AggregateExpressionMethods for T
Source§fn aggregate_distinct(self) -> Self::Outputwhere
Self: DistinctDsl,
fn aggregate_distinct(self) -> Self::Outputwhere
Self: DistinctDsl,
DISTINCT modifier for aggregate functions Read moreSource§fn aggregate_all(self) -> Self::Outputwhere
Self: AllDsl,
fn aggregate_all(self) -> Self::Outputwhere
Self: AllDsl,
ALL modifier for aggregate functions Read moreSource§fn aggregate_filter<P>(self, f: P) -> Self::Output
fn aggregate_filter<P>(self, f: P) -> Self::Output
Source§fn aggregate_order<O>(self, o: O) -> Self::Outputwhere
Self: OrderAggregateDsl<O>,
fn aggregate_order<O>(self, o: O) -> Self::Outputwhere
Self: OrderAggregateDsl<O>,
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoSql for T
impl<T> IntoSql for T
Source§fn into_sql<T>(self) -> Self::Expression
fn into_sql<T>(self) -> Self::Expression
self to an expression for Diesel’s query builder. Read moreSource§fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expression
fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expression
&self to an expression for Diesel’s query builder. Read moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.