From 8dc5b19ffc973e9b90070226258cc552c9c2dc77 Mon Sep 17 00:00:00 2001 From: chmanie Date: Mon, 19 Dec 2022 18:35:07 +0900 Subject: [PATCH] Add anchors for event- and metadata --- docs/api/README.md | 1 + docs/api/classes/Colony.md | 54 +++++++++++++++---------- docs/api/classes/ColonyNetwork.md | 8 ++-- docs/api/classes/ColonyToken.md | 6 +-- docs/api/classes/ColonyTxCreator.md | 8 ++-- docs/api/classes/MetaTxCreator.md | 8 ++-- docs/api/classes/OneTxPayment.md | 4 +- docs/api/classes/TxCreator.md | 4 +- docs/api/classes/VotingReputation.md | 26 ++++++------ docs/api/interfaces/ColonyEvent.md | 6 +-- docs/api/interfaces/DecisionMetadata.md | 19 +++++++++ src/ColonyNetwork/Colony.ts | 54 +++++++++++++++---------- src/ColonyNetwork/ColonyNetwork.ts | 8 ++-- src/ColonyNetwork/ColonyToken.ts | 4 +- src/ColonyNetwork/ERC20Token.ts | 2 +- src/ColonyNetwork/ERC2612Token.ts | 2 +- src/ColonyNetwork/OneTxPayment.ts | 4 +- src/ColonyNetwork/TokenLocking.ts | 4 +- src/ColonyNetwork/VotingReputation.ts | 20 ++++----- 19 files changed, 145 insertions(+), 97 deletions(-) create mode 100644 docs/api/interfaces/DecisionMetadata.md diff --git a/docs/api/README.md b/docs/api/README.md index a4fd6ae4..5d5635bb 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -43,6 +43,7 @@ - [ColonyMultiFilter](interfaces/ColonyMultiFilter.md) - [ColonyNetworkOptions](interfaces/ColonyNetworkOptions.md) - [ColonyTopic](interfaces/ColonyTopic.md) +- [DecisionMetadata](interfaces/DecisionMetadata.md) - [DomainMetadata](interfaces/DomainMetadata.md) - [Ethers6Filter](interfaces/Ethers6Filter.md) - [Ethers6FilterByBlockHash](interfaces/Ethers6FilterByBlockHash.md) diff --git a/docs/api/classes/Colony.md b/docs/api/classes/Colony.md index 7242812c..d3090408 100644 --- a/docs/api/classes/Colony.md +++ b/docs/api/classes/Colony.md @@ -94,7 +94,7 @@ If [AnnotationMetadata](../interfaces/AnnotationMetadata.md) is provided directl A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -102,7 +102,9 @@ A transaction creator | `txHash` | BigNumber | The hash of the annotated transaction | | `metadata` | BigNumber | The IPFS hash (CID) of the metadata object | -**Metadata** (can be obtained by calling and awaiting the `getMetadata` function) +#### Metadata + +(can be obtained by calling and awaiting the `getMetadata` function) | Property | Type | Description | | :------ | :------ | :------ | @@ -136,7 +138,7 @@ Only users with *Root* role are allowed to award reputation A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -171,7 +173,7 @@ use `ethers.constants.AddressZero` to claim ETH. A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -222,7 +224,7 @@ import { TeamColor } from '@colony/sdk'; A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -231,7 +233,9 @@ A transaction creator | `fundingPotId` | BigNumber | Integer id of the corresponding funding pot | | `metadata` | string | IPFS CID of metadata attached to this transaction | -**Metadata** (can be obtained by calling and awaiting the `getMetadata` function) +#### Metadata + +(can be obtained by calling and awaiting the `getMetadata` function) | Property | Type | Description | | :------ | :------ | :------ | @@ -253,7 +257,7 @@ Currently you can only add domains within the `Root` domain. This restriction wi A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -288,7 +292,7 @@ Only works for native tokens deployed with Colony (not imported tokens). A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -317,7 +321,7 @@ Teams can be deprecated which will remove them from the UI. As they can't be del A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -363,7 +367,7 @@ This will overwrite all exisiting metadata! A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -372,7 +376,9 @@ A transaction creator | `token` | string | Address of the token that is used as the colony's native token | | `metadata` | string | IPFS CID of metadata attached to this transaction | -**Metadata** (can be obtained by calling and awaiting the `getMetadata` function) +#### Metadata + +(can be obtained by calling and awaiting the `getMetadata` function) | Property | Type | Description | | :------ | :------ | :------ | @@ -422,7 +428,7 @@ import { TeamColor } from '@colony/sdk'; A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -430,7 +436,9 @@ A transaction creator | `domainId` | BigNumber | Integer domain id of the created team | | `metadata` | string | IPFS CID of metadata attached to this transaction | -**Metadata** (can be obtained by calling and awaiting the `getMetadata` function) +#### Metadata + +(can be obtained by calling and awaiting the `getMetadata` function) | Property | Type | Description | | :------ | :------ | :------ | @@ -458,7 +466,7 @@ Be aware that to exit Recovery Mode a quorum of 50% is needed of all users who h A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -480,7 +488,7 @@ In Recovery Mode, no actions are possible on the colony. Only users who have the A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -637,7 +645,7 @@ After an extension was installed, `colony.updateExtensions()` needs to be called A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -738,7 +746,7 @@ import { w } from '@colony/sdk'; A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -792,7 +800,7 @@ import { Tokens, w } from '@colony/sdk'; A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -844,7 +852,8 @@ import { ColonyRole } from '@colony/sdk'; A transaction creator -**Event data** +#### Event data + Heads up!* This event is emitted for every role that was set | Property | Type | Description | @@ -883,7 +892,7 @@ Only users with *Arbitration* role are allowed to award reputation A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -914,7 +923,8 @@ Unset (remove) roles from a user/contract A transaction creator -**Event data** +#### Event data + Heads up!* This event is emitted for every role that was unset | Property | Type | Description | @@ -967,7 +977,7 @@ This method upgrades the colony to a specified version or, if no version is prov A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | diff --git a/docs/api/classes/ColonyNetwork.md b/docs/api/classes/ColonyNetwork.md index c6751371..3b4e45ee 100644 --- a/docs/api/classes/ColonyNetwork.md +++ b/docs/api/classes/ColonyNetwork.md @@ -86,7 +86,7 @@ import { Tokens } from '@colony/sdk'; A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -95,7 +95,9 @@ A transaction creator | `token` | string | Address of the token that is used as the colony's native token | | `metadata` | string | IPFS CID of metadata attached to this transaction | -**Metadata** (can be obtained by calling and awaiting the `getMetadata` function) +#### Metadata + +(can be obtained by calling and awaiting the `getMetadata` function) | Property | Type | Description | | :------ | :------ | :------ | @@ -140,7 +142,7 @@ There is more to creating a fully functional colony that can be used within the A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | diff --git a/docs/api/classes/ColonyToken.md b/docs/api/classes/ColonyToken.md index 35e7cb76..8de62725 100644 --- a/docs/api/classes/ColonyToken.md +++ b/docs/api/classes/ColonyToken.md @@ -76,7 +76,7 @@ import { w } from '@colony/sdk'; A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -166,7 +166,7 @@ import { w } from '@colony/sdk'; A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -198,7 +198,7 @@ Only works for native tokens deployed with Colony (not imported tokens). A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | diff --git a/docs/api/classes/ColonyTxCreator.md b/docs/api/classes/ColonyTxCreator.md index a64a8dce..78b5a615 100644 --- a/docs/api/classes/ColonyTxCreator.md +++ b/docs/api/classes/ColonyTxCreator.md @@ -86,7 +86,7 @@ ___ ### metaTx -▸ **metaTx**(): `Promise`<[`E`, [`ParsedLogTransactionReceipt`](../interfaces/ParsedLogTransactionReceipt.md), () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => `DecisionMetadata` = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, [`ParsedLogTransactionReceipt`](../interfaces/ParsedLogTransactionReceipt.md)]\> +▸ **metaTx**(): `Promise`<[`E`, [`ParsedLogTransactionReceipt`](../interfaces/ParsedLogTransactionReceipt.md), () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => [`DecisionMetadata`](../interfaces/DecisionMetadata.md) = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, [`ParsedLogTransactionReceipt`](../interfaces/ParsedLogTransactionReceipt.md)]\> Forces an action using a gasless metatransaction @@ -96,7 +96,7 @@ The user sending this transaction has to have the appropriate permissions to do #### Returns -`Promise`<[`E`, [`ParsedLogTransactionReceipt`](../interfaces/ParsedLogTransactionReceipt.md), () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => `DecisionMetadata` = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, [`ParsedLogTransactionReceipt`](../interfaces/ParsedLogTransactionReceipt.md)]\> +`Promise`<[`E`, [`ParsedLogTransactionReceipt`](../interfaces/ParsedLogTransactionReceipt.md), () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => [`DecisionMetadata`](../interfaces/DecisionMetadata.md) = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, [`ParsedLogTransactionReceipt`](../interfaces/ParsedLogTransactionReceipt.md)]\> A tupel of event data and contract receipt (and a function to retrieve metadata if applicable) @@ -134,7 +134,7 @@ ___ ### tx -▸ **tx**(): `Promise`<[`E`, `ContractReceipt`, () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => `DecisionMetadata` = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, `ContractReceipt`]\> +▸ **tx**(): `Promise`<[`E`, `ContractReceipt`, () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => [`DecisionMetadata`](../interfaces/DecisionMetadata.md) = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, `ContractReceipt`]\> Create a standard transaction ("force" in dApp) @@ -144,7 +144,7 @@ The user sending this transaction has to have the appropriate permissions to do #### Returns -`Promise`<[`E`, `ContractReceipt`, () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => `DecisionMetadata` = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, `ContractReceipt`]\> +`Promise`<[`E`, `ContractReceipt`, () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => [`DecisionMetadata`](../interfaces/DecisionMetadata.md) = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, `ContractReceipt`]\> A tupel of event data and contract receipt (and a function to retrieve metadata if applicable) diff --git a/docs/api/classes/MetaTxCreator.md b/docs/api/classes/MetaTxCreator.md index 8469ba05..2ba2c865 100644 --- a/docs/api/classes/MetaTxCreator.md +++ b/docs/api/classes/MetaTxCreator.md @@ -64,7 +64,7 @@ Learn more about these functions in their individual documentation ### metaTx -▸ **metaTx**(): `Promise`<[`E`, [`ParsedLogTransactionReceipt`](../interfaces/ParsedLogTransactionReceipt.md), () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => `DecisionMetadata` = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, [`ParsedLogTransactionReceipt`](../interfaces/ParsedLogTransactionReceipt.md)]\> +▸ **metaTx**(): `Promise`<[`E`, [`ParsedLogTransactionReceipt`](../interfaces/ParsedLogTransactionReceipt.md), () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => [`DecisionMetadata`](../interfaces/DecisionMetadata.md) = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, [`ParsedLogTransactionReceipt`](../interfaces/ParsedLogTransactionReceipt.md)]\> Forces an action using a gasless metatransaction @@ -74,7 +74,7 @@ The user sending this transaction has to have the appropriate permissions to do #### Returns -`Promise`<[`E`, [`ParsedLogTransactionReceipt`](../interfaces/ParsedLogTransactionReceipt.md), () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => `DecisionMetadata` = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, [`ParsedLogTransactionReceipt`](../interfaces/ParsedLogTransactionReceipt.md)]\> +`Promise`<[`E`, [`ParsedLogTransactionReceipt`](../interfaces/ParsedLogTransactionReceipt.md), () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => [`DecisionMetadata`](../interfaces/DecisionMetadata.md) = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, [`ParsedLogTransactionReceipt`](../interfaces/ParsedLogTransactionReceipt.md)]\> A tupel of event data and contract receipt (and a function to retrieve metadata if applicable) @@ -82,7 +82,7 @@ ___ ### tx -▸ **tx**(): `Promise`<[`E`, `ContractReceipt`, () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => `DecisionMetadata` = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, `ContractReceipt`]\> +▸ **tx**(): `Promise`<[`E`, `ContractReceipt`, () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => [`DecisionMetadata`](../interfaces/DecisionMetadata.md) = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, `ContractReceipt`]\> Create a standard transaction ("force" in dApp) @@ -92,7 +92,7 @@ The user sending this transaction has to have the appropriate permissions to do #### Returns -`Promise`<[`E`, `ContractReceipt`, () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => `DecisionMetadata` = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, `ContractReceipt`]\> +`Promise`<[`E`, `ContractReceipt`, () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => [`DecisionMetadata`](../interfaces/DecisionMetadata.md) = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, `ContractReceipt`]\> A tupel of event data and contract receipt (and a function to retrieve metadata if applicable) diff --git a/docs/api/classes/OneTxPayment.md b/docs/api/classes/OneTxPayment.md index c41749fc..08a2b200 100644 --- a/docs/api/classes/OneTxPayment.md +++ b/docs/api/classes/OneTxPayment.md @@ -94,7 +94,7 @@ import { Id, Tokens, w } from '@colony/sdk'; A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -129,7 +129,7 @@ This method upgrades this extension to a specified version or, if no version is A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | diff --git a/docs/api/classes/TxCreator.md b/docs/api/classes/TxCreator.md index 3baafd9b..517f2b1a 100644 --- a/docs/api/classes/TxCreator.md +++ b/docs/api/classes/TxCreator.md @@ -57,7 +57,7 @@ Learn more about these functions in their individual documentation ### tx -▸ **tx**(): `Promise`<[`E`, `ContractReceipt`, () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => `DecisionMetadata` = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, `ContractReceipt`]\> +▸ **tx**(): `Promise`<[`E`, `ContractReceipt`, () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => [`DecisionMetadata`](../interfaces/DecisionMetadata.md) = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, `ContractReceipt`]\> Create a standard transaction ("force" in dApp) @@ -67,6 +67,6 @@ The user sending this transaction has to have the appropriate permissions to do #### Returns -`Promise`<[`E`, `ContractReceipt`, () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => `DecisionMetadata` = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, `ContractReceipt`]\> +`Promise`<[`E`, `ContractReceipt`, () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](../interfaces/ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => [`DecisionMetadata`](../interfaces/DecisionMetadata.md) = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](../interfaces/DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`MD`]\>\>] \| [`E`, `ContractReceipt`]\> A tupel of event data and contract receipt (and a function to retrieve metadata if applicable) diff --git a/docs/api/classes/VotingReputation.md b/docs/api/classes/VotingReputation.md index bb433ade..0332bf84 100644 --- a/docs/api/classes/VotingReputation.md +++ b/docs/api/classes/VotingReputation.md @@ -132,7 +132,7 @@ This will annotate a decision with certain metadata (see below). This only reall **`Remarks`** -If DecisionMetadata is provided directly (as opposed to a [CID](https://docs.ipfs.io/concepts/content-addressing/#identifier-formats) for a JSON file) this requires an [IpfsAdapter](../interfaces/IpfsAdapter.md) that can upload and pin to IPFS. See its documentation for more information. Keep in mind that **the annotation itself is a transaction**. +If [DecisionMetadata](../interfaces/DecisionMetadata.md) is provided directly (as opposed to a [CID](https://docs.ipfs.io/concepts/content-addressing/#identifier-formats) for a JSON file) this requires an [IpfsAdapter](../interfaces/IpfsAdapter.md) that can upload and pin to IPFS. See its documentation for more information. Keep in mind that **the annotation itself is a transaction**. **`Example`** @@ -159,7 +159,7 @@ If DecisionMetadata is provided directly (as opposed to a [CID](https://docs.ipf | Name | Type | Description | | :------ | :------ | :------ | | `txHash` | `string` | Transaction hash of the transaction to annotate (within the Colony) | -| `metadata` | `string` \| `DecisionMetadata` | The annotation metadata you would like to annotate the transaction with (or an IPFS CID pointing to valid metadata) | +| `metadata` | `string` \| [`DecisionMetadata`](../interfaces/DecisionMetadata.md) | The annotation metadata you would like to annotate the transaction with (or an IPFS CID pointing to valid metadata) | #### Returns @@ -167,7 +167,7 @@ If DecisionMetadata is provided directly (as opposed to a [CID](https://docs.ipf A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -175,7 +175,9 @@ A transaction creator | `txHash` | string | The hash of the annotated transaction | | `metadata` | string | The IPFS hash (CID) of the metadata object | -**Metadata** (can be obtained by calling and awaiting the `getMetadata` function) +#### Metadata + +(can be obtained by calling and awaiting the `getMetadata` function) | Property | Type | Description | | :------ | :------ | :------ | @@ -209,7 +211,7 @@ This method can't be executed as a motion A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -230,7 +232,7 @@ Keep in mind that a decision is just a motion without an on-chain action that is **`Remarks`** -If DecisionMetadata is provided directly (as opposed to a [CID](https://docs.ipfs.io/concepts/content-addressing/#identifier-formats) for a JSON file) this requires an [IpfsAdapter](../interfaces/IpfsAdapter.md) that can upload and pin to IPFS. See its documentation for more information. Keep in mind that **the annotation itself is a transaction**. +If [DecisionMetadata](../interfaces/DecisionMetadata.md) is provided directly (as opposed to a [CID](https://docs.ipfs.io/concepts/content-addressing/#identifier-formats) for a JSON file) this requires an [IpfsAdapter](../interfaces/IpfsAdapter.md) that can upload and pin to IPFS. See its documentation for more information. Keep in mind that **the annotation itself is a transaction**. **`Example`** @@ -264,7 +266,7 @@ If DecisionMetadata is provided directly (as opposed to a [CID](https://docs.ipf A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -301,7 +303,7 @@ Finalize a motion, executing its action A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -452,7 +454,7 @@ Reveal a vote for a motion A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -506,7 +508,7 @@ import { Vote, w } from '@colony/sdk'; A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -541,7 +543,7 @@ This method can't be executed as a motion A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | @@ -575,7 +577,7 @@ This method upgrades this extension to a specified version or, if no version is A transaction creator -**Event data** +#### Event data | Property | Type | Description | | :------ | :------ | :------ | diff --git a/docs/api/interfaces/ColonyEvent.md b/docs/api/interfaces/ColonyEvent.md index 106f468d..1c86057f 100644 --- a/docs/api/interfaces/ColonyEvent.md +++ b/docs/api/interfaces/ColonyEvent.md @@ -68,15 +68,15 @@ ___ ### getMetadata -• `Optional` **getMetadata**: () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => `DecisionMetadata` = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`T`]\>\> +• `Optional` **getMetadata**: () => `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => [`DecisionMetadata`](DecisionMetadata.md) = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`T`]\>\> #### Type declaration -▸ (): `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => `DecisionMetadata` = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`T`]\>\> +▸ (): `Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => [`DecisionMetadata`](DecisionMetadata.md) = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`T`]\>\> ##### Returns -`Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => `DecisionMetadata` = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`T`]\>\> +`Promise`<`ReturnType`<{ `None`: () => `void` ; `annotation`: (`res`: `string`) => `string` = getAnnotationMsgFromResponse; `colony`: (`res`: `string`) => [`ColonyMetadata`](ColonyMetadata.md) = getColonyMetadataFromResponse; `decision`: (`res`: `string`) => [`DecisionMetadata`](DecisionMetadata.md) = getDecisionDetailsFromResponse; `domain`: (`res`: `string`) => [`DomainMetadata`](DomainMetadata.md) = getDomainMetadataFromResponse; `misc`: (`res`: `string`) => `MiscMetadata` = getMiscDataFromResponse }[`T`]\>\> ___ diff --git a/docs/api/interfaces/DecisionMetadata.md b/docs/api/interfaces/DecisionMetadata.md new file mode 100644 index 00000000..61ca3fcd --- /dev/null +++ b/docs/api/interfaces/DecisionMetadata.md @@ -0,0 +1,19 @@ +# Interface: DecisionMetadata + +## Properties + +### description + +• **description**: `string` + +___ + +### motionDomainId + +• **motionDomainId**: `number` + +___ + +### title + +• **title**: `string` diff --git a/src/ColonyNetwork/Colony.ts b/src/ColonyNetwork/Colony.ts index 9857fbc8..083fde2b 100644 --- a/src/ColonyNetwork/Colony.ts +++ b/src/ColonyNetwork/Colony.ts @@ -338,7 +338,7 @@ export class Colony { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -347,7 +347,9 @@ export class Colony { * | `token` | string | Address of the token that is used as the colony's native token | * | `metadata` | string | IPFS CID of metadata attached to this transaction | * - * **Metadata** (can be obtained by calling and awaiting the `getMetadata` function) + * #### Metadata + * + * (can be obtained by calling and awaiting the `getMetadata` function) * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -406,7 +408,7 @@ export class Colony { * @param metadata - The team metadata you would like to add (or an IPFS CID pointing to valid metadata). If [[DomainMetadata]] is provided directly (as opposed to a [CID](https://docs.ipfs.io/concepts/content-addressing/#identifier-formats) for a JSON file) this requires an [[IpfsAdapter]] that can upload and pin to IPFS (like the [[PinataAdapter]]). See its documentation for more information. * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -415,7 +417,9 @@ export class Colony { * | `fundingPotId` | BigNumber | Integer id of the corresponding funding pot | * | `metadata` | string | IPFS CID of metadata attached to this transaction | * - * **Metadata** (can be obtained by calling and awaiting the `getMetadata` function) + * #### Metadata + * + * (can be obtained by calling and awaiting the `getMetadata` function) * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -443,7 +447,7 @@ export class Colony { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -540,7 +544,7 @@ export class Colony { * @param metadata - The team metadata you would like to add (or an IPFS CID pointing to valid metadata). If [[DomainMetadata]] is provided directly (as opposed to a [CID](https://docs.ipfs.io/concepts/content-addressing/#identifier-formats) for a JSON file) this requires an [[IpfsAdapter]] that can upload and pin to IPFS (like the [[PinataAdapter]]). See its documentation for more information. * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -548,7 +552,9 @@ export class Colony { * | `domainId` | BigNumber | Integer domain id of the created team | * | `metadata` | string | IPFS CID of metadata attached to this transaction | * - * **Metadata** (can be obtained by calling and awaiting the `getMetadata` function) + * #### Metadata + * + * (can be obtained by calling and awaiting the `getMetadata` function) * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -592,7 +598,7 @@ export class Colony { * @param deprecated - `true`: Deprecate team; `false`: Undeprecate team * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -644,7 +650,7 @@ export class Colony { * @param tokenAddress - The address of the token to claim the funds for. Default is the Colony's native token * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -696,7 +702,7 @@ export class Colony { * @param tokenAddress - The address of the token to be transferred. Default is the Colony's native token * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -885,7 +891,7 @@ export class Colony { * @param metadata - The annotation metadata you would like to annotate the transaction with (or an IPFS CID pointing to valid metadata) * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -893,7 +899,9 @@ export class Colony { * | `txHash` | BigNumber | The hash of the annotated transaction | * | `metadata` | BigNumber | The IPFS hash (CID) of the metadata object | * - * **Metadata** (can be obtained by calling and awaiting the `getMetadata` function) + * #### Metadata + * + * (can be obtained by calling and awaiting the `getMetadata` function) * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -947,7 +955,7 @@ export class Colony { * @param extension - Name of the extension you'd like to install * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -1003,7 +1011,8 @@ export class Colony { * @param teamId - Team to apply the role(s) in * @returns A transaction creator * - * **Event data** + * #### Event data + * * Heads up!* This event is emitted for every role that was set * * | Property | Type | Description | @@ -1062,7 +1071,8 @@ export class Colony { * * @returns A transaction creator * - * **Event data** + * #### Event data + * * Heads up!* This event is emitted for every role that was unset * * | Property | Type | Description | @@ -1138,7 +1148,7 @@ export class Colony { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -1170,7 +1180,7 @@ export class Colony { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -1214,7 +1224,7 @@ export class Colony { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -1241,7 +1251,7 @@ export class Colony { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -1274,7 +1284,7 @@ export class Colony { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -1310,7 +1320,7 @@ export class Colony { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -1354,7 +1364,7 @@ export class Colony { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | diff --git a/src/ColonyNetwork/ColonyNetwork.ts b/src/ColonyNetwork/ColonyNetwork.ts index 1ab0de15..92233a42 100644 --- a/src/ColonyNetwork/ColonyNetwork.ts +++ b/src/ColonyNetwork/ColonyNetwork.ts @@ -286,7 +286,7 @@ export class ColonyNetwork { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -295,7 +295,9 @@ export class ColonyNetwork { * | `token` | string | Address of the token that is used as the colony's native token | * | `metadata` | string | IPFS CID of metadata attached to this transaction | * - * **Metadata** (can be obtained by calling and awaiting the `getMetadata` function) + * #### Metadata + * + * (can be obtained by calling and awaiting the `getMetadata` function) * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -337,7 +339,7 @@ export class ColonyNetwork { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | diff --git a/src/ColonyNetwork/ColonyToken.ts b/src/ColonyNetwork/ColonyToken.ts index 6a14a174..25798044 100644 --- a/src/ColonyNetwork/ColonyToken.ts +++ b/src/ColonyNetwork/ColonyToken.ts @@ -75,7 +75,7 @@ export class ColonyToken extends ERC20Token { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -104,7 +104,7 @@ export class ColonyToken extends ERC20Token { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | diff --git a/src/ColonyNetwork/ERC20Token.ts b/src/ColonyNetwork/ERC20Token.ts index 8c766197..22ac4559 100644 --- a/src/ColonyNetwork/ERC20Token.ts +++ b/src/ColonyNetwork/ERC20Token.ts @@ -97,7 +97,7 @@ export class ERC20Token { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | diff --git a/src/ColonyNetwork/ERC2612Token.ts b/src/ColonyNetwork/ERC2612Token.ts index e70c4cd4..f6a43bff 100644 --- a/src/ColonyNetwork/ERC2612Token.ts +++ b/src/ColonyNetwork/ERC2612Token.ts @@ -75,7 +75,7 @@ export class ERC2612Token extends ERC20Token { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | diff --git a/src/ColonyNetwork/OneTxPayment.ts b/src/ColonyNetwork/OneTxPayment.ts index d643cf1e..b5e4ca15 100644 --- a/src/ColonyNetwork/OneTxPayment.ts +++ b/src/ColonyNetwork/OneTxPayment.ts @@ -105,7 +105,7 @@ export class OneTxPayment { * @param teamId - The team to use to send the funds from. Has to have funding of at least the amount you need to send. See [[Colony.moveFundsToTeam]]. Defaults to the Colony's root team * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -188,7 +188,7 @@ export class OneTxPayment { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | diff --git a/src/ColonyNetwork/TokenLocking.ts b/src/ColonyNetwork/TokenLocking.ts index ea14520a..2aa8f21c 100644 --- a/src/ColonyNetwork/TokenLocking.ts +++ b/src/ColonyNetwork/TokenLocking.ts @@ -58,7 +58,7 @@ export class TokenLocking { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -102,7 +102,7 @@ export class TokenLocking { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | diff --git a/src/ColonyNetwork/VotingReputation.ts b/src/ColonyNetwork/VotingReputation.ts index 048567e7..4479f918 100644 --- a/src/ColonyNetwork/VotingReputation.ts +++ b/src/ColonyNetwork/VotingReputation.ts @@ -436,7 +436,7 @@ export class VotingReputation { * @param team - Team id to create the decision in * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -511,7 +511,7 @@ export class VotingReputation { * @param metadata - The annotation metadata you would like to annotate the transaction with (or an IPFS CID pointing to valid metadata) * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -519,7 +519,9 @@ export class VotingReputation { * | `txHash` | string | The hash of the annotated transaction | * | `metadata` | string | The IPFS hash (CID) of the metadata object | * - * **Metadata** (can be obtained by calling and awaiting the `getMetadata` function) + * #### Metadata + * + * (can be obtained by calling and awaiting the `getMetadata` function) * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -562,7 +564,7 @@ export class VotingReputation { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -616,7 +618,7 @@ export class VotingReputation { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -752,7 +754,7 @@ export class VotingReputation { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -817,7 +819,7 @@ export class VotingReputation { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -899,7 +901,7 @@ export class VotingReputation { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ | @@ -945,7 +947,7 @@ export class VotingReputation { * * @returns A transaction creator * - * **Event data** + * #### Event data * * | Property | Type | Description | * | :------ | :------ | :------ |