Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 | 6x 6x 6x 6x 18x | import {
Bool,
PublicKey,
SmartContract,
VerificationKey,
Field,
Struct,
Poseidon,
Option,
} from "o1js";
export {
UpgradeAuthorityBase,
VerificationKeyUpgradeData,
UpgradeAuthorityContractConstructor,
UpgradableContract,
PublicKeyOption,
UpgradeAuthorityAnswer,
};
/**
* Represents the data required to upgrade a contract's verification key.
* It includes the contract's address, token ID, previous verification key hash,
* and the new verification key hash. This class also provides a `hash()` method
* to generate a unique identifier for the upgrade data.
*/
class VerificationKeyUpgradeData extends Struct({
/** The address of the contract to be upgraded. */
address: PublicKey,
/** The token ID associated with the contract. */
tokenId: Field,
/** The hash of the previous verification key. */
previousVerificationKeyHash: Field,
/** The hash of the new verification key. */
newVerificationKeyHash: Field,
}) {
/**
* Generates a unique hash for the upgrade data using the Poseidon hash function.
* @returns {Field} The hash representing the upgrade data.
*/
hash(): Field {
return Poseidon.hash(VerificationKeyUpgradeData.toFields(this));
}
}
/**
* An optional `PublicKey` type, used to specify the next upgrade authority if needed.
* This is crucial when the current upgrade authority cannot be used in future upgrades
* due to changes in the o1js version or other factors.
*/
class PublicKeyOption extends Option(PublicKey) {}
/**
* Represents the response from the upgrade authority after verifying the upgrade data.
* It contains the next upgrade authority's public key if a change is required, and a boolean
* indicating whether the upgrade data has been successfully verified.
*/
class UpgradeAuthorityAnswer extends Struct({
/**
* The public key of the next upgrade authority, if a change is required.
*
* If we upgrade the verification key, we may not be able to use the same upgrade
* authority next time because the new o1js version can break the verification key
* of the upgrade authority too, and since the upgrade authority serves many
* contracts, it cannot be upgraded. In this case, we need to use another upgrade
* authority with the public key that will be provided in `nextUpgradeAuthority`.
*/
nextUpgradeAuthority: PublicKeyOption,
/** Indicates whether the upgrade data has been successfully verified. */
isVerified: Bool,
}) {}
/**
* Interface that any upgrade authority contract should implement.
* Extends `SmartContract` and requires the implementation of the `verifyUpgradeData()` method,
* which takes `VerificationKeyUpgradeData` as input and returns an `UpgradeAuthorityAnswer`.
*/
type UpgradeAuthorityBase = SmartContract & {
/**
* Verifies the upgrade data for upgrading a contract's verification key.
* @param {VerificationKeyUpgradeData} data - The data required for verification.
* @returns {Promise<UpgradeAuthorityAnswer>} The result of the verification.
*/
verifyUpgradeData(
data: VerificationKeyUpgradeData
): Promise<UpgradeAuthorityAnswer>;
};
/**
* Interface for contracts that can be upgraded.
* Extends `SmartContract` and requires methods to retrieve the associated upgrade authority contract
* and to upgrade the contract's verification key using the provided verification key.
*/
type UpgradableContract = SmartContract & {
/**
* Retrieves the associated upgrade authority contract.
* @returns {Promise<UpgradeAuthorityBase>} The upgrade authority contract.
*/
getUpgradeContract(): Promise<UpgradeAuthorityBase>;
/**
* Upgrades the contract's verification key using the provided verification key.
* @param {VerificationKey} vk - The new verification key.
* @returns {Promise<void>}
*/
upgradeVerificationKey(vk: VerificationKey): Promise<void>;
};
/**
* Defines a constructor for contracts implementing `UpgradeAuthorityBase`,
* accepting an `upgradeAuthority` public key and returning an instance of `UpgradeAuthorityBase`.
*/
type UpgradeAuthorityContractConstructor = new (
upgradeAuthority: PublicKey
) => UpgradeAuthorityBase;
|