Skip to content

Commit

Permalink
chore: generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chmanie authored and github-actions[bot] committed Oct 30, 2024
1 parent 816b5c0 commit 9878751
Show file tree
Hide file tree
Showing 12 changed files with 50 additions and 121 deletions.
6 changes: 6 additions & 0 deletions packages/colony-js/docs/api/interfaces/ColonyNetworkClient.md
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,12 @@ IColonyNetwork.deployTransaction

___

### disableVersionCheck

**disableVersionCheck**: `boolean`

___

### estimateGas

**estimateGas**: `ExtendedEstimate`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

## Properties

### disableVersionCheck

`Optional` **disableVersionCheck**: `boolean`

___

### networkAddress

`Optional` **networkAddress**: `string`
Expand Down
11 changes: 9 additions & 2 deletions packages/sdk/docs/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@
- [ColonyNetwork](classes/ColonyNetwork.md)
- [ColonyToken](classes/ColonyToken.md)
- [ColonyTxCreator](classes/ColonyTxCreator.md)
- [CustomColonyNetwork](classes/CustomColonyNetwork.md)
- [CustomContract](classes/CustomContract.md)
- [ERC20Token](classes/ERC20Token.md)
- [ERC2612Token](classes/ERC2612Token.md)
Expand Down Expand Up @@ -87,9 +86,9 @@
- [ColonyMetaTransaction](interfaces/ColonyMetaTransaction.md)
- [ColonyMetadata](interfaces/ColonyMetadata.md)
- [ColonyMultiFilter](interfaces/ColonyMultiFilter.md)
- [ColonyNetworkOptions](interfaces/ColonyNetworkOptions.md)
- [ColonyTopic](interfaces/ColonyTopic.md)
- [ColonyTransaction](interfaces/ColonyTransaction.md)
- [ContractOptions](interfaces/ContractOptions.md)
- [ContractReceipt](interfaces/ContractReceipt.md)
- [ContractTransaction](interfaces/ContractTransaction.md)
- [DataTypeMap](interfaces/DataTypeMap.md)
Expand All @@ -116,6 +115,14 @@

## Type Aliases

### Abi

Ƭ **Abi**: readonly (`AbiConstructor` \| `AbiError` \| `AbiEvent` \| `AbiFallback` \| `AbiFunction` \| `AbiReceive`)[]

Contract [ABI Specification](https://docs.soliditylang.org/en/latest/abi-spec.html#json)

___

### Data

Ƭ **Data**: [`AnnotationData`](interfaces/AnnotationData.md) \| [`ColonyData`](interfaces/ColonyData.md) \| [`DecisionData`](interfaces/DecisionData.md) \| [`DomainData`](interfaces/DomainData.md) \| [`MiscData`](interfaces/MiscData.md)
Expand Down
8 changes: 8 additions & 0 deletions packages/sdk/docs/api/classes/Colony.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@ A shortcut to the [ColonyNetwork](ColonyNetwork.md) instance

___

### config

**config**: `ContractConfig`

The colony's contract config (taken from ColonyNetwork)

___

### ext

**ext**: [`SupportedExtensions`](../interfaces/SupportedExtensions.md)
Expand Down
43 changes: 1 addition & 42 deletions packages/sdk/docs/api/classes/ColonyNetwork.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,33 +28,7 @@ const colonyNetwork = new ColonyNetwork(provider);
| Name | Type | Description |
| :------ | :------ | :------ |
| `signerOrProvider` | [`SignerOrProvider`](../README.md#signerorprovider) | An _ethers_ compatible Signer or Provider instance |
| `options?` | [`ColonyNetworkOptions`](../interfaces/ColonyNetworkOptions.md) | Optional custom [ColonyNetworkOptions](../interfaces/ColonyNetworkOptions.md) |

## Properties

### ipfs

**ipfs**: [`IpfsMetadata`](IpfsMetadata.md)

The IPFS adapter for Metadata. Defaults to a read-only adapter

___

### network

**network**: [`Network`](../enums/Network.md)

The network the client is connected to. Defaults to Arbitrum One

___

### signerOrProvider

**signerOrProvider**: [`SignerOrProvider`](../README.md#signerorprovider)

An ethers.js [Signer](https://docs.ethers.org/v5/api/signer/#Signer) or [Provider](https://docs.ethers.org/v5/api/providers/).

E.g. a [Wallet](https://docs.ethers.org/v5/api/signer/#Wallet) or a [Web3Provider](https://docs.ethers.org/v5/api/providers/other/#Web3Provider) (MetaMask)
| `options?` | [`ContractOptions`](../interfaces/ContractOptions.md) | Optional custom ColonyNetworkOptions |

## Methods

Expand Down Expand Up @@ -298,21 +272,6 @@ A Colony abstaction instance of the MetaColony

___

### getSigner

**getSigner**(): `Signer`

Get the signer that was provided when the ColonyNetwork was instantiated.
Throws if the Signer is only a (read-only) Provider

#### Returns

`Signer`

An Ethers.js compatible Signer instance

___

### getTokenLocking

**getTokenLocking**(): `Promise`<[`TokenLocking`](TokenLocking.md)\>
Expand Down
63 changes: 0 additions & 63 deletions packages/sdk/docs/api/classes/CustomColonyNetwork.md

This file was deleted.

14 changes: 10 additions & 4 deletions packages/sdk/docs/api/classes/CustomContract.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

| Name | Type |
| :------ | :------ |
| `A` | extends `Abi` |
| `A` | extends [`Abi`](../README.md#abi) |

## Constructors

### constructor

**new CustomContract**<`A`\>(`colonyNetwork`, `address`, `abi`)
**new CustomContract**<`A`\>(`address`, `abi`, `config`)

Creates a new instance of a custom contract

Expand All @@ -21,22 +21,28 @@ From here you should be able to instantiate all the required instances for Colon

| Name | Type |
| :------ | :------ |
| `A` | extends `Abi` |
| `A` | extends [`Abi`](../README.md#abi) |

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `colonyNetwork` | [`ColonyNetwork`](ColonyNetwork.md) \| [`CustomColonyNetwork`](CustomColonyNetwork.md) | [ColonyNetwork](ColonyNetwork.md) instance |
| `address` | \`0x${string}\` | Address of the deployed contract |
| `abi` | `A` | JSON ABI of the contract |
| `config` | `ContractConfig` | An instance of a ContractConfig (mind: _not_ ContractOptions!) |

## Properties

### address

**address**: \`0x${string}\`

___

### config

**config**: `ContractConfig`

## Methods

### createTxCreator
Expand Down
2 changes: 1 addition & 1 deletion packages/sdk/docs/api/classes/MetaTxCreator.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Learn more about these functions in their individual documentation
| :------ | :------ |
| `«destructured»` | `Object` |
| › `args` | `unknown`[] \| () => `Promise`<`unknown`[]\> |
| › `colonyNetwork` | [`ColonyNetwork`](ColonyNetwork.md) \| [`CustomColonyNetwork`](CustomColonyNetwork.md) |
| › `config` | `ContractConfig` |
| › `contract` | `C` |
| › `eventData?` | (`receipt`: [`ContractReceipt`](../interfaces/ContractReceipt.md)) => `Promise`<`E`\> |
| › `metadataType?` | `MD` |
Expand Down
2 changes: 1 addition & 1 deletion packages/sdk/docs/api/classes/TxCreator.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Learn more about these functions in their individual documentation
| :------ | :------ |
| `«destructured»` | `Object` |
| › `args` | `unknown`[] \| () => `Promise`<`unknown`[]\> |
| › `colonyNetwork` | [`ColonyNetwork`](ColonyNetwork.md) \| [`CustomColonyNetwork`](CustomColonyNetwork.md) |
| › `config` | `ContractConfig` |
| › `contract` | `C` |
| › `eventData?` | (`receipt`: [`ContractReceipt`](../interfaces/ContractReceipt.md)) => `Promise`<`E`\> |
| › `metadataType?` | `MD` |
Expand Down
8 changes: 4 additions & 4 deletions packages/sdk/docs/api/classes/VotingReputation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The `VotingReputation` extension allows any member of a Colony to propose a Moti
### Extension parameters

Before the `VotingReputation` extension can be used you need to initialize it using a few parameters that heavily influence the Motion lifecycle.
For that please see the [initialize](VotingReputation.md#initialize) function and also [this document](https://docs.colony.io/use/governance/motions-and-disputes/parameters) for an in-depth explanation of the various parameters.
For that please see the [initialize](VotingReputation.md#initialize) function and also [this document](https://docs.colony.io/learn/governance/parameters) for an in-depth explanation of the various parameters.

### What is a Motion?

Expand All @@ -18,7 +18,7 @@ Motions that pass (the outcome is _Yay_) will execute the `action` once they are

:::info

The exact lifecycle is determined by the parameters that were set when the `VotingReputation` extension was installed for the Colony. You can find a detailed explanation of all the parameters [here](https://colony.gitbook.io/colony/extensions/governance/parameters).
The exact lifecycle is determined by the parameters that were set when the `VotingReputation` extension was installed for the Colony. You can find a detailed explanation of all the parameters [here](https://docs.colony.io/learn/governance/parameters).

:::

Expand Down Expand Up @@ -356,7 +356,7 @@ ___
Get the initialized configuration options

Get the configuration options that were set when the extension was initialized.
For more information on the individual values see https://docs.colony.io/use/governance/motions-and-disputes/parameters
For more information on the individual values see https://docs.colony.io/learn/governance/parameters

#### Returns

Expand Down Expand Up @@ -518,7 +518,7 @@ Before you can use the extension you need to initialize it by calling this funct
- Fractions are in wei to allow for precise adjustments (you can use the `w` helper method to specify fractions - see example)
- All periods values are given in seconds

See also [this page](https://docs.colony.io/use/governance/motions-and-disputes/parameters) for a detailed explanation of the parameters.
See also [this page](https://docs.colony.io/learn/governance/parameters) for a detailed explanation of the parameters.

**`Example`**

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Interface: ColonyNetworkOptions
# Interface: ContractOptions

Additional options for the [ColonyNetwork](../classes/ColonyNetwork.md)
Additional options for instatiating Contracts within the Colony Network

## Properties

Expand Down
4 changes: 2 additions & 2 deletions packages/sdk/docs/api/interfaces/TxCreatorConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@

___

### colonyNetwork
### config

**colonyNetwork**: [`ColonyNetwork`](../classes/ColonyNetwork.md)
**config**: `ContractConfig`

___

Expand Down

0 comments on commit 9878751

Please sign in to comment.