-
Notifications
You must be signed in to change notification settings - Fork 3
docs: update documentation for new features #137
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.
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
base: main
Are you sure you want to change the base?
docs: update documentation for new features #137
Conversation
| Before creating a campaign, verify that the creator has predeposited enough tokens to cover the campaign amount plus fees, and that the operator has sufficient allowance. If multiple campaigns are created in sequence, track both the remaining predeposited balance and remaining allowance to avoid unintended fallback behavior or failed transactions. | ||
| {% endhint %} | ||
|
|
||
| ## 🧪 Test campaigns |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you can remove the test campaign paragraph here
| It's expected for your campaign's **TVL and APR to show 0** at launch, and for the **leaderboard to appear empty**. The Merkl Engine needs a few hours to perform [the necessary computations](../merkl-mechanisms/technical-overview.md#reward-computation) before this data becomes available. | ||
| {% endhint %} | ||
|
|
||
| ## Creating campaigns on behalf of a creator |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you put this in the before you start section: as helpful as well in the context of the multi campaign section
| 1. **`setClaimRecipient(recipient, address(0))`** | ||
| - Sets a **global recipient** that applies to all tokens without specific recipients | ||
|
|
||
| 2. **`setClaimRecipientWithGov(user, recipient, address(0))`** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you can delete reference to governance here
| * by calling `toggleOperator`, Alice can allow Bob to claim on her behalf. Then, Bob can claim for Alice by sending Alice's proof to the contract, and rewards are then sent to Alice. | ||
| **How regular operators work:** | ||
|
|
||
| You can approve an operator to claim on your behalf by calling the function `toggleOperator` on the [distributor smart contract](https://app.merkl.xyz/status). When an operator claims on your behalf, the rewards are still sent to your original address—the operator only facilitates the transaction. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you add in this section that if you toggleOperator address(0) then anyone can claim on your behalf
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would be even more explicit in the last sentence (+ I would remove the em dash):
"the rewards are still sent to your original address. The operator’s role is limited to sign the claim transaction."
| ### Operator System: Delegating Claim Rights | ||
|
|
||
| So to sum up, assuming Alice earned the rewards: | ||
| By default, rewards can only be claimed by the address that earned them. However, Merkl provides a flexible operator system that allows you to delegate the right to claim rewards to another address, while still receiving the rewards yourself. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can specify that some addresses may have in some cases admin rights to claim for everyone -> on a case by case basis (cf indirect reference to main operator)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here I would say:
However, Merkl provides a flexible operator system that lets you delegate the right to execute the claim transaction on your behalf, while still receiving the rewards yourself.
…ou-start, add admin rights and address(0) operator info, remove governance references
No description provided.