Struct TokenPolicy

pub struct TokenPolicy<T: MoveType> {
    pub id: UID,
    pub spent_balance: Balance<T>,
    pub rules: VecMap<String, VecSet<TypeName>>,
    /* private fields */
}

TokenPolicy represents a set of rules that define what actions can be performed on a Token and which Rules must be satisfied for the action to succeed.

• For the sake of availability, TokenPolicy is a key-only object.
• Each TokenPolicy is managed by a matching TokenPolicyCap.
• For an action to become available, there needs to be a record in the rules VecMap. To allow an action to be performed freely, there’s an allow function that can be called by the TokenPolicyCap owner.

Fields

id: UID

spent_balance: Balance<T>

The balance that is effectively spent by the user on the “spend” action. However, actual decrease of the supply can only be done by the TreasuryCap owner when flush is called.

This balance is effectively spent and cannot be accessed by anyone but the TreasuryCap owner.

rules: VecMap<String, VecSet<TypeName>>

The set of rules that define what actions can be performed on the token. For each “action” there’s a set of Rules that must be satisfied for the ActionRequest to be confirmed.

Implementations

impl<T: MoveType> TokenPolicy<T>

pub fn new( id: UID, spent_balance: Balance<T>, rules: VecMap<String, VecSet<TypeName>>, ) -> Self

Constructs a new TokenPolicy.

impl<T: MoveType> TokenPolicy<T>

pub fn move_instance(self, t: <T as MoveType>::TypeTag) -> MoveInstance<Self>

pub fn type_(t: <T as MoveType>::TypeTag) -> TokenPolicyTypeTag<T>

Trait Implementations

impl<T: Clone + MoveType> Clone for TokenPolicy<T>

fn clone(&self) -> TokenPolicy<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + MoveType> Debug for TokenPolicy<T>

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

Formats the value using the given formatter.

impl<'de, T: MoveType> Deserialize<'de> for TokenPolicy<T>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: MoveType> Display for TokenPolicy<T>

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

Formats the value using the given formatter.

impl<T: MoveType> HasKey for TokenPolicy<T>

fn object_id(&self) -> ObjectId

impl<T: Hash + MoveType> Hash for TokenPolicy<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: MoveType> MoveStruct for TokenPolicy<T>

type StructTag = TokenPolicyTypeTag<T>

impl<T: MoveType> MoveType for TokenPolicy<T>

type TypeTag = TokenPolicyTypeTag<T>

fn from_bcs(bytes: &[u8]) -> Result<Self, Error>

Deserialize the contents of the Move type from BCS bytes.

fn into_bcs(self) -> Result<Vec<u8>, Error>

Consuming version of to_bcs.

fn to_bcs(&self) -> Result<Vec<u8>, Error>

Serialize the contents of the Move type to BCS bytes.

fn into_json(self) -> Value

Consuming version of to_json.

fn to_json(&self) -> Value

Serialize the contents of the Move type to JSON.

impl<T: PartialEq + MoveType> PartialEq for TokenPolicy<T>

fn eq(&self, other: &TokenPolicy<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for TokenPolicy<T>

where T: Serialize + MoveType,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: MoveType> StaticAddress for TokenPolicy<T>

fn address() -> Address

impl<T: MoveType> StaticModule for TokenPolicy<T>

fn module() -> Identifier

impl<T: MoveType> StaticName for TokenPolicy<T>

fn name() -> Identifier

impl<T: MoveType + StaticTypeTag> StaticTypeParams for TokenPolicy<T>

fn type_params() -> Vec<TypeTag>

impl<T: MoveType> Tabled for TokenPolicy<T>

const LENGTH: usize = 3usize

A length of fields and headers, which must be the same.

fn fields(&self) -> Vec<Cow<'_, str>>

Fields method must return a list of cells.

fn headers() -> Vec<Cow<'static, str>>

Headers must return a list of column names.

impl<T: Eq + MoveType> Eq for TokenPolicy<T>

impl<T: MoveType> StructuralPartialEq for TokenPolicy<T>