feat: add layer zero examples #3326

natanasow · 2024-12-11T16:44:17Z

Description:

LZ is deployed on Hedera and we'd like to dig into see what's possible when considering HTS and it's representation fo ERC20 and ERC 721s.

Explore the LZ offering, and gain familiarity as a team and POC so cross-chain bridging of HTS tokens

Self-improvement docs:

Tasks

POC of a simple OApp used for messaging to any other LZ support EVM chain (Ethereum, Polygon or Base) hedera-smart-contracts#1060
POC of a simple OFT to any other LZ support EVM chain hedera-smart-contracts#1077
POC of a simple OFT Adapter to any other LZ support EVM chain hedera-smart-contracts#1078
POC of a simple ONFT to any other LZ support EVM chain hedera-smart-contracts#1079
POC of a simple ONFT Adapter to any other LZ support EVM chain hedera-smart-contracts#1080
POC an approach to wrap an HTS fungible token and bridge to any other LZ support EVM chain (Ethereum, Polygon or Base) hedera-smart-contracts#1061

Related issue(s):

Fixes #3339

Notes for reviewer:

Checklist

Documented (Code comments, README, etc.)
Tested (unit, integration, etc.)

Signed-off-by: nikolay <[email protected]>

github-actions · 2024-12-11T16:48:38Z

Test Results

23 files + 3 303 suites +43 55m 38s ⏱️ + 14m 1s
617 tests + 5 601 ✅ - 5 4 💤 ±0 12 ❌ +10
817 runs +60 801 ✅ +52 4 💤 - 2 12 ❌ +10

For more details on these failures, see this check.

Results for commit 4cac520. ± Comparison against base commit b5e747f.

♻️ This comment has been updated with latest results.

Signed-off-by: nikolay <[email protected]>

tools/layer-zero-example/contracts/BaseHTSOFT.sol

quiet-node

Without context it's quite hard to follow the PR. Could you provide a design document or any documentation that outlines the purpose of the project? The document could also define terms such as OFT and OApp. I believe the document you shared with the team last Friday was very effective. Would you consider updating and including it in this project?

tools/layer-zero-example/hardhat.config.js

tools/layer-zero-example/contracts/ExampleOFTHTS.sol

Signed-off-by: nikolay <[email protected]>

Nana-EC

Nice progress, some suggestions

Nana-EC · 2024-12-19T18:34:04Z

tools/layer-zero-example/README.md

+npx hardhat test --grep "HTSAdapterTests @hedera @test" --network hedera_testnet
+npx hardhat test --grep "HTSAdapterTests @bsc @test" --network bsc_testnet
+
+### WHBAR flow


This shouldn't be in the layer zero dir in it's final form.
Move this to tools/whbar

Agreed. I put it there because the WHBAR example is on another branch and if I create a duplication of it in that PR, there will be future conflicts to resolve. Will move it as you suggested after I finalize the README.

Nana-EC · 2024-12-19T18:44:09Z

tools/layer-zero-example/contracts/HTSConnector.sol

+     * @return amountReceivedLD The amount received in local decimals on the remote.
+     */
+    function _debit(
+        address _from,


Q: If _from is not msg.sender then it presumes an approval exists for the contract right?
If not do we need a check?

There was a check here and approval that had been executed afterward but after some feedback from Fernando, I decided to completely remove the approval from this call. It's user's/dapp's responsibility to ensure the token's approval beforehand like it's done in ERC20 swaps via 2 transactions so we don't need any extra actions here.

tools/layer-zero-example/contracts/WHBAR.sol

Nana-EC · 2024-12-19T18:49:45Z

tools/layer-zero-example/contracts/hts/HederaResponseCodes.sol

+// SPDX-License-Identifier: Apache-2.0
+pragma solidity >=0.4.9 <0.9.0;
+
+library HederaResponseCodes {


nit: might not be necessary to dupe the whole file.
Why not just pull in the response code you need and add a comment ref to the HederaResponseCodes in the smart contracts repo.
Once we get the npm package this will be easier

tools/layer-zero-example/contracts/hts/IHederaTokenService.sol

tools/layer-zero-example/contracts/hts/KeyHelper.sol

tools/layer-zero-example/hardhat.config.js

tools/layer-zero-example/README.md

Ferparishuertas · 2024-12-20T09:44:08Z

tools/layer-zero-example/contracts/HTSConnector.sol

+abstract contract HTSConnector is OFTCore, KeyHelper, ExpiryHelper, HederaTokenService {
+    address public htsTokenAddress;
+
+    event CreatedToken(address tokenAddress);


Isnt it more standard, and language rich, TokenCreated?

As people could have already an HTS Token, or want to create one

is it an adapter escenario when it already exists?

Instead creating it inside, if you create outside and the you connect, it is almost The same as the previous sentence.

Whats de difference? Both scenarios could use the same code, we have at the connector

Does it makes sense to create the token inside in this connector?
If it can work in Adapter and connector mode, the only reason to use a connector is to avoid liquidity logic?

I think this doubts needs to be cased somehow on our doc, comparing adapter vs connector, with an existing token

Signed-off-by: nikolay <[email protected]>

sonarqubecloud · 2024-12-20T14:42:03Z

Quality Gate failed

Failed conditions
3.2% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

codecov · 2024-12-20T15:40:10Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.95%. Comparing base (b5e747f) to head (4cac520).
Report is 11 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3326      +/-   ##
==========================================
- Coverage   84.91%   83.95%   -0.97%     
==========================================
  Files          69       69              
  Lines        4655     4688      +33     
  Branches     1042     1050       +8     
==========================================
- Hits         3953     3936      -17     
- Misses        397      424      +27     
- Partials      305      328      +23

Flag	Coverage Δ
config-service	`98.14% <ø> (ø)`
relay	`79.72% <ø> (+0.96%)`	⬆️
server	`83.28% <ø> (ø)`
ws-server	`36.66% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

see 13 files with indirect coverage changes

Nana-EC

Nice work.
Some suggestions to make it easy to illustrate the E2E flow

Nana-EC · 2024-12-20T00:10:14Z

tools/layer-zero-example/contracts/HTSConnector.sol

+     * @dev In the case of OFT, address(this) and erc20 are the same contract.
+     */
+    function token() public view returns (address) {
+        return address(this);


Shouldn't this be htsTokenAddress instead of address(this)?
This contract doesn't conform to any token standard on it's own

Nana-EC · 2024-12-21T04:04:00Z

tools/layer-zero-example/contracts/HTSConnector.sol

+        IHederaTokenService.TokenKey[] memory keys = new IHederaTokenService.TokenKey[](2);
+        keys[0] = getSingleKey(
+            KeyType.ADMIN,
+            KeyType.PAUSE,


I don't think we need the pause key. Let's keep this part simple with just admin and supply.

Nana-EC · 2024-12-21T04:05:32Z

tools/layer-zero-example/contracts/HTSConnector.sol

+    ) payable OFTCore(8, _lzEndpoint, _delegate) {
+        IHederaTokenService.TokenKey[] memory keys = new IHederaTokenService.TokenKey[](2);
+        keys[0] = getSingleKey(
+            KeyType.ADMIN,


Wondering if we even need the admin key or only the supply.
I forget if you have to specify admin in this case or if we can make the token immutable.
Even if we set it shouldn't it be a CONTRACT_ID type?

Nana-EC · 2024-12-21T04:12:09Z

tools/layer-zero-example/hardhat.config.js

+    const contract = await contractFactory.deploy();
+    await contract.deployTransaction.wait();
+
+    console.log(`(${hre.network.name}) WHBAR to: ` + contract.address);


Can you log the tx hashes in these tasks.
Would be nice to follow the transactions in an E2E run

Nana-EC · 2024-12-21T04:13:42Z

tools/layer-zero-example/test/htsAdapterTests.js

+const amount = '100';
+
+describe('HTSAdapterTests', function() {
+  it('@hedera @fund-and-approve transfer to adapter', async () => {


Similar to other comment can you log all the state changing transaction hashes for all the tests to make it easy to tell the E2E story on a given run

chore: add initial lz setup

8089199

Signed-off-by: nikolay <[email protected]>

natanasow self-assigned this Dec 11, 2024

chore: fix tests

a755877

Signed-off-by: nikolay <[email protected]>

natanasow added this to the 0.64.0 milestone Dec 12, 2024

natanasow added the dev tools Features enabling dev tool integration label Dec 12, 2024

natanasow added 2 commits December 12, 2024 11:38

chore: remove unused tests

b955221

Signed-off-by: nikolay <[email protected]>

chore: add oft hts example

cf025fd

Signed-off-by: nikolay <[email protected]>

natanasow marked this pull request as ready for review December 16, 2024 15:02

natanasow requested review from AlfredoG87, Nana-EC, a team, georgi-l95 and Ivo-Yankov as code owners December 16, 2024 15:02

natanasow requested a review from jeromy-cannon December 16, 2024 15:02

quiet-node reviewed Dec 16, 2024

View reviewed changes

tools/layer-zero-example/contracts/BaseHTSOFT.sol Outdated Show resolved Hide resolved

quiet-node reviewed Dec 16, 2024

View reviewed changes

tools/layer-zero-example/hardhat.config.js Show resolved Hide resolved

quiet-node added the internal For changes that affect the project's internal workings but not its outward-facing functionality. label Dec 16, 2024

Ferparishuertas reviewed Dec 17, 2024

View reviewed changes

tools/layer-zero-example/contracts/ExampleOFTHTS.sol Outdated Show resolved Hide resolved

Ferparishuertas reviewed Dec 17, 2024

View reviewed changes

tools/layer-zero-example/contracts/ExampleOFTHTS.sol Outdated Show resolved Hide resolved

chore: fix contracts

5ee7083

Signed-off-by: nikolay <[email protected]>

natanasow requested review from a team as code owners December 18, 2024 13:00

natanasow requested a review from dalvizu December 18, 2024 13:00

natanasow added 3 commits December 19, 2024 12:27

chore: rename contracts

45a2259

Signed-off-by: nikolay <[email protected]>

chore: add hts adapter

447a0ff

Signed-off-by: nikolay <[email protected]>

chore: add whbar example

30813ab

Signed-off-by: nikolay <[email protected]>

natanasow requested a review from Ferparishuertas December 19, 2024 14:34

Nana-EC reviewed Dec 19, 2024

View reviewed changes

Ferparishuertas reviewed Dec 20, 2024

View reviewed changes

natanasow added 4 commits December 20, 2024 15:49

chore: cleanup and fix readme

cb1d5e1

Signed-off-by: nikolay <[email protected]>

chore: add hts connector to the readme

e4c1f47

Signed-off-by: nikolay <[email protected]>

chore: fix readme

f4b1bfe

Signed-off-by: nikolay <[email protected]>

chore: fix readme

4cac520

Signed-off-by: nikolay <[email protected]>

Nana-EC reviewed Dec 21, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add layer zero examples #3326

feat: add layer zero examples #3326

natanasow commented Dec 11, 2024 •

edited

Loading

github-actions bot commented Dec 11, 2024 •

edited

Loading

quiet-node left a comment

Nana-EC left a comment

Nana-EC Dec 19, 2024

natanasow Dec 20, 2024

Nana-EC Dec 19, 2024

natanasow Dec 20, 2024

Nana-EC Dec 19, 2024

natanasow Dec 20, 2024

Ferparishuertas Dec 20, 2024

Ferparishuertas Dec 20, 2024

sonarqubecloud bot commented Dec 20, 2024

codecov bot commented Dec 20, 2024

Nana-EC left a comment

Nana-EC Dec 20, 2024

Nana-EC Dec 21, 2024

Nana-EC Dec 21, 2024

Nana-EC Dec 21, 2024

Nana-EC Dec 21, 2024

feat: add layer zero examples #3326

Are you sure you want to change the base?

feat: add layer zero examples #3326

Conversation

natanasow commented Dec 11, 2024 • edited Loading

Tasks

github-actions bot commented Dec 11, 2024 • edited Loading

Test Results

quiet-node left a comment

Choose a reason for hiding this comment

Nana-EC left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Dec 20, 2024

Quality Gate failed

codecov bot commented Dec 20, 2024

Codecov Report

Nana-EC left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

natanasow commented Dec 11, 2024 •

edited

Loading

github-actions bot commented Dec 11, 2024 •

edited

Loading