Skip to main content

UnbondArgs

Struct UnbondArgs 

Source
pub struct UnbondArgs {
    pub to_mbps: Option<u64>,
    pub all: bool,
    pub amount: Option<u128>,
    pub yes: bool,
    pub chain: ChainArgs,
}
Expand description

decdn node unbond — lower the bond via CapacityBond.requestUnbond + unbond (ADR 026 § Capacity-bond curve). One command covers all three phases of the window; which one runs is read from chain state, not from a flag. A run that lost its requestUnbond after declareMbps landed resumes on re-run, the way BondArgs converges; once requestUnbond HAS landed a re-run with an amount flag is a deliberate error, since the request can no longer be changed.

The amount flags apply only when starting a request — passing one while a request is already in flight is an error rather than a silent no-op. All three are mutually exclusive; exactly one is required to start a request.

Fields§

§to_mbps: Option<u64>

Reduce the declared capacity tier to MBPS and release the surplus bond. The released amount is derived from the on-chain bondRequired curve — you do not pass a token amount. The retained bond is max(minBond, bondRequired(MBPS)), so the node stays eligible at the new tier. Must not exceed the current declared tier (raise with decdn node bond --mbps); passing the tier the node is already at is accepted and skips the redundant declareMbps, which is how a partially-failed run resumes. A tier that will actually be declared must be inside the governable [minCapacityMbps, maxCapacityMbps] band.

§all: bool

Release everything the bond curve permits, retaining only bondRequired(declaredMbps). Unlike --to-mbps this ignores the minBond floor, so at low declared tiers the retained bond can land below minBond and the node stays inactive until it re-bonds. Whether it does is tier-dependent; the command reports below_min_bond before submitting.

For an operator that is NOT in the registered set — ejected, or bonded and declared but never registered — this additionally clears the declared tier (declareMbps(0)), making it a full exit: nothing is retained. That is the only route to the bond those operators have, since decdn node deregister requires an active registration. A registered node exits by running decdn node deregister first.

§amount: Option<u128>

Release exactly this many TOKEN base units (1 TOKEN = 1e18). Escape hatch for an exact figure; the curve is still pre-checked, so an amount the contract would reject fails with the decdn node bond --mbps invocation needed to make it legal.

§yes: bool

Skip the interactive confirmation. Required when starting a request from a non-interactive shell, since that deactivates the node for the full window; the withdrawal phase never prompts. The consequences are printed either way — this suppresses the prompt, not the warning.

§chain: ChainArgs

Chain coordinates: RPC endpoint, contract addresses, and keystore.

Trait Implementations§

Source§

impl Args for UnbondArgs

Source§

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments
Source§

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

impl Debug for UnbondArgs

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for UnbondArgs

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

Auto Trait Implementations§

Blanket Implementations§

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<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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> MaybeSend for T
where T: Send,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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