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.

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: typos in the docs #7

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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 scalable-dex/contracts/src/components/ActionHash.sol
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ contract ActionHash is MainStorage, LibConstants {
function setActionHash(bytes32 actionHash, bool premiumCost) internal {
// The rate of forced trade requests is restricted.
// First restriction is by capping the number of requests in a block.
// User can override this cap by requesting with a permium flag set,
// User can override this cap by requesting with a premium flag set,
// in this case, the gas cost is high (~1M) but no "technical" limit is set.
// However, the high gas cost creates an obvious limitation due to the block gas limit.
if (premiumCost) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import "./MainStorage.sol";

/**
A :sol:mod:`Committee` contract is a contract that the exchange service sends committee member
signatures to attesting that they have a copy of the data over which a new Merkel root is to be
signatures to attest that they have a copy of the data over which a new Merkel root is to be
accepted as the new state root. In addition, the exchange contract can call an availability
verifier to check if such signatures were indeed provided by a sufficient number of committee
members as hard coded in the :sol:mod:`Committee` contract for a given state transition
Expand Down
2 changes: 1 addition & 1 deletion scalable-dex/contracts/src/components/FactRegistry.sol
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ contract FactRegistry is IQueryableFactRegistry {

/*
This is an internal method to check if the fact is already registered.
In current implementation of FactRegistry it's identical to isValid().
In the current implementation of FactRegistry it's identical to isValid().
But the check is against the local fact registry,
So for a derived referral fact registry, it's not the same.
*/
Expand Down
4 changes: 2 additions & 2 deletions scalable-dex/contracts/src/components/MainGovernance.sol
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ import "./GovernanceStorage.sol";
1. First, an existing governor nominates a new governor (:sol:func:`mainNominateNewGovernor`)
2. Then, the new governor must accept governance to become a governor (:sol:func:`mainAcceptGovernance`)

This two step procedure ensures that a governor public key cannot be nominated unless there is an
This two step procedure ensures that a governor's public key cannot be nominated unless there is an
entity that has the corresponding private key. This is intended to prevent errors in the addition
process.

The governor private key should typically be held in a secure cold wallet.
The governor's private key should typically be held in a secure cold wallet.
*/
/*
Implements Governance for the StarkDex main contract.
Expand Down
6 changes: 3 additions & 3 deletions scalable-dex/contracts/src/components/MainStorage.sol
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ contract MainStorage is ProxyStorage {
// True if and only if the address is allowed to add tokens.
mapping(address => bool) tokenAdmins;

// This mapping is no longer in use, remains for backwards compatibility.
// This mapping is no longer in use, remains for backward compatibility.
mapping(address => bool) userAdmins_DEPRECATED; // NOLINT: naming-convention.

// True if and only if the address is an operator (allowed to update state).
Expand All @@ -69,7 +69,7 @@ contract MainStorage is ProxyStorage {
// Mapping from contract ID to quantum.
mapping(uint256 => uint256) assetTypeToQuantum; // NOLINT: uninitialized-state.

// This mapping is no longer in use, remains for backwards compatibility.
// This mapping is no longer in use, remains for backward compatibility.
mapping(address => uint256) starkKeys_DEPRECATED; // NOLINT: naming-convention.

// Mapping from STARK public key to the Ethereum public key of its owner.
Expand All @@ -91,7 +91,7 @@ contract MainStorage is ProxyStorage {
// Onchain-data version configured for the system.
uint256 onchainDataVersion_DEPRECATED; // NOLINT: naming-convention constable-states.

// Counter of forced action request in block. The key is the block number.
// Counter of forced action request in a block. The key is the block number.
mapping(uint256 => uint256) forcedRequestsInBlock;

// ForcedAction requests: actionHash => requestTime.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ contract PedersenMerkleVerifier {

// For k = 0..HASHES-1, Compute the k'th hash by summing the k'th column in table.
// Instead of k we use offset := k * sizeof(EC point).
// Additonally we use ptr := offset + j * rowSize to ge over the EC points we want
// Additionally we use ptr := offset + j * rowSize to ge over the EC points we want
// to sum.
for {

Expand Down
2 changes: 1 addition & 1 deletion scalable-dex/contracts/src/components/Users.sol
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ import "../libraries/LibConstants.sol";
1. The key registered is not zero and has not been registered in the past by the user or anyone else.
2. The key provided represents a valid point on the Stark-friendly elliptic curve.
3. The linkage between the provided Ethereum address and the selected Stark Key is signed using
the privte key of the selected Stark Key.
the private key of the selected Stark Key.

If the above holds, the Ethereum address is registered by the contract, mapping it to the Stark Key.
*/
Expand Down
2 changes: 1 addition & 1 deletion scalable-dex/contracts/src/components/Verifiers.sol
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import "./MainStorage.sol";
of the assumed proof).

The exchange contract will normally query only one verifier contract for proof validity checks.
However, in the event that the verifier algorithm needs to updated, additional verifiers may be
However, in the event that the verifier algorithm needs to be updated, additional verifiers may be
registered with the exchange contract by the contract :sol:mod:`MainGovernance`. Such new
verifiers are then also be required to attest to the validity of state transitions and only if all
the verifiers attest to the validity the state transition is accepted.
Expand Down