regenerate documentation

masa-finance · May 4, 2023 · 5a0b6c2 · 5a0b6c2
1 parent 9aba0f5
commit 5a0b6c2
Show file tree

Hide file tree

Showing 11 changed files with 308 additions and 0 deletions.
diff --git a/docs/SoulLinker.md b/docs/SoulLinker.md
@@ -21,6 +21,23 @@ function DEFAULT_ADMIN_ROLE() external view returns (bytes32)
 
 
 
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes32 | undefined |
+
+### PROJECT_ADMIN_ROLE
+
+```solidity
+function PROJECT_ADMIN_ROLE() external view returns (bytes32)
+```
+
+
+
+
+
+
 #### Returns
 
 | Name | Type | Description |
@@ -1228,6 +1245,17 @@ error TransferFailed()
 
 
 
+### UserMustHaveProtocolOrProjectAdminRole
+
+```solidity
+error UserMustHaveProtocolOrProjectAdminRole()
+```
+
+
+
+
+
+
 ### ValidPeriodExpired
 
 ```solidity

diff --git a/docs/SoulStore.md b/docs/SoulStore.md
@@ -21,6 +21,23 @@ function DEFAULT_ADMIN_ROLE() external view returns (bytes32)
 
 
 
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes32 | undefined |
+
+### PROJECT_ADMIN_ROLE
+
+```solidity
+function PROJECT_ADMIN_ROLE() external view returns (bytes32)
+```
+
+
+
+
+
+
 #### Returns
 
 | Name | Type | Description |
@@ -1132,6 +1149,17 @@ error TransferFailed()
 
 
 
+### UserMustHaveProtocolOrProjectAdminRole
+
+```solidity
+error UserMustHaveProtocolOrProjectAdminRole()
+```
+
+
+
+
+
+
 ### ZeroAddress
 
 ```solidity

diff --git a/docs/SoulboundCreditScore.md b/docs/SoulboundCreditScore.md
@@ -21,6 +21,23 @@ function DEFAULT_ADMIN_ROLE() external view returns (bytes32)
 
 
 
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes32 | undefined |
+
+### PROJECT_ADMIN_ROLE
+
+```solidity
+function PROJECT_ADMIN_ROLE() external view returns (bytes32)
+```
+
+
+
+
+
+
 #### Returns
 
 | Name | Type | Description |
@@ -1438,6 +1455,17 @@ error TransferFailed()
 
 
 
+### UserMustHaveProtocolOrProjectAdminRole
+
+```solidity
+error UserMustHaveProtocolOrProjectAdminRole()
+```
+
+
+
+
+
+
 ### ZeroAddress
 
 ```solidity

diff --git a/docs/SoulboundGreen.md b/docs/SoulboundGreen.md
@@ -21,6 +21,23 @@ function DEFAULT_ADMIN_ROLE() external view returns (bytes32)
 
 
 
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes32 | undefined |
+
+### PROJECT_ADMIN_ROLE
+
+```solidity
+function PROJECT_ADMIN_ROLE() external view returns (bytes32)
+```
+
+
+
+
+
+
 #### Returns
 
 | Name | Type | Description |
@@ -1422,6 +1439,17 @@ error TransferFailed()
 
 
 
+### UserMustHaveProtocolOrProjectAdminRole
+
+```solidity
+error UserMustHaveProtocolOrProjectAdminRole()
+```
+
+
+
+
+
+
 ### ZeroAddress
 
 ```solidity

diff --git a/docs/SoulboundIdentity.md b/docs/SoulboundIdentity.md
@@ -38,6 +38,23 @@ function MINTER_ROLE() external view returns (bytes32)
 
 
 
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes32 | undefined |
+
+### PROJECT_ADMIN_ROLE
+
+```solidity
+function PROJECT_ADMIN_ROLE() external view returns (bytes32)
+```
+
+
+
+
+
+
 #### Returns
 
 | Name | Type | Description |
@@ -1603,6 +1620,17 @@ error TransferFailed()
 
 
 
+### UserMustHaveProtocolOrProjectAdminRole
+
+```solidity
+error UserMustHaveProtocolOrProjectAdminRole()
+```
+
+
+
+
+
+
 ### ZeroAddress
 
 ```solidity

diff --git a/docs/dex/PaymentGateway.md b/docs/dex/PaymentGateway.md
@@ -21,6 +21,23 @@ function DEFAULT_ADMIN_ROLE() external view returns (bytes32)
 
 
 
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes32 | undefined |
+
+### PROJECT_ADMIN_ROLE
+
+```solidity
+function PROJECT_ADMIN_ROLE() external view returns (bytes32)
+```
+
+
+
+
+
+
 #### Returns
 
 | Name | Type | Description |
@@ -602,4 +619,15 @@ error SameValue()
 
 
 
+### UserMustHaveProtocolOrProjectAdminRole
+
+```solidity
+error UserMustHaveProtocolOrProjectAdminRole()
+```
+
+
+
+
+
+
 
diff --git a/docs/reference/ReferenceSBTAuthority.md b/docs/reference/ReferenceSBTAuthority.md
@@ -38,6 +38,23 @@ function MINTER_ROLE() external view returns (bytes32)
 
 
 
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes32 | undefined |
+
+### PROJECT_ADMIN_ROLE
+
+```solidity
+function PROJECT_ADMIN_ROLE() external view returns (bytes32)
+```
+
+
+
+
+
+
 #### Returns
 
 | Name | Type | Description |
@@ -1328,4 +1345,15 @@ error TransferFailed()
 
 
 
+### UserMustHaveProtocolOrProjectAdminRole
+
+```solidity
+error UserMustHaveProtocolOrProjectAdminRole()
+```
+
+
+
+
+
+
 
diff --git a/docs/reference/ReferenceSBTSelfSovereign.md b/docs/reference/ReferenceSBTSelfSovereign.md
@@ -21,6 +21,23 @@ function DEFAULT_ADMIN_ROLE() external view returns (bytes32)
 
 
 
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes32 | undefined |
+
+### PROJECT_ADMIN_ROLE
+
+```solidity
+function PROJECT_ADMIN_ROLE() external view returns (bytes32)
+```
+
+
+
+
+
+
 #### Returns
 
 | Name | Type | Description |
@@ -1438,6 +1455,17 @@ error TransferFailed()
 
 
 
+### UserMustHaveProtocolOrProjectAdminRole
+
+```solidity
+error UserMustHaveProtocolOrProjectAdminRole()
+```
+
+
+
+
+
+
 ### ZeroAddress
 
 ```solidity

diff --git a/docs/tokens/MasaSBT.md b/docs/tokens/MasaSBT.md
@@ -21,6 +21,23 @@ function DEFAULT_ADMIN_ROLE() external view returns (bytes32)
 
 
 
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | bytes32 | undefined |
+
+### PROJECT_ADMIN_ROLE
+
+```solidity
+function PROJECT_ADMIN_ROLE() external view returns (bytes32)
+```
+
+
+
+
+
+
 #### Returns
 
 | Name | Type | Description |
@@ -1166,4 +1183,15 @@ error SameValue()
 
 
 
+### UserMustHaveProtocolOrProjectAdminRole
+
+```solidity
+error UserMustHaveProtocolOrProjectAdminRole()
+```
+
+
+
+
+
+