Struct NumericalDescriptor 

pub struct NumericalDescriptor {
    pub payout_function: PayoutFunction,
    pub rounding_intervals: RoundingIntervals,
    pub difference_params: Option<DifferenceParams>,
    pub oracle_numeric_infos: OracleNumericInfo,
}

Contains information about a contract based on a numerical outcome.

Fields

payout_function: PayoutFunction

The function representing the set of payouts.

rounding_intervals: RoundingIntervals

Rounding intervals enabling reducing the precision of the payout values which in turns reduces the number of required adaptor signatures.

difference_params: Option<DifferenceParams>

Information about the allowed differences in outcome value between oracles. If None, a quorum of oracle needs to sign the same value for the contract to be closeable.

oracle_numeric_infos: OracleNumericInfo

Information about base and number of digits for each oracle.

Implementations

impl NumericalDescriptor

pub fn get_range_payouts( &self, total_collateral: Amount, ) -> Result<Vec<RangePayout>, Error>

Returns the set of RangePayout for the descriptor generated from the payout function.

pub fn validate(&self, max_value: u64) -> Result<(), Error>

Validate that the descriptor covers all possible outcomes of the given digit decomposition event descriptor.

pub fn get_payouts( &self, total_collateral: Amount, ) -> Result<Vec<Payout>, Error>

Returns the set of payouts for the descriptor generated from the payout function.

pub fn verify_and_get_adaptor_info( &self, secp: &Secp256k1<All>, total_collateral: Amount, fund_pubkey: &PublicKey, funding_script_pubkey: &Script, fund_output_value: Amount, threshold: usize, precomputed_points: &[Vec<Vec<PublicKey>>], cets: &[Transaction], adaptor_pairs: &[EcdsaAdaptorSignature], adaptor_index_start: usize, ) -> Result<(AdaptorInfo, usize), Error>

Verify the given set of adaptor signatures and generate the adaptor info.

pub fn get_adaptor_info( &self, secp: &Secp256k1<All>, total_collateral: Amount, fund_priv_key: &SecretKey, funding_script_pubkey: &Script, fund_output_value: Amount, threshold: usize, precomputed_points: &[Vec<Vec<PublicKey>>], cets: &[Transaction], adaptor_index_start: usize, ) -> Result<(AdaptorInfo, Vec<EcdsaAdaptorSignature>), Error>

Generate the set of adaptor signatures and the adaptor info.

Trait Implementations

impl Clone for NumericalDescriptor

fn clone(&self) -> NumericalDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NumericalDescriptor

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

Formats the value using the given formatter.

impl From<&NumericalDescriptor> for NumericOutcomeContractDescriptor

fn from( num_descriptor: &NumericalDescriptor, ) -> NumericOutcomeContractDescriptor

Converts to this type from the input type.

impl Readable for NumericalDescriptor

fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError>

Reads a Self in from the given Read.

impl Writeable for NumericalDescriptor

fn write<W: Writer>(&self, w: &mut W) -> Result<(), Error>

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.