@aztec/ethereum 0.0.0-test.1 → 0.0.1-commit.1142ef1

package/dest/contracts/governance.js

@@ -1,9 +1,9 @@
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { sleep } from '@aztec/foundation/sleep';
-import { GovernanceAbi } from '@aztec/l1-artifacts';
-import { encodeFunctionData, getContract } from 'viem';
-import { L1TxUtils } from '../l1_tx_utils.js';
-import { GovernanceProposerContract } from './governance_proposer.js';
+import { GovernanceAbi } from '@aztec/l1-artifacts/GovernanceAbi';
+import { encodeFunctionData, getContract, parseEventLogs } from 'viem';
+import { createL1TxUtilsFromViemWallet } from '../l1_tx_utils/index.js';
+import { isExtendedClient } from '../types.js';
 // NOTE: Must be kept in sync with DataStructures.ProposalState in l1-contracts
 export var ProposalState = /*#__PURE__*/ function(ProposalState) {
     ProposalState[ProposalState["Pending"] = 0] = "Pending";
@@ -16,90 +16,52 @@ export var ProposalState = /*#__PURE__*/ function(ProposalState) {
     ProposalState[ProposalState["Expired"] = 7] = "Expired";
     return ProposalState;
 }({});
-export class GovernanceContract {
-    publicClient;
-    walletClient;
-    publicGovernance;
-    walletGovernance;
-    constructor(address, publicClient, walletClient){
-        this.publicClient = publicClient;
-        this.walletClient = walletClient;
-        this.publicGovernance = getContract({
+export function extractProposalIdFromLogs(logs) {
+    const parsedLogs = parseEventLogs({
+        abi: GovernanceAbi,
+        logs: logs,
+        eventName: 'Proposed'
+    });
+    if (parsedLogs.length === 0) {
+        throw new Error('Proposal log not found');
+    }
+    return parsedLogs[0].args.proposalId;
+}
+export class ReadOnlyGovernanceContract {
+    client;
+    governanceContract;
+    constructor(address, client){
+        this.client = client;
+        this.governanceContract = getContract({
             address,
             abi: GovernanceAbi,
-            client: publicClient
+            client: client
         });
-        this.walletGovernance = walletClient ? getContract({
-            address,
-            abi: GovernanceAbi,
-            client: walletClient
-        }) : undefined;
     }
     get address() {
-        return EthAddress.fromString(this.publicGovernance.address);
+        return EthAddress.fromString(this.governanceContract.address);
     }
-    async getProposer() {
-        const governanceProposerAddress = EthAddress.fromString(await this.publicGovernance.read.governanceProposer());
-        return new GovernanceProposerContract(this.publicClient, governanceProposerAddress.toString());
+    async getGovernanceProposerAddress() {
+        return EthAddress.fromString(await this.governanceContract.read.governanceProposer());
     }
-    async getGovernanceAddresses() {
-        const governanceProposer = await this.getProposer();
-        const [rollupAddress, registryAddress] = await Promise.all([
-            governanceProposer.getRollupAddress(),
-            governanceProposer.getRegistryAddress()
-        ]);
-        return {
-            governanceAddress: this.address,
-            rollupAddress,
-            registryAddress,
-            governanceProposerAddress: governanceProposer.address
-        };
+    getConfiguration() {
+        return this.governanceContract.read.getConfiguration();
     }
     getProposal(proposalId) {
-        return this.publicGovernance.read.getProposal([
+        return this.governanceContract.read.getProposal([
             proposalId
         ]);
     }
     async getProposalState(proposalId) {
-        const state = await this.publicGovernance.read.getProposalState([
+        const state = await this.governanceContract.read.getProposalState([
             proposalId
         ]);
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
         if (state < 0 || state > 7) {
             throw new Error(`Invalid proposal state: ${state}`);
         }
         return state;
     }
-    assertWalletGovernance() {
-        if (!this.walletGovernance) {
-            throw new Error('Wallet client is required for this operation');
-        }
-        return this.walletGovernance;
-    }
-    async deposit(onBehalfOf, amount) {
-        const walletGovernance = this.assertWalletGovernance();
-        const depositTx = await walletGovernance.write.deposit([
-            onBehalfOf,
-            amount
-        ]);
-        await this.publicClient.waitForTransactionReceipt({
-            hash: depositTx
-        });
-    }
-    async proposeWithLock({ payloadAddress, withdrawAddress }) {
-        const walletGovernance = this.assertWalletGovernance();
-        const proposeTx = await walletGovernance.write.proposeWithLock([
-            payloadAddress,
-            withdrawAddress
-        ]);
-        const receipt = await this.publicClient.waitForTransactionReceipt({
-            hash: proposeTx
-        });
-        if (receipt.status !== 'success') {
-            throw new Error(`Proposal failed: ${receipt.status}`);
-        }
-        const proposalId = Number(receipt.logs[1].topics[1]);
-        return proposalId;
-    }
     async awaitProposalActive({ proposalId, logger }) {
         const state = await this.getProposalState(proposalId);
         if (state === 1) {
@@ -109,7 +71,7 @@ export class GovernanceContract {
         } else {
             const proposal = await this.getProposal(proposalId);
             const startOfActive = proposal.creation + proposal.config.votingDelay;
-            const block = await this.publicClient.getBlock();
+            const block = await this.client.getBlock();
             // Add 12 seconds to the time to make sure we don't vote too early
             const secondsToActive = Number(startOfActive - block.timestamp) + 12;
             const now = new Date();
@@ -135,7 +97,7 @@ export class GovernanceContract {
         } else {
             const proposal = await this.getProposal(proposalId);
             const startOfExecutable = proposal.creation + proposal.config.votingDelay + proposal.config.votingDuration + proposal.config.executionDelay;
-            const block = await this.publicClient.getBlock();
+            const block = await this.client.getBlock();
             const secondsToExecutable = Number(startOfExecutable - block.timestamp) + 12;
             const now = new Date();
             logger.info(`
@@ -146,17 +108,57 @@ export class GovernanceContract {
             await sleep(secondsToExecutable * 1000);
         }
     }
+}
+export class GovernanceContract extends ReadOnlyGovernanceContract {
+    client;
+    governanceContract;
+    constructor(address, client){
+        if (address instanceof EthAddress) {
+            address = address.toString();
+        }
+        super(address, client), this.client = client;
+        if (!isExtendedClient(client)) {
+            throw new Error('GovernanceContract has to be instantiated with a wallet client.');
+        }
+        this.governanceContract = getContract({
+            address,
+            abi: GovernanceAbi,
+            client
+        });
+    }
+    async deposit(onBehalfOf, amount) {
+        const depositTx = await this.governanceContract.write.deposit([
+            onBehalfOf,
+            amount
+        ]);
+        await this.client.waitForTransactionReceipt({
+            hash: depositTx
+        });
+    }
+    async proposeWithLock({ payloadAddress, withdrawAddress }) {
+        const proposeTx = await this.governanceContract.write.proposeWithLock([
+            payloadAddress,
+            withdrawAddress
+        ]);
+        const receipt = await this.client.waitForTransactionReceipt({
+            hash: proposeTx
+        });
+        if (receipt.status !== 'success') {
+            throw new Error(`Proposal failed: ${receipt.status}`);
+        }
+        return extractProposalIdFromLogs(receipt.logs);
+    }
     async getPower() {
-        const walletGovernance = this.assertWalletGovernance();
-        const now = await this.publicClient.getBlock();
-        return walletGovernance.read.powerAt([
-            this.walletClient.account.address,
+        const now = await this.client.getBlock();
+        return this.governanceContract.read.powerAt([
+            this.client.account.address,
             now.timestamp
         ]);
     }
     async vote({ proposalId, voteAmount, inFavor, retries = 10, logger }) {
-        const walletGovernance = this.assertWalletGovernance();
-        const l1TxUtils = new L1TxUtils(this.publicClient, this.walletClient, logger);
+        const l1TxUtils = createL1TxUtilsFromViemWallet(this.client, {
+            logger
+        });
         const retryDelaySeconds = 12;
         voteAmount = voteAmount ?? await this.getPower();
         let success = false;
@@ -173,7 +175,7 @@ export class GovernanceContract {
                 };
                 const encodedVoteData = encodeFunctionData(voteFunctionData);
                 const { receipt } = await l1TxUtils.sendAndMonitorTransaction({
-                    to: walletGovernance.address,
+                    to: this.governanceContract.address,
                     data: encodedVoteData
                 });
                 if (receipt.status === 'success') {
@@ -182,7 +184,7 @@ export class GovernanceContract {
                 } else {
                     const args = {
                         ...voteFunctionData,
-                        address: walletGovernance.address
+                        address: this.governanceContract.address
                     };
                     const errorMsg = await l1TxUtils.tryGetErrorFromRevertedTx(encodedVoteData, args, undefined, []);
                     logger.error(`Error voting on proposal ${proposalId}: ${errorMsg}`);
@@ -198,13 +200,14 @@ export class GovernanceContract {
         }
         logger.info(`Voted [${inFavor ? 'yea' : 'nay'}] on proposal [${proposalId}]`);
         const proposal = await this.getProposal(proposalId);
-        logger.info(`Proposal [${proposalId}] has state [${proposal.state}]`);
+        logger.info(`Proposal [${proposalId}] has cached state [${proposal.cachedState}]`);
         logger.info(`Proposal [${proposalId}] has summedBallot yea [${proposal.summedBallot.yea}]`);
-        logger.info(`Proposal [${proposalId}] has summedBallot nea [${proposal.summedBallot.nea}]`);
+        logger.info(`Proposal [${proposalId}] has summedBallot nay [${proposal.summedBallot.nay}]`);
     }
     async executeProposal({ proposalId, retries = 10, logger }) {
-        const walletGovernance = this.assertWalletGovernance();
-        const l1TxUtils = new L1TxUtils(this.publicClient, this.walletClient, logger);
+        const l1TxUtils = createL1TxUtilsFromViemWallet(this.client, {
+            logger
+        });
         const retryDelaySeconds = 12;
         let success = false;
         for(let i = 0; i < retries; i++){
@@ -218,7 +221,7 @@ export class GovernanceContract {
                 };
                 const encodedExecuteData = encodeFunctionData(executeFunctionData);
                 const { receipt } = await l1TxUtils.sendAndMonitorTransaction({
-                    to: walletGovernance.address,
+                    to: this.governanceContract.address,
                     data: encodedExecuteData
                 });
                 if (receipt.status === 'success') {
@@ -227,7 +230,7 @@ export class GovernanceContract {
                 } else {
                     const args = {
                         ...executeFunctionData,
-                        address: walletGovernance.address
+                        address: this.governanceContract.address
                     };
                     const errorMsg = await l1TxUtils.tryGetErrorFromRevertedTx(encodedExecuteData, args, undefined, []);
                     logger.error(`Error executing proposal ${proposalId}: ${errorMsg}`);

package/dest/contracts/governance_proposer.d.ts

@@ -1,28 +1,32 @@
+import { SlotNumber } from '@aztec/foundation/branded-types';
 import { EthAddress } from '@aztec/foundation/eth-address';
-import { type Hex, type TransactionReceipt } from 'viem';
-import type { GasPrice, L1TxRequest, L1TxUtils } from '../l1_tx_utils.js';
-import type { ViemPublicClient } from '../types.js';
+import { type Hex, type TransactionReceipt, type TypedDataDefinition } from 'viem';
+import type { L1TxRequest, L1TxUtils } from '../l1_tx_utils/index.js';
+import type { ViemClient } from '../types.js';
 import { type IEmpireBase } from './empire_base.js';
 export declare class GovernanceProposerContract implements IEmpireBase {
-    readonly client: ViemPublicClient;
+    readonly client: ViemClient;
     private readonly proposer;
-    constructor(client: ViemPublicClient, address: Hex);
+    constructor(client: ViemClient, address: Hex | EthAddress);
     get address(): EthAddress;
     getRollupAddress(): Promise<EthAddress>;
     getRegistryAddress(): Promise<EthAddress>;
     getQuorumSize(): Promise<bigint>;
     getRoundSize(): Promise<bigint>;
-    computeRound(slot: bigint): Promise<bigint>;
+    getInstance(): Promise<`0x${string}`>;
+    computeRound(slot: SlotNumber): Promise<bigint>;
     getRoundInfo(rollupAddress: Hex, round: bigint): Promise<{
-        lastVote: bigint;
-        leader: Hex;
+        lastSignalSlot: SlotNumber;
+        payloadWithMostSignals: Hex;
+        quorumReached: boolean;
         executed: boolean;
     }>;
-    getProposalVotes(rollupAddress: Hex, round: bigint, proposal: Hex): Promise<bigint>;
-    createVoteRequest(payload: Hex): L1TxRequest;
-    executeProposal(round: bigint, l1TxUtils: L1TxUtils): Promise<{
+    getPayloadSignals(rollupAddress: Hex, round: bigint, payload: Hex): Promise<bigint>;
+    createSignalRequest(payload: Hex): L1TxRequest;
+    createSignalRequestWithSignature(payload: Hex, slot: SlotNumber, chainId: number, signerAddress: Hex, signer: (msg: TypedDataDefinition) => Promise<Hex>): Promise<L1TxRequest>;
+    submitRoundWinner(round: bigint, l1TxUtils: L1TxUtils): Promise<{
         receipt: TransactionReceipt;
-        gasPrice: GasPrice;
+        proposalId: bigint;
     }>;
 }
-//# sourceMappingURL=governance_proposer.d.ts.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ292ZXJuYW5jZV9wcm9wb3Nlci5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbnRyYWN0cy9nb3Zlcm5hbmNlX3Byb3Bvc2VyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxVQUFVLEVBQUUsTUFBTSxpQ0FBaUMsQ0FBQztBQUU3RCxPQUFPLEVBQUUsVUFBVSxFQUFFLE1BQU0sK0JBQStCLENBQUM7QUFHM0QsT0FBTyxFQUVMLEtBQUssR0FBRyxFQUNSLEtBQUssa0JBQWtCLEVBQ3ZCLEtBQUssbUJBQW1CLEVBR3pCLE1BQU0sTUFBTSxDQUFDO0FBRWQsT0FBTyxLQUFLLEVBQUUsV0FBVyxFQUFFLFNBQVMsRUFBRSxNQUFNLHlCQUF5QixDQUFDO0FBQ3RFLE9BQU8sS0FBSyxFQUFFLFVBQVUsRUFBRSxNQUFNLGFBQWEsQ0FBQztBQUM5QyxPQUFPLEVBQUUsS0FBSyxXQUFXLEVBQThELE1BQU0sa0JBQWtCLENBQUM7QUFHaEgscUJBQWEsMEJBQTJCLFlBQVcsV0FBVzthQUkxQyxNQUFNLEVBQUUsVUFBVTtJQUhwQyxPQUFPLENBQUMsUUFBUSxDQUFDLFFBQVEsQ0FBa0U7SUFFM0YsWUFDa0IsTUFBTSxFQUFFLFVBQVUsRUFDbEMsT0FBTyxFQUFFLEdBQUcsR0FBRyxVQUFVLEVBTTFCO0lBRUQsSUFBVyxPQUFPLGVBRWpCO0lBRVksZ0JBQWdCLHdCQUU1QjtJQUdZLGtCQUFrQix3QkFFOUI7SUFFTSxhQUFhLElBQUksT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUV0QztJQUVNLFlBQVksSUFBSSxPQUFPLENBQUMsTUFBTSxDQUFDLENBRXJDO0lBRU0sV0FBVywyQkFFakI7SUFFTSxZQUFZLENBQUMsSUFBSSxFQUFFLFVBQVUsR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLENBRXJEO0lBRVksWUFBWSxDQUN2QixhQUFhLEVBQUUsR0FBRyxFQUNsQixLQUFLLEVBQUUsTUFBTSxHQUNaLE9BQU8sQ0FBQztRQUFFLGNBQWMsRUFBRSxVQUFVLENBQUM7UUFBQyxzQkFBc0IsRUFBRSxHQUFHLENBQUM7UUFBQyxhQUFhLEVBQUUsT0FBTyxDQUFDO1FBQUMsUUFBUSxFQUFFLE9BQU8sQ0FBQTtLQUFFLENBQUMsQ0FZakg7SUFFTSxpQkFBaUIsQ0FBQyxhQUFhLEVBQUUsR0FBRyxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsT0FBTyxFQUFFLEdBQUcsR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLENBRXpGO0lBRU0sbUJBQW1CLENBQUMsT0FBTyxFQUFFLEdBQUcsR0FBRyxXQUFXLENBS3BEO0lBRVksZ0NBQWdDLENBQzNDLE9BQU8sRUFBRSxHQUFHLEVBQ1osSUFBSSxFQUFFLFVBQVUsRUFDaEIsT0FBTyxFQUFFLE1BQU0sRUFDZixhQUFhLEVBQUUsR0FBRyxFQUNsQixNQUFNLEVBQUUsQ0FBQyxHQUFHLEVBQUUsbUJBQW1CLEtBQUssT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUNqRCxPQUFPLENBQUMsV0FBVyxDQUFDLENBYXRCO0lBRVksaUJBQWlCLENBQzVCLEtBQUssRUFBRSxNQUFNLEVBQ2IsU0FBUyxFQUFFLFNBQVMsR0FDbkIsT0FBTyxDQUFDO1FBQ1QsT0FBTyxFQUFFLGtCQUFrQixDQUFDO1FBQzVCLFVBQVUsRUFBRSxNQUFNLENBQUM7S0FDcEIsQ0FBQyxDQVdEO0NBQ0YifQ==

package/dest/contracts/governance_proposer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"governance_proposer.d.ts","sourceRoot":"","sources":["../../src/contracts/governance_proposer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAG3D,OAAO,EAA8B,KAAK,GAAG,EAAE,KAAK,kBAAkB,EAAmC,MAAM,MAAM,CAAC;AAEtH,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC1E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,KAAK,WAAW,EAAc,MAAM,kBAAkB,CAAC;AAEhE,qBAAa,0BAA2B,YAAW,WAAW;aAGhC,MAAM,EAAE,gBAAgB;IAFpD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAwE;gBAErE,MAAM,EAAE,gBAAgB,EAAE,OAAO,EAAE,GAAG;IAIlE,IAAW,OAAO,eAEjB;IAEY,gBAAgB;IAKhB,kBAAkB;IAIxB,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAIhC,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC;IAI/B,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIrC,YAAY,CACvB,aAAa,EAAE,GAAG,EAClB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,GAAG,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAA;KAAE,CAAC;IASzD,gBAAgB,CAAC,aAAa,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;IAInF,iBAAiB,CAAC,OAAO,EAAE,GAAG,GAAG,WAAW;IAO5C,eAAe,CACpB,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,SAAS,GACnB,OAAO,CAAC;QACT,OAAO,EAAE,kBAAkB,CAAC;QAC5B,QAAQ,EAAE,QAAQ,CAAC;KACpB,CAAC;CAUH"}
+{"version":3,"file":"governance_proposer.d.ts","sourceRoot":"","sources":["../../src/contracts/governance_proposer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAE7D,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAG3D,OAAO,EAEL,KAAK,GAAG,EACR,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EAGzB,MAAM,MAAM,CAAC;AAEd,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,KAAK,WAAW,EAA8D,MAAM,kBAAkB,CAAC;AAGhH,qBAAa,0BAA2B,YAAW,WAAW;aAI1C,MAAM,EAAE,UAAU;IAHpC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAkE;IAE3F,YACkB,MAAM,EAAE,UAAU,EAClC,OAAO,EAAE,GAAG,GAAG,UAAU,EAM1B;IAED,IAAW,OAAO,eAEjB;IAEY,gBAAgB,wBAE5B;IAGY,kBAAkB,wBAE9B;IAEM,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC,CAEtC;IAEM,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAErC;IAEM,WAAW,2BAEjB;IAEM,YAAY,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAErD;IAEY,YAAY,CACvB,aAAa,EAAE,GAAG,EAClB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC;QAAE,cAAc,EAAE,UAAU,CAAC;QAAC,sBAAsB,EAAE,GAAG,CAAC;QAAC,aAAa,EAAE,OAAO,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAA;KAAE,CAAC,CAYjH;IAEM,iBAAiB,CAAC,aAAa,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAEzF;IAEM,mBAAmB,CAAC,OAAO,EAAE,GAAG,GAAG,WAAW,CAKpD;IAEY,gCAAgC,CAC3C,OAAO,EAAE,GAAG,EACZ,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,GAAG,EAClB,MAAM,EAAE,CAAC,GAAG,EAAE,mBAAmB,KAAK,OAAO,CAAC,GAAG,CAAC,GACjD,OAAO,CAAC,WAAW,CAAC,CAatB;IAEY,iBAAiB,CAC5B,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,SAAS,GACnB,OAAO,CAAC;QACT,OAAO,EAAE,kBAAkB,CAAC;QAC5B,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC,CAWD;CACF"}