Skip to content

Commit

Permalink
regenerate documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@miquelcabot
miquelcabot committed Dec 22, 2022
1 parent 6faf2da commit 86ec5ea
Show file tree
Hide file tree
Showing 9 changed files with 137 additions and 76 deletions.
73 changes: 73 additions & 0 deletions docs/SoulLinker.md
View file
Expand Up @@ -244,6 +244,29 @@ Returns the price for storing a link
|---|---|---|
| _0 | uint256 | Current price for storing a link |

### getPriceForQueryLink

```solidity
function getPriceForQueryLink(address paymentMethod, address token) external view returns (uint256)
```

Returns the price for querying a link

*Returns the current pricing for querying a link*

#### Parameters

| Name | Type | Description |
|---|---|---|
| paymentMethod | address | Address of token that user want to pay |
| token | address | Token that user want to query link |

#### Returns

| Name | Type | Description |
|---|---|---|
| _0 | uint256 | Current price for querying a link |

### getSBTConnections

```solidity
Expand Down Expand Up @@ -352,6 +375,35 @@ function paused() external view returns (bool)
|---|---|---|
| _0 | bool | undefined |

### queryLink

```solidity
function queryLink(address paymentMethod, uint256 readerIdentityId, uint256 ownerIdentityId, address token, uint256 tokenId, uint256 signatureDate, uint256 expirationDate, bytes signature) external payable returns (bool)
```

Validates a link signature, of a given read link request, without storing it

*The token must be linked to this soul linker*

#### Parameters

| Name | Type | Description |
|---|---|---|
| paymentMethod | address | undefined |
| readerIdentityId | uint256 | Id of the identity of the reader |
| ownerIdentityId | uint256 | Id of the identity of the owner of the SBT |
| token | address | Address of the SBT contract |
| tokenId | uint256 | Id of the token |
| signatureDate | uint256 | Signature date of the signature |
| expirationDate | uint256 | Expiration date of the signature |
| signature | bytes | Signature of the read link request made by the owner |

#### Returns

| Name | Type | Description |
|---|---|---|
| _0 | bool | True if the link is valid |

### renounceOwnership

```solidity
Expand Down Expand Up @@ -631,6 +683,27 @@ event LinkAdded(uint256 readerIdentityId, uint256 ownerIdentityId, address token



#### Parameters

| Name | Type | Description |
|---|---|---|
| readerIdentityId | uint256 | undefined |
| ownerIdentityId | uint256 | undefined |
| token | address | undefined |
| tokenId | uint256 | undefined |
| signatureDate | uint256 | undefined |
| expirationDate | uint256 | undefined |

### LinkQuery

```solidity
event LinkQuery(uint256 readerIdentityId, uint256 ownerIdentityId, address token, uint256 tokenId, uint256 signatureDate, uint256 expirationDate)
```





#### Parameters

| Name | Type | Description |
Expand Down
20 changes: 10 additions & 10 deletions docs/Soulbound2FA.md
View file
Expand Up @@ -517,10 +517,10 @@ function ownerOf(uint256 tokenId) external view returns (address)
|---|---|---|
| _0 | address | undefined |

### readDataPrice
### queryLinkPrice

```solidity
function readDataPrice() external view returns (uint256)
function queryLinkPrice() external view returns (uint256)
```


Expand All @@ -534,10 +534,10 @@ function readDataPrice() external view returns (uint256)
|---|---|---|
| _0 | uint256 | undefined |

### readDataPriceMASA
### queryLinkPriceMASA

```solidity
function readDataPriceMASA() external view returns (uint256)
function queryLinkPriceMASA() external view returns (uint256)
```


Expand Down Expand Up @@ -693,10 +693,10 @@ Sets the price of minting in MASA
|---|---|---|
| _mintPriceMASA | uint256 | New price of minting in MASA |

### setReadDataPrice
### setQueryLinkPrice

```solidity
function setReadDataPrice(uint256 _readDataPrice) external nonpayable
function setQueryLinkPrice(uint256 _queryLinkPrice) external nonpayable
```

Sets the price for reading data in SoulLinker in stable coin
Expand All @@ -707,12 +707,12 @@ Sets the price for reading data in SoulLinker in stable coin

| Name | Type | Description |
|---|---|---|
| _readDataPrice | uint256 | New price for reading data in SoulLinker in stable coin |
| _queryLinkPrice | uint256 | New price for reading data in SoulLinker in stable coin |

### setReadDataPriceMASA
### setQueryLinkPriceMASA

```solidity
function setReadDataPriceMASA(uint256 _readDataPriceMASA) external nonpayable
function setQueryLinkPriceMASA(uint256 _queryLinkPriceMASA) external nonpayable
```

Sets the price for reading data in SoulLinker in MASA
Expand All @@ -723,7 +723,7 @@ Sets the price for reading data in SoulLinker in MASA

| Name | Type | Description |
|---|---|---|
| _readDataPriceMASA | uint256 | New price for reading data in SoulLinker in MASA |
| _queryLinkPriceMASA | uint256 | New price for reading data in SoulLinker in MASA |

### setReserveWallet

Expand Down
20 changes: 10 additions & 10 deletions docs/SoulboundCreditScore.md
View file
Expand Up @@ -517,10 +517,10 @@ function ownerOf(uint256 tokenId) external view returns (address)
|---|---|---|
| _0 | address | undefined |

### readDataPrice
### queryLinkPrice

```solidity
function readDataPrice() external view returns (uint256)
function queryLinkPrice() external view returns (uint256)
```


Expand All @@ -534,10 +534,10 @@ function readDataPrice() external view returns (uint256)
|---|---|---|
| _0 | uint256 | undefined |

### readDataPriceMASA
### queryLinkPriceMASA

```solidity
function readDataPriceMASA() external view returns (uint256)
function queryLinkPriceMASA() external view returns (uint256)
```


Expand Down Expand Up @@ -693,10 +693,10 @@ Sets the price of minting in MASA
|---|---|---|
| _mintPriceMASA | uint256 | New price of minting in MASA |

### setReadDataPrice
### setQueryLinkPrice

```solidity
function setReadDataPrice(uint256 _readDataPrice) external nonpayable
function setQueryLinkPrice(uint256 _queryLinkPrice) external nonpayable
```

Sets the price for reading data in SoulLinker in stable coin
Expand All @@ -707,12 +707,12 @@ Sets the price for reading data in SoulLinker in stable coin

| Name | Type | Description |
|---|---|---|
| _readDataPrice | uint256 | New price for reading data in SoulLinker in stable coin |
| _queryLinkPrice | uint256 | New price for reading data in SoulLinker in stable coin |

### setReadDataPriceMASA
### setQueryLinkPriceMASA

```solidity
function setReadDataPriceMASA(uint256 _readDataPriceMASA) external nonpayable
function setQueryLinkPriceMASA(uint256 _queryLinkPriceMASA) external nonpayable
```

Sets the price for reading data in SoulLinker in MASA
Expand All @@ -723,7 +723,7 @@ Sets the price for reading data in SoulLinker in MASA

| Name | Type | Description |
|---|---|---|
| _readDataPriceMASA | uint256 | New price for reading data in SoulLinker in MASA |
| _queryLinkPriceMASA | uint256 | New price for reading data in SoulLinker in MASA |

### setReserveWallet

Expand Down
20 changes: 10 additions & 10 deletions docs/SoulboundIdentity.md
View file
Expand Up @@ -435,10 +435,10 @@ Returns the owner address of a soul name
|---|---|---|
| _0 | address | Address of the owner of the identity |

### readDataPrice
### queryLinkPrice

```solidity
function readDataPrice() external view returns (uint256)
function queryLinkPrice() external view returns (uint256)
```


Expand All @@ -452,10 +452,10 @@ function readDataPrice() external view returns (uint256)
|---|---|---|
| _0 | uint256 | undefined |

### readDataPriceMASA
### queryLinkPriceMASA

```solidity
function readDataPriceMASA() external view returns (uint256)
function queryLinkPriceMASA() external view returns (uint256)
```


Expand Down Expand Up @@ -535,10 +535,10 @@ Sets the price for adding the link in SoulLinker in MASA
|---|---|---|
| _addLinkPriceMASA | uint256 | New price for adding the link in SoulLinker in MASA |

### setReadDataPrice
### setQueryLinkPrice

```solidity
function setReadDataPrice(uint256 _readDataPrice) external nonpayable
function setQueryLinkPrice(uint256 _queryLinkPrice) external nonpayable
```

Sets the price for reading data in SoulLinker in stable coin
Expand All @@ -549,12 +549,12 @@ Sets the price for reading data in SoulLinker in stable coin

| Name | Type | Description |
|---|---|---|
| _readDataPrice | uint256 | New price for reading data in SoulLinker in stable coin |
| _queryLinkPrice | uint256 | New price for reading data in SoulLinker in stable coin |

### setReadDataPriceMASA
### setQueryLinkPriceMASA

```solidity
function setReadDataPriceMASA(uint256 _readDataPriceMASA) external nonpayable
function setQueryLinkPriceMASA(uint256 _queryLinkPriceMASA) external nonpayable
```

Sets the price for reading data in SoulLinker in MASA
Expand All @@ -565,7 +565,7 @@ Sets the price for reading data in SoulLinker in MASA

| Name | Type | Description |
|---|---|---|
| _readDataPriceMASA | uint256 | New price for reading data in SoulLinker in MASA |
| _queryLinkPriceMASA | uint256 | New price for reading data in SoulLinker in MASA |

### setSoulName

Expand Down
12 changes: 0 additions & 12 deletions docs/console.md
View file

This file was deleted.

8 changes: 4 additions & 4 deletions docs/interfaces/ILinkableSBT.md
View file
Expand Up @@ -88,10 +88,10 @@ Find the owner of an SBT
|---|---|---|
| _0 | address | The address of the owner of the SBT |

### readDataPrice
### queryLinkPrice

```solidity
function readDataPrice() external view returns (uint256)
function queryLinkPrice() external view returns (uint256)
```


Expand All @@ -105,10 +105,10 @@ function readDataPrice() external view returns (uint256)
|---|---|---|
| _0 | uint256 | undefined |

### readDataPriceMASA
### queryLinkPriceMASA

```solidity
function readDataPriceMASA() external view returns (uint256)
function queryLinkPriceMASA() external view returns (uint256)
```


Expand Down
20 changes: 10 additions & 10 deletions docs/tokens/MasaSBT.md
View file
Expand Up @@ -222,10 +222,10 @@ function ownerOf(uint256 tokenId) external view returns (address)
|---|---|---|
| _0 | address | undefined |

### readDataPrice
### queryLinkPrice

```solidity
function readDataPrice() external view returns (uint256)
function queryLinkPrice() external view returns (uint256)
```


Expand All @@ -239,10 +239,10 @@ function readDataPrice() external view returns (uint256)
|---|---|---|
| _0 | uint256 | undefined |

### readDataPriceMASA
### queryLinkPriceMASA

```solidity
function readDataPriceMASA() external view returns (uint256)
function queryLinkPriceMASA() external view returns (uint256)
```


Expand Down Expand Up @@ -322,10 +322,10 @@ Sets the price for adding the link in SoulLinker in MASA
|---|---|---|
| _addLinkPriceMASA | uint256 | New price for adding the link in SoulLinker in MASA |

### setReadDataPrice
### setQueryLinkPrice

```solidity
function setReadDataPrice(uint256 _readDataPrice) external nonpayable
function setQueryLinkPrice(uint256 _queryLinkPrice) external nonpayable
```

Sets the price for reading data in SoulLinker in stable coin
Expand All @@ -336,12 +336,12 @@ Sets the price for reading data in SoulLinker in stable coin

| Name | Type | Description |
|---|---|---|
| _readDataPrice | uint256 | New price for reading data in SoulLinker in stable coin |
| _queryLinkPrice | uint256 | New price for reading data in SoulLinker in stable coin |

### setReadDataPriceMASA
### setQueryLinkPriceMASA

```solidity
function setReadDataPriceMASA(uint256 _readDataPriceMASA) external nonpayable
function setQueryLinkPriceMASA(uint256 _queryLinkPriceMASA) external nonpayable
```

Sets the price for reading data in SoulLinker in MASA
Expand All @@ -352,7 +352,7 @@ Sets the price for reading data in SoulLinker in MASA

| Name | Type | Description |
|---|---|---|
| _readDataPriceMASA | uint256 | New price for reading data in SoulLinker in MASA |
| _queryLinkPriceMASA | uint256 | New price for reading data in SoulLinker in MASA |

### supportsInterface

Expand Down

0 comments on commit 86ec5ea

Please sign in to comment.