Skip to main content

Cheatcodes

Struct Cheatcodes 

Source
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>

Source

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();
Source

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();
Source

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();
Source

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();
Source

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}");
Source

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();
Source

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();
Source

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);
Source

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);
Source

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);
Source

pub fn deploy_program(&self, program_name: &str) -> SurfnetResult<Pubkey>

Deploy a program from local workspace artifacts.

This looks for:

  • target/deploy/{program_name}.so
  • target/deploy/{program_name}-keypair.json
  • target/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}");
Source

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);
Source

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

Source§

fn aggregate_distinct(self) -> Self::Output
where Self: DistinctDsl,

DISTINCT modifier for aggregate functions Read more
Source§

fn aggregate_all(self) -> Self::Output
where Self: AllDsl,

ALL modifier for aggregate functions Read more
Source§

fn aggregate_filter<P>(self, f: P) -> Self::Output
where P: AsExpression<Bool>, Self: FilterDsl<<P as AsExpression<Bool>>::Expression>,

Add an aggregate function filter Read more
Source§

fn aggregate_order<O>(self, o: O) -> Self::Output
where Self: OrderAggregateDsl<O>,

Add an aggregate function order Read more
Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts 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>

Converts 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)

Converts &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)

Converts &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
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Sync + Send>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> IntoSql for T

Source§

fn into_sql<T>(self) -> Self::Expression

Convert self to an expression for Diesel’s query builder. Read more
Source§

fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expression
where &'a Self: AsExpression<T>, T: SqlType + TypedExpressionType,

Convert &self to an expression for Diesel’s query builder. Read more
Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows 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
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows 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
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .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
where Self: BorrowMut<B>, B: ?Sized,

Calls .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
where Self: AsRef<R>, R: ?Sized,

Calls .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
where Self: AsMut<R>, R: ?Sized,

Calls .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
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WindowExpressionMethods for T

Source§

fn over(self) -> Self::Output
where Self: OverDsl,

Turn a function call into a window function call Read more
Source§

fn window_filter<P>(self, f: P) -> Self::Output
where P: AsExpression<Bool>, Self: FilterDsl<<P as AsExpression<Bool>>::Expression>,

Add a filter to the current window function Read more
Source§

fn partition_by<E>(self, expr: E) -> Self::Output
where Self: PartitionByDsl<E>,

Add a partition clause to the current window function Read more
Source§

fn window_order<E>(self, expr: E) -> Self::Output
where Self: OrderWindowDsl<E>,

Add a order clause to the current window function Read more
Source§

fn frame_by<E>(self, expr: E) -> Self::Output
where Self: FrameDsl<E>,

Add a frame clause to the current window function Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more