From 5980799a566e1932c7e0e61f392f1c9bbdc30db5 Mon Sep 17 00:00:00 2001 From: Aaron DeRuvo Date: Wed, 13 Nov 2024 15:28:06 +0100 Subject: [PATCH] update docs --- docs/sdk/governance/README.md | 4 + ...osal_builder.InteractiveProposalBuilder.md | 64 +++ .../proposal_builder.ProposalBuilder.md | 420 ++++++++++++++++++ .../proposals.InteractiveProposalBuilder.md | 64 --- .../classes/proposals.ProposalBuilder.md | 420 ------------------ .../proposals.ProposalTransactionJSON.md | 12 +- .../interfaces/proposals.RegistryAdditions.md | 9 + docs/sdk/governance/modules/index.md | 60 ++- .../modules/interactive_proposal_builder.md | 33 ++ .../governance/modules/proposal_builder.md | 9 + docs/sdk/governance/modules/proposals.md | 165 ++++++- .../governance/modules/test_utils_globals.md | 19 + .../modules/test_utils_setup_global.md | 23 + 13 files changed, 802 insertions(+), 500 deletions(-) create mode 100644 docs/sdk/governance/classes/interactive_proposal_builder.InteractiveProposalBuilder.md create mode 100644 docs/sdk/governance/classes/proposal_builder.ProposalBuilder.md delete mode 100644 docs/sdk/governance/classes/proposals.InteractiveProposalBuilder.md delete mode 100644 docs/sdk/governance/classes/proposals.ProposalBuilder.md create mode 100644 docs/sdk/governance/interfaces/proposals.RegistryAdditions.md create mode 100644 docs/sdk/governance/modules/interactive_proposal_builder.md create mode 100644 docs/sdk/governance/modules/proposal_builder.md create mode 100644 docs/sdk/governance/modules/test_utils_globals.md create mode 100644 docs/sdk/governance/modules/test_utils_setup_global.md diff --git a/docs/sdk/governance/README.md b/docs/sdk/governance/README.md index 6ffd21158..068a66b4a 100644 --- a/docs/sdk/governance/README.md +++ b/docs/sdk/governance/README.md @@ -7,4 +7,8 @@ ### Modules - [index](modules/index.md) +- [interactive-proposal-builder](modules/interactive_proposal_builder.md) +- [proposal-builder](modules/proposal_builder.md) - [proposals](modules/proposals.md) +- [test-utils/globals](modules/test_utils_globals.md) +- [test-utils/setup.global](modules/test_utils_setup_global.md) diff --git a/docs/sdk/governance/classes/interactive_proposal_builder.InteractiveProposalBuilder.md b/docs/sdk/governance/classes/interactive_proposal_builder.InteractiveProposalBuilder.md new file mode 100644 index 000000000..85a764f72 --- /dev/null +++ b/docs/sdk/governance/classes/interactive_proposal_builder.InteractiveProposalBuilder.md @@ -0,0 +1,64 @@ +[@celo/governance](../README.md) / [interactive-proposal-builder](../modules/interactive_proposal_builder.md) / InteractiveProposalBuilder + +# Class: InteractiveProposalBuilder + +[interactive-proposal-builder](../modules/interactive_proposal_builder.md).InteractiveProposalBuilder + +## Table of contents + +### Constructors + +- [constructor](interactive_proposal_builder.InteractiveProposalBuilder.md#constructor) + +### Methods + +- [outputTransactions](interactive_proposal_builder.InteractiveProposalBuilder.md#outputtransactions) +- [promptTransactions](interactive_proposal_builder.InteractiveProposalBuilder.md#prompttransactions) + +## Constructors + +### constructor + +• **new InteractiveProposalBuilder**(`builder`): [`InteractiveProposalBuilder`](interactive_proposal_builder.InteractiveProposalBuilder.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `builder` | [`ProposalBuilder`](proposal_builder.ProposalBuilder.md) | + +#### Returns + +[`InteractiveProposalBuilder`](interactive_proposal_builder.InteractiveProposalBuilder.md) + +#### Defined in + +[packages/sdk/governance/src/interactive-proposal-builder.ts:14](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/interactive-proposal-builder.ts#L14) + +## Methods + +### outputTransactions + +▸ **outputTransactions**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/sdk/governance/src/interactive-proposal-builder.ts:16](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/interactive-proposal-builder.ts#L16) + +___ + +### promptTransactions + +▸ **promptTransactions**(): `Promise`\<[`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md)[]\> + +#### Returns + +`Promise`\<[`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md)[]\> + +#### Defined in + +[packages/sdk/governance/src/interactive-proposal-builder.ts:21](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/interactive-proposal-builder.ts#L21) diff --git a/docs/sdk/governance/classes/proposal_builder.ProposalBuilder.md b/docs/sdk/governance/classes/proposal_builder.ProposalBuilder.md new file mode 100644 index 000000000..1eb980adb --- /dev/null +++ b/docs/sdk/governance/classes/proposal_builder.ProposalBuilder.md @@ -0,0 +1,420 @@ +[@celo/governance](../README.md) / [proposal-builder](../modules/proposal_builder.md) / ProposalBuilder + +# Class: ProposalBuilder + +[proposal-builder](../modules/proposal_builder.md).ProposalBuilder + +Builder class to construct proposals from JSON or transaction objects. + +## Table of contents + +### Constructors + +- [constructor](proposal_builder.ProposalBuilder.md#constructor) + +### Properties + +- [buildFunctionCallToExternalContract](proposal_builder.ProposalBuilder.md#buildfunctioncalltoexternalcontract) +- [externalCallProxyRepoint](proposal_builder.ProposalBuilder.md#externalcallproxyrepoint) +- [isRegistered](proposal_builder.ProposalBuilder.md#isregistered) +- [registryAdditions](proposal_builder.ProposalBuilder.md#registryadditions) + +### Methods + +- [addJsonTx](proposal_builder.ProposalBuilder.md#addjsontx) +- [addProxyRepointingTx](proposal_builder.ProposalBuilder.md#addproxyrepointingtx) +- [addTx](proposal_builder.ProposalBuilder.md#addtx) +- [addWeb3Tx](proposal_builder.ProposalBuilder.md#addweb3tx) +- [build](proposal_builder.ProposalBuilder.md#build) +- [buildCallToCoreContract](proposal_builder.ProposalBuilder.md#buildcalltocorecontract) +- [buildCallToExternalContract](proposal_builder.ProposalBuilder.md#buildcalltoexternalcontract) +- [fromJsonTx](proposal_builder.ProposalBuilder.md#fromjsontx) +- [fromWeb3tx](proposal_builder.ProposalBuilder.md#fromweb3tx) +- [getRegistryAddition](proposal_builder.ProposalBuilder.md#getregistryaddition) +- [isRegistryContract](proposal_builder.ProposalBuilder.md#isregistrycontract) +- [lookupExternalMethodABI](proposal_builder.ProposalBuilder.md#lookupexternalmethodabi) +- [setRegistryAddition](proposal_builder.ProposalBuilder.md#setregistryaddition) +- [transformArgs](proposal_builder.ProposalBuilder.md#transformargs) + +## Constructors + +### constructor + +• **new ProposalBuilder**(`kit`, `builders?`, `registryAdditions?`): [`ProposalBuilder`](proposal_builder.ProposalBuilder.md) + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `kit` | `ContractKit` | `undefined` | +| `builders` | () => `Promise`\<`ProposalTransaction`\>[] | `[]` | +| `registryAdditions` | [`RegistryAdditions`](../interfaces/proposals.RegistryAdditions.md) | `{}` | + +#### Returns + +[`ProposalBuilder`](proposal_builder.ProposalBuilder.md) + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:40](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L40) + +## Properties + +### buildFunctionCallToExternalContract + +• **buildFunctionCallToExternalContract**: (`tx`: [`ExternalProposalTransactionJSON`](../modules/proposals.md#externalproposaltransactionjson)) => `Promise`\<`ProposalTransaction`\> + +#### Type declaration + +▸ (`tx`): `Promise`\<`ProposalTransaction`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `tx` | [`ExternalProposalTransactionJSON`](../modules/proposals.md#externalproposaltransactionjson) | + +##### Returns + +`Promise`\<`ProposalTransaction`\> + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:182](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L182) + +___ + +### externalCallProxyRepoint + +• **externalCallProxyRepoint**: `Map`\<`string`, `string`\> + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:38](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L38) + +___ + +### isRegistered + +• **isRegistered**: (`contract`: `CeloContract`) => `boolean` + +#### Type declaration + +▸ (`contract`): `boolean` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `contract` | `CeloContract` | + +##### Returns + +`boolean` + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:122](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L122) + +___ + +### registryAdditions + +• `Readonly` **registryAdditions**: [`RegistryAdditions`](../interfaces/proposals.RegistryAdditions.md) = `{}` + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:43](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L43) + +## Methods + +### addJsonTx + +▸ **addJsonTx**(`tx`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `tx` | [`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md) | + +#### Returns + +`number` + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:260](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L260) + +___ + +### addProxyRepointingTx + +▸ **addProxyRepointingTx**(`contract`, `newImplementationAddress`): `void` + +Adds a transaction to set the implementation on a proxy to the given address. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `contract` | `CeloContract` | Celo contract name of the proxy which should have its implementation set. | +| `newImplementationAddress` | `string` | Address of the new contract implementation. | + +#### Returns + +`void` + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:74](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L74) + +___ + +### addTx + +▸ **addTx**(`tx`, `params?`): `void` + +Adds a Celo transaction to the list for proposal construction. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `tx` | `CeloTransactionObject`\<`any`\> | A Celo transaction object to add to the proposal. | +| `params` | `Partial`\<[`ProposalTxParams`](../modules/proposals.md#proposaltxparams)\> | Optional parameters for how the transaction should be executed. | + +#### Returns + +`void` + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:100](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L100) + +___ + +### addWeb3Tx + +▸ **addWeb3Tx**(`tx`, `params`): `number` + +Adds a Web3 transaction to the list for proposal construction. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `tx` | `CeloTxObject`\<`any`\> | A Web3 transaction object to add to the proposal. | +| `params` | [`ProposalTxParams`](../modules/proposals.md#proposaltxparams) | Parameters for how the transaction should be executed. | + +#### Returns + +`number` + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:92](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L92) + +___ + +### build + +▸ **build**(): `Promise`\<`ProposalTransaction`[]\> + +Build calls all of the added build steps and returns the final proposal. + +#### Returns + +`Promise`\<`ProposalTransaction`[]\> + +A constructed Proposal object (i.e. a list of ProposalTransaction) + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:50](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L50) + +___ + +### buildCallToCoreContract + +▸ **buildCallToCoreContract**(`tx`): `Promise`\<`ProposalTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `tx` | [`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md) | + +#### Returns + +`Promise`\<`ProposalTransaction`\> + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:203](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L203) + +___ + +### buildCallToExternalContract + +▸ **buildCallToExternalContract**(`tx`): `Promise`\<`ProposalTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `tx` | [`ExternalProposalTransactionJSON`](../modules/proposals.md#externalproposaltransactionjson) | + +#### Returns + +`Promise`\<`ProposalTransaction`\> + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:146](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L146) + +___ + +### fromJsonTx + +▸ **fromJsonTx**(`tx`): `Promise`\<`ProposalTransaction`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `tx` | [`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md) \| [`ExternalProposalTransactionJSON`](../modules/proposals.md#externalproposaltransactionjson) | + +#### Returns + +`Promise`\<`ProposalTransaction`\> + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:233](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L233) + +___ + +### fromWeb3tx + +▸ **fromWeb3tx**(`tx`, `params`): `ProposalTransaction` + +Converts a Web3 transaction into a proposal transaction object. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `tx` | `CeloTxObject`\<`any`\> | A Web3 transaction object to convert. | +| `params` | [`ProposalTxParams`](../modules/proposals.md#proposaltxparams) | Parameters for how the transaction should be executed. | + +#### Returns + +`ProposalTransaction` + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:63](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L63) + +___ + +### getRegistryAddition + +▸ **getRegistryAddition**(`contract`): `undefined` \| `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `contract` | `CeloContract` | + +#### Returns + +`undefined` \| `string` + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:112](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L112) + +___ + +### isRegistryContract + +▸ **isRegistryContract**(`contract`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `contract` | `CeloContract` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:115](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L115) + +___ + +### lookupExternalMethodABI + +▸ **lookupExternalMethodABI**(`address`, `tx`): `Promise`\<``null`` \| `AbiItem`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `address` | `string` | +| `tx` | [`ExternalProposalTransactionJSON`](../modules/proposals.md#externalproposaltransactionjson) | + +#### Returns + +`Promise`\<``null`` \| `AbiItem`\> + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:124](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L124) + +___ + +### setRegistryAddition + +▸ **setRegistryAddition**(`contract`, `address`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `contract` | `CeloContract` | +| `address` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:109](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L109) + +___ + +### transformArgs + +▸ **transformArgs**(`abi`, `args`): `any`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `abi` | `AbiItem` | +| `args` | `any`[] | + +#### Returns + +`any`[] + +#### Defined in + +[packages/sdk/governance/src/proposal-builder.ts:184](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposal-builder.ts#L184) diff --git a/docs/sdk/governance/classes/proposals.InteractiveProposalBuilder.md b/docs/sdk/governance/classes/proposals.InteractiveProposalBuilder.md deleted file mode 100644 index d2fe9c299..000000000 --- a/docs/sdk/governance/classes/proposals.InteractiveProposalBuilder.md +++ /dev/null @@ -1,64 +0,0 @@ -[@celo/governance](../README.md) / [proposals](../modules/proposals.md) / InteractiveProposalBuilder - -# Class: InteractiveProposalBuilder - -[proposals](../modules/proposals.md).InteractiveProposalBuilder - -## Table of contents - -### Constructors - -- [constructor](proposals.InteractiveProposalBuilder.md#constructor) - -### Methods - -- [outputTransactions](proposals.InteractiveProposalBuilder.md#outputtransactions) -- [promptTransactions](proposals.InteractiveProposalBuilder.md#prompttransactions) - -## Constructors - -### constructor - -• **new InteractiveProposalBuilder**(`builder`): [`InteractiveProposalBuilder`](proposals.InteractiveProposalBuilder.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `builder` | [`ProposalBuilder`](proposals.ProposalBuilder.md) | - -#### Returns - -[`InteractiveProposalBuilder`](proposals.InteractiveProposalBuilder.md) - -#### Defined in - -[proposals.ts:466](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L466) - -## Methods - -### outputTransactions - -▸ **outputTransactions**(): `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[proposals.ts:468](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L468) - -___ - -### promptTransactions - -▸ **promptTransactions**(): `Promise`\<[`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md)[]\> - -#### Returns - -`Promise`\<[`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md)[]\> - -#### Defined in - -[proposals.ts:473](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L473) diff --git a/docs/sdk/governance/classes/proposals.ProposalBuilder.md b/docs/sdk/governance/classes/proposals.ProposalBuilder.md deleted file mode 100644 index 5a123e945..000000000 --- a/docs/sdk/governance/classes/proposals.ProposalBuilder.md +++ /dev/null @@ -1,420 +0,0 @@ -[@celo/governance](../README.md) / [proposals](../modules/proposals.md) / ProposalBuilder - -# Class: ProposalBuilder - -[proposals](../modules/proposals.md).ProposalBuilder - -Builder class to construct proposals from JSON or transaction objects. - -## Table of contents - -### Constructors - -- [constructor](proposals.ProposalBuilder.md#constructor) - -### Properties - -- [buildFunctionCallToExternalContract](proposals.ProposalBuilder.md#buildfunctioncalltoexternalcontract) -- [externalCallProxyRepoint](proposals.ProposalBuilder.md#externalcallproxyrepoint) -- [isRegistered](proposals.ProposalBuilder.md#isregistered) -- [registryAdditions](proposals.ProposalBuilder.md#registryadditions) - -### Methods - -- [addJsonTx](proposals.ProposalBuilder.md#addjsontx) -- [addProxyRepointingTx](proposals.ProposalBuilder.md#addproxyrepointingtx) -- [addTx](proposals.ProposalBuilder.md#addtx) -- [addWeb3Tx](proposals.ProposalBuilder.md#addweb3tx) -- [build](proposals.ProposalBuilder.md#build) -- [buildCallToCoreContract](proposals.ProposalBuilder.md#buildcalltocorecontract) -- [buildCallToExternalContract](proposals.ProposalBuilder.md#buildcalltoexternalcontract) -- [fromJsonTx](proposals.ProposalBuilder.md#fromjsontx) -- [fromWeb3tx](proposals.ProposalBuilder.md#fromweb3tx) -- [getRegistryAddition](proposals.ProposalBuilder.md#getregistryaddition) -- [isRegistryContract](proposals.ProposalBuilder.md#isregistrycontract) -- [lookupExternalMethodABI](proposals.ProposalBuilder.md#lookupexternalmethodabi) -- [setRegistryAddition](proposals.ProposalBuilder.md#setregistryaddition) -- [transformArgs](proposals.ProposalBuilder.md#transformargs) - -## Constructors - -### constructor - -• **new ProposalBuilder**(`kit`, `builders?`, `registryAdditions?`): [`ProposalBuilder`](proposals.ProposalBuilder.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `kit` | `ContractKit` | `undefined` | -| `builders` | () => `Promise`\<`ProposalTransaction`\>[] | `[]` | -| `registryAdditions` | `RegistryAdditions` | `{}` | - -#### Returns - -[`ProposalBuilder`](proposals.ProposalBuilder.md) - -#### Defined in - -[proposals.ts:241](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L241) - -## Properties - -### buildFunctionCallToExternalContract - -• **buildFunctionCallToExternalContract**: (`tx`: [`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md)) => `Promise`\<`ProposalTransaction`\> - -#### Type declaration - -▸ (`tx`): `Promise`\<`ProposalTransaction`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `tx` | [`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md) | - -##### Returns - -`Promise`\<`ProposalTransaction`\> - -#### Defined in - -[proposals.ts:384](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L384) - -___ - -### externalCallProxyRepoint - -• **externalCallProxyRepoint**: `Map`\<`string`, `string`\> - -#### Defined in - -[proposals.ts:239](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L239) - -___ - -### isRegistered - -• **isRegistered**: (`contract`: `CeloContract`) => `boolean` - -#### Type declaration - -▸ (`contract`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `contract` | `CeloContract` | - -##### Returns - -`boolean` - -#### Defined in - -[proposals.ts:324](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L324) - -___ - -### registryAdditions - -• `Readonly` **registryAdditions**: `RegistryAdditions` = `{}` - -#### Defined in - -[proposals.ts:244](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L244) - -## Methods - -### addJsonTx - -▸ **addJsonTx**(`tx`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tx` | [`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md) | - -#### Returns - -`number` - -#### Defined in - -[proposals.ts:460](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L460) - -___ - -### addProxyRepointingTx - -▸ **addProxyRepointingTx**(`contract`, `newImplementationAddress`): `void` - -Adds a transaction to set the implementation on a proxy to the given address. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contract` | `CeloContract` | Celo contract name of the proxy which should have its implementation set. | -| `newImplementationAddress` | `string` | Address of the new contract implementation. | - -#### Returns - -`void` - -#### Defined in - -[proposals.ts:275](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L275) - -___ - -### addTx - -▸ **addTx**(`tx`, `params?`): `void` - -Adds a Celo transaction to the list for proposal construction. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tx` | `CeloTransactionObject`\<`any`\> | A Celo transaction object to add to the proposal. | -| `params` | `Partial`\<`ProposalTxParams`\> | Optional parameters for how the transaction should be executed. | - -#### Returns - -`void` - -#### Defined in - -[proposals.ts:301](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L301) - -___ - -### addWeb3Tx - -▸ **addWeb3Tx**(`tx`, `params`): `number` - -Adds a Web3 transaction to the list for proposal construction. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tx` | `CeloTxObject`\<`any`\> | A Web3 transaction object to add to the proposal. | -| `params` | `ProposalTxParams` | Parameters for how the transaction should be executed. | - -#### Returns - -`number` - -#### Defined in - -[proposals.ts:293](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L293) - -___ - -### build - -▸ **build**(): `Promise`\<`ProposalTransaction`[]\> - -Build calls all of the added build steps and returns the final proposal. - -#### Returns - -`Promise`\<`ProposalTransaction`[]\> - -A constructed Proposal object (i.e. a list of ProposalTransaction) - -#### Defined in - -[proposals.ts:251](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L251) - -___ - -### buildCallToCoreContract - -▸ **buildCallToCoreContract**(`tx`): `Promise`\<`ProposalTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tx` | [`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md) | - -#### Returns - -`Promise`\<`ProposalTransaction`\> - -#### Defined in - -[proposals.ts:405](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L405) - -___ - -### buildCallToExternalContract - -▸ **buildCallToExternalContract**(`tx`): `Promise`\<`ProposalTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tx` | [`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md) | - -#### Returns - -`Promise`\<`ProposalTransaction`\> - -#### Defined in - -[proposals.ts:348](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L348) - -___ - -### fromJsonTx - -▸ **fromJsonTx**(`tx`): `Promise`\<`ProposalTransaction`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tx` | [`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md) | - -#### Returns - -`Promise`\<`ProposalTransaction`\> - -#### Defined in - -[proposals.ts:435](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L435) - -___ - -### fromWeb3tx - -▸ **fromWeb3tx**(`tx`, `params`): `ProposalTransaction` - -Converts a Web3 transaction into a proposal transaction object. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tx` | `CeloTxObject`\<`any`\> | A Web3 transaction object to convert. | -| `params` | `ProposalTxParams` | Parameters for how the transaction should be executed. | - -#### Returns - -`ProposalTransaction` - -#### Defined in - -[proposals.ts:264](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L264) - -___ - -### getRegistryAddition - -▸ **getRegistryAddition**(`contract`): `undefined` \| `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contract` | `CeloContract` | - -#### Returns - -`undefined` \| `string` - -#### Defined in - -[proposals.ts:314](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L314) - -___ - -### isRegistryContract - -▸ **isRegistryContract**(`contract`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contract` | `CeloContract` | - -#### Returns - -`boolean` - -#### Defined in - -[proposals.ts:317](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L317) - -___ - -### lookupExternalMethodABI - -▸ **lookupExternalMethodABI**(`address`, `tx`): `Promise`\<``null`` \| `AbiItem`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | -| `tx` | [`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md) | - -#### Returns - -`Promise`\<``null`` \| `AbiItem`\> - -#### Defined in - -[proposals.ts:326](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L326) - -___ - -### setRegistryAddition - -▸ **setRegistryAddition**(`contract`, `address`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contract` | `CeloContract` | -| `address` | `string` | - -#### Returns - -`string` - -#### Defined in - -[proposals.ts:311](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L311) - -___ - -### transformArgs - -▸ **transformArgs**(`abi`, `args`): `any`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `abi` | `AbiItem` | -| `args` | `any`[] | - -#### Returns - -`any`[] - -#### Defined in - -[proposals.ts:386](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L386) diff --git a/docs/sdk/governance/interfaces/proposals.ProposalTransactionJSON.md b/docs/sdk/governance/interfaces/proposals.ProposalTransactionJSON.md index 9233d2915..d334a431a 100644 --- a/docs/sdk/governance/interfaces/proposals.ProposalTransactionJSON.md +++ b/docs/sdk/governance/interfaces/proposals.ProposalTransactionJSON.md @@ -35,7 +35,7 @@ Example: #### Defined in -[proposals.ts:75](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L75) +[packages/sdk/governance/src/proposals.ts:55](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L55) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[proposals.ts:77](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L77) +[packages/sdk/governance/src/proposals.ts:57](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L57) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[proposals.ts:74](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L74) +[packages/sdk/governance/src/proposals.ts:54](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L54) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[proposals.ts:76](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L76) +[packages/sdk/governance/src/proposals.ts:56](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L56) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[proposals.ts:78](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L78) +[packages/sdk/governance/src/proposals.ts:58](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L58) ___ @@ -85,4 +85,4 @@ ___ #### Defined in -[proposals.ts:79](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L79) +[packages/sdk/governance/src/proposals.ts:59](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L59) diff --git a/docs/sdk/governance/interfaces/proposals.RegistryAdditions.md b/docs/sdk/governance/interfaces/proposals.RegistryAdditions.md new file mode 100644 index 000000000..39e273bfc --- /dev/null +++ b/docs/sdk/governance/interfaces/proposals.RegistryAdditions.md @@ -0,0 +1,9 @@ +[@celo/governance](../README.md) / [proposals](../modules/proposals.md) / RegistryAdditions + +# Interface: RegistryAdditions + +[proposals](../modules/proposals.md).RegistryAdditions + +## Indexable + +▪ [contractName: `string`]: `Address` diff --git a/docs/sdk/governance/modules/index.md b/docs/sdk/governance/modules/index.md index 2febc3f60..c011a1753 100644 --- a/docs/sdk/governance/modules/index.md +++ b/docs/sdk/governance/modules/index.md @@ -6,25 +6,39 @@ ### References +- [ExternalProposalTransactionJSON](index.md#externalproposaltransactionjson) - [InteractiveProposalBuilder](index.md#interactiveproposalbuilder) - [ProposalBuilder](index.md#proposalbuilder) - [ProposalTransactionJSON](index.md#proposaltransactionjson) +- [ProposalTxParams](index.md#proposaltxparams) +- [RegistryAdditions](index.md#registryadditions) +- [debug](index.md#debug) - [hotfixExecuteAbi](index.md#hotfixexecuteabi) - [hotfixToEncodedParams](index.md#hotfixtoencodedparams) - [hotfixToHash](index.md#hotfixtohash) +- [isProxySetAndInitFunction](index.md#isproxysetandinitfunction) +- [isProxySetFunction](index.md#isproxysetfunction) +- [isRegistryRepoint](index.md#isregistryrepoint) - [proposalToJSON](index.md#proposaltojson) +- [registryRepointArgs](index.md#registryrepointargs) ## References +### ExternalProposalTransactionJSON + +Re-exports [ExternalProposalTransactionJSON](proposals.md#externalproposaltransactionjson) + +___ + ### InteractiveProposalBuilder -Re-exports [InteractiveProposalBuilder](../classes/proposals.InteractiveProposalBuilder.md) +Re-exports [InteractiveProposalBuilder](../classes/interactive_proposal_builder.InteractiveProposalBuilder.md) ___ ### ProposalBuilder -Re-exports [ProposalBuilder](../classes/proposals.ProposalBuilder.md) +Re-exports [ProposalBuilder](../classes/proposal_builder.ProposalBuilder.md) ___ @@ -34,6 +48,24 @@ Re-exports [ProposalTransactionJSON](../interfaces/proposals.ProposalTransaction ___ +### ProposalTxParams + +Re-exports [ProposalTxParams](proposals.md#proposaltxparams) + +___ + +### RegistryAdditions + +Re-exports [RegistryAdditions](../interfaces/proposals.RegistryAdditions.md) + +___ + +### debug + +Re-exports [debug](proposals.md#debug) + +___ + ### hotfixExecuteAbi Re-exports [hotfixExecuteAbi](proposals.md#hotfixexecuteabi) @@ -52,6 +84,30 @@ Re-exports [hotfixToHash](proposals.md#hotfixtohash) ___ +### isProxySetAndInitFunction + +Re-exports [isProxySetAndInitFunction](proposals.md#isproxysetandinitfunction) + +___ + +### isProxySetFunction + +Re-exports [isProxySetFunction](proposals.md#isproxysetfunction) + +___ + +### isRegistryRepoint + +Re-exports [isRegistryRepoint](proposals.md#isregistryrepoint) + +___ + ### proposalToJSON Re-exports [proposalToJSON](proposals.md#proposaltojson) + +___ + +### registryRepointArgs + +Re-exports [registryRepointArgs](proposals.md#registryrepointargs) diff --git a/docs/sdk/governance/modules/interactive_proposal_builder.md b/docs/sdk/governance/modules/interactive_proposal_builder.md new file mode 100644 index 000000000..7f70f22a3 --- /dev/null +++ b/docs/sdk/governance/modules/interactive_proposal_builder.md @@ -0,0 +1,33 @@ +[@celo/governance](../README.md) / interactive-proposal-builder + +# Module: interactive-proposal-builder + +## Table of contents + +### Classes + +- [InteractiveProposalBuilder](../classes/interactive_proposal_builder.InteractiveProposalBuilder.md) + +### Functions + +- [requireABI](interactive_proposal_builder.md#requireabi) + +## Functions + +### requireABI + +▸ **requireABI**(`contractName`): `ABIDefinition`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `contractName` | `CeloContract` | + +#### Returns + +`ABIDefinition`[] + +#### Defined in + +[packages/sdk/governance/src/interactive-proposal-builder.ts:122](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/interactive-proposal-builder.ts#L122) diff --git a/docs/sdk/governance/modules/proposal_builder.md b/docs/sdk/governance/modules/proposal_builder.md new file mode 100644 index 000000000..dcc760823 --- /dev/null +++ b/docs/sdk/governance/modules/proposal_builder.md @@ -0,0 +1,9 @@ +[@celo/governance](../README.md) / proposal-builder + +# Module: proposal-builder + +## Table of contents + +### Classes + +- [ProposalBuilder](../classes/proposal_builder.ProposalBuilder.md) diff --git a/docs/sdk/governance/modules/proposals.md b/docs/sdk/governance/modules/proposals.md index a52a9de4f..72e417ef7 100644 --- a/docs/sdk/governance/modules/proposals.md +++ b/docs/sdk/governance/modules/proposals.md @@ -4,14 +4,20 @@ ## Table of contents -### Classes +### References -- [InteractiveProposalBuilder](../classes/proposals.InteractiveProposalBuilder.md) -- [ProposalBuilder](../classes/proposals.ProposalBuilder.md) +- [InteractiveProposalBuilder](proposals.md#interactiveproposalbuilder) +- [ProposalBuilder](proposals.md#proposalbuilder) ### Interfaces - [ProposalTransactionJSON](../interfaces/proposals.ProposalTransactionJSON.md) +- [RegistryAdditions](../interfaces/proposals.RegistryAdditions.md) + +### Type Aliases + +- [ExternalProposalTransactionJSON](proposals.md#externalproposaltransactionjson) +- [ProposalTxParams](proposals.md#proposaltxparams) ### Variables @@ -19,9 +25,46 @@ ### Functions +- [debug](proposals.md#debug) - [hotfixToEncodedParams](proposals.md#hotfixtoencodedparams) - [hotfixToHash](proposals.md#hotfixtohash) +- [isProxySetAndInitFunction](proposals.md#isproxysetandinitfunction) +- [isProxySetFunction](proposals.md#isproxysetfunction) +- [isRegistryRepoint](proposals.md#isregistryrepoint) - [proposalToJSON](proposals.md#proposaltojson) +- [registryRepointArgs](proposals.md#registryrepointargs) + +## References + +### InteractiveProposalBuilder + +Re-exports [InteractiveProposalBuilder](../classes/interactive_proposal_builder.InteractiveProposalBuilder.md) + +___ + +### ProposalBuilder + +Re-exports [ProposalBuilder](../classes/proposal_builder.ProposalBuilder.md) + +## Type Aliases + +### ExternalProposalTransactionJSON + +Ƭ **ExternalProposalTransactionJSON**: `Omit`\<[`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md), ``"contract"``\> & \{ `contract?`: `string` } + +#### Defined in + +[packages/sdk/governance/src/proposals.ts:62](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L62) + +___ + +### ProposalTxParams + +Ƭ **ProposalTxParams**: `Pick`\<`ProposalTransaction`, ``"to"`` \| ``"value"``\> + +#### Defined in + +[packages/sdk/governance/src/proposals.ts:218](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L218) ## Variables @@ -31,10 +74,31 @@ #### Defined in -[proposals.ts:49](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L49) +[packages/sdk/governance/src/proposals.ts:29](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L29) ## Functions +### debug + +▸ **debug**(`formatter`, `...args`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `formatter` | `any` | +| `...args` | `any`[] | + +#### Returns + +`void` + +#### Defined in + +[packages/sdk/governance/src/proposals.ts:27](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L27) + +___ + ### hotfixToEncodedParams ▸ **hotfixToEncodedParams**(`kit`, `proposal`, `salt`): `string` @@ -53,7 +117,7 @@ #### Defined in -[proposals.ts:51](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L51) +[packages/sdk/governance/src/proposals.ts:31](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L31) ___ @@ -75,7 +139,67 @@ ___ #### Defined in -[proposals.ts:57](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L57) +[packages/sdk/governance/src/proposals.ts:37](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L37) + +___ + +### isProxySetAndInitFunction + +▸ **isProxySetAndInitFunction**(`tx`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `tx` | `Pick`\<[`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md), ``"function"``\> | + +#### Returns + +`boolean` + +#### Defined in + +[packages/sdk/governance/src/proposals.ts:103](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L103) + +___ + +### isProxySetFunction + +▸ **isProxySetFunction**(`tx`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `tx` | `Pick`\<[`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md), ``"function"``\> | + +#### Returns + +`boolean` + +#### Defined in + +[packages/sdk/governance/src/proposals.ts:106](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L106) + +___ + +### isRegistryRepoint + +▸ **isRegistryRepoint**(`tx`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `tx` | `Pick`\<[`ExternalProposalTransactionJSON`](proposals.md#externalproposaltransactionjson), ``"function"`` \| ``"contract"``\> | + +#### Returns + +`boolean` + +#### Defined in + +[packages/sdk/governance/src/proposals.ts:66](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L66) ___ @@ -91,7 +215,7 @@ Convert a compiled proposal to a human-readable JSON form using network informat | :------ | :------ | :------ | | `kit` | `ContractKit` | Contract kit instance used to resolve addresses to contract names. | | `proposal` | `Proposal` | A constructed proposal object. | -| `registryAdditions?` | `RegistryAdditions` | Registry remappings prior to parsing the proposal as a map of name to corresponding contract address. | +| `registryAdditions?` | [`RegistryAdditions`](../interfaces/proposals.RegistryAdditions.md) | Registry remappings prior to parsing the proposal as a map of name to corresponding contract address. | #### Returns @@ -101,4 +225,29 @@ The JSON encoding of the proposal. #### Defined in -[proposals.ts:128](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L128) +[packages/sdk/governance/src/proposals.ts:116](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L116) + +___ + +### registryRepointArgs + +▸ **registryRepointArgs**(`tx`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `tx` | `Pick`\<[`ExternalProposalTransactionJSON`](proposals.md#externalproposaltransactionjson), ``"function"`` \| ``"contract"`` \| ``"args"``\> | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `address` | `string` | +| `name` | `CeloContract` | + +#### Defined in + +[packages/sdk/governance/src/proposals.ts:74](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L74) diff --git a/docs/sdk/governance/modules/test_utils_globals.md b/docs/sdk/governance/modules/test_utils_globals.md new file mode 100644 index 000000000..03db95b85 --- /dev/null +++ b/docs/sdk/governance/modules/test_utils_globals.md @@ -0,0 +1,19 @@ +[@celo/governance](../README.md) / test-utils/globals + +# Module: test-utils/globals + +## Table of contents + +### Variables + +- [fetchMock](test_utils_globals.md#fetchmock) + +## Variables + +### fetchMock + +• `Const` **fetchMock**: `FetchMockSandbox` + +#### Defined in + +[packages/sdk/governance/src/test-utils/globals.d.ts:5](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/test-utils/globals.d.ts#L5) diff --git a/docs/sdk/governance/modules/test_utils_setup_global.md b/docs/sdk/governance/modules/test_utils_setup_global.md new file mode 100644 index 000000000..4c05fa4f0 --- /dev/null +++ b/docs/sdk/governance/modules/test_utils_setup_global.md @@ -0,0 +1,23 @@ +[@celo/governance](../README.md) / test-utils/setup.global + +# Module: test-utils/setup.global + +## Table of contents + +### Functions + +- [default](test_utils_setup_global.md#default) + +## Functions + +### default + +▸ **default**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/sdk/governance/src/test-utils/setup.global.ts:4](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/test-utils/setup.global.ts#L4)