Struct sapio::contract::object::Object

pub struct Object {
    pub ctv_to_tx: HashMap<Hash, Template>,
    pub suggested_txs: HashMap<Hash, Template>,
    pub policy: Option<Clause>,
    pub address: Address,
    pub descriptor: Option<Descriptor<PublicKey>>,
    pub amount_range: AmountRange,
}

Object holds a contract’s complete context required post-compilation There is no guarantee that Object is properly constructed presently.

Fields

ctv_to_tx: HashMap<Hash, Template>

a map of template hashes to the corresponding template, that in the policy are a CTV protected

suggested_txs: HashMap<Hash, Template>

a map of template hashes to the corresponding template, that in the policy are not necessarily CTV protected but we might want to know about anyways.

policy: Option<Clause>

The Object’s Policy – if known

address: Address

The Object’s address

descriptor: Option<Descriptor<PublicKey>>

The Object’s descriptor – if there is one known/available

amount_range: AmountRange

The amount_range safe to send this object

Implementations

impl Object

pub fn from_address(address: Address, a: Option<AmountRange>) -> Object

Creates an object from a given address. The optional AmountRange argument determines the safe bounds the contract can receive, otherwise it is set to any.

pub fn from_script(
    script: Script,
    a: Option<AmountRange>,
    net: Network
) -> Result<Object, ObjectError>

Creates an object from a given script. The optional AmountRange argument determines the safe bounds the contract can receive, otherwise it is set to any.

pub fn bind(&self, out_in: OutPoint) -> (Vec<Transaction>, Vec<Value>)

bind attaches an Object to a specific UTXO and returns a vec of transactions and transaction metadata.

pub fn bind_psbt(
    &self,
    out_in: OutPoint,
    output_map: HashMap<Sha256, Vec<Option<OutPoint>>>,
    blockdata: Rc<dyn TxIndex>,
    emulator: &dyn CTVEmulator
) -> Result<(Vec<PartiallySignedTransaction>, Vec<Value>), ObjectError>

bind_psbt attaches and Object to a specific UTXO, returning a Vector of PSBTs and transaction metadata.

bind_psbt accepts a CTVEmulator, a txindex, and a map of outputs to be bound to specific template hashes.

Trait Implementations

impl Clone for Object

fn clone(&self) -> Object

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Compilable for Compiled

Implements a basic identity

fn compile(&self, _ctx: &Context) -> Result<Compiled, CompilationError>

Compile a compilable object returning errors, if any.

impl Debug for Object

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Object

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Object

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

pub fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for Object

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.