@aztec/ethereum 0.0.0-test.1 → 0.0.1-commit.023c3e5

package/src/contracts/slasher_contract.ts

@@ -0,0 +1,89 @@
+import { EthAddress } from '@aztec/foundation/eth-address';
+import { createLogger } from '@aztec/foundation/log';
+import { SlasherAbi } from '@aztec/l1-artifacts/SlasherAbi';
+
+import { type GetContractReturnType, getContract } from 'viem';
+
+import type { ViemClient } from '../types.js';
+
+/**
+ * Typescript wrapper around the Slasher contract.
+ */
+export class SlasherContract {
+  private contract: GetContractReturnType<typeof SlasherAbi, ViemClient>;
+
+  constructor(
+    private readonly client: ViemClient,
+    private readonly address: EthAddress,
+    private readonly log = createLogger('slasher-contract'),
+  ) {
+    this.contract = getContract({
+      address: this.address.toString(),
+      abi: SlasherAbi,
+      client: this.client,
+    });
+  }
+
+  /**
+   * Checks if a slash payload is vetoed.
+   * @param payloadAddress - The address of the payload to check
+   * @returns True if the payload is vetoed, false otherwise
+   */
+  public async isPayloadVetoed(payloadAddress: EthAddress): Promise<boolean> {
+    try {
+      return await this.contract.read.vetoedPayloads([payloadAddress.toString()]);
+    } catch (error) {
+      this.log.error(`Error checking if payload ${payloadAddress} is vetoed`, error);
+      throw error;
+    }
+  }
+
+  /**
+   * Checks if slashing is currently enabled. Slashing can be disabled by the vetoer.
+   * @returns True if slashing is enabled, false otherwise
+   */
+  public async isSlashingEnabled(): Promise<boolean> {
+    try {
+      return await this.contract.read.isSlashingEnabled();
+    } catch (error) {
+      this.log.error(`Error checking if slashing is enabled`, error);
+      throw error;
+    }
+  }
+
+  /**
+   * Gets the current vetoer address.
+   * @returns The vetoer address
+   */
+  public async getVetoer(): Promise<EthAddress> {
+    const vetoer = await this.contract.read.VETOER();
+    return EthAddress.fromString(vetoer);
+  }
+
+  /**
+   * Gets the disable duration by the vetoer.
+   * @returns The disable duration in seconds
+   */
+  public async getSlashingDisableDuration(): Promise<number> {
+    const duration = await this.contract.read.SLASHING_DISABLE_DURATION();
+    return Number(duration);
+  }
+
+  /**
+   * Gets the current governance address.
+   * @returns The governance address
+   */
+  public async getGovernance(): Promise<EthAddress> {
+    const governance = await this.contract.read.GOVERNANCE();
+    return EthAddress.fromString(governance);
+  }
+
+  /**
+   * Gets the current proposer address.
+   * @returns The proposer address
+   */
+  public async getProposer(): Promise<EthAddress> {
+    const proposer = await this.contract.read.PROPOSER();
+    return EthAddress.fromString(proposer);
+  }
+}

package/src/contracts/tally_slashing_proposer.ts

@@ -0,0 +1,322 @@
+import type { L1TxRequest } from '@aztec/ethereum/l1-tx-utils';
+import type { ViemClient } from '@aztec/ethereum/types';
+import { mergeAbis, tryExtractEvent } from '@aztec/ethereum/utils';
+import { SlotNumber } from '@aztec/foundation/branded-types';
+import { Buffer32 } from '@aztec/foundation/buffer';
+import { EthAddress } from '@aztec/foundation/eth-address';
+import { Signature } from '@aztec/foundation/eth-signature';
+import { hexToBuffer } from '@aztec/foundation/string';
+import { SlasherAbi } from '@aztec/l1-artifacts/SlasherAbi';
+import { TallySlashingProposerAbi } from '@aztec/l1-artifacts/TallySlashingProposerAbi';
+
+import {
+  type GetContractReturnType,
+  type Hex,
+  type Log,
+  type TypedDataDefinition,
+  encodeFunctionData,
+  getContract,
+} from 'viem';
+
+/**
+ * Wrapper around the TallySlashingProposer contract that provides
+ * a TypeScript interface for interacting with the consensus-based slashing system.
+ */
+export class TallySlashingProposerContract {
+  private readonly contract: GetContractReturnType<typeof TallySlashingProposerAbi, ViemClient>;
+
+  public readonly type = 'tally' as const;
+
+  constructor(
+    public readonly client: ViemClient,
+    address: Hex | EthAddress,
+  ) {
+    this.contract = getContract({
+      address: typeof address === 'string' ? address : address.toString(),
+      abi: TallySlashingProposerAbi,
+      client,
+    });
+  }
+
+  public get address() {
+    return EthAddress.fromString(this.contract.address);
+  }
+
+  public getQuorumSize(): Promise<bigint> {
+    return this.contract.read.QUORUM();
+  }
+
+  public getRoundSize(): Promise<bigint> {
+    return this.contract.read.ROUND_SIZE();
+  }
+
+  public getCommitteeSize(): Promise<bigint> {
+    return this.contract.read.COMMITTEE_SIZE();
+  }
+
+  public getRoundSizeInEpochs(): Promise<bigint> {
+    return this.contract.read.ROUND_SIZE_IN_EPOCHS();
+  }
+
+  public getLifetimeInRounds(): Promise<bigint> {
+    return this.contract.read.LIFETIME_IN_ROUNDS();
+  }
+
+  public getExecutionDelayInRounds(): Promise<bigint> {
+    return this.contract.read.EXECUTION_DELAY_IN_ROUNDS();
+  }
+
+  public getSlashingAmounts(): Promise<[bigint, bigint, bigint]> {
+    return Promise.all([
+      this.contract.read.SLASH_AMOUNT_SMALL(),
+      this.contract.read.SLASH_AMOUNT_MEDIUM(),
+      this.contract.read.SLASH_AMOUNT_LARGE(),
+    ]);
+  }
+
+  public getSlashOffsetInRounds(): Promise<bigint> {
+    return this.contract.read.SLASH_OFFSET_IN_ROUNDS();
+  }
+
+  public getCurrentRound(): Promise<bigint> {
+    return this.contract.read.getCurrentRound();
+  }
+
+  /**
+   * Get round information
+   * @param round - The round number to query
+   * @returns Round status information
+   */
+  public async getRound(round: bigint): Promise<{
+    isExecuted: boolean;
+    voteCount: bigint;
+  }> {
+    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
+   */
+  public async isRoundReadyToExecute(round: bigint, slot: SlotNumber): Promise<boolean> {
+    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) */
+  public async getPayload(
+    round: bigint,
+  ): Promise<{ actions: { slashAmount: bigint; validator: EthAddress }[]; address: EthAddress }> {
+    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 */
+  public async getTally(
+    round: bigint,
+  ): Promise<{ actions: { slashAmount: bigint; validator: EthAddress }[]; committees: EthAddress[][] }> {
+    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)) };
+  }
+
+  private mapSlashActions(
+    actions: readonly { slashAmount: bigint; validator: Hex }[],
+  ): { slashAmount: bigint; validator: EthAddress }[] {
+    return actions.map(({ validator, slashAmount }) => ({
+      validator: EthAddress.fromString(validator),
+      slashAmount,
+    }));
+  }
+
+  /** Tries to extract a VoteCast event from the given logs. */
+  public tryExtractVoteCastEvent(logs: Log[]) {
+    return tryExtractEvent(logs, this.address.toString(), TallySlashingProposerAbi, 'VoteCast');
+  }
+
+  /** Tries to extract a RoundExecuted event from the given logs. */
+  public tryExtractRoundExecutedEvent(logs: Log[]) {
+    return tryExtractEvent(logs, this.address.toString(), TallySlashingProposerAbi, '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
+   */
+  public async buildVoteRequestFromSigner(
+    votes: Hex,
+    slot: SlotNumber,
+    signer: (msg: TypedDataDefinition) => Promise<Hex>,
+  ): Promise<L1TxRequest> {
+    const typedData = this.buildVoteTypedData(votes, slot);
+    const signature = Signature.fromString(await signer(typedData));
+
+    return {
+      to: this.contract.address,
+      abi: TallySlashingProposerAbi,
+      data: encodeFunctionData({
+        abi: TallySlashingProposerAbi,
+        functionName: 'vote',
+        args: [votes, signature.toViemSignature()],
+      }),
+    };
+  }
+
+  /** Returns the typed data definition to EIP712-sign for voting */
+  public buildVoteTypedData(votes: Hex, slot: SlotNumber): TypedDataDefinition {
+    const domain = {
+      name: 'TallySlashingProposer',
+      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 */
+  public async getVoteDataDigest(votes: Hex, slot: SlotNumber): Promise<Buffer32> {
+    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
+   */
+  public buildVoteRequestWithSignature(votes: Hex, signature: { v: number; r: Hex; s: Hex }): L1TxRequest {
+    return {
+      to: this.contract.address,
+      abi: TallySlashingProposerAbi,
+      data: encodeFunctionData({
+        abi: TallySlashingProposerAbi,
+        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
+   */
+  public buildExecuteRoundRequest(round: bigint, committees: EthAddress[][]): L1TxRequest {
+    return {
+      to: this.contract.address,
+      abi: mergeAbis([TallySlashingProposerAbi, SlasherAbi]),
+      data: encodeFunctionData({
+        abi: TallySlashingProposerAbi,
+        functionName: 'executeRound',
+        args: [round, committees.map(c => c.map(addr => addr.toString()))],
+      }),
+    };
+  }
+
+  /** Returns the last vote emitted for a given round  */
+  public async getLastVote(round: bigint) {
+    const { voteCount } = await this.getRound(round);
+    const validators = (await this.contract.simulate.getSlashTargetCommittees([round])).result.flat();
+    const vote = await this.contract.read.getVotes([round, voteCount - 1n]);
+    const decoded = decodeSlashConsensusVotes(hexToBuffer(vote));
+    const slashAmounts = await this.getSlashingAmounts();
+    return decoded
+      .map((units, i) => ({
+        validator: EthAddress.fromString(validators[i]),
+        slashAmount: slashAmounts[units - 1] ?? 0n,
+      }))
+      .filter(v => v.slashAmount > 0n);
+  }
+
+  /**
+   * Listen for VoteCast events
+   * @param callback - Callback function to handle vote cast events
+   * @returns Unwatch function
+   */
+  public listenToVoteCast(callback: (args: { round: bigint; proposer: string }) => void): () => void {
+    return this.contract.watchEvent.VoteCast(
+      {},
+      {
+        onLogs: logs => {
+          for (const log of logs) {
+            const { round, proposer } = log.args;
+            if (round !== undefined && proposer) {
+              callback({ round, proposer });
+            }
+          }
+        },
+      },
+    );
+  }
+
+  /**
+   * Listen for RoundExecuted events
+   * @param callback - Callback function to handle round executed events
+   * @returns Unwatch function
+   */
+  public listenToRoundExecuted(
+    callback: (args: { round: bigint; slashCount: bigint; l1BlockHash: Hex }) => void,
+  ): () => void {
+    return this.contract.watchEvent.RoundExecuted(
+      {},
+      {
+        onLogs: logs => {
+          for (const log of logs) {
+            const { round, slashCount } = log.args;
+            if (round !== undefined && slashCount !== undefined) {
+              callback({ round, slashCount, l1BlockHash: log.blockHash });
+            }
+          }
+        },
+      },
+    );
+  }
+}
+
+/**
+ * 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: Buffer): number[] {
+  const votes: number[] = [];
+  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;
+}

package/src/contracts/utils.ts

@@ -0,0 +1,14 @@
+import type { ViemClient } from '../types.js';
+import { BlockTagTooOldError } from './errors.js';
+
+const L1_NON_ARCHIVE_BLOCK_HISTORY_LENGTH = 128n;
+
+export async function checkBlockTag(block: bigint | undefined, publicClient: ViemClient) {
+  if (block === undefined) {
+    return;
+  }
+  const latestBlock = await publicClient.getBlockNumber();
+  if (block < latestBlock - L1_NON_ARCHIVE_BLOCK_HISTORY_LENGTH) {
+    throw new BlockTagTooOldError(block, latestBlock);
+  }
+}