@peeramid-labs/sdk 2.0.0 → 2.0.2

package/docs/docs/classes/MAODistributorClient.md

@@ -0,0 +1,307 @@
+# Class: MAODistributorClient
+
+Client for managing MAO Distribution operations
+Handles creation, management and interaction with MAO instances
+
+## Hierarchy
+
+- `DistributorClient`
+
+  ↳ **`MAODistributorClient`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](MAODistributorClient.md#constructor)
+
+### Properties
+
+- [publicClient](MAODistributorClient.md#publicclient)
+- [address](MAODistributorClient.md#address)
+- [walletClient](MAODistributorClient.md#walletclient)
+- [parseInstantiated](MAODistributorClient.md#parseinstantiated)
+
+### Methods
+
+- [getDistributions](MAODistributorClient.md#getdistributions)
+- [getInstances](MAODistributorClient.md#getinstances)
+- [getInstance](MAODistributorClient.md#getinstance)
+- [getNamedDistributionInstances](MAODistributorClient.md#getnameddistributioninstances)
+- [getNamedDistributionInstance](MAODistributorClient.md#getnameddistributioninstance)
+- [addressesToContracts](MAODistributorClient.md#addressestocontracts)
+- [getMAOInstances](MAODistributorClient.md#getmaoinstances)
+- [parseToContracts](MAODistributorClient.md#parsetocontracts)
+- [getMAOInstance](MAODistributorClient.md#getmaoinstance)
+- [instantiate](MAODistributorClient.md#instantiate)
+
+## Constructors
+
+### constructor
+
+• **new MAODistributorClient**(`chainId`, `client`): [`MAODistributorClient`](MAODistributorClient.md)
+
+Creates a new MAODistributorClient instance
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `chainId` | `number` | ID of the blockchain network |
+| `client` | `Object` | Object containing public and wallet clients |
+| `client.publicClient` | `Object` | - |
+| `client.walletClient?` | `Object` | - |
+
+#### Returns
+
+[`MAODistributorClient`](MAODistributorClient.md)
+
+#### Overrides
+
+DistributorClient.constructor
+
+## Properties
+
+### publicClient
+
+• **publicClient**: `Object`
+
+#### Inherited from
+
+DistributorClient.publicClient
+
+___
+
+### address
+
+• **address**: \`0x$\{string}\`
+
+#### Inherited from
+
+DistributorClient.address
+
+___
+
+### walletClient
+
+• `Optional` **walletClient**: `Object`
+
+___
+
+### parseInstantiated
+
+• **parseInstantiated**: (`instances`: `string`[]) => [`MAOInstances`](../interfaces/MAOInstances.md) = `parseInstantiated`
+
+#### Type declaration
+
+▸ (`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
+
+## Methods
+
+### getDistributions
+
+▸ **getDistributions**(): `Promise`\<readonly \`0x$\{string}\`[]\>
+
+#### Returns
+
+`Promise`\<readonly \`0x$\{string}\`[]\>
+
+#### Inherited from
+
+DistributorClient.getDistributions
+
+___
+
+### getInstances
+
+▸ **getInstances**(`distributorsId`): `Promise`\<\`0x$\{string}\`[][]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `distributorsId` | \`0x$\{string}\` |
+
+#### Returns
+
+`Promise`\<\`0x$\{string}\`[][]\>
+
+#### Inherited from
+
+DistributorClient.getInstances
+
+___
+
+### getInstance
+
+▸ **getInstance**(`distributorsId`, `instanceId`): `Promise`\<\`0x$\{string}\`[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `distributorsId` | \`0x$\{string}\` |
+| `instanceId` | `bigint` |
+
+#### Returns
+
+`Promise`\<\`0x$\{string}\`[]\>
+
+#### Inherited from
+
+DistributorClient.getInstance
+
+___
+
+### getNamedDistributionInstances
+
+▸ **getNamedDistributionInstances**(`«destructured»`): `Promise`\<\`0x$\{string}\`[][]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `namedDistribution` | `string` |
+
+#### Returns
+
+`Promise`\<\`0x$\{string}\`[][]\>
+
+#### Inherited from
+
+DistributorClient.getNamedDistributionInstances
+
+___
+
+### getNamedDistributionInstance
+
+▸ **getNamedDistributionInstance**(`namedDistribution`, `instanceId`): `Promise`\<\`0x$\{string}\`[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `namedDistribution` | `string` |
+| `instanceId` | `bigint` |
+
+#### Returns
+
+`Promise`\<\`0x$\{string}\`[]\>
+
+#### Inherited from
+
+DistributorClient.getNamedDistributionInstance
+
+___
+
+### addressesToContracts
+
+▸ **addressesToContracts**(`addresses`): [`MAOInstanceContracts`](../interfaces/MAOInstanceContracts.md)
+
+Converts MAOInstances addresses to their respective contract instances
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `addresses` | [`MAOInstances`](../interfaces/MAOInstances.md) | Object containing contract addresses for MAO distribution components |
+
+#### Returns
+
+[`MAOInstanceContracts`](../interfaces/MAOInstanceContracts.md)
+
+Object containing initialized contract instances
+
+**`Throws`**
+
+Error if any of the addresses are invalid
+
+___
+
+### getMAOInstances
+
+▸ **getMAOInstances**(`namedDistribution?`): `Promise`\<[`MAOInstanceContracts`](../interfaces/MAOInstanceContracts.md)[]\>
+
+Get MAOInstances instances by distribution name
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `namedDistribution` | `string` | `MAODistributorClient.DEFAULT_NAME` | Distribution name (defaults to "MAO Distribution") |
+
+#### Returns
+
+`Promise`\<[`MAOInstanceContracts`](../interfaces/MAOInstanceContracts.md)[]\>
+
+Array of MAOInstances contract instances
+
+___
+
+### parseToContracts
+
+▸ **parseToContracts**(`instances`): [`MAOInstanceContracts`](../interfaces/MAOInstanceContracts.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `instances` | readonly \`0x$\{string}\`[] |
+
+#### Returns
+
+[`MAOInstanceContracts`](../interfaces/MAOInstanceContracts.md)
+
+___
+
+### getMAOInstance
+
+▸ **getMAOInstance**(`name?`, `instanceId`): `Promise`\<[`MAOInstanceContracts`](../interfaces/MAOInstanceContracts.md)\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `name` | `string` | `MAODistributorClient.DEFAULT_NAME` |
+| `instanceId` | `bigint` | `undefined` |
+
+#### Returns
+
+`Promise`\<[`MAOInstanceContracts`](../interfaces/MAOInstanceContracts.md)\>
+
+___
+
+### instantiate
+
+▸ **instantiate**(`args`, `name?`, `chain`): `Promise`\<[`MAOInstanceContracts`](../interfaces/MAOInstanceContracts.md)\>
+
+Create a new MAODistribution instance
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `args` | `undefined` \| readonly [\{ `tokenSettings`: \{ `tokenName`: `string` ; `tokenSymbol`: `string`  } ; `rankifySettings`: \{ `principalCost`: `bigint` ; `principalTimeConstant`: `bigint` ; `metadata`: `string` ; `rankTokenURI`: `string` ; `rankTokenContractURI`: `string`  }  }] \| readonly [\{ `tokenSettings`: \{ `tokenName`: `string` ; `tokenSymbol`: `string`  } ; `rankifySettings`: \{ `principalCost`: `bigint` ; `principalTimeConstant`: `bigint` ; `metadata`: `string` ; `rankTokenURI`: `string` ; `rankTokenContractURI`: `string`  }  }] | `undefined` | Distribution arguments (encoded as bytes) |
+| `name` | `string` | `MAODistributorClient.DEFAULT_NAME` | - |
+| `chain` | `Chain` | `undefined` | - |
+
+#### Returns
+
+`Promise`\<[`MAOInstanceContracts`](../interfaces/MAOInstanceContracts.md)\>
+
+Array of created contract addresses

package/docs/docs/classes/Multipass.md

@@ -0,0 +1,276 @@
+# Class: Multipass
+
+Main Multipass class for handling registrations and queries
+
+## Hierarchy
+
+- [`MultipassBase`](MultipassBase.md)
+
+  ↳ **`Multipass`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Multipass.md#constructor)
+
+### Properties
+
+- [chainId](Multipass.md#chainid)
+
+### Methods
+
+- [getRegistrarMessage](Multipass.md#getregistrarmessage)
+- [formQueryByAddress](Multipass.md#formquerybyaddress)
+- [formQueryById](Multipass.md#formquerybyid)
+- [formQueryByUsername](Multipass.md#formquerybyusername)
+- [formQueryByUsernameAndId](Multipass.md#formquerybyusernameandid)
+- [formQueryByFullDetails](Multipass.md#formquerybyfulldetails)
+- [signRegistrarMessage](Multipass.md#signregistrarmessage)
+- [getDappURL](Multipass.md#getdappurl)
+
+## Constructors
+
+### constructor
+
+• **new Multipass**(`params`): [`Multipass`](Multipass.md)
+
+Creates a new Multipass instance
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `params` | `Object` | Constructor parameters |
+| `params.chainId` | `number` | ID of the blockchain network |
+| `params.walletClient` | `Object` | Wallet client for signing transactions |
+
+#### Returns
+
+[`Multipass`](Multipass.md)
+
+#### Overrides
+
+[MultipassBase](MultipassBase.md).[constructor](MultipassBase.md#constructor)
+
+## Properties
+
+### chainId
+
+• **chainId**: `number`
+
+Chain ID for the network
+
+#### Inherited from
+
+[MultipassBase](MultipassBase.md).[chainId](MultipassBase.md#chainid)
+
+## Methods
+
+### getRegistrarMessage
+
+▸ **getRegistrarMessage**(`«destructured»`): [`RegisterMessage`](../interfaces/RegisterMessage.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `username` | `string` |
+| › `id` | `string` |
+| › `domainName` | `string` |
+| › `validUntil` | `number` |
+
+#### Returns
+
+[`RegisterMessage`](../interfaces/RegisterMessage.md)
+
+#### Inherited from
+
+[MultipassBase](MultipassBase.md).[getRegistrarMessage](MultipassBase.md#getregistrarmessage)
+
+___
+
+### formQueryByAddress
+
+▸ **formQueryByAddress**(`params`): [`NameQuery`](../index.md#namequery)
+
+Creates a name query by address
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `params` | `Object` | Parameters for creating the query |
+| `params.address` | `string` | Address to be encoded in the query |
+| `params.domainName` | `string` | Domain name to be encoded in the query |
+| `params.targetDomain?` | `string` | Target domain to be encoded in the query |
+
+#### Returns
+
+[`NameQuery`](../index.md#namequery)
+
+The generated name query
+
+#### Inherited from
+
+[MultipassBase](MultipassBase.md).[formQueryByAddress](MultipassBase.md#formquerybyaddress)
+
+___
+
+### formQueryById
+
+▸ **formQueryById**(`params`): [`NameQuery`](../index.md#namequery)
+
+Creates a name query by ID
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `params` | `Object` | Parameters for creating the query |
+| `params.id` | `string` | ID to be encoded in the query |
+| `params.domainName` | `string` | Domain name to be encoded in the query |
+| `params.targetDomain?` | `string` | Target domain to be encoded in the query |
+
+#### Returns
+
+[`NameQuery`](../index.md#namequery)
+
+The generated name query
+
+#### Inherited from
+
+[MultipassBase](MultipassBase.md).[formQueryById](MultipassBase.md#formquerybyid)
+
+___
+
+### formQueryByUsername
+
+▸ **formQueryByUsername**(`params`): [`NameQuery`](../index.md#namequery)
+
+Creates a name query by username
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `params` | `Object` | Parameters for creating the query |
+| `params.username` | `string` | Username to be encoded in the query |
+| `params.domainName` | `string` | Domain name to be encoded in the query |
+| `params.targetDomain?` | `string` | Target domain to be encoded in the query |
+
+#### Returns
+
+[`NameQuery`](../index.md#namequery)
+
+The generated name query
+
+#### Inherited from
+
+[MultipassBase](MultipassBase.md).[formQueryByUsername](MultipassBase.md#formquerybyusername)
+
+___
+
+### formQueryByUsernameAndId
+
+▸ **formQueryByUsernameAndId**(`params`): [`NameQuery`](../index.md#namequery)
+
+Creates a name query by username and ID
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `params` | `Object` | Parameters for creating the query |
+| `params.username` | `string` | Username to be encoded in the query |
+| `params.id` | `string` | ID to be encoded in the query |
+| `params.domainName` | `string` | Domain name to be encoded in the query |
+| `params.targetDomain?` | `string` | Target domain to be encoded in the query |
+
+#### Returns
+
+[`NameQuery`](../index.md#namequery)
+
+The generated name query
+
+#### Inherited from
+
+[MultipassBase](MultipassBase.md).[formQueryByUsernameAndId](MultipassBase.md#formquerybyusernameandid)
+
+___
+
+### formQueryByFullDetails
+
+▸ **formQueryByFullDetails**(`params`): [`NameQuery`](../index.md#namequery)
+
+Creates a name query with full details
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `params` | `Object` | Parameters for creating the query |
+| `params.username` | `string` | Username to be encoded in the query |
+| `params.id` | `string` | ID to be encoded in the query |
+| `params.domainName` | `string` | Domain name to be encoded in the query |
+| `params.targetDomain?` | `string` | Target domain to be encoded in the query |
+| `params.address` | `string` | Address to be encoded in the query |
+
+#### Returns
+
+[`NameQuery`](../index.md#namequery)
+
+The generated name query
+
+#### Inherited from
+
+[MultipassBase](MultipassBase.md).[formQueryByFullDetails](MultipassBase.md#formquerybyfulldetails)
+
+___
+
+### signRegistrarMessage
+
+▸ **signRegistrarMessage**(`message`, `verifierAddress`): `Promise`\<\`0x$\{string}\`\>
+
+Signs a registrar message for registration
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `message` | [`RegisterMessage`](../interfaces/RegisterMessage.md) | Message to sign |
+| `verifierAddress` | \`0x$\{string}\` | Address of the verifier contract |
+
+#### Returns
+
+`Promise`\<\`0x$\{string}\`\>
+
+Signed message
+
+___
+
+### getDappURL
+
+▸ **getDappURL**(`message`, `signature`, `basepath`, `contractAddress`): `string`
+
+Generates a URL for a dapp
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `message` | `object` | Message object to be encoded in the URL |
+| `signature` | `string` | Signature to be encoded in the URL |
+| `basepath` | `string` | Base path of the URL |
+| `contractAddress` | `string` | Address of the contract |
+
+#### Returns
+
+`string`
+
+The generated URL
+
+#### Overrides
+
+[MultipassBase](MultipassBase.md).[getDappURL](MultipassBase.md#getdappurl)