missing dependencies for running tests

.env.example

@@ -0,0 +1,14 @@
+ALCHEMY_API_KEY=
+ALCHEMY_OPTKOV_API_KEY=
+ALCHEMY_MUMBAI_API_KEY=
+BSC_TESTNET_RPC=
+FUJI_RPC=
+HARDHAT_NETWORK=hardhat
+HARDHAT_MAX_MEMORY=4096
+HARDHAT_SHOW_STACK_TRACES=true
+HARDHAT_VERBOSE=true
+INFURA_PROJECT_ID=
+INFURA_API_KEY=
+MNEMONIC="test test test test test test test test test test test junk"
+FORKING=false
+VERBOSE=true

.gitignore

@@ -0,0 +1,124 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+node_modules
+
+package-lock.json
+
+#Hardhat files
+cache
+artifacts
+
+# webstorm local files
+.idea/
+
+.openzeppelin/
+
+.DS_Store
+.layerzero
+.chainlink
+deployments/localhost/
+
+transactions.md

.npmrc

@@ -0,0 +1 @@
+//registry.npmjs.org/:_authToken=${NPM_TOKEN}

.prettierrc.js

@@ -0,0 +1,35 @@
+module.exports = {
+    overrides: [
+        {
+            files: "*.sol",
+            options: {
+                bracketSpacing: false,
+                printWidth: 300,
+                tabWidth: 4,
+                useTabs: false,
+                singleQuote: false,
+                explicitTypes: "never",
+            },
+        },
+        {
+            files: "*.ts",
+            options: {
+                printWidth: 145,
+                semi: false,
+                tabWidth: 4,
+                useTabs: false,
+                trailingComma: "es5",
+            },
+        },
+        {
+            files: "*.js",
+            options: {
+                printWidth: 145,
+                semi: false,
+                tabWidth: 4,
+                useTabs: false,
+                trailingComma: "es5",
+            },
+        },
+    ],
+}

contracts/interfaces/ILayerZeroEndpoint.sol

@@ -0,0 +1,87 @@
+// SPDX-License-Identifier: BUSL-1.1
+
+pragma solidity >=0.5.0;
+
+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 _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
+    // @param _adapterParams - parameters for custom functionality. e.g. receive airdropped native gas from the relayer on destination
+    function send(uint16 _dstChainId, bytes calldata _destination, bytes calldata _payload, address payable _refundAddress, address _zroPaymentAddress, bytes calldata _adapterParams) external payable;
+
+    // @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 _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
+    function receivePayload(uint16 _srcChainId, bytes calldata _srcAddress, address _dstAddress, uint64 _nonce, uint _gasLimit, bytes calldata _payload) external;
+
+    // @notice get the inboundNonce of a receiver from a source chain which could be EVM or non-EVM chain
+    // @param _srcChainId - the source chain identifier
+    // @param _srcAddress - the source chain contract address
+    function getInboundNonce(uint16 _srcChainId, bytes calldata _srcAddress) external view returns (uint64);
+
+    // @notice get the outboundNonce from this source chain which, consequently, is always an EVM
+    // @param _srcAddress - the source chain contract address
+    function getOutboundNonce(uint16 _dstChainId, address _srcAddress) external view returns (uint64);
+
+    // @notice gets a quote in source native gas, for the amount that send() requires to pay for message delivery
+    // @param _dstChainId - the destination chain identifier
+    // @param _userApplication - the user app address on this EVM chain
+    // @param _payload - the custom message to send over LayerZero
+    // @param _payInZRO - if false, user app pays the protocol fee in native token
+    // @param _adapterParam - parameters for the adapter service, e.g. send some dust native token to dstChain
+    function estimateFees(uint16 _dstChainId, address _userApplication, bytes calldata _payload, bool _payInZRO, bytes calldata _adapterParam) external view returns (uint nativeFee, uint zroFee);
+
+    // @notice get this Endpoint's immutable source identifier
+    function getChainId() external view returns (uint16);
+
+    // @notice the interface to retry failed message on this Endpoint destination
+    // @param _srcChainId - the source chain identifier
+    // @param _srcAddress - the source chain contract address
+    // @param _payload - the payload to be retried
+    function retryPayload(uint16 _srcChainId, bytes calldata _srcAddress, bytes calldata _payload) external;
+
+    // @notice query if any STORED payload (message blocking) at the endpoint.
+    // @param _srcChainId - the source chain identifier
+    // @param _srcAddress - the source chain contract address
+    function hasStoredPayload(uint16 _srcChainId, bytes calldata _srcAddress) external view returns (bool);
+
+    // @notice query if the _libraryAddress is valid for sending msgs.
+    // @param _userApplication - the user app address on this EVM chain
+    function getSendLibraryAddress(address _userApplication) external view returns (address);
+
+    // @notice query if the _libraryAddress is valid for receiving msgs.
+    // @param _userApplication - the user app address on this EVM chain
+    function getReceiveLibraryAddress(address _userApplication) external view returns (address);
+
+    // @notice query if the non-reentrancy guard for send() is on
+    // @return true if the guard is on. false otherwise
+    function isSendingPayload() external view returns (bool);
+
+    // @notice query if the non-reentrancy guard for receive() is on
+    // @return true if the guard is on. false otherwise
+    function isReceivingPayload() external view returns (bool);
+
+    // @notice get the configuration of the LayerZero messaging library of the specified version
+    // @param _version - messaging library version
+    // @param _chainId - the chainId for the pending config change
+    // @param _userApplication - the contract address of the user application
+    // @param _configType - type of configuration. every messaging library has its own convention.
+    function getConfig(uint16 _version, uint16 _chainId, address _userApplication, uint _configType) external view returns (bytes memory);
+
+    // @notice get the send() LayerZero messaging library version
+    // @param _userApplication - the contract address of the user application
+    function getSendVersion(address _userApplication) external view returns (uint16);
+
+    // @notice get the lzReceive() LayerZero messaging library version
+    // @param _userApplication - the contract address of the user application
+    function getReceiveVersion(address _userApplication) external view returns (uint16);
+}

contracts/interfaces/ILayerZeroMessagingLibrary.sol

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: BUSL-1.1
+
+pragma solidity >=0.7.0;
+
+import "./ILayerZeroUserApplicationConfig.sol";
+
+interface ILayerZeroMessagingLibrary {
+    // send(), messages will be inflight.
+    function send(address _userApplication, uint64 _lastNonce, uint16 _chainId, bytes calldata _destination, bytes calldata _payload, address payable refundAddress, address _zroPaymentAddress, bytes calldata _adapterParams) external payable;
+
+    // estimate native fee at the send side
+    function estimateFees(uint16 _chainId, address _userApplication, bytes calldata _payload, bool _payInZRO, bytes calldata _adapterParam) external view returns (uint nativeFee, uint zroFee);
+
+    //---------------------------------------------------------------------------
+    // setConfig / getConfig are User Application (UA) functions to specify Oracle, Relayer, blockConfirmations, libraryVersion
+    function setConfig(uint16 _chainId, address _userApplication, uint _configType, bytes calldata _config) external;
+
+    function getConfig(uint16 _chainId, address _userApplication, uint _configType) external view returns (bytes memory);
+}

contracts/interfaces/ILayerZeroReceiver.sol

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: BUSL-1.1
+
+pragma solidity >=0.5.0;
+
+interface ILayerZeroReceiver {
+    // @notice LayerZero endpoint will invoke this function to deliver the message on the destination
+    // @param _srcChainId - the source endpoint identifier
+    // @param _srcAddress - the source sending contract address from the source chain
+    // @param _nonce - the ordered message nonce
+    // @param _payload - the signed payload is the UA bytes has encoded to be sent
+    function lzReceive(uint16 _srcChainId, bytes calldata _srcAddress, uint64 _nonce, bytes calldata _payload) external;
+}

contracts/interfaces/ILayerZeroRelayer.sol

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: BUSL-1.1
+
+pragma solidity >=0.7.0;
+
+interface ILayerZeroRelayer {
+    // @notice query the relayer price for relaying the payload and its proof to the destination chain
+    // @param _dstChainId - the destination endpoint identifier
+    // @param _outboundProofType - the proof type identifier to specify proof to be relayed
+    // @param _userApplication - the source sending contract address. relayers may apply price discrimination to user apps
+    // @param _payloadSize - the length of the payload. it is an indicator of gas usage for relaying cross-chain messages
+    // @param _adapterParams - optional parameters for extra service plugins, e.g. sending dust tokens at the destination chain
+    function getPrice(uint16 _dstChainId, uint16 _outboundProofType, address _userApplication, uint _payloadSize, bytes calldata _adapterParams) external view returns (uint price);
+
+    // @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 _adapterParams - optional parameters for extra service plugins, e.g. sending dust tokens at the destination chain
+    function notifyRelayer(uint16 _dstChainId, uint16 _outboundProofType, bytes calldata _adapterParams) external;
+
+    // @notice query if the address is an approved actor for privileges like data submission and fee withdrawal etc.
+    // @param _address - the address to be checked
+    function isApproved(address _address) external view returns (bool approved);
+}

contracts/interfaces/ILayerZeroUltraLightNodeV1.sol

@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: BUSL-1.1
+
+pragma solidity >=0.7.0;
+
+interface ILayerZeroUltraLightNodeV1 {
+    // a Relayer can execute the validateTransactionProof()
+    function validateTransactionProof(uint16 _srcChainId, address _dstAddress, uint _gasLimit, bytes32 _lookupHash, bytes calldata _transactionProof) external;
+
+    // an Oracle delivers the block data using updateHash()
+    function updateHash(uint16 _remoteChainId, bytes32 _lookupHash, uint _confirmations, bytes32 _data) external;
+
+    // can only withdraw the receivable of the msg.sender
+    function withdrawNative(uint8 _type, address _owner, address payable _to, uint _amount) external;
+
+    function withdrawZRO(address _to, uint _amount) external;
+
+    // view functions
+    function oracleQuotedAmount(address _oracle) external view returns (uint);
+
+    function relayerQuotedAmount(address _relayer) external view returns (uint);
+}

contracts/interfaces/ILayerZeroUserApplicationConfig.sol

@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: BUSL-1.1
+
+pragma solidity >=0.5.0;
+
+interface ILayerZeroUserApplicationConfig {
+    // @notice set the configuration of the LayerZero messaging library of the specified version
+    // @param _version - messaging library version
+    // @param _chainId - the chainId for the pending config change
+    // @param _configType - type of configuration. every messaging library has its own convention.
+    // @param _config - configuration in the bytes. can encode arbitrary content.
+    function setConfig(uint16 _version, uint16 _chainId, uint _configType, bytes calldata _config) external;
+
+    // @notice set the send() LayerZero messaging library version to _version
+    // @param _version - new messaging library version
+    function setSendVersion(uint16 _version) external;
+
+    // @notice set the lzReceive() LayerZero messaging library version to _version
+    // @param _version - new messaging library version
+    function setReceiveVersion(uint16 _version) external;
+
+    // @notice Only when the UA needs to resume the message flow in blocking mode and clear the stored payload
+    // @param _srcChainId - the chainId of the source chain
+    // @param _srcAddress - the contract address of the source contract at the source chain
+    function forceResumeReceive(uint16 _srcChainId, bytes calldata _srcAddress) external;
+}