@peeramid-labs/sdk 2.0.1 → 2.0.2

package/docs/docs/interfaces/ApiErrorOptions.md

@@ -0,0 +1,30 @@
+# Interface: ApiErrorOptions
+
+## Hierarchy
+
+- `ErrorOptions`
+
+  ↳ **`ApiErrorOptions`**
+
+## Table of contents
+
+### Properties
+
+- [cause](ApiErrorOptions.md#cause)
+- [status](ApiErrorOptions.md#status)
+
+## Properties
+
+### cause
+
+• `Optional` **cause**: `unknown`
+
+#### Inherited from
+
+ErrorOptions.cause
+
+___
+
+### status
+
+• `Optional` **status**: `number`

package/docs/docs/interfaces/MAOInstanceContracts.md

@@ -0,0 +1,53 @@
+# Interface: MAOInstanceContracts
+
+Collection of contract instances for a MAO deployment
+
+## Table of contents
+
+### Properties
+
+- [rankToken](MAOInstanceContracts.md#ranktoken)
+- [instance](MAOInstanceContracts.md#instance)
+- [govtToken](MAOInstanceContracts.md#govttoken)
+- [govTokenAccessManager](MAOInstanceContracts.md#govtokenaccessmanager)
+- [ACIDAccessManager](MAOInstanceContracts.md#acidaccessmanager)
+
+## Properties
+
+### rankToken
+
+• **rankToken**: `Object`
+
+Rank token contract instance
+
+___
+
+### instance
+
+• **instance**: `Object`
+
+Main instance contract
+
+___
+
+### govtToken
+
+• **govtToken**: `Object`
+
+Governance token contract
+
+___
+
+### govTokenAccessManager
+
+• **govTokenAccessManager**: `Object`
+
+Access manager for governance token
+
+___
+
+### ACIDAccessManager
+
+• **ACIDAccessManager**: `Object`
+
+Access manager for ACID

package/docs/docs/interfaces/MAOInstances.md

@@ -0,0 +1,53 @@
+# Interface: MAOInstances
+
+Interface representing the contract addresses for a MAO instance
+
+## Table of contents
+
+### Properties
+
+- [govToken](MAOInstances.md#govtoken)
+- [govTokenAccessManager](MAOInstances.md#govtokenaccessmanager)
+- [ACIDInstance](MAOInstances.md#acidinstance)
+- [ACIDAccessManager](MAOInstances.md#acidaccessmanager)
+- [rankToken](MAOInstances.md#ranktoken)
+
+## Properties
+
+### govToken
+
+• **govToken**: `string`
+
+Address of the governance token contract
+
+___
+
+### govTokenAccessManager
+
+• **govTokenAccessManager**: `string`
+
+Address of the governance token access manager contract
+
+___
+
+### ACIDInstance
+
+• **ACIDInstance**: `string`
+
+Address of the ACID instance contract
+
+___
+
+### ACIDAccessManager
+
+• **ACIDAccessManager**: `string`
+
+Address of the ACID access manager contract
+
+___
+
+### rankToken
+
+• **rankToken**: `string`
+
+Address of the rank token contract

package/docs/docs/interfaces/RegisterMessage.md

@@ -0,0 +1,53 @@
+# Interface: RegisterMessage
+
+Message structure for user registration
+
+## Table of contents
+
+### Properties
+
+- [name](RegisterMessage.md#name)
+- [id](RegisterMessage.md#id)
+- [domainName](RegisterMessage.md#domainname)
+- [validUntil](RegisterMessage.md#validuntil)
+- [nonce](RegisterMessage.md#nonce)
+
+## Properties
+
+### name
+
+• **name**: \`0x$\{string}\`
+
+Hex encoded name
+
+___
+
+### id
+
+• **id**: \`0x$\{string}\`
+
+Hex encoded unique identifier
+
+___
+
+### domainName
+
+• **domainName**: \`0x$\{string}\`
+
+Hex encoded domain name
+
+___
+
+### validUntil
+
+• **validUntil**: `bigint`
+
+Timestamp until which the registration is valid
+
+___
+
+### nonce
+
+• **nonce**: `bigint`
+
+Registration nonce

package/docs/docs/interfaces/SignerIdentity.md

@@ -0,0 +1,35 @@
+# Interface: SignerIdentity
+
+Represents a signer's identity in the system
+
+## Table of contents
+
+### Properties
+
+- [name](SignerIdentity.md#name)
+- [id](SignerIdentity.md#id)
+- [wallet](SignerIdentity.md#wallet)
+
+## Properties
+
+### name
+
+• **name**: `string`
+
+User's display name
+
+___
+
+### id
+
+• **id**: `string`
+
+Unique identifier for the user
+
+___
+
+### wallet
+
+• **wallet**: `Object`
+
+Wallet client associated with the signer

package/docs/enums/SearchCriteria.md

@@ -0,0 +1,29 @@
+# Enumeration: SearchCriteria
+
+Criteria used for searching entities in the system
+
+## Table of contents
+
+### Enumeration Members
+
+- [id](SearchCriteria.md#id)
+- [username](SearchCriteria.md#username)
+- [address](SearchCriteria.md#address)
+
+## Enumeration Members
+
+### id
+
+• **id** = ``0``
+
+___
+
+### username
+
+• **username** = ``1``
+
+___
+
+### address
+
+• **address** = ``2``

package/docs/enums/gameStatusEnum.md

@@ -0,0 +1,71 @@
+# Enumeration: gameStatusEnum
+
+Enum representing different states of a game instance
+
+## Table of contents
+
+### Enumeration Members
+
+- [created](gameStatusEnum.md#created)
+- [open](gameStatusEnum.md#open)
+- [started](gameStatusEnum.md#started)
+- [lastTurn](gameStatusEnum.md#lastturn)
+- [overtime](gameStatusEnum.md#overtime)
+- [finished](gameStatusEnum.md#finished)
+- [notFound](gameStatusEnum.md#notfound)
+
+## Enumeration Members
+
+### created
+
+• **created** = ``"Game created"``
+
+Game has been created but not opened for registration
+
+___
+
+### open
+
+• **open** = ``"Registration open"``
+
+Game is open for player registration
+
+___
+
+### started
+
+• **started** = ``"In progress"``
+
+Game is in progress
+
+___
+
+### lastTurn
+
+• **lastTurn** = ``"Playing last turn"``
+
+Game is in its final turn
+
+___
+
+### overtime
+
+• **overtime** = ``"PLaying in overtime"``
+
+Game is in overtime
+
+___
+
+### finished
+
+• **finished** = ``"Finished"``
+
+Game has finished
+
+___
+
+### notFound
+
+• **notFound** = ``"not found"``
+
+Game was not found