Skip to content
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

fix: docstring newlines #512

Merged
merged 1 commit into from
Jul 9, 2024
Merged

fix: docstring newlines #512

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
2 changes: 1 addition & 1 deletion examples/arc75/artifacts/ARC75.arc32.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@
},
{
"name": "setAppWhitelist",
"desc": "Sets a app whitelist for the sender. Should only be used when adding/removingmore than one app",
"desc": "Sets a app whitelist for the sender. Should only be used when adding/removing\nmore than one app",
"args": [
{
"name": "arc",
Expand Down
2 changes: 1 addition & 1 deletion examples/arc75/artifacts/ARC75.arc4.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
},
{
"name": "setAppWhitelist",
"desc": "Sets a app whitelist for the sender. Should only be used when adding/removingmore than one app",
"desc": "Sets a app whitelist for the sender. Should only be used when adding/removing\nmore than one app",
"args": [
{
"name": "arc",
Expand Down
2 changes: 1 addition & 1 deletion examples/arc75/artifacts/ARC75.arc56_draft.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
},
{
"name": "setAppWhitelist",
"desc": "Sets a app whitelist for the sender. Should only be used when adding/removingmore than one app",
"desc": "Sets a app whitelist for the sender. Should only be used when adding/removing\nmore than one app",
"args": [
{
"name": "arc",
Expand Down
26 changes: 13 additions & 13 deletions examples/reti/artifacts/StakingPool.arc32.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@
},
{
"name": "initStorage",
"desc": "Called after we're created and then funded, so we can create our large stakers ledger storageCaller has to get MBR amounts from ValidatorRegistry to know how much to fund us to cover the box storage costIf this is pool 1 AND the validator has specified a reward token, opt-in to that tokenso that the validator can seed the pool with future rewards of that token.",
"desc": "Called after we're created and then funded, so we can create our large stakers ledger storage\nCaller has to get MBR amounts from ValidatorRegistry to know how much to fund us to cover the box storage cost\nIf this is pool 1 AND the validator has specified a reward token, opt-in to that token\nso that the validator can seed the pool with future rewards of that token.",
"args": [
{
"name": "mbrPayment",
Expand All @@ -228,7 +228,7 @@
},
{
"name": "addStake",
"desc": "Adds stake to the given account.Can ONLY be called by the validator contract that created usMust receive payment from the validator contract for amount being staked.",
"desc": "Adds stake to the given account.\nCan ONLY be called by the validator contract that created us\nMust receive payment from the validator contract for amount being staked.",
"args": [
{
"name": "stakedAmountPayment",
Expand All @@ -243,17 +243,17 @@
],
"returns": {
"type": "uint64",
"desc": "{uint64}new 'entry round' round number of stake add"
"desc": "uint64 new 'entry round' round number of stake add"
}
},
{
"name": "removeStake",
"desc": "Removes stake on behalf of caller (removing own stake). If any token rewards exist, those are always sent infull. Also notifies the validator contract for this pools validator of the staker / balance changes.",
"desc": "Removes stake on behalf of caller (removing own stake). If any token rewards exist, those are always sent in\nfull. Also notifies the validator contract for this pools validator of the staker / balance changes.",
"args": [
{
"name": "staker",
"type": "address",
"desc": "account to remove. normally same as sender, but the validator owner or manager can also callthis to remove the specified staker explicitly. The removed stake MUST only go to the staker of course. This isso a validator can shut down a poool and refund the stakers. It can also be used to kick out stakers who no longermeet the gating requirements (determined by the node daemon)."
"desc": "account to remove. normally same as sender, but the validator owner or manager can also call\nthis to remove the specified staker explicitly. The removed stake MUST only go to the staker of course. This is\nso a validator can shut down a poool and refund the stakers. It can also be used to kick out stakers who no longer\nmeet the gating requirements (determined by the node daemon)."
},
{
"name": "amountToUnstake",
Expand All @@ -267,7 +267,7 @@
},
{
"name": "claimTokens",
"desc": "Claims all the available reward tokens a staker has available, sending their entire balance to the staker frompool 1 (either directly, or via validator->pool1 to pay it out)Also notifies the validator contract for this pools validator of the staker / balance changes.",
"desc": "Claims all the available reward tokens a staker has available, sending their entire balance to the staker from\npool 1 (either directly, or via validator-pool1 to pay it out)\nAlso notifies the validator contract for this pools validator of the staker / balance changes.",
"args": [],
"returns": {
"type": "void"
Expand All @@ -285,12 +285,12 @@
],
"returns": {
"type": "(address,uint64,uint64,uint64,uint64)",
"desc": "{StakedInfo}- The staked information for the given staker."
"desc": "StakedInfo - The staked information for the given staker."
}
},
{
"name": "payTokenReward",
"desc": "[Internal protocol method] Remove a specified amount of 'community token' rewards for a staker.This can ONLY be called by our validator and only if we're pool 1 - with the token.Note: this can also be called by validator as part of OWNER wanting to send the reward tokenssomewhere else (ie if they're sunsetting their validator and need the reward tokens back).It's up to the validator to ensure that the balance in rewardTokenHeldBack is honored.",
"desc": "[Internal protocol method] Remove a specified amount of 'community token' rewards for a staker.\nThis can ONLY be called by our validator and only if we're pool 1 - with the token.\nNote: this can also be called by validator as part of OWNER wanting to send the reward tokens\nsomewhere else (ie if they're sunsetting their validator and need the reward tokens back).\nIt's up to the validator to ensure that the balance in rewardTokenHeldBack is honored.",
"args": [
{
"name": "staker",
Expand All @@ -314,7 +314,7 @@
},
{
"name": "updateAlgodVer",
"desc": "Update the (honor system) algod version for the node associated to this pool. The node management daemonshould compare its current nodes version to the version stored in global state, updating when different.The reti node daemon composes its own version string using format:{major}.{minor}.{build}{branch}[{commit hash}],ie: 3.22.0 rel/stable [6b508975][ ONLY OWNER OR MANAGER CAN CALL ]",
"desc": "Update the (honor system) algod version for the node associated to this pool. The node management daemon\nshould compare its current nodes version to the version stored in global state, updating when different.\nThe reti node daemon composes its own version string using format:\nmajor.minor.build branch [commit hash],\nie: 3.22.0 rel/stable [6b508975]\n[ ONLY OWNER OR MANAGER CAN CALL ]",
"args": [
{
"name": "algodVer",
Expand All @@ -328,15 +328,15 @@
},
{
"name": "epochBalanceUpdate",
"desc": "Updates the balance of stakers in the pool based on the received 'rewards' (current balance vs known staked balance)stakers outstanding balance is adjusted based on their % of stake and time in the current epoch - so that balancecompounds over time and staker can remove that amount at will.The validator is paid their percentage each epoch payout.Note: ANYONE can call this.",
"desc": "Updates the balance of stakers in the pool based on the received 'rewards' (current balance vs known staked balance)\nstakers outstanding balance is adjusted based on their % of stake and time in the current epoch - so that balance\ncompounds over time and staker can remove that amount at will.\nThe validator is paid their percentage each epoch payout.\n\n\nNote: ANYONE can call this.",
"args": [],
"returns": {
"type": "void"
}
},
{
"name": "goOnline",
"desc": "Registers a staking pool key online against a participation key.[ ONLY OWNER OR MANAGER CAN CALL ]",
"desc": "Registers a staking pool key online against a participation key.\n[ ONLY OWNER OR MANAGER CAN CALL ]",
"args": [
{
"name": "feePayment",
Expand Down Expand Up @@ -380,7 +380,7 @@
},
{
"name": "goOffline",
"desc": "Marks a staking pool key OFFLINE.[ ONLY OWNER OR MANAGER CAN CALL ]",
"desc": "Marks a staking pool key OFFLINE.\n[ ONLY OWNER OR MANAGER CAN CALL ]",
"args": [],
"returns": {
"type": "void"
Expand All @@ -404,7 +404,7 @@
},
{
"name": "proxiedSetTokenPayoutRatio",
"desc": "proxiedSetTokenPayoutRatio is meant to be called by pools != 1 - calling US, pool #1We need to verify that we are in fact being called by another of OUR pools (not us)and then we'll call the validator on their behalf to update the token payouts",
"desc": "proxiedSetTokenPayoutRatio is meant to be called by pools != 1 - calling US, pool #1\nWe need to verify that we are in fact being called by another of OUR pools (not us)\nand then we'll call the validator on their behalf to update the token payouts",
"args": [
{
"name": "poolKey",
Expand Down
26 changes: 13 additions & 13 deletions examples/reti/artifacts/StakingPool.arc4.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
},
{
"name": "initStorage",
"desc": "Called after we're created and then funded, so we can create our large stakers ledger storageCaller has to get MBR amounts from ValidatorRegistry to know how much to fund us to cover the box storage costIf this is pool 1 AND the validator has specified a reward token, opt-in to that tokenso that the validator can seed the pool with future rewards of that token.",
"desc": "Called after we're created and then funded, so we can create our large stakers ledger storage\nCaller has to get MBR amounts from ValidatorRegistry to know how much to fund us to cover the box storage cost\nIf this is pool 1 AND the validator has specified a reward token, opt-in to that token\nso that the validator can seed the pool with future rewards of that token.",
"args": [
{
"name": "mbrPayment",
Expand All @@ -62,7 +62,7 @@
},
{
"name": "addStake",
"desc": "Adds stake to the given account.Can ONLY be called by the validator contract that created usMust receive payment from the validator contract for amount being staked.",
"desc": "Adds stake to the given account.\nCan ONLY be called by the validator contract that created us\nMust receive payment from the validator contract for amount being staked.",
"args": [
{
"name": "stakedAmountPayment",
Expand All @@ -77,17 +77,17 @@
],
"returns": {
"type": "uint64",
"desc": "{uint64}new 'entry round' round number of stake add"
"desc": "uint64 new 'entry round' round number of stake add"
}
},
{
"name": "removeStake",
"desc": "Removes stake on behalf of caller (removing own stake). If any token rewards exist, those are always sent infull. Also notifies the validator contract for this pools validator of the staker / balance changes.",
"desc": "Removes stake on behalf of caller (removing own stake). If any token rewards exist, those are always sent in\nfull. Also notifies the validator contract for this pools validator of the staker / balance changes.",
"args": [
{
"name": "staker",
"type": "address",
"desc": "account to remove. normally same as sender, but the validator owner or manager can also callthis to remove the specified staker explicitly. The removed stake MUST only go to the staker of course. This isso a validator can shut down a poool and refund the stakers. It can also be used to kick out stakers who no longermeet the gating requirements (determined by the node daemon)."
"desc": "account to remove. normally same as sender, but the validator owner or manager can also call\nthis to remove the specified staker explicitly. The removed stake MUST only go to the staker of course. This is\nso a validator can shut down a poool and refund the stakers. It can also be used to kick out stakers who no longer\nmeet the gating requirements (determined by the node daemon)."
},
{
"name": "amountToUnstake",
Expand All @@ -101,7 +101,7 @@
},
{
"name": "claimTokens",
"desc": "Claims all the available reward tokens a staker has available, sending their entire balance to the staker frompool 1 (either directly, or via validator->pool1 to pay it out)Also notifies the validator contract for this pools validator of the staker / balance changes.",
"desc": "Claims all the available reward tokens a staker has available, sending their entire balance to the staker from\npool 1 (either directly, or via validator-pool1 to pay it out)\nAlso notifies the validator contract for this pools validator of the staker / balance changes.",
"args": [],
"returns": {
"type": "void"
Expand All @@ -119,12 +119,12 @@
],
"returns": {
"type": "(address,uint64,uint64,uint64,uint64)",
"desc": "{StakedInfo}- The staked information for the given staker."
"desc": "StakedInfo - The staked information for the given staker."
}
},
{
"name": "payTokenReward",
"desc": "[Internal protocol method] Remove a specified amount of 'community token' rewards for a staker.This can ONLY be called by our validator and only if we're pool 1 - with the token.Note: this can also be called by validator as part of OWNER wanting to send the reward tokenssomewhere else (ie if they're sunsetting their validator and need the reward tokens back).It's up to the validator to ensure that the balance in rewardTokenHeldBack is honored.",
"desc": "[Internal protocol method] Remove a specified amount of 'community token' rewards for a staker.\nThis can ONLY be called by our validator and only if we're pool 1 - with the token.\nNote: this can also be called by validator as part of OWNER wanting to send the reward tokens\nsomewhere else (ie if they're sunsetting their validator and need the reward tokens back).\nIt's up to the validator to ensure that the balance in rewardTokenHeldBack is honored.",
"args": [
{
"name": "staker",
Expand All @@ -148,7 +148,7 @@
},
{
"name": "updateAlgodVer",
"desc": "Update the (honor system) algod version for the node associated to this pool. The node management daemonshould compare its current nodes version to the version stored in global state, updating when different.The reti node daemon composes its own version string using format:{major}.{minor}.{build}{branch}[{commit hash}],ie: 3.22.0 rel/stable [6b508975][ ONLY OWNER OR MANAGER CAN CALL ]",
"desc": "Update the (honor system) algod version for the node associated to this pool. The node management daemon\nshould compare its current nodes version to the version stored in global state, updating when different.\nThe reti node daemon composes its own version string using format:\nmajor.minor.build branch [commit hash],\nie: 3.22.0 rel/stable [6b508975]\n[ ONLY OWNER OR MANAGER CAN CALL ]",
"args": [
{
"name": "algodVer",
Expand All @@ -162,15 +162,15 @@
},
{
"name": "epochBalanceUpdate",
"desc": "Updates the balance of stakers in the pool based on the received 'rewards' (current balance vs known staked balance)stakers outstanding balance is adjusted based on their % of stake and time in the current epoch - so that balancecompounds over time and staker can remove that amount at will.The validator is paid their percentage each epoch payout.Note: ANYONE can call this.",
"desc": "Updates the balance of stakers in the pool based on the received 'rewards' (current balance vs known staked balance)\nstakers outstanding balance is adjusted based on their % of stake and time in the current epoch - so that balance\ncompounds over time and staker can remove that amount at will.\nThe validator is paid their percentage each epoch payout.\n\n\nNote: ANYONE can call this.",
"args": [],
"returns": {
"type": "void"
}
},
{
"name": "goOnline",
"desc": "Registers a staking pool key online against a participation key.[ ONLY OWNER OR MANAGER CAN CALL ]",
"desc": "Registers a staking pool key online against a participation key.\n[ ONLY OWNER OR MANAGER CAN CALL ]",
"args": [
{
"name": "feePayment",
Expand Down Expand Up @@ -214,7 +214,7 @@
},
{
"name": "goOffline",
"desc": "Marks a staking pool key OFFLINE.[ ONLY OWNER OR MANAGER CAN CALL ]",
"desc": "Marks a staking pool key OFFLINE.\n[ ONLY OWNER OR MANAGER CAN CALL ]",
"args": [],
"returns": {
"type": "void"
Expand All @@ -238,7 +238,7 @@
},
{
"name": "proxiedSetTokenPayoutRatio",
"desc": "proxiedSetTokenPayoutRatio is meant to be called by pools != 1 - calling US, pool #1We need to verify that we are in fact being called by another of OUR pools (not us)and then we'll call the validator on their behalf to update the token payouts",
"desc": "proxiedSetTokenPayoutRatio is meant to be called by pools != 1 - calling US, pool #1\nWe need to verify that we are in fact being called by another of OUR pools (not us)\nand then we'll call the validator on their behalf to update the token payouts",
"args": [
{
"name": "poolKey",
Expand Down
Loading
Loading