@peeramid-labs/sdk 2.1.2 → 3.0.0

package/docs/docs/classes/MultipassBase.md

@@ -17,6 +17,7 @@ Base class for Multipass functionality
 ### Properties
 
 - [chainId](MultipassBase.md#chainid)
+- [publicClient](MultipassBase.md#publicclient)
 
 ### Methods
 
@@ -27,6 +28,12 @@ Base class for Multipass functionality
 - [formQueryByUsername](MultipassBase.md#formquerybyusername)
 - [formQueryByUsernameAndId](MultipassBase.md#formquerybyusernameandid)
 - [formQueryByFullDetails](MultipassBase.md#formquerybyfulldetails)
+- [getContractAddress](MultipassBase.md#getcontractaddress)
+- [getDomainState](MultipassBase.md#getdomainstate)
+- [getDomainStateById](MultipassBase.md#getdomainstatebyid)
+- [getContractState](MultipassBase.md#getcontractstate)
+- [listDomains](MultipassBase.md#listdomains)
+- [listRecords](MultipassBase.md#listrecords)
 
 ## Constructors
 
@@ -42,6 +49,7 @@ Creates a new MultipassBase instance
 | :------ | :------ | :------ |
 | `params` | `Object` | Constructor parameters |
 | `params.chainId` | `number` | ID of the blockchain network |
+| `params.publicClient` | `Object` | Public client for reading contracts |
 
 #### Returns
 
@@ -55,6 +63,14 @@ Creates a new MultipassBase instance
 
 Chain ID for the network
 
+___
+
+### publicClient
+
+• **publicClient**: `Object`
+
+Public client for reading contracts
+
 ## Methods
 
 ### getDappURL
@@ -215,3 +231,107 @@ Creates a name query with full details
 [`NameQuery`](../index.md#namequery)
 
 The generated name query
+
+___
+
+### getContractAddress
+
+▸ **getContractAddress**(): \`0x$\{string}\`
+
+#### Returns
+
+\`0x$\{string}\`
+
+___
+
+### getDomainState
+
+▸ **getDomainState**(`domainName`): `Promise`\<`Domain`\>
+
+Get domain state
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `domainName` | \`0x$\{string}\` | Domain name to query |
+
+#### Returns
+
+`Promise`\<`Domain`\>
+
+Domain state
+
+___
+
+### getDomainStateById
+
+▸ **getDomainStateById**(`id`): `Promise`\<`Domain`\>
+
+Get domain state by ID
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `id` | `bigint` | Domain ID to query |
+
+#### Returns
+
+`Promise`\<`Domain`\>
+
+Domain state
+
+___
+
+### getContractState
+
+▸ **getContractState**(): `Promise`\<`bigint`\>
+
+Get contract state
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+Total number of domains
+
+___
+
+### listDomains
+
+▸ **listDomains**(`onlyActive?`): `Promise`\<`Domain`[]\>
+
+List all domains with their active status
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `onlyActive?` | `boolean` | If true, only return active domains |
+
+#### Returns
+
+`Promise`\<`Domain`[]\>
+
+Array of domains with their states
+
+___
+
+### listRecords
+
+▸ **listRecords**(`onlyActive?`): `Promise`\<\{ `record`: `CustomRecord` ; `isActive`: `boolean`  }[]\>
+
+List all records with their states
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `onlyActive?` | `boolean` | If true, only return active records |
+
+#### Returns
+
+`Promise`\<\{ `record`: `CustomRecord` ; `isActive`: `boolean`  }[]\>
+
+Array of records with their states

package/docs/docs/classes/RankTokenClient.md

@@ -15,6 +15,8 @@
 ### Methods
 
 - [getRankTokenURI](RankTokenClient.md#getranktokenuri)
+- [isFellowshipMetadata](RankTokenClient.md#isfellowshipmetadata)
+- [getMetadata](RankTokenClient.md#getmetadata)
 - [getRankTokenBalance](RankTokenClient.md#getranktokenbalance)
 
 ## Constructors
@@ -66,6 +68,38 @@ ___
 
 ___
 
+### isFellowshipMetadata
+
+▸ **isFellowshipMetadata**(`data`): data is FellowshipMetadata
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | `unknown` |
+
+#### Returns
+
+data is FellowshipMetadata
+
+___
+
+### getMetadata
+
+▸ **getMetadata**(`ipfsGateway`): `Promise`\<[`FellowshipMetadata`](../index.md#fellowshipmetadata)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `ipfsGateway` | `string` |
+
+#### Returns
+
+`Promise`\<[`FellowshipMetadata`](../index.md#fellowshipmetadata)\>
+
+___
+
 ### getRankTokenBalance
 
 ▸ **getRankTokenBalance**(`tokenId`, `account`): `Promise`\<`bigint`\>

package/docs/docs/enums/CONTENT_STORAGE.md

@@ -0,0 +1,27 @@
+# Enumeration: CONTENT\_STORAGE
+
+## Table of contents
+
+### Enumeration Members
+
+- [IPFS](CONTENT_STORAGE.md#ipfs)
+- [ARWEAVE](CONTENT_STORAGE.md#arweave)
+- [USER\_URL](CONTENT_STORAGE.md#user_url)
+
+## Enumeration Members
+
+### IPFS
+
+• **IPFS** = ``"IPFS"``
+
+___
+
+### ARWEAVE
+
+• **ARWEAVE** = ``"ARWEAVE"``
+
+___
+
+### USER\_URL
+
+• **USER\_URL** = ``"USER_URL"``

package/docs/docs/enums/SUBMISSION_TYPES.md

@@ -0,0 +1,41 @@
+# Enumeration: SUBMISSION\_TYPES
+
+## Table of contents
+
+### Enumeration Members
+
+- [MARKDOWN](SUBMISSION_TYPES.md#markdown)
+- [IMAGE](SUBMISSION_TYPES.md#image)
+- [VIDEO](SUBMISSION_TYPES.md#video)
+- [AUDIO](SUBMISSION_TYPES.md#audio)
+- [BYTES](SUBMISSION_TYPES.md#bytes)
+
+## Enumeration Members
+
+### MARKDOWN
+
+• **MARKDOWN** = ``"MARKDOWN"``
+
+___
+
+### IMAGE
+
+• **IMAGE** = ``"IMAGE"``
+
+___
+
+### VIDEO
+
+• **VIDEO** = ``"VIDEO"``
+
+___
+
+### AUDIO
+
+• **AUDIO** = ``"AUDIO"``
+
+___
+
+### BYTES
+
+• **BYTES** = ``"BYTES"``

package/docs/docs/index.md

@@ -1,4 +1,4 @@
-# Rankify SDK API Documentation - v2.1.2
+# Rankify SDK API Documentation - v3.0.0
 
 ## Table of contents
 
@@ -10,6 +10,8 @@
 
 - [gameStatusEnum](enums/gameStatusEnum.md)
 - [SearchCriteria](enums/SearchCriteria.md)
+- [SUBMISSION\_TYPES](enums/SUBMISSION_TYPES.md)
+- [CONTENT\_STORAGE](enums/CONTENT_STORAGE.md)
 
 ### Classes
 
@@ -36,6 +38,15 @@
 - [TokenArgumentsStructOutput](index.md#tokenargumentsstructoutput)
 - [UserRankifySettingsStructOutput](index.md#userrankifysettingsstructoutput)
 - [DistributorArgumentsStruct](index.md#distributorargumentsstruct)
+- [FellowshipMetadata](index.md#fellowshipmetadata)
+- [MediaFormat](index.md#mediaformat)
+- [AudioRules](index.md#audiorules)
+- [VideoRules](index.md#videorules)
+- [ImageRules](index.md#imagerules)
+- [TextRules](index.md#textrules)
+- [BytesRules](index.md#bytesrules)
+- [SubmissionContent](index.md#submissioncontent)
+- [ValidationRule](index.md#validationrule)
 - [SupportedChains](index.md#supportedchains)
 - [ArtifactTypes](index.md#artifacttypes)
 - [ArtifactAbi](index.md#artifactabi)
@@ -50,6 +61,7 @@
 - [getApiError](index.md#getapierror)
 - [getArtifact](index.md#getartifact)
 - [getContract](index.md#getcontract)
+- [parseInstantiated](index.md#parseinstantiated)
 
 ## References
 
@@ -125,6 +137,106 @@ Combined arguments for new community initialization
 
 ___
 
+### FellowshipMetadata
+
+Ƭ **FellowshipMetadata**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+| `description` | `string` |
+| `image` | `string` |
+| `banner_image?` | `string` |
+| `featured_image?` | `string` |
+| `external_link?` | `string` |
+| `collaborators?` | `Address`[] |
+| `submissions` | \{ `type`: [`SUBMISSION_TYPES`](enums/SUBMISSION_TYPES.md) ; `rules`: [`AudioRules`](index.md#audiorules) \| [`VideoRules`](index.md#videorules) \| [`ImageRules`](index.md#imagerules) \| [`TextRules`](index.md#textrules) \| [`BytesRules`](index.md#bytesrules) ; `customValidation?`: [`ValidationRule`](index.md#validationrule)[] ; `store_at`: [`CONTENT_STORAGE`](enums/CONTENT_STORAGE.md)  }[] |
+
+___
+
+### MediaFormat
+
+Ƭ **MediaFormat**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `mimeTypes` | `string`[] |
+| `maxSizeBytes?` | `number` |
+| `minSizeBytes?` | `number` |
+
+___
+
+### AudioRules
+
+Ƭ **AudioRules**: [`MediaFormat`](index.md#mediaformat) & \{ `maxDurationSeconds?`: `number` ; `minDurationSeconds?`: `number` ; `allowedEncodings?`: `string`[] ; `minBitrate?`: `number` ; `maxBitrate?`: `number`  }
+
+___
+
+### VideoRules
+
+Ƭ **VideoRules**: [`AudioRules`](index.md#audiorules) & \{ `minResolution?`: \{ `width`: `number` ; `height`: `number`  } ; `maxResolution?`: \{ `width`: `number` ; `height`: `number`  } ; `maxFrameRate?`: `number` ; `minFrameRate?`: `number`  }
+
+___
+
+### ImageRules
+
+Ƭ **ImageRules**: [`MediaFormat`](index.md#mediaformat) & \{ `minResolution?`: \{ `width`: `number` ; `height`: `number`  } ; `maxResolution?`: \{ `width`: `number` ; `height`: `number`  } ; `allowedFormats?`: `string`[] ; `maxAspectRatio?`: `number` ; `minAspectRatio?`: `number`  }
+
+___
+
+### TextRules
+
+Ƭ **TextRules**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `minLength?` | `number` |
+| `maxLength?` | `number` |
+| `allowedFormats?` | `string`[] |
+| `allowedCharsets?` | `string`[] |
+
+___
+
+### BytesRules
+
+Ƭ **BytesRules**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `minSize?` | `number` |
+| `maxSize?` | `number` |
+| `allowedEncodings?` | `string`[] |
+
+___
+
+### SubmissionContent
+
+Ƭ **SubmissionContent**: \{ `AUDIO`: \{ `data`: `ArrayBuffer` ; `duration`: `number` ; `bitrate?`: `number` ; `channels?`: `number` ; `sampleRate?`: `number`  } ; `VIDEO`: \{ `data`: `ArrayBuffer` ; `duration`: `number` ; `width`: `number` ; `height`: `number` ; `frameRate?`: `number` ; `bitrate?`: `number`  } ; `IMAGE`: \{ `data`: `ArrayBuffer` ; `width`: `number` ; `height`: `number` ; `format`: `string`  } ; `MARKDOWN`: \{ `content`: `string` ; `length`: `number`  } ; `BYTES`: \{ `data`: `ArrayBuffer` ; `size`: `number` ; `encoding?`: `string`  }  }[[`SUBMISSION_TYPES`](enums/SUBMISSION_TYPES.md)]
+
+___
+
+### ValidationRule
+
+Ƭ **ValidationRule**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `type` | ``"script_url"`` \| ``"regex"`` \| ``"function"`` |
+| `value` | `string` \| (`content`: [`SubmissionContent`](index.md#submissioncontent)) => `boolean` |
+| `errorMessage` | `string` |
+
+___
+
 ### SupportedChains
 
 Ƭ **SupportedChains**: ``"anvil"`` \| ``"localhost"``
@@ -133,7 +245,7 @@ ___
 
 ### ArtifactTypes
 
-Ƭ **ArtifactTypes**: ``"Rankify"`` \| ``"Multipass"`` \| ``"SimpleAccessManager"`` \| ``"DAODistributor"``
+Ƭ **ArtifactTypes**: ``"Rankify"`` \| ``"Multipass"`` \| ``"SimpleAccessManager"`` \| ``"DAODistributor"`` \| ``"CodeIndex"``
 
 ___
 
@@ -149,6 +261,7 @@ ___
 | `Multipass` | typeof `multipassAbi` |
 | `SimpleAccessManager` | typeof `simpleAccessManagerAbi` |
 | `DAODistributor` | typeof `DAODistributorabi` |
+| `CodeIndex` | typeof `CodeIndexAbi` |
 
 ## Variables
 
@@ -368,3 +481,23 @@ Gets a contract instance with the appropriate ABI and address for the given chai
 \{ [K in string \| number \| symbol]: (\{ [K in string \| number \| symbol]: (((TClient extends Object ? TClient\<TClient\>["public"] : TClient) extends Client ? (IsNever\<(...) extends (...) ? (...) : (...)\> extends true ? unknown : Object) & (IsNever\<(...) extends (...) ? (...) : (...)\> extends true ? unknown : Object) & (IsNever\<(...) extends (...) ? (...) : (...)\> extends true ? unknown : Object) : unknown) & ((TClient extends Object ? TClient\<TClient\>["wallet"] : TClient) extends Client ? IsNever\<(...)[(...)] extends Abi ? (...) extends (...) ? (...) : (...) : string\> extends true ? unknown : Object : unknown))[K] } & Object)[K] }
 
 A viem contract instance
+
+___
+
+### parseInstantiated
+
+▸ **parseInstantiated**(`instances`): [`MAOInstances`](interfaces/MAOInstances.md)
+
+Parse an array of contract addresses into a MAOInstances object
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `instances` | `string`[] | Array of contract addresses in the order they were deployed |
+
+#### Returns
+
+[`MAOInstances`](interfaces/MAOInstances.md)
+
+MAOInstances object with named contract addresses

package/docs/enums/CONTENT_STORAGE.md

@@ -0,0 +1,27 @@
+# Enumeration: CONTENT\_STORAGE
+
+## Table of contents
+
+### Enumeration Members
+
+- [IPFS](CONTENT_STORAGE.md#ipfs)
+- [ARWEAVE](CONTENT_STORAGE.md#arweave)
+- [USER\_URL](CONTENT_STORAGE.md#user_url)
+
+## Enumeration Members
+
+### IPFS
+
+• **IPFS** = ``"IPFS"``
+
+___
+
+### ARWEAVE
+
+• **ARWEAVE** = ``"ARWEAVE"``
+
+___
+
+### USER\_URL
+
+• **USER\_URL** = ``"USER_URL"``

package/docs/enums/SUBMISSION_TYPES.md

@@ -0,0 +1,41 @@
+# Enumeration: SUBMISSION\_TYPES
+
+## Table of contents
+
+### Enumeration Members
+
+- [MARKDOWN](SUBMISSION_TYPES.md#markdown)
+- [IMAGE](SUBMISSION_TYPES.md#image)
+- [VIDEO](SUBMISSION_TYPES.md#video)
+- [AUDIO](SUBMISSION_TYPES.md#audio)
+- [BYTES](SUBMISSION_TYPES.md#bytes)
+
+## Enumeration Members
+
+### MARKDOWN
+
+• **MARKDOWN** = ``"MARKDOWN"``
+
+___
+
+### IMAGE
+
+• **IMAGE** = ``"IMAGE"``
+
+___
+
+### VIDEO
+
+• **VIDEO** = ``"VIDEO"``
+
+___
+
+### AUDIO
+
+• **AUDIO** = ``"AUDIO"``
+
+___
+
+### BYTES
+
+• **BYTES** = ``"BYTES"``

package/docs/index.md

@@ -1,4 +1,4 @@
-# Rankify SDK API Documentation - v2.1.2
+# Rankify SDK API Documentation - v3.0.0
 
 ## Table of contents
 
@@ -10,6 +10,8 @@
 
 - [gameStatusEnum](enums/gameStatusEnum.md)
 - [SearchCriteria](enums/SearchCriteria.md)
+- [SUBMISSION\_TYPES](enums/SUBMISSION_TYPES.md)
+- [CONTENT\_STORAGE](enums/CONTENT_STORAGE.md)
 
 ### Classes
 
@@ -36,6 +38,15 @@
 - [TokenArgumentsStructOutput](index.md#tokenargumentsstructoutput)
 - [UserRankifySettingsStructOutput](index.md#userrankifysettingsstructoutput)
 - [DistributorArgumentsStruct](index.md#distributorargumentsstruct)
+- [FellowshipMetadata](index.md#fellowshipmetadata)
+- [MediaFormat](index.md#mediaformat)
+- [AudioRules](index.md#audiorules)
+- [VideoRules](index.md#videorules)
+- [ImageRules](index.md#imagerules)
+- [TextRules](index.md#textrules)
+- [BytesRules](index.md#bytesrules)
+- [SubmissionContent](index.md#submissioncontent)
+- [ValidationRule](index.md#validationrule)
 - [SupportedChains](index.md#supportedchains)
 - [ArtifactTypes](index.md#artifacttypes)
 - [ArtifactAbi](index.md#artifactabi)
@@ -50,6 +61,7 @@
 - [getApiError](index.md#getapierror)
 - [getArtifact](index.md#getartifact)
 - [getContract](index.md#getcontract)
+- [parseInstantiated](index.md#parseinstantiated)
 
 ## References
 
@@ -125,6 +137,106 @@ Combined arguments for new community initialization
 
 ___
 
+### FellowshipMetadata
+
+Ƭ **FellowshipMetadata**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+| `description` | `string` |
+| `image` | `string` |
+| `banner_image?` | `string` |
+| `featured_image?` | `string` |
+| `external_link?` | `string` |
+| `collaborators?` | `Address`[] |
+| `submissions` | \{ `type`: [`SUBMISSION_TYPES`](enums/SUBMISSION_TYPES.md) ; `rules`: [`AudioRules`](index.md#audiorules) \| [`VideoRules`](index.md#videorules) \| [`ImageRules`](index.md#imagerules) \| [`TextRules`](index.md#textrules) \| [`BytesRules`](index.md#bytesrules) ; `customValidation?`: [`ValidationRule`](index.md#validationrule)[] ; `store_at`: [`CONTENT_STORAGE`](enums/CONTENT_STORAGE.md)  }[] |
+
+___
+
+### MediaFormat
+
+Ƭ **MediaFormat**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `mimeTypes` | `string`[] |
+| `maxSizeBytes?` | `number` |
+| `minSizeBytes?` | `number` |
+
+___
+
+### AudioRules
+
+Ƭ **AudioRules**: [`MediaFormat`](index.md#mediaformat) & \{ `maxDurationSeconds?`: `number` ; `minDurationSeconds?`: `number` ; `allowedEncodings?`: `string`[] ; `minBitrate?`: `number` ; `maxBitrate?`: `number`  }
+
+___
+
+### VideoRules
+
+Ƭ **VideoRules**: [`AudioRules`](index.md#audiorules) & \{ `minResolution?`: \{ `width`: `number` ; `height`: `number`  } ; `maxResolution?`: \{ `width`: `number` ; `height`: `number`  } ; `maxFrameRate?`: `number` ; `minFrameRate?`: `number`  }
+
+___
+
+### ImageRules
+
+Ƭ **ImageRules**: [`MediaFormat`](index.md#mediaformat) & \{ `minResolution?`: \{ `width`: `number` ; `height`: `number`  } ; `maxResolution?`: \{ `width`: `number` ; `height`: `number`  } ; `allowedFormats?`: `string`[] ; `maxAspectRatio?`: `number` ; `minAspectRatio?`: `number`  }
+
+___
+
+### TextRules
+
+Ƭ **TextRules**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `minLength?` | `number` |
+| `maxLength?` | `number` |
+| `allowedFormats?` | `string`[] |
+| `allowedCharsets?` | `string`[] |
+
+___
+
+### BytesRules
+
+Ƭ **BytesRules**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `minSize?` | `number` |
+| `maxSize?` | `number` |
+| `allowedEncodings?` | `string`[] |
+
+___
+
+### SubmissionContent
+
+Ƭ **SubmissionContent**: \{ `AUDIO`: \{ `data`: `ArrayBuffer` ; `duration`: `number` ; `bitrate?`: `number` ; `channels?`: `number` ; `sampleRate?`: `number`  } ; `VIDEO`: \{ `data`: `ArrayBuffer` ; `duration`: `number` ; `width`: `number` ; `height`: `number` ; `frameRate?`: `number` ; `bitrate?`: `number`  } ; `IMAGE`: \{ `data`: `ArrayBuffer` ; `width`: `number` ; `height`: `number` ; `format`: `string`  } ; `MARKDOWN`: \{ `content`: `string` ; `length`: `number`  } ; `BYTES`: \{ `data`: `ArrayBuffer` ; `size`: `number` ; `encoding?`: `string`  }  }[[`SUBMISSION_TYPES`](enums/SUBMISSION_TYPES.md)]
+
+___
+
+### ValidationRule
+
+Ƭ **ValidationRule**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `type` | ``"script_url"`` \| ``"regex"`` \| ``"function"`` |
+| `value` | `string` \| (`content`: [`SubmissionContent`](index.md#submissioncontent)) => `boolean` |
+| `errorMessage` | `string` |
+
+___
+
 ### SupportedChains
 
 Ƭ **SupportedChains**: ``"anvil"`` \| ``"localhost"``
@@ -133,7 +245,7 @@ ___
 
 ### ArtifactTypes
 
-Ƭ **ArtifactTypes**: ``"Rankify"`` \| ``"Multipass"`` \| ``"SimpleAccessManager"`` \| ``"DAODistributor"``
+Ƭ **ArtifactTypes**: ``"Rankify"`` \| ``"Multipass"`` \| ``"SimpleAccessManager"`` \| ``"DAODistributor"`` \| ``"CodeIndex"``
 
 ___
 
@@ -149,6 +261,7 @@ ___
 | `Multipass` | typeof `multipassAbi` |
 | `SimpleAccessManager` | typeof `simpleAccessManagerAbi` |
 | `DAODistributor` | typeof `DAODistributorabi` |
+| `CodeIndex` | typeof `CodeIndexAbi` |
 
 ## Variables
 
@@ -368,3 +481,23 @@ Gets a contract instance with the appropriate ABI and address for the given chai
 \{ [K in string \| number \| symbol]: (\{ [K in string \| number \| symbol]: (((TClient extends Object ? TClient\<TClient\>["public"] : TClient) extends Client ? (IsNever\<(...) extends (...) ? (...) : (...)\> extends true ? unknown : Object) & (IsNever\<(...) extends (...) ? (...) : (...)\> extends true ? unknown : Object) & (IsNever\<(...) extends (...) ? (...) : (...)\> extends true ? unknown : Object) : unknown) & ((TClient extends Object ? TClient\<TClient\>["wallet"] : TClient) extends Client ? IsNever\<(...)[(...)] extends Abi ? (...) extends (...) ? (...) : (...) : string\> extends true ? unknown : Object : unknown))[K] } & Object)[K] }
 
 A viem contract instance
+
+___
+
+### parseInstantiated
+
+▸ **parseInstantiated**(`instances`): [`MAOInstances`](interfaces/MAOInstances.md)
+
+Parse an array of contract addresses into a MAOInstances object
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `instances` | `string`[] | Array of contract addresses in the order they were deployed |
+
+#### Returns
+
+[`MAOInstances`](interfaces/MAOInstances.md)
+
+MAOInstances object with named contract addresses