regenerate documentation

masa-finance · May 8, 2023 · 9648fe5 · 9648fe5
1 parent 6dee2c5
commit 9648fe5
Show file tree

Hide file tree

Showing 3 changed files with 105 additions and 0 deletions.
diff --git a/docs/SoulName.md b/docs/SoulName.md
@@ -116,6 +116,29 @@ function contractURI() external view returns (string)
 |---|---|---|
 | _0 | string | undefined |
 
+### defaultSoulName
+
+```solidity
+function defaultSoulName(address) external view returns (bool exists, uint256 tokenId)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| exists | bool | undefined |
+| tokenId | uint256 | undefined |
+
 ### exists
 
 ```solidity
@@ -177,6 +200,28 @@ function getApproved(uint256 tokenId) external view returns (address)
 |---|---|---|
 | _0 | address | undefined |
 
+### getDefaultSoulName
+
+```solidity
+function getDefaultSoulName(address owner) external view returns (string)
+```
+
+Returns the default soul name of an account
+
+*This function queries the default soul name of the specified account*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| owner | address | Address of the owner of the identities |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | string | Default soul name associated to the account |
+
 ### getExtension
 
 ```solidity
@@ -630,6 +675,22 @@ Sets the URI of the smart contract metadata
 |---|---|---|
 | _contractURI | string | URI of the smart contract metadata |
 
+### setDefaultSoulName
+
+```solidity
+function setDefaultSoulName(uint256 tokenId) external nonpayable
+```
+
+Sets the default soul name for the owner
+
+*The caller must be the owner of the soul name.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| tokenId | uint256 | TokenId of the soul name |
+
 ### setExtension
 
 ```solidity

diff --git a/docs/SoulboundIdentity.md b/docs/SoulboundIdentity.md
@@ -138,6 +138,28 @@ Returns true if the token exists
 |---|---|---|
 | _0 | bool | True if the token exists |
 
+### getDefaultSoulName
+
+```solidity
+function getDefaultSoulName(address owner) external view returns (string)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| owner | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | string | undefined |
+
 ### getExtension
 
 ```solidity

diff --git a/docs/interfaces/ISoulName.md b/docs/interfaces/ISoulName.md
@@ -10,6 +10,28 @@
 
 ## Methods
 
+### getDefaultSoulName
+
+```solidity
+function getDefaultSoulName(address owner) external view returns (string)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| owner | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | string | undefined |
+
 ### getExtension
 
 ```solidity