From 15e362f663fd22fd47f0b154fae35f0df0968bb3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B8r=E2=88=82=C2=A1?= Date: Sat, 22 Jul 2023 17:17:04 +0200 Subject: [PATCH] Make the network mandatory on get plugin install item --- modules/client/examples/01-client/01-create-dao.ts | 2 +- .../examples/02-multisig-client/01-installation.ts | 2 +- .../examples/03-tokenVoting-client/01-installation.ts | 4 ++-- .../04-addresslistVoting-client/01-installation.ts | 2 +- modules/client/src/addresslistVoting/client.ts | 2 +- modules/client/src/multisig/client.ts | 2 +- modules/client/src/tokenVoting/client.ts | 2 +- modules/client/test/helpers/build-daos.ts | 11 +++++++---- modules/client/test/helpers/deployContracts.ts | 2 +- .../addresslistVoting-client/encoding.test.ts | 5 ++++- .../client/test/integration/client/estimation.test.ts | 6 ++++-- .../client/test/integration/client/methods.test.ts | 6 ++++-- .../test/integration/multisig-client/encoding.test.ts | 5 ++++- .../integration/tokenVoting-client/encoding.test.ts | 5 ++++- 14 files changed, 36 insertions(+), 20 deletions(-) diff --git a/modules/client/examples/01-client/01-create-dao.ts b/modules/client/examples/01-client/01-create-dao.ts index a92b72ecc..3fa5463da 100644 --- a/modules/client/examples/01-client/01-create-dao.ts +++ b/modules/client/examples/01-client/01-create-dao.ts @@ -62,7 +62,7 @@ const tokenVotingPluginInstallParams: TokenVotingPluginInstall = { // Creates a TokenVoting plugin client with the parameteres defined above (with an existing token). const tokenVotingInstallItem = TokenVotingClient.encoding - .getPluginInstallItem(tokenVotingPluginInstallParams); + .getPluginInstallItem(tokenVotingPluginInstallParams, "goerli"); const createDaoParams: CreateDaoParams = { metadataUri, diff --git a/modules/client/examples/02-multisig-client/01-installation.ts b/modules/client/examples/02-multisig-client/01-installation.ts index 93cd0c46f..b13eb9454 100644 --- a/modules/client/examples/02-multisig-client/01-installation.ts +++ b/modules/client/examples/02-multisig-client/01-installation.ts @@ -42,7 +42,7 @@ const multisigPluginIntallParams: MultisigPluginInstallParams = { // Encodes the parameters of the Multisig plugin. These will get used in the installation plugin for the DAO. const multisigPluginInstallItem = MultisigClient.encoding - .getPluginInstallItem(multisigPluginIntallParams); + .getPluginInstallItem(multisigPluginIntallParams, "goerli"); // Pin metadata to IPFS, returns IPFS CID string. const metadataUri: string = await client.methods.pinMetadata({ diff --git a/modules/client/examples/03-tokenVoting-client/01-installation.ts b/modules/client/examples/03-tokenVoting-client/01-installation.ts index b2049e191..e25c22d4d 100644 --- a/modules/client/examples/03-tokenVoting-client/01-installation.ts +++ b/modules/client/examples/03-tokenVoting-client/01-installation.ts @@ -75,10 +75,10 @@ const tokenVotingPluginInstallParams2: TokenVotingPluginInstall = { // Creates a TokenVoting plugin client with the parameteres defined above (with an existing token). const tokenVotingPluginInstallItem1 = TokenVotingClient.encoding - .getPluginInstallItem(tokenVotingPluginInstallParams1); + .getPluginInstallItem(tokenVotingPluginInstallParams1, "goerli"); // Creates a TokenVoting plugin client with the parameteres defined above (with newly minted tokens). const tokenVotingPluginInstallItem2 = TokenVotingClient.encoding - .getPluginInstallItem(tokenVotingPluginInstallParams2); + .getPluginInstallItem(tokenVotingPluginInstallParams2, "goerli"); const daoMetadata: DaoMetadata = { name: "My DAO", diff --git a/modules/client/examples/04-addresslistVoting-client/01-installation.ts b/modules/client/examples/04-addresslistVoting-client/01-installation.ts index e367fd872..ffb235e38 100644 --- a/modules/client/examples/04-addresslistVoting-client/01-installation.ts +++ b/modules/client/examples/04-addresslistVoting-client/01-installation.ts @@ -45,7 +45,7 @@ const addresslistVotingPluginInstallParams: AddresslistVotingPluginInstall = { // Encodes the plugin instructions for installing into the DAO with its defined parameters. const addresslistVotingPluginInstallItem = AddresslistVotingClient - .encoding.getPluginInstallItem(addresslistVotingPluginInstallParams); + .encoding.getPluginInstallItem(addresslistVotingPluginInstallParams, "goerli"); const daoMetadata: DaoMetadata = { name: "My DAO", diff --git a/modules/client/src/addresslistVoting/client.ts b/modules/client/src/addresslistVoting/client.ts index 8faa7fc41..8a80255c4 100644 --- a/modules/client/src/addresslistVoting/client.ts +++ b/modules/client/src/addresslistVoting/client.ts @@ -43,7 +43,7 @@ export class AddresslistVotingClient extends ClientCore */ getPluginInstallItem: ( params: AddresslistVotingPluginInstall, - network: Networkish = "mainnet", + network: Networkish, ): PluginInstallItem => AddresslistVotingClientEncoding.getPluginInstallItem(params, network), }; diff --git a/modules/client/src/multisig/client.ts b/modules/client/src/multisig/client.ts index f859a143f..4e6d56319 100644 --- a/modules/client/src/multisig/client.ts +++ b/modules/client/src/multisig/client.ts @@ -43,7 +43,7 @@ export class MultisigClient extends ClientCore implements IMultisigClient { getPluginInstallItem: ( params: MultisigPluginInstallParams, - network: Networkish = "mainnet", + network: Networkish, ): PluginInstallItem => MultisigClientEncoding.getPluginInstallItem(params, network), }; diff --git a/modules/client/src/tokenVoting/client.ts b/modules/client/src/tokenVoting/client.ts index 5ee21371a..f07615376 100644 --- a/modules/client/src/tokenVoting/client.ts +++ b/modules/client/src/tokenVoting/client.ts @@ -46,7 +46,7 @@ export class TokenVotingClient extends ClientCore */ getPluginInstallItem: ( params: TokenVotingPluginInstall, - network: Networkish = "mainnet", + network: Networkish, ): PluginInstallItem => TokenVotingClientEncoding.getPluginInstallItem(params, network), }; diff --git a/modules/client/test/helpers/build-daos.ts b/modules/client/test/helpers/build-daos.ts index 4d31b6c1b..32c87bf41 100644 --- a/modules/client/test/helpers/build-daos.ts +++ b/modules/client/test/helpers/build-daos.ts @@ -26,7 +26,7 @@ export async function buildMultisigDAO(pluginRepoAddress: string) { minApprovals: 1, onlyListed: true, }, - }); + }, client.web3.getProvider().network.name); const createDaoParams: CreateDaoParams = { ensSubdomain: "teting-" + Math.random().toString().slice(2), @@ -78,7 +78,10 @@ export async function buildTokenVotingDAO( }, }; const pluginInstallItem = TokenVotingClient.encoding - .getPluginInstallItem(pluginInstallParams); + .getPluginInstallItem( + pluginInstallParams, + client.web3.getProvider().network.name + ); const createDaoParams: CreateDaoParams = { ensSubdomain: "teting-" + Math.random().toString().slice(2), @@ -141,7 +144,7 @@ export async function buildExistingTokenVotingDAO( minProposerVotingPower: BigInt(0), votingMode, }, - }); + }, client.web3.getProvider().network.name); const createDaoParams: CreateDaoParams = { ensSubdomain: "teting-" + Math.random().toString().slice(2), @@ -187,7 +190,7 @@ export async function buildAddressListVotingDAO( minProposerVotingPower: BigInt(0), votingMode, }, - }); + }, client.web3.getProvider().network.name); const createDaoParams: CreateDaoParams = { ensSubdomain: "teting-" + Math.random().toString().slice(2), diff --git a/modules/client/test/helpers/deployContracts.ts b/modules/client/test/helpers/deployContracts.ts index 2c7a831e4..43e3bb50e 100644 --- a/modules/client/test/helpers/deployContracts.ts +++ b/modules/client/test/helpers/deployContracts.ts @@ -445,7 +445,7 @@ export async function createAddresslistDAO( votingMode, minProposerVotingPower: BigInt(0), }, - }); + }, (await deployment.daoFactory.provider.getNetwork()).name); const pluginInstallItems = [ { diff --git a/modules/client/test/integration/addresslistVoting-client/encoding.test.ts b/modules/client/test/integration/addresslistVoting-client/encoding.test.ts index 974dafcd4..da3a16f1b 100644 --- a/modules/client/test/integration/addresslistVoting-client/encoding.test.ts +++ b/modules/client/test/integration/addresslistVoting-client/encoding.test.ts @@ -10,9 +10,11 @@ import { bytesToHex, InvalidAddressError } from "@aragon/sdk-common"; import { ADDRESS_ONE, contextParamsLocalChain } from "../constants"; import { Context, SupportedNetworksArray } from "@aragon/sdk-client-common"; +const NETWORK_NAME = "goerli"; + jest.spyOn(SupportedNetworksArray, "includes").mockReturnValue(true); jest.spyOn(Context.prototype, "network", "get").mockReturnValue( - { chainId: 5, name: "goerli" }, + { chainId: 5, name: NETWORK_NAME }, ); describe("Client Address List", () => { beforeAll(() => { @@ -37,6 +39,7 @@ describe("Client Address List", () => { const installPluginItemItem = AddresslistVotingClient.encoding .getPluginInstallItem( withdrawParams, + NETWORK_NAME, ); expect(typeof installPluginItemItem).toBe("object"); diff --git a/modules/client/test/integration/client/estimation.test.ts b/modules/client/test/integration/client/estimation.test.ts index 549ea8984..3c722b649 100644 --- a/modules/client/test/integration/client/estimation.test.ts +++ b/modules/client/test/integration/client/estimation.test.ts @@ -20,9 +20,11 @@ import { TokenType, } from "@aragon/sdk-client-common"; +const NETWORK_NAME = "goerli"; + jest.spyOn(SupportedNetworksArray, "includes").mockReturnValue(true); jest.spyOn(Context.prototype, "network", "get").mockReturnValue( - { chainId: 5, name: "goerli" }, + { chainId: 5, name: NETWORK_NAME }, ); let daoAddress = "0x1234567890123456789012345678901234567890"; describe("Client", () => { @@ -62,7 +64,7 @@ describe("Client", () => { }; const addresslistVotingPlugin = AddresslistVotingClient.encoding - .getPluginInstallItem(pluginParams); + .getPluginInstallItem(pluginParams, NETWORK_NAME); addresslistVotingPlugin.id = deployment.addresslistVotingRepo.address; const daoCreationParams: CreateDaoParams = { diff --git a/modules/client/test/integration/client/methods.test.ts b/modules/client/test/integration/client/methods.test.ts index dbc49951b..fef852f5a 100644 --- a/modules/client/test/integration/client/methods.test.ts +++ b/modules/client/test/integration/client/methods.test.ts @@ -72,9 +72,11 @@ import { } from "@aragon/sdk-client-common"; import { INSTALLATION_ABI } from "../../../src/multisig/internal/constants"; +const NETWORK_NAME = "goerli"; + jest.spyOn(SupportedNetworksArray, "includes").mockReturnValue(true); jest.spyOn(Context.prototype, "network", "get").mockReturnValue( - { chainId: 5, name: "goerli" }, + { chainId: 5, name: NETWORK_NAME }, ); describe("Client", () => { let daoAddress: string; @@ -144,7 +146,7 @@ describe("Client", () => { }; const addresslistVotingPlugin = AddresslistVotingClient.encoding - .getPluginInstallItem(pluginParams); + .getPluginInstallItem(pluginParams, NETWORK_NAME); addresslistVotingPlugin.id = deployment.addresslistVotingRepo.address; const daoCreationParams: CreateDaoParams = { diff --git a/modules/client/test/integration/multisig-client/encoding.test.ts b/modules/client/test/integration/multisig-client/encoding.test.ts index 8d08bbce5..f11093778 100644 --- a/modules/client/test/integration/multisig-client/encoding.test.ts +++ b/modules/client/test/integration/multisig-client/encoding.test.ts @@ -15,9 +15,11 @@ import { } from "../constants"; import { Context, SupportedNetworksArray } from "@aragon/sdk-client-common"; +const NETWORK_NAME = "goerli"; + jest.spyOn(SupportedNetworksArray, "includes").mockReturnValue(true); jest.spyOn(Context.prototype, "network", "get").mockReturnValue( - { chainId: 5, name: "goerli" }, + { chainId: 5, name: NETWORK_NAME }, ); describe("Client Multisig", () => { @@ -43,6 +45,7 @@ describe("Client Multisig", () => { const installPluginItemItem = MultisigClient.encoding .getPluginInstallItem( multisigIntallParams, + NETWORK_NAME ); expect(typeof installPluginItemItem).toBe("object"); diff --git a/modules/client/test/integration/tokenVoting-client/encoding.test.ts b/modules/client/test/integration/tokenVoting-client/encoding.test.ts index d989f72e6..f4458c16e 100644 --- a/modules/client/test/integration/tokenVoting-client/encoding.test.ts +++ b/modules/client/test/integration/tokenVoting-client/encoding.test.ts @@ -12,9 +12,11 @@ import { InvalidAddressError } from "@aragon/sdk-common"; import { ADDRESS_ONE, contextParamsLocalChain } from "../constants"; import { Context, SupportedNetworksArray } from "@aragon/sdk-client-common"; +const NETWORK_NAME = "goerli"; + jest.spyOn(SupportedNetworksArray, "includes").mockReturnValue(true); jest.spyOn(Context.prototype, "network", "get").mockReturnValue( - { chainId: 5, name: "goerli" }, + { chainId: 5, name: NETWORK_NAME }, ); describe("Token Voting Client", () => { @@ -39,6 +41,7 @@ describe("Token Voting Client", () => { const tokenVotingInstallPluginItem = TokenVotingClient.encoding .getPluginInstallItem( initParams, + NETWORK_NAME ); expect(typeof tokenVotingInstallPluginItem).toBe("object");