Private #_Private #executionA list of event types that can be emitted using this.emitEvent()`.
Static Optional _maxStatic _methodStatic Optional _methodsStatic Optional _proversStatic Optional _verificationCurrent account of the SmartContract.
Balance of this SmartContract.
Current network state of the SmartContract.
Returns the current AccountUpdate associated to this SmartContract.
The public key of the current transaction's sender account.
Throws an error if not inside a transaction, or the sender wasn't passed in.
Warning: The fact that this public key equals the current sender is not part of the proof. A malicious prover could use any other public key without affecting the validity of the proof.
Token of the SmartContract.
Approve an account update or callback. This will include the account update in the zkApp's public input, which means it allows you to read and use its content in a proof, make assertions about it, and modify it.
If this is called with a callback as the first parameter, it will first extract the account update produced by that callback. The extracted account update is returned.
\@method myApprovingMethod(callback: Callback) {
let approvedUpdate = this.approve(callback);
}
Under the hood, "approving" just means that the account update is made a child of the zkApp in the
tree of account updates that forms the transaction.
The second parameter layout allows you to also make assertions about the approved update's own children,
by specifying a certain expected layout of children. See Layout.
The account update that was approved (needed when passing in a Callback)
Optional layout: AccountUpdatesLayoutDeploys a SmartContract.
let tx = await Mina.transaction(feePayer, () => {
AccountUpdate.fundNewAccount(feePayer, { initialBalance });
zkapp.deploy({ zkappKey });
});
Optional verificationOptional zkappFetches a list of events that have been emitted by this SmartContract.
SmartContract.init() will be called only when a SmartContract will be first deployed, not for redeployment.
This method can be overridden as follows
class MyContract extends SmartContract {
init() {
super.init();
this.account.permissions.set(...);
this.x.set(Field(1));
}
}
Optional zkappKey: PrivateKeySame as SmartContract.self but explicitly creates a new AccountUpdate.
Use this command if the account update created by this SmartContract should be signed by the account owner, instead of authorized with a proof.
Note that the smart contract's Permissions determine which updates have to be (can be) authorized by a signature.
If you only want to avoid creating proofs for quicker testing, we advise you to
use LocalBlockchain({ proofsEnabled: false }) instead of requireSignature(). Setting
proofsEnabled to false allows you to test your transactions with the same authorization flow as in production,
with the only difference being that quick mock proofs are filled in instead of real proofs.
use this.account.permissions.set()
this.sign() is deprecated in favor of this.requireSignature()
Optional zkappKey: PrivateKeyUse this command if the account update created by this SmartContract should have no authorization on it, instead of being authorized with a proof.
WARNING: This is a method that should rarely be useful. If you want to disable proofs for quicker testing, take a look
at LocalBlockchain({ proofsEnabled: false }), which causes mock proofs to be created and doesn't require changing the
authorization flow.
Static ProofReturns a Proof type that belongs to this SmartContract.
Static analyzeThis function is run internally before compiling a smart contract, to collect metadata about what each of your smart contract methods does.
For external usage, this function can be handy because calling it involves running all methods in the same "mode" as compile() does,
so it serves as a quick-to-run check for whether your contract can be compiled without errors, which can greatly speed up iterating.
analyzeMethods() will also return the number of rows of each of your method circuits (i.e., the number of constraints in the underlying proof system),
which is a good indicator for circuit size and the time it will take to create proofs.
Note: If this function was already called before, it will short-circuit and just return the metadata collected the first time.
an object, keyed by method name, each entry containing:
rows the size of the constraint system created by this methoddigest a digest of the method circuithasReturn a boolean indicating whether the method returns a valuesequenceEvents the number of actions the method dispatchesStatic compileCompile your smart contract.
This generates both the prover functions, needed to create proofs for running @methods,
and the verification key, needed to deploy your zkApp.
Although provers and verification key are returned by this method, they are also cached internally and used when needed, so you don't actually have to use the return value of this function.
Under the hood, "compiling" means calling into the lower-level Pickles and Kimchi libraries to create two prover & verifier indices (one for the "step circuit" which combines all of your smart contract methods into one circuit, and one for the "wrap circuit" which wraps it so that proofs end up in the original finite field). These are fairly expensive operations, so expect compiling to take at least 20 seconds, up to several minutes if your circuit is large or your hardware is not optimal for these operations.
Static digestComputes a hash of your smart contract, which will reliably change whenever one of your method circuits changes. This digest is quick to compute. it is designed to help with deciding whether a contract should be re-compiled or a cached verification key can be used.
the digest, as a hex string
Static runGenerated using TypeDoc
The main zkapp class. To write a zkapp, extend this class as such: