Class SmartContract

The main zkapp class. To write a zkapp, extend this class as such:

class YourSmartContract extends SmartContract {
// your smart contract code here
}

Hierarchy

  • SmartContract

Constructors

Properties

#_senderState: { sender: Types.PublicKey; transactionId: number }

Type declaration

#executionState: undefined | ExecutionState
address: Types.PublicKey
events: { [key: string]: FlexibleProvablePure<any> } = {}

A list of event types that can be emitted using this.emitEvent()`.

Type declaration

  • [key: string]: FlexibleProvablePure<any>
tokenId: Field
_maxProofsVerified?: 0 | 2 | 1
_methodMetadata: Record<string, { digest: string; hasReturn: boolean; rows: number; sequenceEvents: number }> = {}
_methods?: MethodInterface[]
_provers?: Prover[]
_verificationKey?: { data: string; hash: Field }

Type declaration

  • data: string
  • hash: Field

Accessors

  • get network(): PreconditionClassType<{ blockchainLength: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; globalSlotSinceGenesis: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; globalSlotSinceHardFork: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; minWindowDensity: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; nextEpochData: { epochLength: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; ledger: { hash: { isSome: Bool; value: Field }; totalCurrency: { isSome: Bool; value: { lower: UInt64; upper: UInt64 } } }; lockCheckpoint: { isSome: Bool; value: Field }; seed: { isSome: Bool; value: Field }; startCheckpoint: { isSome: Bool; value: Field } }; snarkedLedgerHash: { isSome: Bool; value: Field }; stakingEpochData: { epochLength: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; ledger: { hash: { isSome: Bool; value: Field }; totalCurrency: { isSome: Bool; value: { lower: UInt64; upper: UInt64 } } }; lockCheckpoint: { isSome: Bool; value: Field }; seed: { isSome: Bool; value: Field }; startCheckpoint: { isSome: Bool; value: Field } }; timestamp: { isSome: Bool; value: { lower: UInt64; upper: UInt64 } }; totalCurrency: { isSome: Bool; value: { lower: UInt64; upper: UInt64 } } }>
  • Current network state of the SmartContract.

    Returns PreconditionClassType<{ blockchainLength: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; globalSlotSinceGenesis: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; globalSlotSinceHardFork: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; minWindowDensity: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; nextEpochData: { epochLength: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; ledger: { hash: { isSome: Bool; value: Field }; totalCurrency: { isSome: Bool; value: { lower: UInt64; upper: UInt64 } } }; lockCheckpoint: { isSome: Bool; value: Field }; seed: { isSome: Bool; value: Field }; startCheckpoint: { isSome: Bool; value: Field } }; snarkedLedgerHash: { isSome: Bool; value: Field }; stakingEpochData: { epochLength: { isSome: Bool; value: { lower: UInt32; upper: UInt32 } }; ledger: { hash: { isSome: Bool; value: Field }; totalCurrency: { isSome: Bool; value: { lower: UInt64; upper: UInt64 } } }; lockCheckpoint: { isSome: Bool; value: Field }; seed: { isSome: Bool; value: Field }; startCheckpoint: { isSome: Bool; value: Field } }; timestamp: { isSome: Bool; value: { lower: UInt64; upper: UInt64 } }; totalCurrency: { isSome: Bool; value: { lower: UInt64; upper: UInt64 } } }>

  • get sender(): Types.PublicKey
  • 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.

    Returns Types.PublicKey

  • get tokenSymbol(): { set: any }
  • Deprecated

    use this.account.tokenSymbol

    Returns { set: any }

    • set:function

Methods

  • 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.

    Returns

    The account update that was approved (needed when passing in a Callback)

    Parameters

    • updateOrCallback: AccountUpdate | Callback<any>
    • Optional layout: AccountUpdatesLayout

    Returns AccountUpdate

  • Deploys a SmartContract.

    let tx = await Mina.transaction(feePayer, () => {
    AccountUpdate.fundNewAccount(feePayer, { initialBalance });
    zkapp.deploy({ zkappKey });
    });

    Parameters

    • __namedParameters: { verificationKey?: { data: string; hash: string | Field }; zkappKey?: PrivateKey } = {}
      • Optional verificationKey?: { data: string; hash: string | Field }
        • data: string
        • hash: string | Field
      • Optional zkappKey?: PrivateKey

    Returns void

  • Emits an event. Events will be emitted as a part of the transaction and can be collected by archive nodes.

    Type Parameters

    Type Parameters

    • K extends string | number

    Parameters

    • type: K
    • event: any

    Returns void

  • 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));
    }
    }

    Parameters

    Returns void

  • 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.

    Returns void

  • Deprecated

    use this.account.<field>.set()

    Type Parameters

    Type Parameters

    • T

    Parameters

    • maybeValue: SetOrKeep<T>
    • value: T

    Returns void

  • Deprecated

    this.sign() is deprecated in favor of this.requireSignature()

    Parameters

    Returns void

  • Use 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.

    Returns void

  • This 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.

    Returns

    an object, keyed by method name, each entry containing:

    • rows the size of the constraint system created by this method
    • digest a digest of the method circuit
    • hasReturn a boolean indicating whether the method returns a value
    • sequenceEvents the number of actions the method dispatches

    Returns Record<string, { digest: string; hasReturn: boolean; rows: number; sequenceEvents: number }>

  • Compile 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.

    Returns Promise<{ provers: Prover[]; verificationKey: { data: string; hash: string }; verify: ((publicInput: PublicInput, proof: unknown) => Promise<boolean>) }>

  • Computes 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.

    Returns

    the digest, as a hex string

    Returns string

  • Parameters

    • run: (() => void)
        • (): void
        • Returns void

    Returns void

Generated using TypeDoc