Enum PolicyError 

pub enum PolicyError {
    Blacklisted {
        address: String,
    },
    NotWhitelisted {
        address: String,
    },
    ExceedsTransactionLimit {
        limit: String,
        amount: String,
    },
    InvalidConfiguration {
        context: String,
    },
}

Errors that can occur during policy evaluation.

Note: These are evaluation errors, not policy denials. For denials, see TxGateError::PolicyDenied.

Variants

Blacklisted

The address is on the blacklist.

Fields

address: String

The blacklisted address.

NotWhitelisted

The address is not on the whitelist (when whitelist is enabled).

Fields

address: String

The address that is not whitelisted.

ExceedsTransactionLimit

The transaction amount exceeds the per-transaction limit.

Fields

limit: String

The configured limit.

amount: String

The requested amount.

InvalidConfiguration

The policy configuration is invalid.

Fields

context: String

Context about what is invalid.

Implementations

impl PolicyError

pub fn blacklisted(address: impl Into<String>) -> Self

Create a Blacklisted error.

pub fn not_whitelisted(address: impl Into<String>) -> Self

Create a NotWhitelisted error.

pub fn exceeds_transaction_limit( limit: impl Into<String>, amount: impl Into<String>, ) -> Self

Create an ExceedsTransactionLimit error.

pub fn invalid_configuration(context: impl Into<String>) -> Self

Create an InvalidConfiguration error.

pub fn denial_reason(&self) -> String

Convert this policy error into a denial reason string.

pub const fn rule_name(&self) -> &'static str

Get the rule name that triggered this error.

Trait Implementations

impl Debug for PolicyError

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

Formats the value using the given formatter.

impl Display for PolicyError

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

Formats the value using the given formatter.

impl Error for PolicyError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<PolicyError> for SigningError

fn from(source: PolicyError) -> Self

Converts to this type from the input type.

impl From<PolicyError> for TxGateError

fn from(source: PolicyError) -> Self

Converts to this type from the input type.