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 #46

Open
wants to merge 7 commits into
base: main
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 README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ ethereum: {
}
```

Example: More than one LayerZero Network on same chain (using expandNetwork)
Example: More than one LayerZero Network on the same chain (using expandNetwork)
```
//hardhat.config.ts
...expandNetwork({
Expand Down
8 changes: 4 additions & 4 deletions contracts/UltraLightNode.sol
Original file line number Diff line number Diff line change
Expand Up @@ -106,15 +106,15 @@ contract UltraLightNode is ILayerZeroMessagingLibrary, ILayerZeroUltraLightNodeV
//----------------------------------------------------------------------------------
// PROTOCOL

// This function completes delivery of a LayerZero message.
// This function completes the delivery of a LayerZero message.
//
// In order to deliver the message, this function:
// (a) takes the _transactionProof submitted by UA's relayer, and
// (b) retrieve UA's validation library
// (c) takes the _blockData submitted by the UA's oracle given the their configuration (and blockConfirmations),
// (c) takes the _blockData submitted by the UA's oracle given their configuration (and blockConfirmations),
// (d) decodes using UA's validation library using (a) and (c)
// then, this functions asserts that
// (e) the payload originated from the known Ultra Light Node from source chain, and
// then, this function asserts that
// (e) the payload originated from the known Ultra Light Node from the source chain, and
// (f) the _dstAddress the specified destination contract
function validateTransactionProof(uint16 _srcChainId, address _dstAddress, uint _gasLimit, bytes32 _lookupHash, bytes calldata _transactionProof) external override {
// retrieve UA's configuration using the _dstAddress from arguments.
Expand Down
4 changes: 2 additions & 2 deletions contracts/interfaces/ILayerZeroEndpoint.sol
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import "./ILayerZeroUserApplicationConfig.sol";
interface ILayerZeroEndpoint is ILayerZeroUserApplicationConfig {
// @notice send a LayerZero message to the specified address at a LayerZero endpoint.
// @param _dstChainId - the destination chain identifier
// @param _destination - the address on destination chain (in bytes). address length/format may vary by chains
// @param _destination - the address on the destination chain (in bytes). address length/format may vary by chains
// @param _payload - a custom bytes payload to send to the destination contract
// @param _refundAddress - if the source transaction is cheaper than the amount of value passed, refund the additional amount to this address
// @param _zroPaymentAddress - the address of the ZRO token holder who would pay for the transaction
Expand All @@ -17,7 +17,7 @@ interface ILayerZeroEndpoint is ILayerZeroUserApplicationConfig {
// @notice used by the messaging library to publish verified payload
// @param _srcChainId - the source chain identifier
// @param _srcAddress - the source contract (as bytes) at the source chain
// @param _dstAddress - the address on destination chain
// @param _dstAddress - the address on the destination chain
// @param _nonce - the unbound message ordering nonce
// @param _gasLimit - the gas limit for external contract execution
// @param _payload - verified payload to send to the destination contract
Expand Down
2 changes: 1 addition & 1 deletion contracts/interfaces/ILayerZeroOracle.sol
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ interface ILayerZeroOracle {
// @notice Ultra-Light Node notifies the Oracle of a new block information relaying request
// @param _dstChainId the destination endpoint identifier
// @param _outboundProofType the proof type identifier to specify the data to be relayed
// @param _outboundBlockConfirmations the number of source chain block confirmation needed
// @param _outboundBlockConfirmations the number of source chain block confirmations needed
function notifyOracle(uint16 _dstChainId, uint16 _outboundProofType, uint64 _outboundBlockConfirmations) external;

// @notice query if the address is an approved actor for privileges like data submission and fee withdrawal etc.
Expand Down
2 changes: 1 addition & 1 deletion contracts/mocks/LayerZeroOracleBadMock.sol
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ contract LayerZeroOracleBadMock is ILayerZeroOracle, Ownable, ReentrancyGuard {
mapping(uint16 => mapping(uint16 => uint)) public chainPriceLookup;
uint public fee;
ILayerZeroUltraLightNodeV1 public uln; // ultraLightNode instance
ILayerZeroEndpoint public endpoint; // for bad oracles trying to talk to endpoint
ILayerZeroEndpoint public endpoint; // for bad oracles trying to talk to the endpoint

event OracleNotified(uint16 dstChainId, uint16 _outboundProofType, uint blockConfirmations);
event Withdraw(address to, uint amount);
Expand Down
2 changes: 1 addition & 1 deletion contracts/mocks/LayerZeroOracleMock.sol
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ contract LayerZeroOracleMock is ILayerZeroOracle, Ownable, ReentrancyGuard {
}

function updateHash(uint16 _remoteChainId, bytes32 _blockHash, uint _confirmations, bytes32 _data) external {
require(approvedAddresses[msg.sender], "LayerZeroOracleMock: caller must be approved");
require(approvedAddresses[msg.sender], "LayerZeroOracleMock: the caller must be approved");
uln.updateHash(_remoteChainId, _blockHash, _confirmations, _data);
}

Expand Down
2 changes: 1 addition & 1 deletion tasks/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -116,5 +116,5 @@ task("filterHashReceived", "filter on recent UltraLightNode HashReceived events"

task("deleteAndRedeploy", "remove contracts from folder and redeploy", require("./deleteAndRedeploy"))
.addParam("e", "the environment ie: mainnet, testnet or sandbox")
.addParam("contract", "the contrac tto delete and redeploy")
.addParam("contract", "the contract to delete and redeploy")
.addOptionalParam("ignore", "csv of network names to ignore", "", types.string)