Skip to content

Commit

Permalink
chore: doc comment check for validators
Browse files Browse the repository at this point in the history
  • Loading branch information
logicalmechanism committed Jan 13, 2025
1 parent 3dbd87a commit fb75e20
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions seedelf-contracts/validators/seedelf.ak
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
//// The minter is used to define a specific registry in the wallet contract.
//// Its an open policy for minting and burning but each token will always
//// The minter defines a specific registry in the wallet contract.
//// It's an open policy for minting and burning, but each token will always
//// be unique. The token acts as a locator for the root datum. A user can
//// display the token name as their address then another user may locate the
//// UTxO that holds the nft and obtain the Register datum. This datum is then
//// display the token name as their address, then another user may locate the
//// UTxO that holds the nft and obtains the Register datum. This datum is then
//// used to produce a private address for the user. A single user may have
//// multiple 5eed0e1f addresses and can delete them whenever by simply burning
//// the 5eed0e1f token. This is more convenience then mandatory for the wallet
//// to function properly as any token may be used as the locator token.
//// the 5eed0e1f token. This token is more convenient than mandatory for the wallet
//// to function properly, as any token can be the locator.
////

use aiken/primitive/bytearray
Expand Down
6 changes: 3 additions & 3 deletions seedelf-contracts/validators/wallet.ak
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
//// A UTxO may be spent if and only if a user can provide the proper NIZK
//// elements to prove that g^z = g^r * u^c for a given (g, u) register.
//// It is assumed that the set of all elements, (g, u), are unique such that
//// It is assumed that the set of all elements (g, u) is unique such that
//// no two datums have the same hash. This should allow an arbitrary amount
//// of UTxOs to be spent inside a single tx, allowing the contract to act like
//// of UTxOs to be spent inside a single TX, allowing the contract to act like
//// a wallet for some user who knows a secret value x. A user can always
//// find their UTxOs by searching all Register datums for a (g, u) element where
//// g^x = u. Another user can send a UTxO to the (g, u) element by selecting a
//// large random integer d then doing the transformation,
//// (g, u) -> (g^d, u^d). This perserves the g and u relationship while
//// (g, u) -> (g^d, u^d). This preserves the g and u relationship while
//// providing privacy as the new element, (g^d, u^d), can not be inverted into
//// the original (g, u) element.
////
Expand Down

0 comments on commit fb75e20

Please # to comment.