pub struct Signer<'info> { /* private fields */ }
Expand description
Type validating that the account signed the transaction. No other ownership or type checks are done. If this is used, one should not try to access the underlying account data.
Checks:
Signer.info.is_signer == true
Example
#[account]
#[derive(Default)]
pub struct MyData {
pub data: u64
}
#[derive(Accounts)]
pub struct Example<'info> {
#[account(init, payer = payer)]
pub my_acc: Account<'info, MyData>,
#[account(mut)]
pub payer: Signer<'info>,
pub system_program: Program<'info, System>
}
When creating an account with init
, the payer
needs to sign the transaction.
Implementations
Methods from Deref<Target = AccountInfo<'info>>
pub fn signer_key(&self) -> Option<&Pubkey>
pub fn unsigned_key(&self) -> &Pubkey
pub fn lamports(&self) -> u64
pub fn try_lamports(&self) -> Result<u64, ProgramError>
sourcepub unsafe fn original_data_len(&self) -> usize
pub unsafe fn original_data_len(&self) -> usize
Return the account’s original data length when it was serialized for the current program invocation.
Safety
This method assumes that the original data length was serialized as a u32 integer in the 4 bytes immediately preceding the serialized account key.
pub fn data_len(&self) -> usize
pub fn try_data_len(&self) -> Result<usize, ProgramError>
pub fn data_is_empty(&self) -> bool
pub fn try_data_is_empty(&self) -> Result<bool, ProgramError>
pub fn try_borrow_lamports(&self) -> Result<Ref<'_, &mut u64>, ProgramError>
pub fn try_borrow_mut_lamports(
&self
) -> Result<RefMut<'_, &'a mut u64>, ProgramError>
pub fn try_borrow_data(&self) -> Result<Ref<'_, &mut [u8]>, ProgramError>
pub fn try_borrow_mut_data(
&self
) -> Result<RefMut<'_, &'a mut [u8]>, ProgramError>
sourcepub fn realloc(&self, new_len: usize, zero_init: bool) -> Result<(), ProgramError>
pub fn realloc(&self, new_len: usize, zero_init: bool) -> Result<(), ProgramError>
Realloc the account’s data and optionally zero-initialize the new memory.
Note: Account data can be increased within a single call by up to
solana_program::entrypoint::MAX_PERMITTED_DATA_INCREASE
bytes.
Note: Memory used to grow is already zero-initialized upon program
entrypoint and re-zeroing it wastes compute units. If within the same
call a program reallocs from larger to smaller and back to larger again
the new space could contain stale data. Pass true
for zero_init
in
this case, otherwise compute units will be wasted re-zero-initializing.
Safety
This method makes assumptions about the layout and location of memory
referenced by AccountInfo
fields. It should only be called for
instances of AccountInfo
that were created by the runtime and received
in the process_instruction
entrypoint of a program.
pub fn assign(&self, new_owner: &Pubkey)
pub fn deserialize_data<T>(&self) -> Result<T, Box<ErrorKind, Global>> where
T: DeserializeOwned,
pub fn serialize_data<T>(&self, state: &T) -> Result<(), Box<ErrorKind, Global>> where
T: Serialize,
Trait Implementations
sourceimpl<'info> Accounts<'info> for Signer<'info>
impl<'info> Accounts<'info> for Signer<'info>
sourcefn try_accounts(
_program_id: &Pubkey,
accounts: &mut &[AccountInfo<'info>],
_ix_data: &[u8],
_bumps: &mut BTreeMap<String, u8>,
_reallocs: &mut BTreeSet<Pubkey>
) -> Result<Self>
fn try_accounts(
_program_id: &Pubkey,
accounts: &mut &[AccountInfo<'info>],
_ix_data: &[u8],
_bumps: &mut BTreeMap<String, u8>,
_reallocs: &mut BTreeSet<Pubkey>
) -> Result<Self>
Returns the validated accounts struct. What constitutes “valid” is
program dependent. However, users of these types should never have to
worry about account substitution attacks. For example, if a program
expects a Mint
account from the SPL token program in a particular
field, then it should be impossible for this method to return Ok
if
any other account type is given–from the SPL token program or elsewhere. Read more
sourceimpl<'info> AccountsExit<'info> for Signer<'info>
impl<'info> AccountsExit<'info> for Signer<'info>
sourceimpl<'info> AsRef<AccountInfo<'info>> for Signer<'info>
impl<'info> AsRef<AccountInfo<'info>> for Signer<'info>
sourcefn as_ref(&self) -> &AccountInfo<'info>
fn as_ref(&self) -> &AccountInfo<'info>
Converts this type into a shared reference of the (usually inferred) input type.
sourceimpl<'info> Deref for Signer<'info>
impl<'info> Deref for Signer<'info>
type Target = AccountInfo<'info>
type Target = AccountInfo<'info>
The resulting type after dereferencing.
sourceimpl<'info> ToAccountInfos<'info> for Signer<'info>
impl<'info> ToAccountInfos<'info> for Signer<'info>
fn to_account_infos(&self) -> Vec<AccountInfo<'info>>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
sourceimpl<'info> ToAccountMetas for Signer<'info>
impl<'info> ToAccountMetas for Signer<'info>
sourcefn to_account_metas(&self, is_signer: Option<bool>) -> Vec<AccountMeta>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
fn to_account_metas(&self, is_signer: Option<bool>) -> Vec<AccountMeta>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
is_signer
is given as an optional override for the signer meta field.
This covers the edge case when a program-derived-address needs to relay
a transaction from a client to another program but sign the transaction
before the relay. The client cannot mark the field as a signer, and so
we have to override the is_signer meta field given by the client. Read more
Auto Trait Implementations
impl<'info> !RefUnwindSafe for Signer<'info>
impl<'info> !Send for Signer<'info>
impl<'info> !Sync for Signer<'info>
impl<'info> Unpin for Signer<'info>
impl<'info> !UnwindSafe for Signer<'info>
Blanket Implementations
impl<T> AbiExample for T
impl<T> AbiExample for T
default fn example() -> T
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more