@aztec/ethereum 0.0.1-commit.f2ce05ee → 0.0.1-commit.f5a9928

package/dest/contracts/slashing_proposer.js

@@ -0,0 +1,753 @@
+function applyDecs2203RFactory() {
+    function createAddInitializerMethod(initializers, decoratorFinishedRef) {
+        return function addInitializer(initializer) {
+            assertNotFinished(decoratorFinishedRef, "addInitializer");
+            assertCallable(initializer, "An initializer");
+            initializers.push(initializer);
+        };
+    }
+    function memberDec(dec, name, desc, initializers, kind, isStatic, isPrivate, metadata, value) {
+        var kindStr;
+        switch(kind){
+            case 1:
+                kindStr = "accessor";
+                break;
+            case 2:
+                kindStr = "method";
+                break;
+            case 3:
+                kindStr = "getter";
+                break;
+            case 4:
+                kindStr = "setter";
+                break;
+            default:
+                kindStr = "field";
+        }
+        var ctx = {
+            kind: kindStr,
+            name: isPrivate ? "#" + name : name,
+            static: isStatic,
+            private: isPrivate,
+            metadata: metadata
+        };
+        var decoratorFinishedRef = {
+            v: false
+        };
+        ctx.addInitializer = createAddInitializerMethod(initializers, decoratorFinishedRef);
+        var get, set;
+        if (kind === 0) {
+            if (isPrivate) {
+                get = desc.get;
+                set = desc.set;
+            } else {
+                get = function() {
+                    return this[name];
+                };
+                set = function(v) {
+                    this[name] = v;
+                };
+            }
+        } else if (kind === 2) {
+            get = function() {
+                return desc.value;
+            };
+        } else {
+            if (kind === 1 || kind === 3) {
+                get = function() {
+                    return desc.get.call(this);
+                };
+            }
+            if (kind === 1 || kind === 4) {
+                set = function(v) {
+                    desc.set.call(this, v);
+                };
+            }
+        }
+        ctx.access = get && set ? {
+            get: get,
+            set: set
+        } : get ? {
+            get: get
+        } : {
+            set: set
+        };
+        try {
+            return dec(value, ctx);
+        } finally{
+            decoratorFinishedRef.v = true;
+        }
+    }
+    function assertNotFinished(decoratorFinishedRef, fnName) {
+        if (decoratorFinishedRef.v) {
+            throw new Error("attempted to call " + fnName + " after decoration was finished");
+        }
+    }
+    function assertCallable(fn, hint) {
+        if (typeof fn !== "function") {
+            throw new TypeError(hint + " must be a function");
+        }
+    }
+    function assertValidReturnValue(kind, value) {
+        var type = typeof value;
+        if (kind === 1) {
+            if (type !== "object" || value === null) {
+                throw new TypeError("accessor decorators must return an object with get, set, or init properties or void 0");
+            }
+            if (value.get !== undefined) {
+                assertCallable(value.get, "accessor.get");
+            }
+            if (value.set !== undefined) {
+                assertCallable(value.set, "accessor.set");
+            }
+            if (value.init !== undefined) {
+                assertCallable(value.init, "accessor.init");
+            }
+        } else if (type !== "function") {
+            var hint;
+            if (kind === 0) {
+                hint = "field";
+            } else if (kind === 10) {
+                hint = "class";
+            } else {
+                hint = "method";
+            }
+            throw new TypeError(hint + " decorators must return a function or void 0");
+        }
+    }
+    function applyMemberDec(ret, base, decInfo, name, kind, isStatic, isPrivate, initializers, metadata) {
+        var decs = decInfo[0];
+        var desc, init, value;
+        if (isPrivate) {
+            if (kind === 0 || kind === 1) {
+                desc = {
+                    get: decInfo[3],
+                    set: decInfo[4]
+                };
+            } else if (kind === 3) {
+                desc = {
+                    get: decInfo[3]
+                };
+            } else if (kind === 4) {
+                desc = {
+                    set: decInfo[3]
+                };
+            } else {
+                desc = {
+                    value: decInfo[3]
+                };
+            }
+        } else if (kind !== 0) {
+            desc = Object.getOwnPropertyDescriptor(base, name);
+        }
+        if (kind === 1) {
+            value = {
+                get: desc.get,
+                set: desc.set
+            };
+        } else if (kind === 2) {
+            value = desc.value;
+        } else if (kind === 3) {
+            value = desc.get;
+        } else if (kind === 4) {
+            value = desc.set;
+        }
+        var newValue, get, set;
+        if (typeof decs === "function") {
+            newValue = memberDec(decs, name, desc, initializers, kind, isStatic, isPrivate, metadata, value);
+            if (newValue !== void 0) {
+                assertValidReturnValue(kind, newValue);
+                if (kind === 0) {
+                    init = newValue;
+                } else if (kind === 1) {
+                    init = newValue.init;
+                    get = newValue.get || value.get;
+                    set = newValue.set || value.set;
+                    value = {
+                        get: get,
+                        set: set
+                    };
+                } else {
+                    value = newValue;
+                }
+            }
+        } else {
+            for(var i = decs.length - 1; i >= 0; i--){
+                var dec = decs[i];
+                newValue = memberDec(dec, name, desc, initializers, kind, isStatic, isPrivate, metadata, value);
+                if (newValue !== void 0) {
+                    assertValidReturnValue(kind, newValue);
+                    var newInit;
+                    if (kind === 0) {
+                        newInit = newValue;
+                    } else if (kind === 1) {
+                        newInit = newValue.init;
+                        get = newValue.get || value.get;
+                        set = newValue.set || value.set;
+                        value = {
+                            get: get,
+                            set: set
+                        };
+                    } else {
+                        value = newValue;
+                    }
+                    if (newInit !== void 0) {
+                        if (init === void 0) {
+                            init = newInit;
+                        } else if (typeof init === "function") {
+                            init = [
+                                init,
+                                newInit
+                            ];
+                        } else {
+                            init.push(newInit);
+                        }
+                    }
+                }
+            }
+        }
+        if (kind === 0 || kind === 1) {
+            if (init === void 0) {
+                init = function(instance, init) {
+                    return init;
+                };
+            } else if (typeof init !== "function") {
+                var ownInitializers = init;
+                init = function(instance, init) {
+                    var value = init;
+                    for(var i = 0; i < ownInitializers.length; i++){
+                        value = ownInitializers[i].call(instance, value);
+                    }
+                    return value;
+                };
+            } else {
+                var originalInitializer = init;
+                init = function(instance, init) {
+                    return originalInitializer.call(instance, init);
+                };
+            }
+            ret.push(init);
+        }
+        if (kind !== 0) {
+            if (kind === 1) {
+                desc.get = value.get;
+                desc.set = value.set;
+            } else if (kind === 2) {
+                desc.value = value;
+            } else if (kind === 3) {
+                desc.get = value;
+            } else if (kind === 4) {
+                desc.set = value;
+            }
+            if (isPrivate) {
+                if (kind === 1) {
+                    ret.push(function(instance, args) {
+                        return value.get.call(instance, args);
+                    });
+                    ret.push(function(instance, args) {
+                        return value.set.call(instance, args);
+                    });
+                } else if (kind === 2) {
+                    ret.push(value);
+                } else {
+                    ret.push(function(instance, args) {
+                        return value.call(instance, args);
+                    });
+                }
+            } else {
+                Object.defineProperty(base, name, desc);
+            }
+        }
+    }
+    function applyMemberDecs(Class, decInfos, metadata) {
+        var ret = [];
+        var protoInitializers;
+        var staticInitializers;
+        var existingProtoNonFields = new Map();
+        var existingStaticNonFields = new Map();
+        for(var i = 0; i < decInfos.length; i++){
+            var decInfo = decInfos[i];
+            if (!Array.isArray(decInfo)) continue;
+            var kind = decInfo[1];
+            var name = decInfo[2];
+            var isPrivate = decInfo.length > 3;
+            var isStatic = kind >= 5;
+            var base;
+            var initializers;
+            if (isStatic) {
+                base = Class;
+                kind = kind - 5;
+                staticInitializers = staticInitializers || [];
+                initializers = staticInitializers;
+            } else {
+                base = Class.prototype;
+                protoInitializers = protoInitializers || [];
+                initializers = protoInitializers;
+            }
+            if (kind !== 0 && !isPrivate) {
+                var existingNonFields = isStatic ? existingStaticNonFields : existingProtoNonFields;
+                var existingKind = existingNonFields.get(name) || 0;
+                if (existingKind === true || existingKind === 3 && kind !== 4 || existingKind === 4 && kind !== 3) {
+                    throw new Error("Attempted to decorate a public method/accessor that has the same name as a previously decorated public method/accessor. This is not currently supported by the decorators plugin. Property name was: " + name);
+                } else if (!existingKind && kind > 2) {
+                    existingNonFields.set(name, kind);
+                } else {
+                    existingNonFields.set(name, true);
+                }
+            }
+            applyMemberDec(ret, base, decInfo, name, kind, isStatic, isPrivate, initializers, metadata);
+        }
+        pushInitializers(ret, protoInitializers);
+        pushInitializers(ret, staticInitializers);
+        return ret;
+    }
+    function pushInitializers(ret, initializers) {
+        if (initializers) {
+            ret.push(function(instance) {
+                for(var i = 0; i < initializers.length; i++){
+                    initializers[i].call(instance);
+                }
+                return instance;
+            });
+        }
+    }
+    function applyClassDecs(targetClass, classDecs, metadata) {
+        if (classDecs.length > 0) {
+            var initializers = [];
+            var newClass = targetClass;
+            var name = targetClass.name;
+            for(var i = classDecs.length - 1; i >= 0; i--){
+                var decoratorFinishedRef = {
+                    v: false
+                };
+                try {
+                    var nextNewClass = classDecs[i](newClass, {
+                        kind: "class",
+                        name: name,
+                        addInitializer: createAddInitializerMethod(initializers, decoratorFinishedRef),
+                        metadata
+                    });
+                } finally{
+                    decoratorFinishedRef.v = true;
+                }
+                if (nextNewClass !== undefined) {
+                    assertValidReturnValue(10, nextNewClass);
+                    newClass = nextNewClass;
+                }
+            }
+            return [
+                defineMetadata(newClass, metadata),
+                function() {
+                    for(var i = 0; i < initializers.length; i++){
+                        initializers[i].call(newClass);
+                    }
+                }
+            ];
+        }
+    }
+    function defineMetadata(Class, metadata) {
+        return Object.defineProperty(Class, Symbol.metadata || Symbol.for("Symbol.metadata"), {
+            configurable: true,
+            enumerable: true,
+            value: metadata
+        });
+    }
+    return function applyDecs2203R(targetClass, memberDecs, classDecs, parentClass) {
+        if (parentClass !== void 0) {
+            var parentMetadata = parentClass[Symbol.metadata || Symbol.for("Symbol.metadata")];
+        }
+        var metadata = Object.create(parentMetadata === void 0 ? null : parentMetadata);
+        var e = applyMemberDecs(targetClass, memberDecs, metadata);
+        if (!classDecs.length) defineMetadata(targetClass, metadata);
+        return {
+            e: e,
+            get c () {
+                return applyClassDecs(targetClass, classDecs, metadata);
+            }
+        };
+    };
+}
+function _apply_decs_2203_r(targetClass, memberDecs, classDecs, parentClass) {
+    return (_apply_decs_2203_r = applyDecs2203RFactory())(targetClass, memberDecs, classDecs, parentClass);
+}
+var _initProto;
+import { mergeAbis, tryExtractEvent } from '@aztec/ethereum/utils';
+import { Buffer32 } from '@aztec/foundation/buffer';
+import { memoize } from '@aztec/foundation/decorators';
+import { EthAddress } from '@aztec/foundation/eth-address';
+import { Signature } from '@aztec/foundation/eth-signature';
+import { createLogger } from '@aztec/foundation/log';
+import { hexToBuffer } from '@aztec/foundation/string';
+import { SlasherAbi } from '@aztec/l1-artifacts/SlasherAbi';
+import { SlashingProposerAbi } from '@aztec/l1-artifacts/SlashingProposerAbi';
+import { encodeFunctionData, getContract } from 'viem';
+import { watchContractEvent } from './watch_event.js';
+/**
+ * Wrapper around the SlashingProposer contract that provides
+ * a TypeScript interface for interacting with the consensus-based slashing system.
+ */ export class SlashingProposerContract {
+    client;
+    static{
+        ({ e: [_initProto] } = _apply_decs_2203_r(this, [
+            [
+                memoize,
+                2,
+                "getSlashingAmounts"
+            ]
+        ], []));
+    }
+    contract;
+    logger;
+    /**
+   * Slash target validators of the last round asked for. Safe to cache because a round's targets are the committees
+   * of epochs that had already ended when the round opened (see SLASH_OFFSET_IN_ROUNDS), and those committees are
+   * sampled from validator set and randao snapshots taken before the epoch started, so they cannot change while the
+   * round is live. The promise is cached rather than the result, so concurrent callers share one in-flight read.
+   */ slashTargetValidators;
+    constructor(client, address){
+        this.client = client;
+        this.logger = (_initProto(this), createLogger('ethereum:slashing_proposer'));
+        this.contract = getContract({
+            address: typeof address === 'string' ? address : address.toString(),
+            abi: SlashingProposerAbi,
+            client
+        });
+    }
+    get address() {
+        return EthAddress.fromString(this.contract.address);
+    }
+    getQuorumSize() {
+        return this.contract.read.QUORUM();
+    }
+    getRoundSize() {
+        return this.contract.read.ROUND_SIZE();
+    }
+    getCommitteeSize() {
+        return this.contract.read.COMMITTEE_SIZE();
+    }
+    getRoundSizeInEpochs() {
+        return this.contract.read.ROUND_SIZE_IN_EPOCHS();
+    }
+    getLifetimeInRounds() {
+        return this.contract.read.LIFETIME_IN_ROUNDS();
+    }
+    getExecutionDelayInRounds() {
+        return this.contract.read.EXECUTION_DELAY_IN_ROUNDS();
+    }
+    /** Returns the slash amounts for the three slash unit levels. Immutable on the contract, so memoized. */ getSlashingAmounts() {
+        return Promise.all([
+            this.contract.read.SLASH_AMOUNT_SMALL(),
+            this.contract.read.SLASH_AMOUNT_MEDIUM(),
+            this.contract.read.SLASH_AMOUNT_LARGE()
+        ]);
+    }
+    getSlashOffsetInRounds() {
+        return this.contract.read.SLASH_OFFSET_IN_ROUNDS();
+    }
+    getCurrentRound() {
+        return this.contract.read.getCurrentRound();
+    }
+    /**
+   * Get round information
+   * @param round - The round number to query
+   * @returns Round status information
+   */ async getRound(round) {
+        const [isExecuted, voteCount] = await this.contract.read.getRound([
+            round
+        ]);
+        return {
+            isExecuted,
+            voteCount
+        };
+    }
+    /**
+   * Check if a round is ready to execute at a given slot
+   * @param round - The round number to check
+   * @param slot - The slot number to check at
+   * @returns Whether the round is ready to execute
+   */ async isRoundReadyToExecute(round, slot) {
+        return await this.contract.read.isRoundReadyToExecute([
+            round,
+            BigInt(slot)
+        ]);
+    }
+    /** Returns the slash actions and payload address for a given round (zero if no slash actions) */ async getPayload(round) {
+        const { result: committees } = await this.contract.simulate.getSlashTargetCommittees([
+            round
+        ]);
+        const tally = await this.contract.read.getTally([
+            round,
+            committees
+        ]);
+        const address = await this.contract.read.getPayloadAddress([
+            round,
+            tally
+        ]);
+        const actions = this.mapSlashActions(tally);
+        return {
+            actions,
+            address: EthAddress.fromString(address)
+        };
+    }
+    /** Returns the slash actions to be executed for a given round based on votes */ async getTally(round) {
+        const { result: committees } = await this.contract.simulate.getSlashTargetCommittees([
+            round
+        ]);
+        const tally = await this.contract.read.getTally([
+            round,
+            committees
+        ]);
+        return {
+            actions: this.mapSlashActions(tally),
+            committees: committees.map((c)=>c.map(EthAddress.fromString))
+        };
+    }
+    mapSlashActions(actions) {
+        return actions.map(({ validator, slashAmount })=>({
+                validator: EthAddress.fromString(validator),
+                slashAmount
+            }));
+    }
+    /** Tries to extract a VoteCast event from the given logs. */ tryExtractVoteCastEvent(logs) {
+        return tryExtractEvent(logs, this.address.toString(), SlashingProposerAbi, 'VoteCast');
+    }
+    /** Tries to extract a RoundExecuted event from the given logs. */ tryExtractRoundExecutedEvent(logs) {
+        return tryExtractEvent(logs, this.address.toString(), SlashingProposerAbi, 'RoundExecuted');
+    }
+    /**
+   * Create a transaction to vote for slashing offenses
+   * @param votes - The encoded votes for slashing
+   * @param slot - The slot number for the vote
+   * @param signer - The signer to produce the signature
+   * @returns L1 transaction request
+   */ async buildVoteRequestFromSigner(votes, slot, signer) {
+        const typedData = this.buildVoteTypedData(votes, slot);
+        const signature = Signature.fromString(await signer(typedData));
+        return {
+            to: this.contract.address,
+            abi: SlashingProposerAbi,
+            data: encodeFunctionData({
+                abi: SlashingProposerAbi,
+                functionName: 'vote',
+                args: [
+                    votes,
+                    signature.toViemSignature()
+                ]
+            })
+        };
+    }
+    /** Returns the typed data definition to EIP712-sign for voting */ buildVoteTypedData(votes, slot) {
+        const domain = {
+            name: 'SlashingProposer',
+            version: '1',
+            chainId: this.client.chain.id,
+            verifyingContract: this.contract.address
+        };
+        const types = {
+            EIP712Domain: [
+                {
+                    name: 'name',
+                    type: 'string'
+                },
+                {
+                    name: 'version',
+                    type: 'string'
+                },
+                {
+                    name: 'chainId',
+                    type: 'uint256'
+                },
+                {
+                    name: 'verifyingContract',
+                    type: 'address'
+                }
+            ],
+            Vote: [
+                {
+                    name: 'votes',
+                    type: 'bytes'
+                },
+                {
+                    name: 'slot',
+                    type: 'uint256'
+                }
+            ]
+        };
+        return {
+            domain,
+            types,
+            primaryType: 'Vote',
+            message: {
+                votes,
+                slot: BigInt(slot)
+            }
+        };
+    }
+    /** Gets the digest to sign for voting directly from the contract */ async getVoteDataDigest(votes, slot) {
+        return Buffer32.fromString(await this.contract.read.getVoteSignatureDigest([
+            votes,
+            BigInt(slot)
+        ]));
+    }
+    /**
+   * Create a transaction to vote for slashing offenses
+   * @param votes - The encoded votes for slashing
+   * @param signature - The signature from the current proposer
+   * @returns L1 transaction request
+   */ buildVoteRequestWithSignature(votes, signature) {
+        return {
+            to: this.contract.address,
+            abi: SlashingProposerAbi,
+            data: encodeFunctionData({
+                abi: SlashingProposerAbi,
+                functionName: 'vote',
+                args: [
+                    votes,
+                    signature
+                ]
+            })
+        };
+    }
+    /**
+   * Create a transaction to execute a slashing round
+   * @param round - The round number to execute
+   * @param committees - The committees for each epoch in the round
+   * @returns L1 transaction request
+   */ buildExecuteRoundRequest(round, committees) {
+        return {
+            to: this.contract.address,
+            abi: mergeAbis([
+                SlashingProposerAbi,
+                SlasherAbi
+            ]),
+            data: encodeFunctionData({
+                abi: SlashingProposerAbi,
+                functionName: 'executeRound',
+                args: [
+                    round,
+                    committees.map((c)=>c.map((addr)=>addr.toString()))
+                ]
+            })
+        };
+    }
+    /**
+   * Returns the validators eligible to be voted against in a round, in the order votes encode them. Cached for the
+   * last round asked for: reading them runs a committee sampling simulation on L1, and every vote of a round decodes
+   * against the same list, so a caller walking a round's votes would otherwise repeat that call per vote. Only the
+   * last round is kept since callers move forward round by round.
+   */ getSlashTargetValidators(round) {
+        const cached = this.slashTargetValidators;
+        if (cached?.round === round) {
+            return cached.validators;
+        }
+        const entry = {
+            round,
+            validators: this.fetchSlashTargetValidators(round)
+        };
+        this.slashTargetValidators = entry;
+        // A failed read must not stay cached, or every later vote of the round would replay the same rejection
+        entry.validators.catch(()=>{
+            if (this.slashTargetValidators === entry) {
+                this.slashTargetValidators = undefined;
+            }
+        });
+        return entry.validators;
+    }
+    async fetchSlashTargetValidators(round) {
+        const { result } = await this.contract.simulate.getSlashTargetCommittees([
+            round
+        ]);
+        return result.flat().map((validator)=>EthAddress.fromString(validator));
+    }
+    /**
+   * Returns the slash amount voted for each target validator by a single vote of a round.
+   * @param index - Position of the vote within the round, from 0 (inclusive) to the round's vote count (exclusive)
+   */ async getVoteAt(round, index) {
+        const [validators, vote, slashAmounts] = await Promise.all([
+            this.getSlashTargetValidators(round),
+            this.contract.read.getVotes([
+                round,
+                index
+            ]),
+            this.getSlashingAmounts()
+        ]);
+        return decodeVote(vote, validators, slashAmounts);
+    }
+    /** Returns the last vote emitted for a given round  */ async getLastVote(round) {
+        const { voteCount } = await this.getRound(round);
+        return await this.getVoteAt(round, voteCount - 1n);
+    }
+    /**
+   * Listen for VoteCast events. Events are delivered by polling `eth_getLogs`: a reorg may re-emit them and
+   * removals are never reported, and events mined within roughly one polling interval of subscribing may be missed.
+   * @param callback - Callback function to handle vote cast events
+   * @returns Unwatch function
+   */ listenToVoteCast(callback, options) {
+        return watchContractEvent(this.client, this.logger, {
+            address: this.contract.address,
+            abi: SlashingProposerAbi,
+            eventName: 'VoteCast',
+            onLog: (log)=>{
+                const { round, proposer } = log.args;
+                if (round !== undefined && proposer) {
+                    return callback({
+                        round,
+                        proposer
+                    });
+                }
+            }
+        }, options);
+    }
+    /**
+   * Listen for RoundExecuted events. Events are delivered by polling `eth_getLogs`: a reorg may re-emit them and
+   * removals are never reported, and events mined within roughly one polling interval of subscribing may be missed.
+   * @param callback - Callback function to handle round executed events
+   * @returns Unwatch function
+   */ listenToRoundExecuted(callback, options) {
+        return watchContractEvent(this.client, this.logger, {
+            address: this.contract.address,
+            abi: SlashingProposerAbi,
+            eventName: 'RoundExecuted',
+            onLog: (log)=>{
+                const { round, slashCount } = log.args;
+                if (round !== undefined && slashCount !== undefined) {
+                    return callback({
+                        round,
+                        slashCount,
+                        l1BlockHash: log.blockHash
+                    });
+                }
+            }
+        }, options);
+    }
+}
+function decodeVote(vote, validators, slashAmounts) {
+    return decodeSlashConsensusVotes(hexToBuffer(vote)).map((units, position)=>({
+            validator: validators[position],
+            slashAmount: slashAmounts[units - 1] ?? 0n,
+            position
+        })).filter((v)=>v.slashAmount > 0n);
+}
+/**
+ * Decodes a Buffer containing slash votes back into an array of numbers.
+ * Each vote is represented as a 2-bit value (0, 1, 2, or 3) representing slashing units.
+ * @dev This should live in stdlib next to encodeSlashConsensusVotes but is here since we
+ * do not have a dependency to stdlib from the ethereum package. We need a larger refactor to fix this.
+ * @param buffer - The Buffer containing encoded slash votes
+ * @returns An array of numbers representing the slash votes
+ */ export function decodeSlashConsensusVotes(buffer) {
+    const votes = [];
+    for(let i = 0; i < buffer.length; i++){
+        const voteByte = buffer.readUInt8(i);
+        // Decode votes from Solidity's bit order (LSB to MSB)
+        // Bits 0-1: validator at index i*4
+        // Bits 2-3: validator at index i*4+1
+        // Bits 4-5: validator at index i*4+2
+        // Bits 6-7: validator at index i*4+3
+        votes.push(voteByte >> 0 & 0x03);
+        votes.push(voteByte >> 2 & 0x03);
+        votes.push(voteByte >> 4 & 0x03);
+        votes.push(voteByte >> 6 & 0x03);
+    }
+    return votes;
+}