Skip to content

Commit

Permalink
docs: fix typos (#1328)
Browse files Browse the repository at this point in the history
  • Loading branch information
vuittont60 authored Oct 24, 2023
1 parent d6ed2f6 commit 9e9e71e
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion src/strategies/proof-of-humanity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

It checks if an address is registered with Proof of Humanity.

It takes the address of the Proof of Humanity contract as a paramter:
It takes the address of the Proof of Humanity contract as a parameter:

```json
{
Expand Down
2 changes: 1 addition & 1 deletion src/strategies/sd-boost-twavp/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# sd-boost-twavp

This strategy is used by StakeDAO to vote with sdToken with Time Weigthed Averaged Voting Power system and veSDT voting boost.
This strategy is used by StakeDAO to vote with sdToken with Time Weighted Averaged Voting Power system and veSDT voting boost.
_sampleSize is in days_
_sampleStep is the number of block for TWAVP_
_avgBlockTime is in seconds_
Expand Down
2 changes: 1 addition & 1 deletion src/strategies/sd-vote-boost-twavp-v2/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# sd-vote-boost-twavp-v2

This strategy is used by Stake DAO to vote with sdToken using Time Weigthed Averaged Voting Power (TWAVP) system and adapted for veSDT boost delegation with possibility to whiteliste address to by pass TWAVP.
This strategy is used by Stake DAO to vote with sdToken using Time Weighted Averaged Voting Power (TWAVP) system and adapted for veSDT boost delegation with possibility to whiteliste address to by pass TWAVP.

```
VotingPower(user) = veToken.balanceOf(liquidLocker) * (average.sdTokenGauge.working_balances(user) / sdTokenGauge.working_supply)
Expand Down
2 changes: 1 addition & 1 deletion src/strategies/sd-vote-boost-twavp-v3/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# sd-vote-boost-twavp-v3

This strategy is used by Stake DAO to vote with sdToken using Time Weigthed Averaged Voting Power (TWAVP) system and adapted for veSDT boost delegation with possibility to whiteliste address to by pass TWAVP.
This strategy is used by Stake DAO to vote with sdToken using Time Weighted Averaged Voting Power (TWAVP) system and adapted for veSDT boost delegation with possibility to whiteliste address to by pass TWAVP.

```
VotingPower(user) = veToken.balanceOf(liquidLocker) * (average.sdTokenGauge.working_balances(user) / sdTokenGauge.working_supply)
Expand Down
2 changes: 1 addition & 1 deletion src/strategies/sd-vote-boost-twavp/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# sd-vote-boost-twavp

This strategy is used by Stake DAO to vote with sdToken using Time Weigthed Averaged Voting Power (TWAVP) system and adapted for veSDT boost delegation.
This strategy is used by Stake DAO to vote with sdToken using Time Weighted Averaged Voting Power (TWAVP) system and adapted for veSDT boost delegation.

```
VotingPower(user) = veToken.balanceOf(liquidLocker) * (average.sdTokenGauge.working_balances(user) / sdTokenGauge.working_supply)
Expand Down
6 changes: 3 additions & 3 deletions src/validations/passport-gated/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,16 @@ Strategy schema & parameters are defined under [schema.json](./schema.json). In

## Code Explanation

The main function (validate()) first fetches the following paramaters:
The main function (validate()) first fetches the following parameters:

* `stamps` (required): a list of Stamps that a passport should own.
* `operator` (required): (and/or) whether a Passport should own all or at least one of the required stamps.
* `scoreThreshold` ([0-100]): the threshold a Passport score should surpass in order to be eligible for creating/voting on a proposal. If not set, default value is set to zero to preserve backward compatibility.

Then, it calls the following validation methods:

* `validateStamps`: it uses the API to fetch the current user's Passport stamps and verifies that each has valid issuance and isn't expired. Then, depending on the `operator`, it will iterate through the requred `stamps` and check that the user holds at least one verifiable credential that makes the passport eligible for that stamp. Finally, a Passport will be set as valid if it meets the criteria.
* `validatePassportScore`: if `scoreThreshold` is set to zero this function will be ommited. Otherwise when called, it uses the Scorer API to submit the passport for scoring and get the latest score. If the API response returns a payload with `status === 'DONE'` it will return the result of evaluating the scoring threshold criteria, otherwise the implementation will make periodic requests (up to `PASSPORT_SCORER_MAX_ATTEMPTS`) to the Scorer API until getting a `DONE` status.
* `validateStamps`: it uses the API to fetch the current user's Passport stamps and verifies that each has valid issuance and isn't expired. Then, depending on the `operator`, it will iterate through the required `stamps` and check that the user holds at least one verifiable credential that makes the passport eligible for that stamp. Finally, a Passport will be set as valid if it meets the criteria.
* `validatePassportScore`: if `scoreThreshold` is set to zero this function will be omitted. Otherwise when called, it uses the Scorer API to submit the passport for scoring and get the latest score. If the API response returns a payload with `status === 'DONE'` it will return the result of evaluating the scoring threshold criteria, otherwise the implementation will make periodic requests (up to `PASSPORT_SCORER_MAX_ATTEMPTS`) to the Scorer API until getting a `DONE` status.

Finally, it checks the results of both eval functions and returns a boolean value indicating whether the user has a valid Passport.

Expand Down

0 comments on commit 9e9e71e

Please sign in to comment.