Skip to content

Commit

Permalink
regenerate documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
miquelcabot committed Nov 14, 2022
1 parent 64360db commit 1197e38
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 56 deletions.
44 changes: 4 additions & 40 deletions docs/SoulName.md
Expand Up @@ -241,7 +241,7 @@ Returns all the active soul names of an account
### getTokenData

```solidity
function getTokenData(string name) external view returns (string sbtName, uint256 identityId, uint256 tokenId, uint256 expirationDate, bool active)
function getTokenData(string name) external view returns (string sbtName, bool linked, uint256 identityId, uint256 tokenId, uint256 expirationDate, bool active)
```

Returns the information of a soul name
Expand All @@ -259,6 +259,7 @@ Returns the information of a soul name
| Name | Type | Description |
|---|---|---|
| sbtName | string | Soul name, in upper/lower case and extension |
| linked | bool | `true` if the soul name is linked, `false` otherwise |
| identityId | uint256 | Identity id of the soul name |
| tokenId | uint256 | SoulName id of the soul name |
| expirationDate | uint256 | Expiration date of the soul name |
Expand Down Expand Up @@ -374,7 +375,7 @@ Checks if a soul name is available
### mint

```solidity
function mint(address to, string name, uint256 identityId, uint256 yearsPeriod, string _tokenURI) external nonpayable returns (uint256)
function mint(address to, string name, uint256 yearsPeriod, string _tokenURI) external nonpayable returns (uint256)
```

Mints a new soul name
Expand All @@ -387,7 +388,6 @@ Mints a new soul name
|---|---|---|
| to | address | Address of the owner of the new soul name |
| name | string | Name of the new soul name |
| identityId | uint256 | TokenId of the soulbound identity that will be pointed from this soul name |
| yearsPeriod | uint256 | Years of validity of the name |
| _tokenURI | string | URI of the NFT |

Expand Down Expand Up @@ -721,7 +721,7 @@ function tokenByIndex(uint256 index) external view returns (uint256)
### tokenData

```solidity
function tokenData(uint256) external view returns (string name, uint256 identityId, uint256 expirationDate)
function tokenData(uint256) external view returns (string name, uint256 expirationDate)
```


Expand All @@ -739,7 +739,6 @@ function tokenData(uint256) external view returns (string name, uint256 identity
| Name | Type | Description |
|---|---|---|
| name | string | undefined |
| identityId | uint256 | undefined |
| expirationDate | uint256 | undefined |

### tokenOfOwnerByIndex
Expand Down Expand Up @@ -860,23 +859,6 @@ function transferOwnership(address newOwner) external nonpayable
|---|---|---|
| newOwner | address | undefined |

### updateIdentityId

```solidity
function updateIdentityId(uint256 tokenId, uint256 identityId) external nonpayable
```

Update the identity id pointed from a soul name

*The caller must be the owner or an approved address of the soul name.*

#### Parameters

| Name | Type | Description |
|---|---|---|
| tokenId | uint256 | TokenId of the soul name |
| identityId | uint256 | New TokenId of the soulbound identity that will be pointed from this soul name |



## Events
Expand Down Expand Up @@ -917,24 +899,6 @@ event ApprovalForAll(address indexed owner, address indexed operator, bool appro
| operator `indexed` | address | undefined |
| approved | bool | undefined |

### IdentityIdUpdated

```solidity
event IdentityIdUpdated(uint256 tokenId, uint256 oldIdentityId, uint256 identityId)
```





#### Parameters

| Name | Type | Description |
|---|---|---|
| tokenId | uint256 | undefined |
| oldIdentityId | uint256 | undefined |
| identityId | uint256 | undefined |

### OwnershipTransferred

```solidity
Expand Down
3 changes: 2 additions & 1 deletion docs/SoulboundIdentity.md
Expand Up @@ -185,7 +185,7 @@ Returns all the active soul names of an account
### getTokenData

```solidity
function getTokenData(string name) external view returns (string sbtName, uint256 identityId, uint256 tokenId, uint256 expirationDate, bool active)
function getTokenData(string name) external view returns (string sbtName, bool linked, uint256 identityId, uint256 tokenId, uint256 expirationDate, bool active)
```

Returns the information of a soul name
Expand All @@ -203,6 +203,7 @@ Returns the information of a soul name
| Name | Type | Description |
|---|---|---|
| sbtName | string | Soul name, in upper/lower case and extension |
| linked | bool | `true` if the soul name is linked, `false` otherwise |
| identityId | uint256 | Identity id of the soul name |
| tokenId | uint256 | SoulName id id of the soul name |
| expirationDate | uint256 | Expiration date of the soul name |
Expand Down
12 changes: 0 additions & 12 deletions docs/console.md

This file was deleted.

6 changes: 3 additions & 3 deletions docs/interfaces/ISoulName.md
Expand Up @@ -74,7 +74,7 @@ function getSoulNames(address owner) external view returns (string[] sbtNames)
### getTokenData

```solidity
function getTokenData(string name) external view returns (string sbtName, uint256 identityId, uint256 tokenId, uint256 expirationDate, bool active)
function getTokenData(string name) external view returns (string sbtName, bool linked, uint256 identityId, uint256 tokenId, uint256 expirationDate, bool active)
```


Expand All @@ -92,6 +92,7 @@ function getTokenData(string name) external view returns (string sbtName, uint25
| Name | Type | Description |
|---|---|---|
| sbtName | string | undefined |
| linked | bool | undefined |
| identityId | uint256 | undefined |
| tokenId | uint256 | undefined |
| expirationDate | uint256 | undefined |
Expand Down Expand Up @@ -144,7 +145,7 @@ function isAvailable(string name) external view returns (bool available)
### mint

```solidity
function mint(address to, string name, uint256 identityId, uint256 yearsPeriod, string _tokenURI) external nonpayable returns (uint256)
function mint(address to, string name, uint256 yearsPeriod, string _tokenURI) external nonpayable returns (uint256)
```


Expand All @@ -157,7 +158,6 @@ function mint(address to, string name, uint256 identityId, uint256 yearsPeriod,
|---|---|---|
| to | address | undefined |
| name | string | undefined |
| identityId | uint256 | undefined |
| yearsPeriod | uint256 | undefined |
| _tokenURI | string | undefined |

Expand Down

0 comments on commit 1197e38

Please sign in to comment.