Skip to content

Commit 6563189

Browse files
andreivladbrgsmol-ninja
andreivladbrg
and
smol-ninja
authored
fix: reference PR fixes (#403)
* fix: reference PR fixes * polish docs --------- Co-authored-by: smol-ninja <[email protected]>
1 parent ccab2f1 commit 6563189

27 files changed

+276
-261
lines changed

‎docs/reference/airdrops/contracts/abstracts/abstract.Adminable.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**Inherits:** [IAdminable](/reference/airdrops/contracts/interfaces/interface.IAdminable.md)
66

7-
See the documentation in {IAdminable}.
7+
See the documentation in [IAdminable](/reference/airdrops/contracts/interfaces/interface.IAdminable.md).
88

99
## State Variables
1010

@@ -28,7 +28,7 @@ modifier onlyAdmin();
2828

2929
### constructor
3030

31-
_Emits a {TransferAdmin} event._
31+
Emits a {TransferAdmin} event.
3232

3333
```solidity
3434
constructor(address initialAdmin);

‎docs/reference/airdrops/contracts/abstracts/abstract.Comptrollerable.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ function setComptroller(ISablierComptroller newComptroller) external override on
6767

6868
Transfers the fees to the comptroller contract.
6969

70-
_Emits a {TransferFeesToComptroller} event._
70+
Emits a {TransferFeesToComptroller} event.
7171

7272
```solidity
7373
function transferFeesToComptroller() external override;

‎docs/reference/airdrops/contracts/abstracts/abstract.SablierFactoryMerkleBase.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ address public override nativeToken;
2929
### constructor
3030

3131
```solidity
32-
constructor(address initialComptroller) [Comptrollerable](/docs/reference/airdrops/contracts/abstracts/abstract.Comptrollerable.md)(initialComptroller);
32+
constructor(address initialComptroller) Comptrollerable(initialComptroller);
3333
```
3434

3535
**Parameters**

‎docs/reference/airdrops/contracts/abstracts/abstract.SablierMerkleBase.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,7 @@ constructor(
155155
string memory ipfsCID_,
156156
bytes32 merkleRoot,
157157
IERC20 token
158-
)
159-
[Adminable](/docs/reference/airdrops/contracts/abstracts/abstract.Adminable.md)(initialAdmin);
158+
) Adminable(initialAdmin)
160159
```
161160

162161
### calculateMinFeeWei

‎docs/reference/airdrops/contracts/contract.SablierMerkleInstant.md‎

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -117,33 +117,35 @@ It emits a {ClaimInstant} event. Requirements:
117117
referenced from https://docs.metamask.io/wallet/how-to/sign-data/#example.
118118

119119
```json
120-
types: {
121-
EIP712Domain: [
122-
{ name: "name", type: "string" },
123-
{ name: "chainId", type: "uint256" },
124-
{ name: "verifyingContract", type: "address" },
125-
],
126-
Claim: [
127-
{ name: "index", type: "uint256" },
128-
{ name: "recipient", type: "address" },
129-
{ name: "to", type: "address" },
130-
{ name: "amount", type: "uint128" },
131-
{ name: "validFrom", type: "uint40" },
132-
],
133-
},
134-
domain: {
135-
name: "Sablier Airdrops Protocol",
136-
chainId: 1, // Chain on which the contract is deployed
137-
verifyingContract: "0xTheAddressOfThisContract", // The address of this contract
138-
},
139-
primaryType: "Claim",
140-
message: {
141-
index: 2, // The index of the signer in the Merkle tree
142-
recipient: "0xTheAddressOfTheRecipient", // The address of the airdrop recipient
143-
to: "0xTheAddressReceivingTheTokens", // The address where recipient wants to transfer the tokens
144-
amount: "1000000000000000000000", // The amount of tokens allocated to the recipient
145-
validFrom: 1752425637 // The timestamp from which the claim signature is valid
146-
},
120+
{
121+
"types": {
122+
"EIP712Domain": [
123+
{ "name": "name", "type": "string" },
124+
{ "name": "chainId", "type": "uint256" },
125+
{ "name": "verifyingContract", "type": "address" }
126+
],
127+
"Claim": [
128+
{ "name": "index", "type": "uint256" },
129+
{ "name": "recipient", "type": "address" },
130+
{ "name": "to", "type": "address" },
131+
{ "name": "amount", "type": "uint128" },
132+
{ "name": "validFrom", "type": "uint40" }
133+
]
134+
},
135+
"domain": {
136+
"name": "Sablier Airdrops Protocol",
137+
"chainId": 1,
138+
"verifyingContract": "0xTheAddressOfThisContract"
139+
},
140+
"primaryType": "Claim",
141+
"message": {
142+
"index": 2,
143+
"recipient": "0xTheAddressOfTheRecipient",
144+
"to": "0xTheAddressReceivingTheTokens",
145+
"amount": "1000000000000000000000",
146+
"validFrom": 1752425637
147+
}
148+
}
147149
```
148150

149151
```solidity

‎docs/reference/airdrops/contracts/contract.SablierMerkleLL.md‎

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -169,33 +169,35 @@ It emits either {ClaimLLWithTransfer} or {ClaimLLWithVesting} event. Requirement
169169
referenced from https://docs.metamask.io/wallet/how-to/sign-data/#example.
170170

171171
```json
172-
types: {
173-
EIP712Domain: [
174-
{ name: "name", type: "string" },
175-
{ name: "chainId", type: "uint256" },
176-
{ name: "verifyingContract", type: "address" },
177-
],
178-
Claim: [
179-
{ name: "index", type: "uint256" },
180-
{ name: "recipient", type: "address" },
181-
{ name: "to", type: "address" },
182-
{ name: "amount", type: "uint128" },
183-
{ name: "validFrom", type: "uint40" },
184-
],
185-
},
186-
domain: {
187-
name: "Sablier Airdrops Protocol",
188-
chainId: 1, // Chain on which the contract is deployed
189-
verifyingContract: "0xTheAddressOfThisContract", // The address of this contract
190-
},
191-
primaryType: "Claim",
192-
message: {
193-
index: 2, // The index of the signer in the Merkle tree
194-
recipient: "0xTheAddressOfTheRecipient", // The address of the airdrop recipient
195-
to: "0xTheAddressReceivingTheTokens", // The address where recipient wants to transfer the tokens
196-
amount: "1000000000000000000000", // The amount of tokens allocated to the recipient
197-
validFrom: 1752425637 // The timestamp from which the claim signature is valid
198-
},
172+
{
173+
"types": {
174+
"EIP712Domain": [
175+
{ "name": "name", "type": "string" },
176+
{ "name": "chainId", "type": "uint256" },
177+
{ "name": "verifyingContract", "type": "address" }
178+
],
179+
"Claim": [
180+
{ "name": "index", "type": "uint256" },
181+
{ "name": "recipient", "type": "address" },
182+
{ "name": "to", "type": "address" },
183+
{ "name": "amount", "type": "uint128" },
184+
{ "name": "validFrom", "type": "uint40" }
185+
]
186+
},
187+
"domain": {
188+
"name": "Sablier Airdrops Protocol",
189+
"chainId": 1,
190+
"verifyingContract": "0xTheAddressOfThisContract"
191+
},
192+
"primaryType": "Claim",
193+
"message": {
194+
"index": 2,
195+
"recipient": "0xTheAddressOfTheRecipient",
196+
"to": "0xTheAddressReceivingTheTokens",
197+
"amount": "1000000000000000000000",
198+
"validFrom": 1752425637
199+
}
200+
}
199201
```
200202

201203
```solidity

‎docs/reference/airdrops/contracts/contract.SablierMerkleLT.md‎

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -151,33 +151,35 @@ It emits either {ClaimLTWithTransfer} or {ClaimLTWithVesting} event. Requirement
151151
referenced from https://docs.metamask.io/wallet/how-to/sign-data/#example.
152152

153153
```json
154-
types: {
155-
EIP712Domain: [
156-
{ name: "name", type: "string" },
157-
{ name: "chainId", type: "uint256" },
158-
{ name: "verifyingContract", type: "address" },
159-
],
160-
Claim: [
161-
{ name: "index", type: "uint256" },
162-
{ name: "recipient", type: "address" },
163-
{ name: "to", type: "address" },
164-
{ name: "amount", type: "uint128" },
165-
{ name: "validFrom", type: "uint40" },
166-
],
167-
},
168-
domain: {
169-
name: "Sablier Airdrops Protocol",
170-
chainId: 1, // Chain on which the contract is deployed
171-
verifyingContract: "0xTheAddressOfThisContract", // The address of this contract
172-
},
173-
primaryType: "Claim",
174-
message: {
175-
index: 2, // The index of the signer in the Merkle tree
176-
recipient: "0xTheAddressOfTheRecipient", // The address of the airdrop recipient
177-
to: "0xTheAddressReceivingTheTokens", // The address where recipient wants to transfer the tokens
178-
amount: "1000000000000000000000", // The amount of tokens allocated to the recipient
179-
validFrom: 1752425637 // The timestamp from which the claim signature is valid
180-
},
154+
{
155+
"types": {
156+
"EIP712Domain": [
157+
{ "name": "name", "type": "string" },
158+
{ "name": "chainId", "type": "uint256" },
159+
{ "name": "verifyingContract", "type": "address" }
160+
],
161+
"Claim": [
162+
{ "name": "index", "type": "uint256" },
163+
{ "name": "recipient", "type": "address" },
164+
{ "name": "to", "type": "address" },
165+
{ "name": "amount", "type": "uint128" },
166+
{ "name": "validFrom", "type": "uint40" }
167+
]
168+
},
169+
"domain": {
170+
"name": "Sablier Airdrops Protocol",
171+
"chainId": 1,
172+
"verifyingContract": "0xTheAddressOfThisContract"
173+
},
174+
"primaryType": "Claim",
175+
"message": {
176+
"index": 2,
177+
"recipient": "0xTheAddressOfTheRecipient",
178+
"to": "0xTheAddressReceivingTheTokens",
179+
"amount": "1000000000000000000000",
180+
"validFrom": 1752425637
181+
}
182+
}
181183
```
182184

183185
```solidity

‎docs/reference/airdrops/contracts/contract.SablierMerkleVCA.md‎

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -173,33 +173,35 @@ It emits a {ClaimVCA} event. Requirements:
173173
https://docs.metamask.io/wallet/how-to/sign-data/#example.
174174

175175
```json
176-
types: {
177-
EIP712Domain: [
178-
{ name: "name", type: "string" },
179-
{ name: "chainId", type: "uint256" },
180-
{ name: "verifyingContract", type: "address" },
181-
],
182-
Claim: [
183-
{ name: "index", type: "uint256" },
184-
{ name: "recipient", type: "address" },
185-
{ name: "to", type: "address" },
186-
{ name: "amount", type: "uint128" },
187-
{ name: "validFrom", type: "uint40" },
188-
],
189-
},
190-
domain: {
191-
name: "Sablier Airdrops Protocol",
192-
chainId: 1, // Chain on which the contract is deployed
193-
verifyingContract: "0xTheAddressOfThisContract", // The address of this contract
194-
},
195-
primaryType: "Claim",
196-
message: {
197-
index: 2, // The index of the signer in the Merkle tree
198-
recipient: "0xTheAddressOfTheRecipient", // The address of the airdrop recipient
199-
to: "0xTheAddressReceivingTheTokens", // The address where recipient wants to transfer the tokens
200-
amount: "1000000000000000000000", // The amount of tokens allocated to the recipient
201-
validFrom: 1752425637 // The timestamp from which the claim signature is valid
202-
},
176+
{
177+
"types": {
178+
"EIP712Domain": [
179+
{ "name": "name", "type": "string" },
180+
{ "name": "chainId", "type": "uint256" },
181+
{ "name": "verifyingContract", "type": "address" }
182+
],
183+
"Claim": [
184+
{ "name": "index", "type": "uint256" },
185+
{ "name": "recipient", "type": "address" },
186+
{ "name": "to", "type": "address" },
187+
{ "name": "amount", "type": "uint128" },
188+
{ "name": "validFrom", "type": "uint40" }
189+
]
190+
},
191+
"domain": {
192+
"name": "Sablier Airdrops Protocol",
193+
"chainId": 1,
194+
"verifyingContract": "0xTheAddressOfThisContract"
195+
},
196+
"primaryType": "Claim",
197+
"message": {
198+
"index": 2,
199+
"recipient": "0xTheAddressOfTheRecipient",
200+
"to": "0xTheAddressReceivingTheTokens",
201+
"amount": "1000000000000000000000",
202+
"validFrom": 1752425637
203+
}
204+
}
203205
```
204206

205207
```solidity

‎docs/reference/airdrops/contracts/interfaces/interface.IComptrollerable.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ function comptroller() external view returns (ISablierComptroller);
1818

1919
Sets the comptroller to a new address.
2020

21-
_Emits a {SetComptroller} event. Requirements:_
21+
Emits a [SetComptroller](#setcomptroller-1) event. Requirements:
2222

2323
- `msg.sender` must be the current comptroller.
2424
- The new comptroller must return `true` from {supportsInterface} with the comptroller's minimal interface ID which is
@@ -43,7 +43,7 @@ function setComptroller(ISablierComptroller newComptroller) external;
4343

4444
Transfers the fees to the comptroller contract.
4545

46-
_Emits a TransferFeesToComptroller event._
46+
Emits a [TransferFeesToComptroller](#transferfeestocomptroller-1) event.\_
4747

4848
```solidity
4949
function transferFeesToComptroller() external;

‎docs/reference/airdrops/contracts/interfaces/interface.ISablierFactoryMerkleInstant.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ function computeMerkleInstant(
3636
Creates a new MerkleInstant campaign for instant distribution of tokens.
3737

3838
Emits a
39-
[CreateMerkleInstant](/docs/reference/airdrops/contracts/interfaces/interface.ISablierFactoryMerkleInstant.md#createmerkleinstant)
39+
[CreateMerkleInstant](/docs/reference/airdrops/contracts/interfaces/interface.ISablierFactoryMerkleInstant.md#createmerkleinstant-1)
4040
event. Notes:
4141

4242
- The contract is created with CREATE2.
@@ -56,11 +56,11 @@ function createMerkleInstant(
5656

5757
**Parameters**
5858

59-
| Name | Type | Description |
60-
| ----------------- | --------------------------------- | ------------------------------------------------------------------------------- |
61-
| `params` | `MerkleInstant.ConstructorParams` | Struct encapsulating the input parameters, which are documented in {DataTypes}. |
62-
| `aggregateAmount` | `uint256` | The total amount of ERC-20 tokens to be distributed to all recipients. |
63-
| `recipientCount` | `uint256` | The total number of recipient addresses eligible for the airdrop. |
59+
| Name | Type | Description |
60+
| ----------------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
61+
| `params` | `MerkleInstant.ConstructorParams` | Struct encapsulating the input parameters, which are documented in [DataTypes](/docs/reference/airdrops/contracts/types/library.MerkleInstant.md). |
62+
| `aggregateAmount` | `uint256` | The total amount of ERC-20 tokens to be distributed to all recipients. |
63+
| `recipientCount` | `uint256` | The total number of recipient addresses eligible for the airdrop. |
6464

6565
**Returns**
6666

0 commit comments

Comments
 (0)