@peeramid-labs/sdk 2.0.0 → 2.0.2

package/docs/classes/MultipassBase.md

@@ -0,0 +1,217 @@
+# Class: MultipassBase
+
+Base class for Multipass functionality
+
+## Hierarchy
+
+- **`MultipassBase`**
+
+  ↳ [`Multipass`](Multipass.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](MultipassBase.md#constructor)
+
+### Properties
+
+- [chainId](MultipassBase.md#chainid)
+
+### Methods
+
+- [getDappURL](MultipassBase.md#getdappurl)
+- [getRegistrarMessage](MultipassBase.md#getregistrarmessage)
+- [formQueryByAddress](MultipassBase.md#formquerybyaddress)
+- [formQueryById](MultipassBase.md#formquerybyid)
+- [formQueryByUsername](MultipassBase.md#formquerybyusername)
+- [formQueryByUsernameAndId](MultipassBase.md#formquerybyusernameandid)
+- [formQueryByFullDetails](MultipassBase.md#formquerybyfulldetails)
+
+## Constructors
+
+### constructor
+
+• **new MultipassBase**(`params`): [`MultipassBase`](MultipassBase.md)
+
+Creates a new MultipassBase instance
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `params` | `Object` | Constructor parameters |
+| `params.chainId` | `number` | ID of the blockchain network |
+
+#### Returns
+
+[`MultipassBase`](MultipassBase.md)
+
+## Properties
+
+### chainId
+
+• **chainId**: `number`
+
+Chain ID for the network
+
+## Methods
+
+### 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
+
+___
+
+### 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)
+
+___
+
+### 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
+
+___
+
+### 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
+
+___
+
+### 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
+
+___
+
+### 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
+
+___
+
+### 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

package/docs/docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/docs/docs/classes/ApiError.md

@@ -0,0 +1,44 @@
+# Class: ApiError
+
+## Hierarchy
+
+- `Error`
+
+  ↳ **`ApiError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](ApiError.md#constructor)
+
+### Properties
+
+- [status](ApiError.md#status)
+
+## Constructors
+
+### constructor
+
+• **new ApiError**(`message`, `options?`): [`ApiError`](ApiError.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `message` | `string` |
+| `options?` | [`ApiErrorOptions`](../interfaces/ApiErrorOptions.md) |
+
+#### Returns
+
+[`ApiError`](ApiError.md)
+
+#### Overrides
+
+Error.constructor
+
+## Properties
+
+### status
+
+• **status**: `undefined` \| `number`