Crate tari_template_lib

This crate contains an interface for WASM templates to interact with the state of the Tari Network, as well as some utilities for executing functions that may be slow in the WASM environment.

In most cases, you will only require the prelude which can be included with:

use tari_template_lib::prelude::*;

Modules

• args
  Definitions and utilities related to instruction arguments
• auth
  Access control rules for template-related data like component methods and resources
• caller_context
  Context definitions related to the caller of an instruction
• component
  Utilities for building and managing components inside templates
• constants
  A collection of convenient constant values
• crypto
  Cryptography utilities related to public keys and balance proofs
• events
  A wrapper for engine calls related to events
• macros
  Rust macros that can be used inside templates
• models
  The collection of all struct definitions that represent data in the Tari network (e.g., resources, components, proofs, etc.)
• panic_hook
  Hook that implements common behavior when a panic happens during template execution
• prelude
  The prelude contains all the commonly used types and functions that are used. To use it, add the import use tari_template_lib::prelude::*;
• rand
  Utilities to get random values inside templates
• resource
  Utilities for building and managing resources inside templates
• template
  Utilities related to templates
• template_dependencies
  Public types that are available to internal template code.

Macros

• __args_inner
  Low-level macro for building instruction arguments, used by both arg! and args! macros. Not intended for general usage.
• __expr_counter
  Low-level macro used for counting characters in the encoding of arguments. Not intended for general usage
• arg
  Utility macro for building a single instruction argument
• args
  Utility macro for building multiple instruction arguments
• debug
  Macro for writing debug messages from inside templates
• error
  Macro for emitting error log messages from inside templates
• info
  Macro for emitting log messages from inside templates
• invoke_args
  Low-level macro used for encoding the arguments of engine calls. Not intended for general usage
• log
  Macro for emitting log messages from inside templates
• newtype_struct_serde_impl
  Low-level macro used for generating serde serializers/deserializers for newtype structs. Not intended for general usage
• warn
  Macro for emitting warn log messages from inside templates

Structs

• AbiContext
  TODO: YAGNI currently, it may come into play for cross-template requests
• Consensus
  The Consensus module provides access to data about the current state of the chain. Currently, it only exposes the epoch via current_epoch.
• Hash
  Representation of a 32-byte hash value
• HashParseError
  Representation of a hash parsing error

Functions

• engine
  Returns the corresponding TariEngine of the current template execution
• get_context
  Returns a template’s current call context
• init_context
  Sets up a template’s current call context
• to_value
  Encodes any Rust type using CBOR