feat(ethers): reexports structs and event from typechain (#528)

* feat(ethers): exports structs and event from typechain

* chore(ethers): updates package version to be alpha

* style: run prettier

* fix: failing deployment tests

* chore: maintained changelog

* fix: type error

* ci: adapt workflows

* fix: remove struct now located in osx-commons-contracts

* feat: add missing exports

* feat: add ens contracts

* chore: maintained changelog

* build: use correct version number

---------

Co-authored-by: Michael Heuer <[email protected]>

packages/contracts-ethers/CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Added the `@ensdomains/ens-contracts`.
+- Re-exported structs and events for the `DAO`, `DAORegistry`, `PluginRepo`, `PluginRepoRegistry`, and `PluginSetupProcessor`.
 - Refactored import statements.
 
 ## v0.2.1-alpha

packages/contracts-ethers/npm/events/DAO.ts

@@ -0,0 +1,31 @@
+export {
+  GrantedEvent,
+  RevokedEvent,
+  ExecutedEvent,
+  UpgradedEvent,
+  DepositedEvent,
+  InitializedEvent,
+  MetadataSetEvent,
+  AdminChangedEvent,
+  BeaconUpgradedEvent,
+  CallbackReceivedEvent,
+  TrustedForwarderSetEvent,
+  NativeTokenDepositedEvent,
+  StandardCallbackRegisteredEvent,
+} from '../../types/core/dao/DAO';
+
+export type EventName =
+  | 'Granted'
+  | 'Revoked'
+  | 'Executed'
+  | 'Upgraded'
+  | 'Deposited'
+  | 'Initialized'
+  | 'MetadataSet'
+  | 'AdminChanged'
+  | 'BeaconUpgraded'
+  | 'CallbackReceived'
+  | 'TrustedForwarderSet'
+  | 'NativeTokenDeposited'
+  | 'SignatureValidatorSet'
+  | 'StandardCallbackRegistered';

packages/contracts-ethers/npm/events/DAORegistry.ts

@@ -0,0 +1,14 @@
+export {
+  UpgradedEvent,
+  AdminChangedEvent,
+  BeaconUpgradedEvent,
+  DAORegisteredEvent,
+  InitializedEvent,
+} from '../../types/framework/dao/DAORegistry';
+
+export type EventName =
+  | 'Upgraded'
+  | 'AdminChanged'
+  | 'BeaconUpgraded'
+  | 'DAORegistered'
+  | 'Initialized';

packages/contracts-ethers/npm/events/PluginRepo.ts

@@ -0,0 +1,20 @@
+export {
+  GrantedEvent,
+  RevokedEvent,
+  UpgradedEvent,
+  InitializedEvent,
+  AdminChangedEvent,
+  BeaconUpgradedEvent,
+  VersionCreatedEvent,
+  ReleaseMetadataUpdatedEvent,
+} from '../../types/framework/plugin/repo/PluginRepo';
+
+export type EventName =
+  | 'Granted'
+  | 'Revoked'
+  | 'Upgraded'
+  | 'Initialized'
+  | 'AdminChanged'
+  | 'BeaconUpgraded'
+  | 'VersionCreated'
+  | 'ReleaseMetadataUpdated';

packages/contracts-ethers/npm/events/PluginRepoRegistry.ts

@@ -0,0 +1,14 @@
+export {
+  UpgradedEvent,
+  InitializedEvent,
+  AdminChangedEvent,
+  BeaconUpgradedEvent,
+  PluginRepoRegisteredEvent,
+} from '../../types/framework/plugin/repo/PluginRepoRegistry';
+
+export type EventName =
+  | 'Upgraded'
+  | 'Initialized'
+  | 'AdminChanged'
+  | 'BeaconUpgraded'
+  | 'PluginRepoRegistered';

packages/contracts-ethers/npm/events/PluginSetupProcessor.ts

@@ -0,0 +1,16 @@
+export {
+  UpdateAppliedEvent,
+  UpdatePreparedEvent,
+  InstallationAppliedEvent,
+  InstallationPreparedEvent,
+  UninstallationAppliedEvent,
+  UninstallationPreparedEvent,
+} from '../../types/framework/plugin/setup/PluginSetupProcessor';
+
+export type EventName =
+  | 'UpdateApplied'
+  | 'UpdatePrepared'
+  | 'InstallationApplied'
+  | 'InstallationPrepared'
+  | 'UninstallationApplied'
+  | 'UninstallationPrepared';

packages/contracts-ethers/npm/events/index.ts

@@ -0,0 +1,5 @@
+export * as DAOEvents from './DAO';
+export * as DAORegistryEvents from './DAORegistry';
+export * as PluginRepoEvents from './PluginRepo';
+export * as PluginRepoRegistryEvents from './PluginRepoRegistry';
+export * as PluginSetupProcessorEvents from './PluginSetupProcessor';

packages/contracts-ethers/npm/index.ts

@@ -1 +1,3 @@
 export * from '../types/';
+export * from './events/';
+export * from './structs';

packages/contracts-ethers/npm/structs/DAO.ts

@@ -0,0 +1,7 @@
+import {IDAO, PermissionLib} from '../../types/core/dao/DAO';
+
+export type ActionStruct = IDAO.ActionStruct;
+export type MultiTargetPermissionStruct =
+  PermissionLib.MultiTargetPermissionStruct;
+export type SingleTargetPermissionStruct =
+  PermissionLib.SingleTargetPermissionStruct;

packages/contracts-ethers/npm/structs/DAOFactory.ts

@@ -0,0 +1,4 @@
+import {DAOFactory} from '../../types/framework/dao/DAOFactory';
+
+export type DAOSettingsStruct = DAOFactory.DAOSettingsStruct;
+export type PluginSettingsStruct = DAOFactory.PluginSettingsStruct;

packages/contracts-ethers/npm/structs/PluginRepo.ts

@@ -0,0 +1,4 @@
+import {PluginRepo} from '../../types/framework/plugin/repo/PluginRepo';
+
+export type TagStruct = PluginRepo.TagStruct;
+export type VersionStruct = PluginRepo.VersionStruct;

packages/contracts-ethers/npm/structs/PluginSetupProcessor.ts

@@ -0,0 +1,26 @@
+import {
+  PluginSetupProcessor,
+  PluginSetupRefStruct as PluginSetupRefStruct_,
+  PluginSetupRefStructOutput as PluginSetupRefStructOutput_,
+} from '../../types/framework/plugin/setup/PluginSetupProcessor';
+
+export type ApplyInstallationParamsStruct =
+  PluginSetupProcessor.ApplyInstallationParamsStruct;
+
+export type ApplyUninstallationParamsStruct =
+  PluginSetupProcessor.ApplyUninstallationParamsStruct;
+
+export type ApplyUpdateParamsStruct =
+  PluginSetupProcessor.ApplyUpdateParamsStruct;
+
+export type PrepareInstallationParamsStruct =
+  PluginSetupProcessor.PrepareInstallationParamsStruct;
+export type PrepareUninstallationParamsStruct =
+  PluginSetupProcessor.PrepareUninstallationParamsStruct;
+
+export type PrepareUpdateParamsStructOutput =
+  PluginSetupProcessor.PrepareUpdateParamsStructOutput;
+
+export type PluginSetupRefStruct = PluginSetupRefStruct_;
+
+export type PluginSetupRefStructOutput = PluginSetupRefStructOutput_;

packages/contracts-ethers/npm/structs/index.ts

@@ -0,0 +1,4 @@
+export * as DAOStructs from './DAO';
+export * as DAOFactoryStructs from './DAOFactory';
+export * as PluginRepoStructs from './PluginRepo';
+export * as PluginSetupProcessorStructs from './PluginSetupProcessor';

packages/contracts-ethers/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aragon/osx-ethers",
-  "version": "1.4.0-rc0",
+  "version": "1.4.0-alpha.0",
   "description": "The Aragon OSx contract definitions for ethers.js",
   "main": "dist/bundle-cjs.js",
   "module": "dist/bundle-esm.js",
@@ -10,7 +10,7 @@
   },
   "scripts": {
     "build:contracts": "cd ../contracts && yarn build",
-    "build": "find ../contracts/artifacts/src/ -name '*.json' -type f | grep -v '.dbg.json' | xargs typechain --target=ethers-v5 --out-dir ./types",
+    "build": "find ../contracts/artifacts/src/ ../contracts/artifacts/@ensdomains/ens-contracts/contracts/ -name '*.json' -type f | grep -v '.dbg.json' | xargs typechain --target=ethers-v5 --out-dir ./types",
     "build:npm": "rollup --config rollup.config.ts",
     "prepublishOnly": "yarn build:contracts && yarn build && yarn build:npm"
   },