Struct sapio::contract::context::Context

pub struct Context {
    pub network: Network,
    // some fields omitted
}

Context is used to track statet during compilation such as remaining value.

Fields

network: Network

which network is the contract building for?

Implementations

impl Context

pub fn new(
    network: Network,
    available_funds: Amount,
    emulator: Arc<dyn CTVEmulator>,
    path: EffectPath,
    effects: Arc<MapEffectDB>
) -> Self

create a context instance. Should only happen once at the very top level.

pub unsafe fn get_effects_internal(&self) -> &Arc<MapEffectDB>

Get this Context’s effect database, for clients

pub fn path(&self) -> &Arc<EffectPath>

Gets this Context’s Path, but does not clone (left to caller)

pub fn derive_str<'a>(
    &mut self,
    path: Arc<String>
) -> Result<Self, CompilationError>

Derive a new contextual path

pub fn derive_num<T: Into<u64>>(
    &mut self,
    path: T
) -> Result<Self, CompilationError>

Derive a new contextual path

pub fn funds(&self) -> Amount

return the available funds

pub fn ctv_emulator(&self, b: Hash) -> Result<Clause, CompilationError>

use the context’s emulator to get a emulated (or not) clause

pub fn compile<A: Compilable>(self, a: A) -> Result<Compiled, CompilationError>

Compile the compilable item with this context.

pub fn with_amount(self, amount: Amount) -> Result<Self, CompilationError>

return a context with the new amount if amount is smaller or equal to available

pub fn spend_amount(self, amount: Amount) -> Result<Self, CompilationError>

decrease the amount available in this context object.

pub fn add_amount(self, amount: Amount) -> Self

Add funds to the context object (not typically needed)

pub fn template(self) -> Builder

Get a template builder from this context object

pub fn compiled_from_descriptor(
    d: Descriptor<PublicKey>,
    a: Option<AmountRange>
) -> Compiled

converts a descriptor and an optional AmountRange to a Object object. This can be used for e.g. creating raw SegWit Scripts.