Struct Did

pub struct Did<M> {
    pub coin: Coin,
    pub proof: Proof,
    pub info: DidInfo<M>,
}

Contains all information needed to spend the outer puzzles of DID coins. The DidInfo is used to construct the puzzle, but the Proof is needed for the solution.

The only thing missing to create a valid coin spend is the inner puzzle and solution. However, this is handled separately to provide as much flexibility as possible.

This type should contain all of the information you need to store in a database for later. As long as you can figure out what puzzle the p2 puzzle hash corresponds to and spend it, you have enough information to spend the DID coin.

Fields

coin: Coin

The coin that this Did represents. Its puzzle hash should match the DidInfo::puzzle_hash.

proof: Proof

The proof is needed by the singleton puzzle to prove that this coin is a legitimate singleton. It’s typically obtained by looking up and parsing the parent coin.

Note that while the proof will be a LineageProof for most coins, for the first singleton in the lineage it will be an EveProof instead. However, the eve coin is typically unhinted and spent in the same transaction as it was created, so this is not relevant for database storage or syncing unspent coins.

info: DidInfo<M>

The information needed to construct the outer puzzle of a DID. See DidInfo for more details.

Implementations

impl<M> Did<M>

pub fn new(coin: Coin, proof: Proof, info: DidInfo<M>) -> Self

pub fn with_metadata<N>(self, metadata: N) -> Did<N>

impl<M> Did<M>

where M: ToTreeHash,

pub fn child_lineage_proof(&self) -> LineageProof

Creates a LineageProof for which would be valid for any children created by this Did.

pub fn child<N>( &self, p2_puzzle_hash: Bytes32, metadata: N, amount: u64, ) -> Did<N>

where M: Clone, N: ToTreeHash,

Creates a new Did that represents a child of this one.

pub fn child_with<N>(&self, info: DidInfo<N>, amount: u64) -> Did<N>

where N: ToTreeHash,

Creates a new Did that represents a child of this one.

You can specify the DidInfo to use for the child manually. In most cases, you will want to use Did::child instead.

It’s important to use the right DidInfo beforehand, otherwise the puzzle hash of the child will not match the one expected by the coin.

impl<M> Did<M>

where M: ToClvm<Allocator> + FromClvm<Allocator> + ToTreeHash + Clone,

pub fn spend( &self, ctx: &mut SpendContext, inner_spend: Spend, ) -> Result<Option<Self>, DriverError>

Spends this DID coin with the provided inner spend. The spend is added to the SpendContext for convenience.

pub fn spend_with<I>( &self, ctx: &mut SpendContext, inner: &I, conditions: Conditions, ) -> Result<Option<Self>, DriverError>

where I: SpendWithConditions,

Spends this DID coin with a Layer that supports SpendWithConditions. This is a building block for built in spend methods, but can also be used to spend DID coins with conditions more easily.

However, if you need full flexibility of the inner spend, you can use Did::spend instead.

pub fn transfer<I>( self, ctx: &mut SpendContext, inner: &I, p2_puzzle_hash: Bytes32, extra_conditions: Conditions, ) -> Result<Did<M>, DriverError>

where M: ToTreeHash, I: SpendWithConditions,

Transfers this DID coin to a new p2 puzzle hash.

This spend requires a Layer that supports SpendWithConditions. If it doesn’t, you can use Did::spend_with instead.

pub fn update_with_metadata<I, N>( self, ctx: &mut SpendContext, inner: &I, metadata: N, extra_conditions: Conditions, ) -> Result<Did<N>, DriverError>

where I: SpendWithConditions, M: ToTreeHash, N: ToClvm<Allocator> + ToTreeHash + Clone,

Updates the metadata of this DID.

Because DID coins aren’t wrapped automatically, and due to the way they are parsed in wallets, an additional update spend is needed. This additional spend is not handled by this method, so you will need to do it manually.

This spend requires a Layer that supports SpendWithConditions. If it doesn’t, you can use Did::spend_with instead.

pub fn update<I>( self, ctx: &mut SpendContext, inner: &I, extra_conditions: Conditions, ) -> Result<Did<M>, DriverError>

where M: ToTreeHash, I: SpendWithConditions,

Spends the DID without changing its metadata or p2 puzzle hash.

This can be done to “settle” the DID’s updated metadata and make it parseable by wallets. It’s also useful if you just want to emit conditions from the DID, without transferring it. For example, when assigning a DID to one or more NFTs you can use an update spend to do so.

This spend requires a Layer that supports SpendWithConditions. If it doesn’t, you can use Did::spend_with instead.

impl<M> Did<M>

where M: ToClvm<Allocator> + FromClvm<Allocator> + Clone,

pub fn parse_child( allocator: &mut Allocator, parent_coin: Coin, parent_puzzle: Puzzle, parent_solution: NodePtr, coin: Coin, ) -> Result<Option<Self>, DriverError>

where Self: Sized,

Parses the child of an Did from the parent coin spend.

This relies on the child being hinted and having the same metadata as the parent. If this is not the case, the DID cannot be parsed or spent without additional context.

Trait Implementations

impl AddAsset for Did<HashedPtr>

fn add(self, spends: &mut Spends)

impl Asset for Did<HashedPtr>

fn coin_id(&self) -> Bytes32

fn full_puzzle_hash(&self) -> Bytes32

fn p2_puzzle_hash(&self) -> Bytes32

fn amount(&self) -> u64

fn constraints(&self) -> OutputConstraints

impl<M: Clone> Clone for Did<M>

fn clone(&self) -> Did<M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug> Debug for Did<M>

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

Formats the value using the given formatter.

impl<M: PartialEq> PartialEq for Did<M>

fn eq(&self, other: &Did<M>) -> 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 SingletonAsset for Did<HashedPtr>

type ChildInfo = ChildDidInfo

fn default_child_info(asset: &Self, spend_kind: &SpendKind) -> Self::ChildInfo

fn needs_additional_spend(child_info: &Self::ChildInfo) -> bool

fn finalize( ctx: &mut SpendContext, singleton: &mut SingletonSpend<Self>, _conditions_puzzle_hash: Bytes32, change_puzzle_hash: Bytes32, ) -> Result<Option<SingletonSpend<Self>>, DriverError>

impl<M: Copy> Copy for Did<M>

impl<M: Eq> Eq for Did<M>

impl<M> StructuralPartialEq for Did<M>