chore: generate docs

JoinColony · Jul 15, 2024 · 479e189 · 479e189
1 parent edcab97
commit 479e189
Show file tree

Hide file tree

Showing 21 changed files with 625 additions and 19 deletions.
diff --git a/packages/colony-js/docs/api/README.md b/packages/colony-js/docs/api/README.md
@@ -20,6 +20,7 @@
 - [MetaTxBroadCasterEndpoint](enums/MetaTxBroadCasterEndpoint.md)
 - [MotionState](enums/MotionState.md)
 - [Network](enums/Network.md)
+- [NetworkId](enums/NetworkId.md)
 - [ReputationOracleEndpoint](enums/ReputationOracleEndpoint.md)
 - [TokenClientType](enums/TokenClientType.md)
 - [UserLabelSuffix](enums/UserLabelSuffix.md)
@@ -337,15 +338,15 @@ Latest versions of all extension contracts
 
 | Name | Type |
 | :------ | :------ |
-| `FundingQueue` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` |
-| `IVotingReputation` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` |
-| `OneTxPayment` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` |
+| `FundingQueue` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` |
+| `IVotingReputation` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` |
+| `OneTxPayment` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` |
 | `ReputationBootstrapper` | ``1`` \| ``2`` \| ``3`` \| ``4`` |
 | `StagedExpenditure` | ``1`` \| ``2`` |
-| `StakedExpenditure` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` |
+| `StakedExpenditure` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` |
 | `StreamingPayments` | ``1`` \| ``2`` \| ``3`` \| ``4`` |
-| `TokenSupplier` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` |
-| `VotingReputation` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` |
+| `TokenSupplier` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` |
+| `VotingReputation` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` |
 
 ___
 

diff --git a/packages/colony-js/docs/api/enums/NetworkId.md b/packages/colony-js/docs/api/enums/NetworkId.md
@@ -0,0 +1,65 @@
+# Enumeration: NetworkId
+
+## Enumeration Members
+
+### ArbitrumOne
+
+• **ArbitrumOne** = ``42161``
+
+Arbitrum One Mainnet
+
+___
+
+### ArbitrumSepolia
+
+• **ArbitrumSepolia** = ``421614``
+
+Arbitrum Testnet
+
+___
+
+### Custom
+
+• **Custom** = ``0``
+
+Use this to specify an own main ColonyNetwork address in the options
+
+___
+
+### Gnosis
+
+• **Gnosis** = ``100``
+
+Gnosis chain
+
+___
+
+### Goerli
+
+• **Goerli** = ``5``
+
+Goerli testnet
+
+___
+
+### Mainnet
+
+• **Mainnet** = ``1``
+
+Ethereum Mainnet
+
+___
+
+### Xdai
+
+• **Xdai** = ``100``
+
+Gnosis chain (alias)
+
+___
+
+### XdaiQa
+
+• **XdaiQa** = ``100``
+
+Gnosis chain custom fork
diff --git a/packages/colony-js/docs/api/enums/Tokens.Arbitrum.md b/packages/colony-js/docs/api/enums/Tokens.Arbitrum.md
@@ -19,3 +19,11 @@ ___
 • **ETH** = ``"0x0000000000000000000000000000000000000000"``
 
 ETH on Arbitrum One
+
+___
+
+### USDC
+
+• **USDC** = ``"0xaf88d065e77c8cC2239327C5EDb3A432268e5831"``
+
+USDC on Arbitrum One
diff --git a/packages/colony-js/docs/api/enums/Tokens.Gnosis.md b/packages/colony-js/docs/api/enums/Tokens.Gnosis.md
@@ -14,6 +14,14 @@ CLNY on Gnosis Chain
 
 ___
 
+### USDC
+
+• **USDC** = ``"0xDDAfbb505ad214D7b80b1f830fcCc89B60fb7A83"``
+
+USDC on Gnosis Chain
+
+___
+
 ### XDAI
 
 • **XDAI** = ``"0x0000000000000000000000000000000000000000"``

diff --git a/packages/colony-js/docs/api/enums/Tokens.Mainnet.md b/packages/colony-js/docs/api/enums/Tokens.Mainnet.md
@@ -6,6 +6,14 @@ Tokens deployed on Mainnet
 
 ## Enumeration Members
 
+### CLNY
+
+• **CLNY** = ``"0x3E828ac5C480069D4765654Fb4b8733b910b13b2"``
+
+CLNY on Mainnet
+
+___
+
 ### ETH
 
 • **ETH** = ``"0x0000000000000000000000000000000000000000"``
@@ -14,8 +22,8 @@ ETH on Mainnet
 
 ___
 
-### Mainnet
+### USDC
 
-• **Mainnet** = ``"0x3E828ac5C480069D4765654Fb4b8733b910b13b2"``
+• **USDC** = ``"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"``
 
-CLNY on Mainnet
+USDC on Mainnet
diff --git a/packages/sdk/docs/api/README.md b/packages/sdk/docs/api/README.md
@@ -202,15 +202,15 @@ Latest versions of all extension contracts
 
 | Name | Type |
 | :------ | :------ |
-| `FundingQueue` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` |
-| `IVotingReputation` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` |
-| `OneTxPayment` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` |
+| `FundingQueue` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` |
+| `IVotingReputation` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` |
+| `OneTxPayment` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` |
 | `ReputationBootstrapper` | ``1`` \| ``2`` \| ``3`` \| ``4`` |
 | `StagedExpenditure` | ``1`` \| ``2`` |
-| `StakedExpenditure` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` |
+| `StakedExpenditure` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` |
 | `StreamingPayments` | ``1`` \| ``2`` \| ``3`` \| ``4`` |
-| `TokenSupplier` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` |
-| `VotingReputation` | ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` |
+| `TokenSupplier` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` |
+| `VotingReputation` | ``1`` \| ``5`` \| ``2`` \| ``3`` \| ``4`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` |
 
 ___
 

diff --git a/packages/sdk/docs/api/classes/IColonyNetworkEvents__factory.md b/packages/sdk/docs/api/classes/IColonyNetworkEvents__factory.md
diff --git a/packages/sdk/docs/api/enums/Tokens.Arbitrum.md b/packages/sdk/docs/api/enums/Tokens.Arbitrum.md
@@ -19,3 +19,11 @@ ___
 • **ETH** = ``"0x0000000000000000000000000000000000000000"``
 
 ETH on Arbitrum One
+
+___
+
+### USDC
+
+• **USDC** = ``"0xaf88d065e77c8cC2239327C5EDb3A432268e5831"``
+
+USDC on Arbitrum One
diff --git a/packages/sdk/docs/api/enums/Tokens.Gnosis.md b/packages/sdk/docs/api/enums/Tokens.Gnosis.md
@@ -14,6 +14,14 @@ CLNY on Gnosis Chain
 
 ___
 
+### USDC
+
+• **USDC** = ``"0xDDAfbb505ad214D7b80b1f830fcCc89B60fb7A83"``
+
+USDC on Gnosis Chain
+
+___
+
 ### XDAI
 
 • **XDAI** = ``"0x0000000000000000000000000000000000000000"``

diff --git a/packages/sdk/docs/api/enums/Tokens.Mainnet.md b/packages/sdk/docs/api/enums/Tokens.Mainnet.md
@@ -6,6 +6,14 @@ Tokens deployed on Mainnet
 
 ## Enumeration Members
 
+### CLNY
+
+• **CLNY** = ``"0x3E828ac5C480069D4765654Fb4b8733b910b13b2"``
+
+CLNY on Mainnet
+
+___
+
 ### ETH
 
 • **ETH** = ``"0x0000000000000000000000000000000000000000"``
@@ -14,8 +22,8 @@ ETH on Mainnet
 
 ___
 
-### Mainnet
+### USDC
 
-• **Mainnet** = ``"0x3E828ac5C480069D4765654Fb4b8733b910b13b2"``
+• **USDC** = ``"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"``
 
-CLNY on Mainnet
+USDC on Mainnet
diff --git a/packages/sdk/docs/api/interfaces/ColonyNetworkEvents.BridgeSetEventObject.md b/packages/sdk/docs/api/interfaces/ColonyNetworkEvents.BridgeSetEventObject.md
@@ -0,0 +1,9 @@
+# Interface: BridgeSetEventObject
+
+[ColonyNetworkEvents](../modules/ColonyNetworkEvents.md).BridgeSetEventObject
+
+## Properties
+
+### bridgeAddress
+
+• **bridgeAddress**: `string`
diff --git a/packages/sdk/docs/api/interfaces/ColonyNetworkEvents.IColonyNetworkEvents.md b/packages/sdk/docs/api/interfaces/ColonyNetworkEvents.IColonyNetworkEvents.md
@@ -98,6 +98,8 @@ ___
 | :------ | :------ |
 | `AuctionCreated` | (`auction?`: ``null``, `token?`: ``null``, `quantity?`: ``null``) => [`AuctionCreatedEventFilter`](../modules/ColonyNetworkEvents.md#auctioncreatedeventfilter) |
 | `AuctionCreated(address,address,uint256)` | (`auction?`: ``null``, `token?`: ``null``, `quantity?`: ``null``) => [`AuctionCreatedEventFilter`](../modules/ColonyNetworkEvents.md#auctioncreatedeventfilter) |
+| `BridgeSet` | (`bridgeAddress?`: ``null``) => [`BridgeSetEventFilter`](../modules/ColonyNetworkEvents.md#bridgeseteventfilter) |
+| `BridgeSet(address)` | (`bridgeAddress?`: ``null``) => [`BridgeSetEventFilter`](../modules/ColonyNetworkEvents.md#bridgeseteventfilter) |
 | `ColonyAdded` | (`colonyId?`: ``null`` \| `BigNumberish`, `colonyAddress?`: ``null`` \| `string`, `token?`: ``null``) => [`ColonyAddedEventFilter`](../modules/ColonyNetworkEvents.md#colonyaddedeventfilter) |
 | `ColonyAdded(uint256,address,address)` | (`colonyId?`: ``null`` \| `BigNumberish`, `colonyAddress?`: ``null`` \| `string`, `token?`: ``null``) => [`ColonyAddedEventFilter`](../modules/ColonyNetworkEvents.md#colonyaddedeventfilter) |
 | `ColonyLabelRegistered` | (`colony?`: ``null`` \| `string`, `label?`: ``null``) => [`ColonyLabelRegisteredEventFilter`](../modules/ColonyNetworkEvents.md#colonylabelregisteredeventfilter) |
@@ -146,8 +148,22 @@ ___
 | `ReputationMiningRewardSet(uint256)` | (`amount?`: ``null``) => [`ReputationMiningRewardSetEventFilter`](../modules/ColonyNetworkEvents.md#reputationminingrewardseteventfilter) |
 | `ReputationRootHashSet` | (`newHash?`: ``null``, `newNNodes?`: ``null``, `stakers?`: ``null``, `reward?`: ``null``) => [`ReputationRootHashSetEventFilter`](../modules/ColonyNetworkEvents.md#reputationroothashseteventfilter) |
 | `ReputationRootHashSet(bytes32,uint256,address[],uint256)` | (`newHash?`: ``null``, `newNNodes?`: ``null``, `stakers?`: ``null``, `reward?`: ``null``) => [`ReputationRootHashSetEventFilter`](../modules/ColonyNetworkEvents.md#reputationroothashseteventfilter) |
+| `ReputationUpdateAddedFromBridge` | (`chainId?`: ``null``, `colony?`: ``null``, `updateNumber?`: ``null``) => [`ReputationUpdateAddedFromBridgeEventFilter`](../modules/ColonyNetworkEvents.md#reputationupdateaddedfrombridgeeventfilter) |
+| `ReputationUpdateAddedFromBridge(uint256,address,uint256)` | (`chainId?`: ``null``, `colony?`: ``null``, `updateNumber?`: ``null``) => [`ReputationUpdateAddedFromBridgeEventFilter`](../modules/ColonyNetworkEvents.md#reputationupdateaddedfrombridgeeventfilter) |
+| `ReputationUpdateSentToBridge` | (`colony?`: ``null``, `count?`: ``null``) => [`ReputationUpdateSentToBridgeEventFilter`](../modules/ColonyNetworkEvents.md#reputationupdatesenttobridgeeventfilter) |
+| `ReputationUpdateSentToBridge(address,uint256)` | (`colony?`: ``null``, `count?`: ``null``) => [`ReputationUpdateSentToBridgeEventFilter`](../modules/ColonyNetworkEvents.md#reputationupdatesenttobridgeeventfilter) |
+| `ReputationUpdateStored` | (`colony?`: ``null``, `count?`: ``null``) => [`ReputationUpdateStoredEventFilter`](../modules/ColonyNetworkEvents.md#reputationupdatestoredeventfilter) |
+| `ReputationUpdateStored(address,uint256)` | (`colony?`: ``null``, `count?`: ``null``) => [`ReputationUpdateStoredEventFilter`](../modules/ColonyNetworkEvents.md#reputationupdatestoredeventfilter) |
+| `ReputationUpdateStoredFromBridge` | (`chainId?`: ``null``, `colony?`: ``null``, `updateNumber?`: ``null``) => [`ReputationUpdateStoredFromBridgeEventFilter`](../modules/ColonyNetworkEvents.md#reputationupdatestoredfrombridgeeventfilter) |
+| `ReputationUpdateStoredFromBridge(uint256,address,uint256)` | (`chainId?`: ``null``, `colony?`: ``null``, `updateNumber?`: ``null``) => [`ReputationUpdateStoredFromBridgeEventFilter`](../modules/ColonyNetworkEvents.md#reputationupdatestoredfrombridgeeventfilter) |
 | `SkillAdded` | (`skillId?`: ``null``, `parentSkillId?`: ``null``) => [`SkillAddedEventFilter`](../modules/ColonyNetworkEvents.md#skilladdedeventfilter) |
 | `SkillAdded(uint256,uint256)` | (`skillId?`: ``null``, `parentSkillId?`: ``null``) => [`SkillAddedEventFilter`](../modules/ColonyNetworkEvents.md#skilladdedeventfilter) |
+| `SkillAddedFromBridge` | (`skillId?`: ``null``) => [`SkillAddedFromBridgeEventFilter`](../modules/ColonyNetworkEvents.md#skilladdedfrombridgeeventfilter) |
+| `SkillAddedFromBridge(uint256)` | (`skillId?`: ``null``) => [`SkillAddedFromBridgeEventFilter`](../modules/ColonyNetworkEvents.md#skilladdedfrombridgeeventfilter) |
+| `SkillCreationStored` | (`skillId?`: ``null``) => [`SkillCreationStoredEventFilter`](../modules/ColonyNetworkEvents.md#skillcreationstoredeventfilter) |
+| `SkillCreationStored(uint256)` | (`skillId?`: ``null``) => [`SkillCreationStoredEventFilter`](../modules/ColonyNetworkEvents.md#skillcreationstoredeventfilter) |
+| `SkillStoredFromBridge` | (`skillId?`: ``null``) => [`SkillStoredFromBridgeEventFilter`](../modules/ColonyNetworkEvents.md#skillstoredfrombridgeeventfilter) |
+| `SkillStoredFromBridge(uint256)` | (`skillId?`: ``null``) => [`SkillStoredFromBridgeEventFilter`](../modules/ColonyNetworkEvents.md#skillstoredfrombridgeeventfilter) |
 | `TokenAuthorityDeployed` | (`tokenAuthorityAddress?`: ``null``) => [`TokenAuthorityDeployedEventFilter`](../modules/ColonyNetworkEvents.md#tokenauthoritydeployedeventfilter) |
 | `TokenAuthorityDeployed(address)` | (`tokenAuthorityAddress?`: ``null``) => [`TokenAuthorityDeployedEventFilter`](../modules/ColonyNetworkEvents.md#tokenauthoritydeployedeventfilter) |
 | `TokenDeployed` | (`tokenAddress?`: ``null``) => [`TokenDeployedEventFilter`](../modules/ColonyNetworkEvents.md#tokendeployedeventfilter) |