Contract

Enum Contract 

Source
pub enum Contract {
    Offered(OfferedContract),
    Accepted(AcceptedContract),
    Signed(SignedContract),
    Confirmed(SignedContract),
    PreClosed(PreClosedContract),
    Closed(ClosedContract),
    Refunded(SignedContract),
    FailedAccept(FailedAcceptContract),
    FailedSign(FailedSignContract),
    Rejected(OfferedContract),
}
Expand description

Enum representing the possible states of a DLC.

Variants§

§

Offered(OfferedContract)

Initial state where a contract is being proposed.

§

Accepted(AcceptedContract)

A contract that was accepted.

§

Signed(SignedContract)

A contract for which signatures have been produced.

§

Confirmed(SignedContract)

A contract whose funding transaction was included in the blockchain with sufficient confirmations.

§

PreClosed(PreClosedContract)

A contract for which a CET was broadcasted, but not fully confirmed to the blockchain.

§

Closed(ClosedContract)

A contract for which a CET was fully confirmed to blockchain

§

Refunded(SignedContract)

A contract whose refund transaction was broadcast.

§

FailedAccept(FailedAcceptContract)

A contract that failed when verifying information from an accept message.

§

FailedSign(FailedSignContract)

A contract that failed when verifying information from a sign message.

§

Rejected(OfferedContract)

A contract that was rejected by the party to whom it was offered.

Implementations§

Source§

impl Contract

Source

pub fn get_id(&self) -> ContractId

Get the id of a contract. Returns the temporary contract id for offered and failed accept contracts.

Source

pub fn get_id_string(&self) -> String

Get the string representation of the contract id.

Source

pub fn get_temporary_id(&self) -> ContractId

Returns the temporary contract id of a contract.

Source

pub fn get_counter_party_id(&self) -> PublicKey

Returns the public key of the counter party’s node.

Source

pub fn is_offer_party(&self) -> bool

Checks if the contract is the offer party.

Source

pub fn get_collateral(&self) -> (Amount, Amount, Amount)

Get the collateral for a contract.

Source

pub fn get_cet_locktime(&self) -> u32

Get the CET locktime for a contract.

Source

pub fn get_refund_locktime(&self) -> u32

Get the refund locktime for a contract.

Source

pub fn get_pnl(&self) -> SignedAmount

Get the profit and loss for a contract.

Source

pub fn get_funding_txid(&self) -> Option<Txid>

Get the funding txid for a contract.

Source

pub fn get_oracle_announcement(&self) -> Option<OracleAnnouncement>

Get the oracle announcement for a contract.

Source

pub fn get_cet_txid(&self) -> Option<Txid>

Get the CET transaction id.

Trait Implementations§

Source§

impl Clone for Contract

Source§

fn clone(&self) -> Contract

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Contract

Source§

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

Formats the value using the given formatter. Read more

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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> 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