@silvana-one/upgradable 0.1.0

package/dist/web/validators.js

@@ -0,0 +1,383 @@
+import { Struct, Field, PublicKey, Signature, ZkProgram, Poseidon, SelfProof, UInt32, Experimental, DynamicProof, FeatureFlags, Bool, Nullifier, Provable, Encoding, } from "o1js";
+import { Storage } from "@silvana-one/storage";
+import { PublicKeyOption } from "./upgradable.js";
+import MinaSigner from "mina-signer";
+export { ValidatorsList, UpgradeAuthorityDatabase, ValidatorsState, ValidatorsDecision, ValidatorDecisionType, ValidatorsDecisionState, ValidatorsVoting, ValidatorsVotingProof, ValidatorsVotingNativeProof, UpgradeDatabaseState, UpgradeDatabaseStatePacked, ChainId, };
+const { IndexedMerkleMap } = Experimental;
+const VALIDATORS_LIST_HEIGHT = 10;
+const UPGRADE_AUTHORITY_DATABASE_HEIGHT = 20;
+/**
+ * The `ValidatorsList` is an indexed Merkle map used to store the list of validators.
+ */
+class ValidatorsList extends IndexedMerkleMap(VALIDATORS_LIST_HEIGHT) {
+}
+/**
+ * The `UpgradeAuthorityDatabase` is an indexed Merkle map used to manage upgrade proposals.
+ */
+class UpgradeAuthorityDatabase extends IndexedMerkleMap(UPGRADE_AUTHORITY_DATABASE_HEIGHT) {
+}
+/** Chain IDs following Auro Wallet naming conventions. */
+const ChainId = {
+    "mina:mainnet": fieldFromString("mina:mainnet"),
+    "mina:devnet": fieldFromString("mina:devnet"),
+    "zeko:mainnet": fieldFromString("zeko:mainnet"),
+    "zeko:devnet": fieldFromString("zeko:devnet"),
+};
+/** Validator decision types for upgrade proposals. */
+const ValidatorDecisionType = {
+    updateDatabase: fieldFromString("updateDatabase"),
+    updateValidatorsList: fieldFromString("updateValidatorsList"),
+};
+/**
+ * Represents the state of the validators.
+ */
+class ValidatorsState extends Struct({
+    /** Chain ID (e.g., 'mina:mainnet') */
+    chainId: Field,
+    /** Merkle root of the ValidatorsList */
+    root: Field,
+    /** Number of validators */
+    count: UInt32,
+}) {
+    /**
+     * Asserts that two `ValidatorsState` instances are equal.
+     * @param a First `ValidatorsState` instance.
+     * @param b Second `ValidatorsState` instance.
+     */
+    static assertEquals(a, b) {
+        a.chainId.assertEquals(b.chainId);
+        a.root.assertEquals(b.root);
+        a.count.assertEquals(b.count);
+    }
+    /**
+     * Computes the hash of the validators state.
+     * @returns Hash of the current state.
+     */
+    hash() {
+        return Poseidon.hashPacked(ValidatorsState, this);
+    }
+    /**
+     * Returns an empty `ValidatorsState`.
+     * @returns An empty `ValidatorsState` instance.
+     */
+    static empty() {
+        return new ValidatorsState({
+            chainId: Field(0),
+            root: Field(0),
+            count: UInt32.zero,
+        });
+    }
+}
+/**
+ * Represents the packed state of the upgrade database.
+ */
+class UpgradeDatabaseStatePacked extends Struct({
+    /** Root of the UpgradeAuthority database */
+    root: Field,
+    /** Storage information (e.g., IPFS hash) */
+    storage: Storage,
+    /** X-coordinate of the next upgrade authority's public key */
+    nextUpgradeAuthorityX: Field,
+    /** Packed data containing version, validFrom, and flags */
+    data: Field,
+}) {
+}
+/**
+ * Represents the state of the upgrade database.
+ */
+class UpgradeDatabaseState extends Struct({
+    /** Root of the UpgradeAuthority database */
+    root: Field,
+    /** Storage information (e.g., IPFS hash) */
+    storage: Storage,
+    /** Optional public key of the next upgrade authority */
+    nextUpgradeAuthority: PublicKeyOption,
+    /** Version of the UpgradeAuthorityDatabase */
+    version: UInt32,
+    /** Slot when the UpgradeAuthority is valid from */
+    validFrom: UInt32,
+}) {
+    /**
+     * Asserts that two `UpgradeDatabaseState` instances are equal.
+     * @param a First `UpgradeDatabaseState` instance.
+     * @param b Second `UpgradeDatabaseState` instance.
+     */
+    static assertEquals(a, b) {
+        a.root.assertEquals(b.root);
+        Storage.assertEquals(a.storage, b.storage);
+        a.nextUpgradeAuthority.value.assertEquals(b.nextUpgradeAuthority.value);
+        a.nextUpgradeAuthority.isSome.assertEquals(b.nextUpgradeAuthority.isSome);
+        a.version.assertEquals(b.version);
+    }
+    /**
+     * Returns an empty `UpgradeDatabaseState`.
+     * @returns An empty `UpgradeDatabaseState` instance.
+     */
+    static empty() {
+        return new UpgradeDatabaseState({
+            root: new UpgradeAuthorityDatabase().root,
+            storage: Storage.empty(),
+            nextUpgradeAuthority: PublicKeyOption.none(),
+            version: UInt32.zero,
+            validFrom: UInt32.MAXINT(),
+        });
+    }
+    /**
+     * Packs the `UpgradeDatabaseState` into a `UpgradeDatabaseStatePacked`.
+     * @returns A packed representation of the upgrade database state.
+     */
+    pack() {
+        const nextUpgradeAuthorityX = this.nextUpgradeAuthority.value.x;
+        const data = Field.fromBits([
+            ...this.version.value.toBits(32),
+            ...this.validFrom.value.toBits(32),
+            this.nextUpgradeAuthority.value.isOdd,
+            this.nextUpgradeAuthority.isSome,
+        ]);
+        return new UpgradeDatabaseStatePacked({
+            root: this.root,
+            storage: this.storage,
+            nextUpgradeAuthorityX,
+            data,
+        });
+    }
+    /**
+     * Unpacks a `UpgradeDatabaseStatePacked` into a `UpgradeDatabaseState`.
+     * @param packed The packed upgrade database state.
+     * @returns An unpacked `UpgradeDatabaseState` instance.
+     */
+    static unpack(packed) {
+        const bits = packed.data.toBits(66);
+        const versionBits = bits.slice(0, 32);
+        const validFromBits = bits.slice(32, 64);
+        const isOddBit = bits[64];
+        const isSomeBit = bits[65];
+        const version = UInt32.Unsafe.fromField(Field.fromBits(versionBits));
+        const validFrom = UInt32.Unsafe.fromField(Field.fromBits(validFromBits));
+        const nextUpgradeAuthority = PublicKeyOption.from(PublicKey.from({ x: packed.nextUpgradeAuthorityX, isOdd: isOddBit }));
+        nextUpgradeAuthority.isSome = isSomeBit;
+        return new UpgradeDatabaseState({
+            root: packed.root,
+            storage: packed.storage,
+            nextUpgradeAuthority,
+            version,
+            validFrom,
+        });
+    }
+}
+/**
+ * Represents a decision made by the validators.
+ */
+class ValidatorsDecision extends Struct({
+    /** Message to be signed when producing the nullifier, also serves as the nonce to prevent replay attacks */
+    message: Field,
+    /** Type of decision (e.g., 'updateDatabase') */
+    decisionType: Field,
+    /** UpgradeAuthority contract address */
+    contractAddress: PublicKey,
+    /** Chain ID */
+    chainId: Field,
+    /** Current validators state */
+    validators: ValidatorsState,
+    /** Current upgrade database state */
+    upgradeDatabase: UpgradeDatabaseState,
+    /** Proposed update to validators state */
+    updateValidatorsList: ValidatorsState,
+    /** Slot when decision expires */
+    expiry: UInt32,
+}) {
+    /**
+     * Asserts that two `ValidatorsDecision` instances are equal.
+     * @param a First `ValidatorsDecision` instance.
+     * @param b Second `ValidatorsDecision` instance.
+     */
+    static assertEquals(a, b) {
+        a.message.assertEquals(b.message);
+        a.decisionType.assertEquals(b.decisionType);
+        a.contractAddress.assertEquals(b.contractAddress);
+        a.chainId.assertEquals(b.chainId);
+        ValidatorsState.assertEquals(a.validators, b.validators);
+        UpgradeDatabaseState.assertEquals(a.upgradeDatabase, b.upgradeDatabase);
+        a.expiry.assertEquals(b.expiry);
+    }
+    createNullifierMessage() {
+        return [this.message, ...ValidatorsDecision.toFields(this)];
+    }
+    createJsonNullifier(params) {
+        const { network, privateKey } = params;
+        const minaSigner = new MinaSigner({ network });
+        const message = this.createNullifierMessage();
+        const nullifier = minaSigner.createNullifier(message.map((field) => field.toBigInt()), privateKey.toBase58());
+        return nullifier;
+    }
+}
+/**
+ * Represents the state of a validators decision during the voting process.
+ */
+class ValidatorsDecisionState extends Struct({
+    /** The validators' decision */
+    decision: ValidatorsDecision,
+    /** Indexed Merkle Map root of the validators who have voted */
+    alreadyVoted: Field,
+    /** Number of votes in favor of the decision */
+    yesVotes: UInt32,
+    /** Number of votes against the decision */
+    noVotes: UInt32,
+    /** Number of votes of abstention */
+    abstainVotes: UInt32,
+}) {
+    static startVoting(decision) {
+        return new ValidatorsDecisionState({
+            decision,
+            alreadyVoted: new ValidatorsList().root,
+            yesVotes: UInt32.zero,
+            noVotes: UInt32.zero,
+            abstainVotes: UInt32.zero,
+        });
+    }
+    /**
+     * Records a vote
+     * @param validatorNullifier The nullifier of the validator.
+     * @param validatorsList The ValidatorsList containing authorized validators.
+     * @param votedList The ValidatorsList tracking who has already voted.
+     * @param yes Whether this is a "yes" vote.
+     * @param no Whether this is a "no" vote.
+     * @param abstain Whether this is an "abstain" vote.
+     * @param signature The signature of the validator.
+     * @returns A new `ValidatorsDecisionState` reflecting the vote.
+     */
+    vote(validatorNullifier, validatorsList, votedList, yes, no, abstain, signature) {
+        const publicKey = validatorNullifier.getPublicKey();
+        const key = validatorNullifier.key();
+        validatorNullifier.verify(this.decision.createNullifierMessage());
+        const previousVotesCount = this.yesVotes
+            .add(this.noVotes)
+            .add(this.abstainVotes);
+        const yesVotes = this.yesVotes.add(Provable.if(yes, UInt32.from(1), UInt32.from(0)));
+        const noVotes = this.noVotes.add(Provable.if(no, UInt32.from(1), UInt32.from(0)));
+        const abstainVotes = this.abstainVotes.add(Provable.if(abstain, UInt32.from(1), UInt32.from(0)));
+        // Ensure exactly one vote type is selected
+        previousVotesCount
+            .add(UInt32.from(1))
+            .assertEquals(yesVotes.add(noVotes).add(abstainVotes));
+        const hash = Poseidon.hashPacked(PublicKey, publicKey);
+        validatorsList.root.assertEquals(this.decision.validators.root);
+        validatorsList
+            .get(hash)
+            .assertBool("Wrong ValidatorsList format")
+            .assertTrue("Validator doesn't have authority to sign");
+        signature
+            .verify(publicKey, ValidatorsDecision.toFields(this.decision))
+            .assertTrue("Wrong validator signature");
+        this.decision.validators.root.assertEquals(validatorsList.root);
+        votedList.root.assertEquals(this.alreadyVoted);
+        votedList.insert(key, Field(1));
+        return new ValidatorsDecisionState({
+            decision: this.decision,
+            alreadyVoted: votedList.root,
+            yesVotes,
+            noVotes,
+            abstainVotes,
+        });
+    }
+    /**
+     * Asserts that two `ValidatorsDecisionState` instances are equal.
+     * @param a First `ValidatorsDecisionState` instance.
+     * @param b Second `ValidatorsDecisionState` instance.
+     */
+    static assertEquals(a, b) {
+        ValidatorsDecision.assertEquals(a.decision, b.decision);
+        a.alreadyVoted.assertEquals(b.alreadyVoted);
+        a.yesVotes.assertEquals(b.yesVotes);
+        a.noVotes.assertEquals(b.noVotes);
+        a.abstainVotes.assertEquals(b.abstainVotes);
+    }
+}
+/**
+ * The `ValidatorsVoting` ZkProgram implements the voting logic for validators.
+ */
+const ValidatorsVoting = ZkProgram({
+    name: "ValidatorsVoting",
+    publicInput: ValidatorsDecisionState,
+    publicOutput: ValidatorsDecisionState,
+    methods: {
+        /**
+         * Starts the voting process for a decision.
+         */
+        startVoting: {
+            privateInputs: [ValidatorsDecision],
+            async method(state, decision) {
+                const calculatedState = ValidatorsDecisionState.startVoting(decision);
+                ValidatorsDecisionState.assertEquals(state, calculatedState);
+                return { publicOutput: calculatedState };
+            },
+        },
+        /**
+         * Records a vote
+         */
+        vote: {
+            privateInputs: [
+                ValidatorsDecision,
+                Nullifier,
+                ValidatorsList,
+                ValidatorsList,
+                Bool,
+                Bool,
+                Bool,
+                Signature,
+            ],
+            async method(state, decision, nullifier, validatorsList, votedList, yes, no, abstain, signature) {
+                const calculatedState = state.vote(nullifier, validatorsList, votedList, yes, no, abstain, signature);
+                return { publicOutput: calculatedState };
+            },
+        },
+        /**
+         * Merges two `ValidatorsDecisionState` proofs.
+         */
+        merge: {
+            privateInputs: [SelfProof, SelfProof],
+            async method(state, proof1, proof2) {
+                proof1.verify();
+                proof2.verify();
+                ValidatorsDecisionState.assertEquals(state, proof1.publicInput);
+                ValidatorsDecisionState.assertEquals(proof1.publicOutput, proof2.publicInput);
+                return { publicOutput: proof2.publicOutput };
+            },
+        },
+    },
+});
+/** Proof classes for the `ValidatorsVoting` ZkProgram. */
+class ValidatorsVotingNativeProof extends ZkProgram.Proof(ValidatorsVoting) {
+}
+class ValidatorsVotingProof extends DynamicProof {
+    static { this.publicInputType = ValidatorsDecisionState; }
+    static { this.publicOutputType = ValidatorsDecisionState; }
+    static { this.maxProofsVerified = 2; }
+    static { this.featureFlags = FeatureFlags.allMaybe; }
+}
+/**
+ * Converts a `Field` element to a string representation.
+ * This is used for serializing `Field` values into strings suitable for storage or transmission.
+ *
+ * @param {Field} field - The `Field` element to convert.
+ * @returns {string} The string representation of the `Field`.
+ */
+function fieldToString(field) {
+    return Encoding.stringFromFields([field]);
+}
+/**
+ * Reconstructs a `Field` element from its string representation.
+ * This function is essential for deserializing strings back into `Field` elements,
+ * which can then be used within the smart contract logic.
+ *
+ * @param {string} storage - The string representation of the `Field`.
+ * @returns {Field} The reconstructed `Field` element.
+ * @throws Will throw an error if the input string does not correspond to exactly one `Field`.
+ */
+function fieldFromString(storage) {
+    const fields = Encoding.stringToFields(storage);
+    if (fields.length !== 1)
+        throw new Error("String is too long");
+    return fields[0];
+}
+//# sourceMappingURL=validators.js.map

package/dist/web/validators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.js","sourceRoot":"","sources":["../../src/validators.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,KAAK,EACL,SAAS,EACT,SAAS,EACT,SAAS,EACT,QAAQ,EACR,SAAS,EACT,MAAM,EACN,YAAY,EACZ,YAAY,EACZ,YAAY,EAEZ,IAAI,EACJ,SAAS,EAET,QAAQ,EACR,QAAQ,GACT,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,UAAU,MAAM,aAAa,CAAC;AAErC,OAAO,EACL,cAAc,EACd,wBAAwB,EACxB,eAAe,EACf,kBAAkB,EAClB,qBAAqB,EACrB,uBAAuB,EACvB,gBAAgB,EAChB,qBAAqB,EACrB,2BAA2B,EAC3B,oBAAoB,EACpB,0BAA0B,EAC1B,OAAO,GACR,CAAC;AAEF,MAAM,EAAE,gBAAgB,EAAE,GAAG,YAAY,CAAC;AAG1C,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAE7C;;GAEG;AACH,MAAM,cAAe,SAAQ,gBAAgB,CAAC,sBAAsB,CAAC;CAAG;AAExE;;GAEG;AACH,MAAM,wBAAyB,SAAQ,gBAAgB,CACrD,iCAAiC,CAClC;CAAG;AAEJ,0DAA0D;AAC1D,MAAM,OAAO,GAAG;IACd,cAAc,EAAE,eAAe,CAAC,cAAc,CAAC;IAC/C,aAAa,EAAE,eAAe,CAAC,aAAa,CAAC;IAC7C,cAAc,EAAE,eAAe,CAAC,cAAc,CAAC;IAC/C,aAAa,EAAE,eAAe,CAAC,aAAa,CAAC;CAC9C,CAAC;AAGF,sDAAsD;AACtD,MAAM,qBAAqB,GAAG;IAC5B,cAAc,EAAE,eAAe,CAAC,gBAAgB,CAAC;IACjD,oBAAoB,EAAE,eAAe,CAAC,sBAAsB,CAAC;CACrD,CAAC;AAGX;;GAEG;AACH,MAAM,eAAgB,SAAQ,MAAM,CAAC;IACnC,sCAAsC;IACtC,OAAO,EAAE,KAAK;IACd,wCAAwC;IACxC,IAAI,EAAE,KAAK;IACX,2BAA2B;IAC3B,KAAK,EAAE,MAAM;CACd,CAAC;IACA;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,CAAkB,EAAE,CAAkB;QACxD,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,IAAI;QACF,OAAO,QAAQ,CAAC,UAAU,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAK;QACV,OAAO,IAAI,eAAe,CAAC;YACzB,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;YACjB,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;YACd,KAAK,EAAE,MAAM,CAAC,IAAI;SACnB,CAAC,CAAC;IACL,CAAC;CACF;AAED;;GAEG;AACH,MAAM,0BAA2B,SAAQ,MAAM,CAAC;IAC9C,4CAA4C;IAC5C,IAAI,EAAE,KAAK;IACX,4CAA4C;IAC5C,OAAO,EAAE,OAAO;IAChB,8DAA8D;IAC9D,qBAAqB,EAAE,KAAK;IAC5B,2DAA2D;IAC3D,IAAI,EAAE,KAAK;CACZ,CAAC;CAAG;AAEL;;GAEG;AACH,MAAM,oBAAqB,SAAQ,MAAM,CAAC;IACxC,4CAA4C;IAC5C,IAAI,EAAE,KAAK;IACX,4CAA4C;IAC5C,OAAO,EAAE,OAAO;IAChB,wDAAwD;IACxD,oBAAoB,EAAE,eAAe;IACrC,8CAA8C;IAC9C,OAAO,EAAE,MAAM;IACf,mDAAmD;IACnD,SAAS,EAAE,MAAM;CAClB,CAAC;IACA;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,CAAuB,EAAE,CAAuB;QAClE,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC5B,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;QAC3C,CAAC,CAAC,oBAAoB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;QACxE,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAC1E,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAK;QACV,OAAO,IAAI,oBAAoB,CAAC;YAC9B,IAAI,EAAE,IAAI,wBAAwB,EAAE,CAAC,IAAI;YACzC,OAAO,EAAE,OAAO,CAAC,KAAK,EAAE;YACxB,oBAAoB,EAAE,eAAe,CAAC,IAAI,EAAE;YAC5C,OAAO,EAAE,MAAM,CAAC,IAAI;YACpB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE;SAC3B,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,IAAI;QACF,MAAM,qBAAqB,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC;QAChE,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC;YAC1B,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YAChC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YAClC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,KAAK;YACrC,IAAI,CAAC,oBAAoB,CAAC,MAAM;SACjC,CAAC,CAAC;QACH,OAAO,IAAI,0BAA0B,CAAC;YACpC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,qBAAqB;YACrB,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,MAAkC;QAC9C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACpC,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACtC,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;QAC3B,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;QACrE,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC;QACzE,MAAM,oBAAoB,GAAG,eAAe,CAAC,IAAI,CAC/C,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,qBAAqB,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CACrE,CAAC;QACF,oBAAoB,CAAC,MAAM,GAAG,SAAS,CAAC;QACxC,OAAO,IAAI,oBAAoB,CAAC;YAC9B,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,oBAAoB;YACpB,OAAO;YACP,SAAS;SACV,CAAC,CAAC;IACL,CAAC;CACF;AAED;;GAEG;AACH,MAAM,kBAAmB,SAAQ,MAAM,CAAC;IACtC,4GAA4G;IAC5G,OAAO,EAAE,KAAK;IACd,gDAAgD;IAChD,YAAY,EAAE,KAAK;IACnB,wCAAwC;IACxC,eAAe,EAAE,SAAS;IAC1B,eAAe;IACf,OAAO,EAAE,KAAK;IACd,+BAA+B;IAC/B,UAAU,EAAE,eAAe;IAC3B,qCAAqC;IACrC,eAAe,EAAE,oBAAoB;IACrC,0CAA0C;IAC1C,oBAAoB,EAAE,eAAe;IACrC,iCAAiC;IACjC,MAAM,EAAE,MAAM;CACf,CAAC;IACA;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,CAAqB,EAAE,CAAqB;QAC9D,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;QAC5C,CAAC,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;QAClD,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAClC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC;QACzD,oBAAoB,CAAC,YAAY,CAAC,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,eAAe,CAAC,CAAC;QACxE,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAED,sBAAsB;QACpB,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED,mBAAmB,CAAC,MAGnB;QACC,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QACvC,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC9C,MAAM,SAAS,GAAG,UAAU,CAAC,eAAe,CAC1C,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,EACxC,UAAU,CAAC,QAAQ,EAAE,CACtB,CAAC;QACF,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,uBAAwB,SAAQ,MAAM,CAAC;IAC3C,+BAA+B;IAC/B,QAAQ,EAAE,kBAAkB;IAC5B,+DAA+D;IAC/D,YAAY,EAAE,KAAK;IACnB,+CAA+C;IAC/C,QAAQ,EAAE,MAAM;IAChB,2CAA2C;IAC3C,OAAO,EAAE,MAAM;IACf,oCAAoC;IACpC,YAAY,EAAE,MAAM;CACrB,CAAC;IACA,MAAM,CAAC,WAAW,CAAC,QAA4B;QAC7C,OAAO,IAAI,uBAAuB,CAAC;YACjC,QAAQ;YACR,YAAY,EAAE,IAAI,cAAc,EAAE,CAAC,IAAI;YACvC,QAAQ,EAAE,MAAM,CAAC,IAAI;YACrB,OAAO,EAAE,MAAM,CAAC,IAAI;YACpB,YAAY,EAAE,MAAM,CAAC,IAAI;SAC1B,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;OAUG;IACH,IAAI,CACF,kBAA6B,EAC7B,cAA8B,EAC9B,SAAyB,EACzB,GAAS,EACT,EAAQ,EACR,OAAa,EACb,SAAoB;QAEpB,MAAM,SAAS,GAAG,kBAAkB,CAAC,YAAY,EAAE,CAAC;QACpD,MAAM,GAAG,GAAG,kBAAkB,CAAC,GAAG,EAAE,CAAC;QACrC,kBAAkB,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,EAAE,CAAC,CAAC;QAElE,MAAM,kBAAkB,GAAG,IAAI,CAAC,QAAQ;aACrC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC;aACjB,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC1B,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAChC,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CACjD,CAAC;QACF,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAC9B,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAChD,CAAC;QACF,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CACxC,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CACrD,CAAC;QACF,2CAA2C;QAC3C,kBAAkB;aACf,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACnB,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;QAEzD,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACvD,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAChE,cAAc;aACX,GAAG,CAAC,IAAI,CAAC;aACT,UAAU,CAAC,6BAA6B,CAAC;aACzC,UAAU,CAAC,0CAA0C,CAAC,CAAC;QAC1D,SAAS;aACN,MAAM,CAAC,SAAS,EAAE,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aAC7D,UAAU,CAAC,2BAA2B,CAAC,CAAC;QAC3C,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAChE,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC/C,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAChC,OAAO,IAAI,uBAAuB,CAAC;YACjC,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,YAAY,EAAE,SAAS,CAAC,IAAI;YAC5B,QAAQ;YACR,OAAO;YACP,YAAY;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,CAA0B,EAAE,CAA0B;QACxE,kBAAkB,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC;QACxD,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;QAC5C,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;CACF;AAED;;GAEG;AACH,MAAM,gBAAgB,GAAG,SAAS,CAAC;IACjC,IAAI,EAAE,kBAAkB;IACxB,WAAW,EAAE,uBAAuB;IACpC,YAAY,EAAE,uBAAuB;IAErC,OAAO,EAAE;QACP;;WAEG;QACH,WAAW,EAAE;YACX,aAAa,EAAE,CAAC,kBAAkB,CAAC;YAEnC,KAAK,CAAC,MAAM,CACV,KAA8B,EAC9B,QAA4B;gBAE5B,MAAM,eAAe,GAAG,uBAAuB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;gBACtE,uBAAuB,CAAC,YAAY,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;gBAC7D,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;YAC3C,CAAC;SACF;QACD;;WAEG;QACH,IAAI,EAAE;YACJ,aAAa,EAAE;gBACb,kBAAkB;gBAClB,SAAS;gBACT,cAAc;gBACd,cAAc;gBACd,IAAI;gBACJ,IAAI;gBACJ,IAAI;gBACJ,SAAS;aACV;YAED,KAAK,CAAC,MAAM,CACV,KAA8B,EAC9B,QAA4B,EAC5B,SAAoB,EACpB,cAA8B,EAC9B,SAAyB,EACzB,GAAS,EACT,EAAQ,EACR,OAAa,EACb,SAAoB;gBAEpB,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,CAChC,SAAS,EACT,cAAc,EACd,SAAS,EACT,GAAG,EACH,EAAE,EACF,OAAO,EACP,SAAS,CACV,CAAC;gBACF,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;YAC3C,CAAC;SACF;QAED;;WAEG;QACH,KAAK,EAAE;YACL,aAAa,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;YAErC,KAAK,CAAC,MAAM,CACV,KAA8B,EAC9B,MAAmE,EACnE,MAAmE;gBAEnE,MAAM,CAAC,MAAM,EAAE,CAAC;gBAChB,MAAM,CAAC,MAAM,EAAE,CAAC;gBAChB,uBAAuB,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;gBAChE,uBAAuB,CAAC,YAAY,CAClC,MAAM,CAAC,YAAY,EACnB,MAAM,CAAC,WAAW,CACnB,CAAC;gBACF,OAAO,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC;YAC/C,CAAC;SACF;KACF;CACF,CAAC,CAAC;AAEH,0DAA0D;AAC1D,MAAM,2BAA4B,SAAQ,SAAS,CAAC,KAAK,CAAC,gBAAgB,CAAC;CAAG;AAC9E,MAAM,qBAAsB,SAAQ,YAGnC;aACQ,oBAAe,GAAG,uBAAuB,CAAC;aAC1C,qBAAgB,GAAG,uBAAuB,CAAC;aAC3C,sBAAiB,GAAG,CAAU,CAAC;aAC/B,iBAAY,GAAG,YAAY,CAAC,QAAQ,CAAC;;AAG9C;;;;;;GAMG;AACH,SAAS,aAAa,CAAC,KAAY;IACjC,OAAO,QAAQ,CAAC,gBAAgB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AAC5C,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,eAAe,CAAC,OAAe;IACtC,MAAM,MAAM,GAAG,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAChD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAC/D,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;AACnB,CAAC"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@silvana-one/upgradable",
+  "description": "Silvana Upgradable interface for Mina zkApps",
+  "version": "0.1.0",
+  "author": "DFST",
+  "bugs": "https://github.com/SilvanaOne/silvana-lib/issues",
+  "dependencies": {
+    "mina-signer": "^3.0.7",
+    "tslib": "^2.8.1"
+  },
+  "devDependencies": {
+    "@silvana-one/storage": "0.1.0",
+    "@types/node": "^22.10.2",
+    "esbuild": "^0.24.0",
+    "o1js": "^2.2.0",
+    "typescript": "^5.7.2"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "exports": {
+    "types": "./dist/node/index.d.ts",
+    "node": {
+      "import": "./dist/node/index.js",
+      "require": "./dist/node/index.cjs"
+    },
+    "browser": "./dist/web/index.js",
+    "default": "./dist/web/index.js"
+  },
+  "files": [
+    "dist",
+    "src",
+    "package.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "homepage": "https://docs.silvana.one",
+  "keywords": [
+    "mina-protocol",
+    "typescript",
+    "Upgradable",
+    "zkApps"
+  ],
+  "license": "Apache-2.0",
+  "main": "dist/web/index.js",
+  "peerDependencies": {
+    "@silvana-one/storage": "0.1.0",
+    "o1js": "^2.2.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": "SilvanaOne/silvana-lib.git",
+  "scripts": {
+    "build": "rm -rf dist && tsc && tsc --build tsconfig.web.json && node build-cjs.js",
+    "release": "npm publish --access public"
+  },
+  "type": "module",
+  "types": "./dist/node/index.d.ts"
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from "./validators.js";
+export * from "./upgrade.js";
+export * from "./upgradable.js";

package/src/upgradable.ts

@@ -0,0 +1,115 @@
+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;