Skip to content

docs: document the missing onlyBetweenPermitted modifier #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Dusk1e wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document the missing onlyBetweenPermitted modifier #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/devdocs/Solidity API/Permissioned.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,19 @@ Modifier that requires the provided signature to be signed by a specific owner a
| permission | struct Permission | Data structure containing the public key and the signature to be verified |
| owner | address | The expected owner of the public key to match against the recovered signer |

### onlyBetweenPermitted

```solidity
modifier onlyBetweenPermitted(struct Permission permission, address owner, address permitted)
```

Modifier that requires the provided signature to be signed by one of two specific addresses

#### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| permission | struct Permission | Data structure containing the public key and the signature to be verified |
| owner | address | The expected owner of the public key to match against the recovered signer |
| permitted | address | A second permitted owner of the public key to match against the recovered signer |

16 changes: 16 additions & 0 deletions versioned_docs/version-Helium/devdocs/Solidity API/Permissioned.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,19 @@ Modifier that requires the provided signature to be signed by a specific owner a
| permission | struct Permission | Data structure containing the public key and the signature to be verified |
| owner | address | The expected owner of the public key to match against the recovered signer |

### onlyBetweenPermitted

```solidity
modifier onlyBetweenPermitted(struct Permission permission, address owner, address permitted)
```

Modifier that requires the provided signature to be signed by one of two specific addresses

#### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| permission | struct Permission | Data structure containing the public key and the signature to be verified |
| owner | address | The expected owner of the public key to match against the recovered signer |
| permitted | address | A second permitted owner of the public key to match against the recovered signer |