regenerate documentation

masa-finance · Jan 30, 2023 · d703b32 · d703b32
1 parent d25eef2
commit d703b32
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 22 deletions.
diff --git a/docs/Soulbound2FA.md b/docs/Soulbound2FA.md
@@ -255,7 +255,7 @@ Returns all available payment methods
 ### getIdentityId
 
 ```solidity
-function getIdentityId(uint256 tokenId) external view returns (uint256)
+function getIdentityId(uint256 tokenId) external view returns (uint256 identityId, bool exists)
 ```
 
 Returns the identityId owned by the given token
@@ -272,7 +272,8 @@ Returns the identityId owned by the given token
 
 | Name | Type | Description |
 |---|---|---|
-| _0 | uint256 | Id of the identity |
+| identityId | uint256 | Id of the identity |
+| exists | bool | True if the identity exists |
 
 ### getMintPrice
 
@@ -391,9 +392,9 @@ Mints a new SBT
 |---|---|---|
 | paymentMethod | address | Address of token that user want to pay |
 | identityId | uint256 | TokenId of the identity to mint the NFT to |
-| authorityAddress | address | undefined |
-| signatureDate | uint256 | undefined |
-| signature | bytes | undefined |
+| authorityAddress | address | Address of the authority that signed the message |
+| signatureDate | uint256 | Date of the signature |
+| signature | bytes | Signature of the message |
 
 #### Returns
 
@@ -417,9 +418,9 @@ Mints a new SBT
 |---|---|---|
 | paymentMethod | address | Address of token that user want to pay |
 | to | address | The address to mint the SBT to |
-| authorityAddress | address | undefined |
-| signatureDate | uint256 | undefined |
-| signature | bytes | undefined |
+| authorityAddress | address | Address of the authority that signed the message |
+| signatureDate | uint256 | Date of the signature |
+| signature | bytes | Signature of the message |
 
 #### Returns
 
@@ -1079,7 +1080,7 @@ event RoleRevoked(bytes32 indexed role, address indexed account, address indexed
 ### Soulbound2FAMinted
 
 ```solidity
-event Soulbound2FAMinted(uint256 tokenId, uint256 identityId, address authorityAddress, uint256 signatureDate, address paymentMethod, uint256 mintPrice)
+event Soulbound2FAMinted(uint256 tokenId, address to, address authorityAddress, uint256 signatureDate, address paymentMethod, uint256 mintPrice)
 ```
 
 
@@ -1091,7 +1092,7 @@ event Soulbound2FAMinted(uint256 tokenId, uint256 identityId, address authorityA
 | Name | Type | Description |
 |---|---|---|
 | tokenId  | uint256 | undefined |
-| identityId  | uint256 | undefined |
+| to  | address | undefined |
 | authorityAddress  | address | undefined |
 | signatureDate  | uint256 | undefined |
 | paymentMethod  | address | undefined |

diff --git a/docs/SoulboundCreditScore.md b/docs/SoulboundCreditScore.md
@@ -255,7 +255,7 @@ Returns all available payment methods
 ### getIdentityId
 
 ```solidity
-function getIdentityId(uint256 tokenId) external view returns (uint256)
+function getIdentityId(uint256 tokenId) external view returns (uint256 identityId, bool exists)
 ```
 
 Returns the identityId owned by the given token
@@ -272,7 +272,8 @@ Returns the identityId owned by the given token
 
 | Name | Type | Description |
 |---|---|---|
-| _0 | uint256 | Id of the identity |
+| identityId | uint256 | Id of the identity |
+| exists | bool | True if the identity exists |
 
 ### getMintPrice
 
@@ -391,9 +392,9 @@ Mints a new SBT
 |---|---|---|
 | paymentMethod | address | Address of token that user want to pay |
 | identityId | uint256 | TokenId of the identity to mint the NFT to |
-| authorityAddress | address | undefined |
-| signatureDate | uint256 | undefined |
-| signature | bytes | undefined |
+| authorityAddress | address | Address of the authority that signed the message |
+| signatureDate | uint256 | Date of the signature |
+| signature | bytes | Signature of the message |
 
 #### Returns
 
@@ -417,9 +418,9 @@ Mints a new SBT
 |---|---|---|
 | paymentMethod | address | Address of token that user want to pay |
 | to | address | The address to mint the SBT to |
-| authorityAddress | address | undefined |
-| signatureDate | uint256 | undefined |
-| signature | bytes | undefined |
+| authorityAddress | address | Address of the authority that signed the message |
+| signatureDate | uint256 | Date of the signature |
+| signature | bytes | Signature of the message |
 
 #### Returns
 
@@ -1079,7 +1080,7 @@ event RoleRevoked(bytes32 indexed role, address indexed account, address indexed
 ### SoulboundCreditScoreMinted
 
 ```solidity
-event SoulboundCreditScoreMinted(uint256 tokenId, uint256 identityId, address authorityAddress, uint256 signatureDate, address paymentMethod, uint256 mintPrice)
+event SoulboundCreditScoreMinted(uint256 tokenId, address to, address authorityAddress, uint256 signatureDate, address paymentMethod, uint256 mintPrice)
 ```
 
 
@@ -1091,7 +1092,7 @@ event SoulboundCreditScoreMinted(uint256 tokenId, uint256 identityId, address au
 | Name | Type | Description |
 |---|---|---|
 | tokenId  | uint256 | undefined |
-| identityId  | uint256 | undefined |
+| to  | address | undefined |
 | authorityAddress  | address | undefined |
 | signatureDate  | uint256 | undefined |
 | paymentMethod  | address | undefined |

diff --git a/docs/tokens/MasaSBTSelfSovereign.md b/docs/tokens/MasaSBTSelfSovereign.md
@@ -255,7 +255,7 @@ Returns all available payment methods
 ### getIdentityId
 
 ```solidity
-function getIdentityId(uint256 tokenId) external view returns (uint256)
+function getIdentityId(uint256 tokenId) external view returns (uint256 identityId, bool exists)
 ```
 
 Returns the identityId owned by the given token
@@ -272,7 +272,8 @@ Returns the identityId owned by the given token
 
 | Name | Type | Description |
 |---|---|---|
-| _0 | uint256 | Id of the identity |
+| identityId | uint256 | Id of the identity |
+| exists | bool | True if the identity exists |
 
 ### getMintPrice