VerificationKeyUpgradeAuthority

VerificationKeyUpgradeAuthority is a smart contract that provides a secure mechanism for upgrading the verification keys of other contracts without requiring redeployment. It manages a list of validators who can vote on upgrade proposals, ensuring that only authorized upgrades are applied.

Key Features:

• Verification Key Management: Allows for secure upgrades of verification keys for other contracts.
• Validators Governance: Maintains a list of authorized validators who can vote on upgrade proposals.
• Secure Voting Mechanism: Implements Zero-Knowledge proofs to validate votes from validators without revealing sensitive information.
• Upgrade Database Management: Keeps track of upgrade proposals and their validity periods.
• Event Emissions: Emits events when validators list or upgrade database is updated.

Hierarchy

• SmartContract
  • VerificationKeyUpgradeAuthority

Implements

• UpgradeAuthorityBase

Index

Constructors

• constructor

Properties

• events
• upgradeDatabasePacked
• validators
• verificationKeyHash

Methods

• checkValidatorsDecision
• deploy
• initialize
• setValidatorsList
• updateDatabase
• updateValidatorsList
• verifyUpgradeData

Constructors

externalconstructor

• new VerificationKeyUpgradeAuthority(address: PublicKey, tokenId?: Field): VerificationKeyUpgradeAuthority

• Inherited from SmartContract.constructor

  Parameters

  • externaladdress: PublicKey

  • externaloptionaltokenId: Field

  Returns VerificationKeyUpgradeAuthority

Properties

events

events: { updateDatabase: typeof UpgradeDatabaseState; validatorsList: typeof ValidatorsListEvent } = ...

Implementation of UpgradeAuthorityBase.events

Overrides SmartContract.events

The events emitted by the VerificationKeyUpgradeAuthority contract.

---

Type declaration

• updateDatabase: typeof UpgradeDatabaseState

• validatorsList: typeof ValidatorsListEvent

upgradeDatabasePacked

upgradeDatabasePacked: State<UpgradeDatabaseStatePacked> = ...

Packed state containing the upgrade database information.

validators

validators: State<Field> = ...

The hash representing the current state of the validators list.

verificationKeyHash

verificationKeyHash: State<Field> = ...

The hash of the verification key.

Methods

checkValidatorsDecision

• checkValidatorsDecision(proof: ValidatorsVotingProof, vk: VerificationKey, decisionType: Field): Promise<void>

• Checks the validators' decision by verifying the provided proof.

  ---

  Parameters

  • proof: ValidatorsVotingProof

    The proof to verify.

  • vk: VerificationKey

    The verification key to validate the proof.

  • decisionType: Field

    The type of decision being validated.

  Returns Promise<void>

deploy

• deploy(): Promise<void>

• Implementation of UpgradeAuthorityBase.deploy

  Overrides SmartContract.deploy

  Deploys the contract and sets the initial state.

  ---

  Returns Promise<void>

initialize

• initialize(validators: ValidatorsState, storage: Storage, verificationKeyHash: Field): Promise<void>

• Initializes the contract with validators and sets the verification key hash.

  ---

  Parameters

  • validators: ValidatorsState

    The initial validators state.

  • storage: Storage

    Off-chain storage information, e.g., IPFS hash.

  • verificationKeyHash: Field

    The hash of the verification key.

  Returns Promise<void>

setValidatorsList

• setValidatorsList(validators: ValidatorsState, storage: Storage): Promise<void>

• Sets the validators list and emits an event.

  ---

  Parameters

  • validators: ValidatorsState

    The validators state to set.

  • storage: Storage

    The storage associated with the validators list.

  Returns Promise<void>

updateDatabase

• updateDatabase(proof: ValidatorsVotingProof, vk: VerificationKey): Promise<void>

• Updates the upgrade database after validator consensus.

  ---

  Parameters

  • proof: ValidatorsVotingProof

    The proof of validators voting.

  • vk: VerificationKey

    The verification key to validate the proof.

  Returns Promise<void>

updateValidatorsList

• updateValidatorsList(validators: ValidatorsState, storage: Storage, proof: ValidatorsVotingProof, vk: VerificationKey): Promise<void>

• Updates the validators list based on validator votes.

  ---

  Parameters

  • validators: ValidatorsState

    The new validators state.

  • storage: Storage

    The storage associated with the validators list.

  • proof: ValidatorsVotingProof

    The proof of validators voting.

  • vk: VerificationKey

    The verification key to validate the proof.

  Returns Promise<void>

publicverifyUpgradeData

• verifyUpgradeData(data: VerificationKeyUpgradeData): Promise<UpgradeAuthorityAnswer>

• Implementation of UpgradeAuthorityBase.verifyUpgradeData

  Verifies the upgrade data provided by another contract.

  ---

  Parameters

  • data: VerificationKeyUpgradeData

    The upgrade data to verify.

  Returns Promise<UpgradeAuthorityAnswer>

  • The answer indicating verification result.