regenerate documentation

masa-finance · May 4, 2023 · 4e9d709 · 4e9d709
1 parent fea4487
commit 4e9d709
Show file tree

Hide file tree

Showing 2 changed files with 94 additions and 0 deletions.
diff --git a/docs/SoulboundIdentity.md b/docs/SoulboundIdentity.md
@@ -484,6 +484,28 @@ function masaToken() external view returns (address)
 
 ### mint
 
+```solidity
+function mint(address to) external nonpayable returns (uint256)
+```
+
+Mints a new soulbound identity
+
+*The caller can only mint one identity per address*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| to | address | Address of the owner of the new identity |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | uint256 | The identity ID of the newly minted identity |
+
+### mint
+
 ```solidity
 function mint(address paymentMethod, address to) external nonpayable returns (uint256)
 ```
@@ -507,6 +529,31 @@ Mints a new soulbound identity
 
 ### mintIdentityWithName
 
+```solidity
+function mintIdentityWithName(address to, string name, uint256 yearsPeriod, string _tokenURI) external nonpayable returns (uint256)
+```
+
+Mints a new soulbound identity with a SoulName associated to it
+
+*The caller can only mint one identity per address, and the name must be unique*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| to | address | Address of the owner of the new identity |
+| name | string | Name of the new identity |
+| yearsPeriod | uint256 | Years of validity of the name |
+| _tokenURI | string | URI of the NFT |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | uint256 | undefined |
+
+### mintIdentityWithName
+
 ```solidity
 function mintIdentityWithName(address paymentMethod, address to, string name, uint256 yearsPeriod, string _tokenURI) external nonpayable returns (uint256)
 ```

diff --git a/docs/interfaces/ISoulboundIdentity.md b/docs/interfaces/ISoulboundIdentity.md
@@ -51,6 +51,28 @@ function getSoulName() external view returns (contract ISoulName)
 
 ### mint
 
+```solidity
+function mint(address to) external nonpayable returns (uint256)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| to | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | uint256 | undefined |
+
+### mint
+
 ```solidity
 function mint(address paymentMethod, address to) external nonpayable returns (uint256)
 ```
@@ -74,6 +96,31 @@ function mint(address paymentMethod, address to) external nonpayable returns (ui
 
 ### mintIdentityWithName
 
+```solidity
+function mintIdentityWithName(address to, string name, uint256 yearsPeriod, string _tokenURI) external nonpayable returns (uint256)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| to | address | undefined |
+| name | string | undefined |
+| yearsPeriod | uint256 | undefined |
+| _tokenURI | string | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | uint256 | undefined |
+
+### mintIdentityWithName
+
 ```solidity
 function mintIdentityWithName(address paymentMethod, address to, string name, uint256 yearsPeriod, string _tokenURI) external nonpayable returns (uint256)
 ```