Struct RuntimeOrigin

pub struct RuntimeOrigin {
    pub caller: OriginCaller,
    /* private fields */
}

The runtime origin type representing the origin of a call.

Origin is always created with the base filter configured in [frame_system::Config::BaseCallFilter].

Fields

caller: OriginCaller

Implementations

impl RuntimeOrigin

pub fn none() -> Self

Create with system none origin and [frame_system::Config::BaseCallFilter].

pub fn root() -> Self

Create with system root origin and [frame_system::Config::BaseCallFilter].

pub fn signed(by: <Runtime as Config>::AccountId) -> Self

Create with system signed origin and [frame_system::Config::BaseCallFilter].

Trait Implementations

impl AsSystemOriginSigner<<Runtime as Config>::AccountId> for RuntimeOrigin

fn as_system_origin_signer(&self) -> Option<&<Runtime as Config>::AccountId>

Extract a reference of the inner value of the System Origin::Signed variant, if self has that variant.

impl AsTransactionAuthorizedOrigin for RuntimeOrigin

fn is_transaction_authorized(&self) -> bool

Whether the origin is authorized to include a transaction in a block.

impl Clone for RuntimeOrigin

fn clone(&self) -> RuntimeOrigin

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RuntimeOrigin

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<Option<<Runtime as Config>::AccountId>> for RuntimeOrigin

fn from(x: Option<<Runtime as Config>::AccountId>) -> Self

Convert to runtime origin with caller being system signed or none and use filter [frame_system::Config::BaseCallFilter].

impl From<OriginCaller> for RuntimeOrigin

fn from(x: OriginCaller) -> Self

Converts to this type from the input type.

impl From<RawOrigin<<Runtime as Config>::AccountId>> for RuntimeOrigin

fn from(x: Origin<Runtime>) -> Self

Convert to runtime origin, using as filter: [frame_system::Config::BaseCallFilter].

impl From<RuntimeOrigin> for Result<Origin<Runtime>, RuntimeOrigin>

fn from(val: RuntimeOrigin) -> Self

NOTE: converting to pallet origin loses the origin filter information.

impl OriginTrait for RuntimeOrigin

type Call = <Runtime as Config>::RuntimeCall

Runtime call type, as in frame_system::Config::Call

type PalletsOrigin = OriginCaller

The caller origin, overarching type of all pallets origins.

type AccountId = <Runtime as Config>::AccountId

The AccountId used across the system.

fn add_filter(&mut self, filter: impl Fn(&Self::Call) -> bool + 'static)

Add a filter to the origin.

fn reset_filter(&mut self)

Reset origin filters to default one, i.e frame_system::1fig::BaseCallFilter.

fn set_caller(&mut self, caller: OriginCaller)

Replace the caller with caller from the other origin

fn set_caller_from(&mut self, other: impl Into<Self>)

Replace the caller with caller from the other origin

fn filter_call(&self, call: &Self::Call) -> bool

Filter the call if caller is not root, if false is returned then the call must be filtered out.

fn caller(&self) -> &Self::PalletsOrigin

Get a reference to the caller (CallerTrait impl).

fn into_caller(self) -> Self::PalletsOrigin

Consume self and return the caller.

fn try_with_caller<R>( self, f: impl FnOnce(Self::PalletsOrigin) -> Result<R, Self::PalletsOrigin>, ) -> Result<R, Self>

Do something with the caller, consuming self but returning it if the caller was unused.

fn none() -> Self

Create with system none origin and frame_system::Config::BaseCallFilter.

fn root() -> Self

Create with system root origin and frame_system::Config::BaseCallFilter.

fn signed(by: Self::AccountId) -> Self

Create with system signed origin and frame_system::Config::BaseCallFilter.

fn set_caller_from_signed(&mut self, caller_account: Self::AccountId)

Replace the caller with caller from the other origin

fn as_signed(self) -> Option<Self::AccountId>

👎Deprecated: Use into_signer instead

Extract the signer from the message if it is a Signed origin.

fn into_signer(self) -> Option<Self::AccountId>

Extract the signer from the message if it is a Signed origin.

fn as_system_ref(&self) -> Option<&RawOrigin<Self::AccountId>>

Extract a reference to the system origin, if that’s what the caller is.

fn as_signer(&self) -> Option<&Self::AccountId>

Extract a reference to the signer, if that’s what the caller is.