Skip to content

Commit

Permalink
chore: edit readme
Browse files Browse the repository at this point in the history 
Signed-off-by: nikolay <n.atanasow94@gmail.com>
  • Loading branch information
@natanasow
natanasow committed Jan 16, 2025
1 parent 67b61c6 commit a21049c
Show file tree
Hide file tree
Showing 5 changed files with 346 additions and 45 deletions.
46 changes: 1 addition & 45 deletions tools/layer-zero-example/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ npx hardhat deploy-erc20 --decimals 18 --mint 10000000000000000000 --network hed
npx hardhat deploy-erc20 --decimals 18 --mint 10000000000000000000 --network bsc_testnet
```

- Deploying an OFT Adapters which will be used as a lockbox of ERC20s deployed the step above
- Deploying an OFT Adapters which will be used as a lockbox of ERC20s deployed the step above, you can use an already existing HTS token as well
```typescript
npx hardhat deploy-oft-adapter --token <erc20_hedera_address> --network hedera_testnet
npx hardhat deploy-oft-adapter --token <erc20_bsc_address> --network bsc_testnet
Expand Down Expand Up @@ -279,50 +279,6 @@ npx hardhat test --grep "HTSConnectorExistingToken @hedera @test" --network hede
npx hardhat test --grep "HTSConnectorExistingToken @bsc @test" --network bsc_testnet
```

### HTS Adapter

If your HTS token already exists on Hedera and you want to connect it to another chain, you can deploy the OFT Adapter contract to act as an intermediary lockbox for it.

- Deploying ERC20 and HTS
```typescript
npx hardhat create-hts-token --network hedera_testnet
npx hardhat deploy-erc20 --decimals 8 --mint 1000 --network bsc_testnet
```

- Deploying an OFT Adapters which will be used as lockboxes of ERC20 and HTS deployed the step above
```typescript
npx hardhat deploy-oft-adapter --token <hts_token_address> --network hedera_testnet
npx hardhat deploy-oft-adapter --token <erc20_bsc_address> --network bsc_testnet
```

- In order to connect OFT Adapters together, we need to set the peer of the target OFT Adapter, more info can be found here https://docs.layerzero.network/v2/developers/evm/getting-started#connecting-your-contracts
```typescript
npx hardhat set-peer --source <hedera_oft_adapter_address> --target <bsc_oft_adapter_address> --network hedera_testnet
npx hardhat set-peer --source <bsc_oft_adapter_address> --target <hedera_oft_adapter_address> --network bsc_testnet
```

- Fill the .env

- Here we're funding the Adapter on both chains with some liquidity and after that we're approving it to spend the signer's token
```typescript
npx hardhat test --grep "HTSAdapterTests @hedera @fund-and-approve" --network hedera_testnet
npx hardhat test --grep "HTSAdapterTests @bsc @fund-and-approve" --network bsc_testnet
```

- On these steps, we're sending already existing tokens that are used by OFT Adapter between different chains
```typescript
npx hardhat test --grep "HTSAdapterTests @hedera @send" --network hedera_testnet
npx hardhat test --grep "HTSAdapterTests @bsc @send" --network bsc_testnet
```

- Wait a couple of minutes, the LZ progress can be tracked on `https://testnet.layerzeroscan.com/tx/<tx_hash>`

- Finally we're checking whether the tokens are transferred successfully
```typescript
npx hardhat test --grep "HTSAdapterTests @hedera @test" --network hedera_testnet
npx hardhat test --grep "HTSAdapterTests @bsc @test" --network bsc_testnet
```

### WHBAR flow

Wrap and transfer HBARs across different chains.
Expand Down
1 change: 1 addition & 0 deletions tools/whbar-hardhat-example/artifacts/build-info/c727fbdd7751ef4216ecb7bff9960403.json
View file

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions tools/whbar-hardhat-example/artifacts/contracts/WHBAR.sol/WHBAR.dbg.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"_format": "hh-sol-dbg-1",
"buildInfo": "../../build-info/c727fbdd7751ef4216ecb7bff9960403.json"
}
299 changes: 299 additions & 0 deletions tools/whbar-hardhat-example/artifacts/contracts/WHBAR.sol/WHBAR.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,299 @@
{
"_format": "hh-sol-artifact-1",
"contractName": "WHBAR",
"sourceName": "contracts/WHBAR.sol",
"abi": [
{
"anonymous": false,
"inputs": [
{
"indexed": true,
"internalType": "address",
"name": "src",
"type": "address"
},
{
"indexed": true,
"internalType": "address",
"name": "guy",
"type": "address"
},
{
"indexed": false,
"internalType": "uint256",
"name": "wad",
"type": "uint256"
}
],
"name": "Approval",
"type": "event"
},
{
"anonymous": false,
"inputs": [
{
"indexed": true,
"internalType": "address",
"name": "dst",
"type": "address"
},
{
"indexed": false,
"internalType": "uint256",
"name": "wad",
"type": "uint256"
}
],
"name": "Deposit",
"type": "event"
},
{
"anonymous": false,
"inputs": [
{
"indexed": true,
"internalType": "address",
"name": "src",
"type": "address"
},
{
"indexed": true,
"internalType": "address",
"name": "dst",
"type": "address"
},
{
"indexed": false,
"internalType": "uint256",
"name": "wad",
"type": "uint256"
}
],
"name": "Transfer",
"type": "event"
},
{
"anonymous": false,
"inputs": [
{
"indexed": true,
"internalType": "address",
"name": "src",
"type": "address"
},
{
"indexed": false,
"internalType": "uint256",
"name": "wad",
"type": "uint256"
}
],
"name": "Withdrawal",
"type": "event"
},
{
"stateMutability": "payable",
"type": "fallback"
},
{
"inputs": [
{
"internalType": "address",
"name": "",
"type": "address"
},
{
"internalType": "address",
"name": "",
"type": "address"
}
],
"name": "allowance",
"outputs": [
{
"internalType": "uint256",
"name": "",
"type": "uint256"
}
],
"stateMutability": "view",
"type": "function"
},
{
"inputs": [
{
"internalType": "address",
"name": "guy",
"type": "address"
},
{
"internalType": "uint256",
"name": "wad",
"type": "uint256"
}
],
"name": "approve",
"outputs": [
{
"internalType": "bool",
"name": "",
"type": "bool"
}
],
"stateMutability": "nonpayable",
"type": "function"
},
{
"inputs": [
{
"internalType": "address",
"name": "",
"type": "address"
}
],
"name": "balanceOf",
"outputs": [
{
"internalType": "uint256",
"name": "",
"type": "uint256"
}
],
"stateMutability": "view",
"type": "function"
},
{
"inputs": [],
"name": "decimals",
"outputs": [
{
"internalType": "uint8",
"name": "",
"type": "uint8"
}
],
"stateMutability": "view",
"type": "function"
},
{
"inputs": [],
"name": "deposit",
"outputs": [],
"stateMutability": "payable",
"type": "function"
},
{
"inputs": [],
"name": "name",
"outputs": [
{
"internalType": "string",
"name": "",
"type": "string"
}
],
"stateMutability": "view",
"type": "function"
},
{
"inputs": [],
"name": "symbol",
"outputs": [
{
"internalType": "string",
"name": "",
"type": "string"
}
],
"stateMutability": "view",
"type": "function"
},
{
"inputs": [],
"name": "totalSupply",
"outputs": [
{
"internalType": "uint256",
"name": "",
"type": "uint256"
}
],
"stateMutability": "view",
"type": "function"
},
{
"inputs": [
{
"internalType": "address",
"name": "dst",
"type": "address"
},
{
"internalType": "uint256",
"name": "wad",
"type": "uint256"
}
],
"name": "transfer",
"outputs": [
{
"internalType": "bool",
"name": "",
"type": "bool"
}
],
"stateMutability": "nonpayable",
"type": "function"
},
{
"inputs": [
{
"internalType": "address",
"name": "src",
"type": "address"
},
{
"internalType": "address",
"name": "dst",
"type": "address"
},
{
"internalType": "uint256",
"name": "wad",
"type": "uint256"
}
],
"name": "transferFrom",
"outputs": [
{
"internalType": "bool",
"name": "",
"type": "bool"
}
],
"stateMutability": "nonpayable",
"type": "function"
},
{
"inputs": [
{
"internalType": "uint256",
"name": "wad",
"type": "uint256"
}
],
"name": "withdraw",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
{
"stateMutability": "payable",
"type": "receive"
}
],
"bytecode": "0x60c0604052600c60809081526b2bb930b83832b210242120a960a11b60a05260009061002b9082610116565b506040805180820190915260058152642ba42120a960d91b60208201526001906100559082610116565b506002805460ff1916600817905534801561006f57600080fd5b506101d5565b634e487b7160e01b600052604160045260246000fd5b600181811c9082168061009f57607f821691505b6020821081036100bf57634e487b7160e01b600052602260045260246000fd5b50919050565b601f821115610111576000816000526020600020601f850160051c810160208610156100ee5750805b601f850160051c820191505b8181101561010d578281556001016100fa565b5050505b505050565b81516001600160401b0381111561012f5761012f610075565b6101438161013d845461008b565b846100c5565b602080601f83116001811461017857600084156101605750858301515b600019600386901b1c1916600185901b17855561010d565b600085815260208120601f198616915b828110156101a757888601518255948401946001909101908401610188565b50858210156101c55787850151600019600388901b60f8161c191681555b5050505050600190811b01905550565b6107ca806101e46000396000f3fe6080604052600436106100b05760003560e01c8063313ce56711610074578063a9059cbb1161004e578063a9059cbb146101ed578063d0e30db0146100bf578063dd62ed3e1461020d576100bf565b8063313ce5671461017f57806370a08231146101ab57806395d89b41146101d8576100bf565b806306fdde03146100c7578063095ea7b3146100f257806318160ddd1461012257806323b872dd1461013f5780632e1a7d4d1461015f576100bf565b366100bf576100bd610245565b005b6100bd610245565b3480156100d357600080fd5b506100dc6102a0565b6040516100e991906105e6565b60405180910390f35b3480156100fe57600080fd5b5061011261010d366004610651565b61032e565b60405190151581526020016100e9565b34801561012e57600080fd5b50475b6040519081526020016100e9565b34801561014b57600080fd5b5061011261015a36600461067b565b61039b565b34801561016b57600080fd5b506100bd61017a3660046106b7565b61051f565b34801561018b57600080fd5b506002546101999060ff1681565b60405160ff90911681526020016100e9565b3480156101b757600080fd5b506101316101c63660046106d0565b60036020526000908152604090205481565b3480156101e457600080fd5b506100dc6105c5565b3480156101f957600080fd5b50610112610208366004610651565b6105d2565b34801561021957600080fd5b506101316102283660046106eb565b600460209081526000928352604080842090915290825290205481565b3360009081526003602052604081208054349290610264908490610734565b909155505060405134815233907fe1fffcc4923d04b559f4d29a8bfc6cda04eb5b0d3c460751c2402c5c5cc9109c9060200160405180910390a2565b600080546102ad90610747565b80601f01602080910402602001604051908101604052809291908181526020018280546102d990610747565b80156103265780601f106102fb57610100808354040283529160200191610326565b820191906000526020600020905b81548152906001019060200180831161030957829003601f168201915b505050505081565b3360008181526004602090815260408083206001600160a01b038716808552925280832085905551919290917f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925906103899086815260200190565b60405180910390a35060015b92915050565b6001600160a01b0383166000908152600360205260408120548211156103c057600080fd5b6001600160a01b03841633148015906103fe57506001600160a01b038416600090815260046020908152604080832033845290915290205460001914155b1561046c576001600160a01b038416600090815260046020908152604080832033845290915290205482111561043357600080fd5b6001600160a01b038416600090815260046020908152604080832033845290915281208054849290610466908490610781565b90915550505b6001600160a01b03841660009081526003602052604081208054849290610494908490610781565b90915550506001600160a01b038316600090815260036020526040812080548492906104c1908490610734565b92505081905550826001600160a01b0316846001600160a01b03167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef8460405161050d91815260200190565b60405180910390a35060019392505050565b3360009081526003602052604090205481111561053b57600080fd5b336000908152600360205260408120805483929061055a908490610781565b9091555050604051339082156108fc029083906000818181858888f1935050505015801561058c573d6000803e3d6000fd5b5060405181815233907f7fcf532c15f0a6db0bd6d0e038bea71d30d808c7d98cb3bf7268a95bf5081b659060200160405180910390a250565b600180546102ad90610747565b60006105df33848461039b565b9392505050565b60006020808352835180602085015260005b81811015610614578581018301518582016040015282016105f8565b506000604082860101526040601f19601f8301168501019250505092915050565b80356001600160a01b038116811461064c57600080fd5b919050565b6000806040838503121561066457600080fd5b61066d83610635565b946020939093013593505050565b60008060006060848603121561069057600080fd5b61069984610635565b92506106a760208501610635565b9150604084013590509250925092565b6000602082840312156106c957600080fd5b5035919050565b6000602082840312156106e257600080fd5b6105df82610635565b600080604083850312156106fe57600080fd5b61070783610635565b915061071560208401610635565b90509250929050565b634e487b7160e01b600052601160045260246000fd5b808201808211156103955761039561071e565b600181811c9082168061075b57607f821691505b60208210810361077b57634e487b7160e01b600052602260045260246000fd5b50919050565b818103818111156103955761039561071e56fea2646970667358221220a1dca85dfef96905d29674251275a3fa44e3baffcf803ce7afe28aac94f9dd4d64736f6c63430008180033",
"deployedBytecode": "0x6080604052600436106100b05760003560e01c8063313ce56711610074578063a9059cbb1161004e578063a9059cbb146101ed578063d0e30db0146100bf578063dd62ed3e1461020d576100bf565b8063313ce5671461017f57806370a08231146101ab57806395d89b41146101d8576100bf565b806306fdde03146100c7578063095ea7b3146100f257806318160ddd1461012257806323b872dd1461013f5780632e1a7d4d1461015f576100bf565b366100bf576100bd610245565b005b6100bd610245565b3480156100d357600080fd5b506100dc6102a0565b6040516100e991906105e6565b60405180910390f35b3480156100fe57600080fd5b5061011261010d366004610651565b61032e565b60405190151581526020016100e9565b34801561012e57600080fd5b50475b6040519081526020016100e9565b34801561014b57600080fd5b5061011261015a36600461067b565b61039b565b34801561016b57600080fd5b506100bd61017a3660046106b7565b61051f565b34801561018b57600080fd5b506002546101999060ff1681565b60405160ff90911681526020016100e9565b3480156101b757600080fd5b506101316101c63660046106d0565b60036020526000908152604090205481565b3480156101e457600080fd5b506100dc6105c5565b3480156101f957600080fd5b50610112610208366004610651565b6105d2565b34801561021957600080fd5b506101316102283660046106eb565b600460209081526000928352604080842090915290825290205481565b3360009081526003602052604081208054349290610264908490610734565b909155505060405134815233907fe1fffcc4923d04b559f4d29a8bfc6cda04eb5b0d3c460751c2402c5c5cc9109c9060200160405180910390a2565b600080546102ad90610747565b80601f01602080910402602001604051908101604052809291908181526020018280546102d990610747565b80156103265780601f106102fb57610100808354040283529160200191610326565b820191906000526020600020905b81548152906001019060200180831161030957829003601f168201915b505050505081565b3360008181526004602090815260408083206001600160a01b038716808552925280832085905551919290917f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925906103899086815260200190565b60405180910390a35060015b92915050565b6001600160a01b0383166000908152600360205260408120548211156103c057600080fd5b6001600160a01b03841633148015906103fe57506001600160a01b038416600090815260046020908152604080832033845290915290205460001914155b1561046c576001600160a01b038416600090815260046020908152604080832033845290915290205482111561043357600080fd5b6001600160a01b038416600090815260046020908152604080832033845290915281208054849290610466908490610781565b90915550505b6001600160a01b03841660009081526003602052604081208054849290610494908490610781565b90915550506001600160a01b038316600090815260036020526040812080548492906104c1908490610734565b92505081905550826001600160a01b0316846001600160a01b03167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef8460405161050d91815260200190565b60405180910390a35060019392505050565b3360009081526003602052604090205481111561053b57600080fd5b336000908152600360205260408120805483929061055a908490610781565b9091555050604051339082156108fc029083906000818181858888f1935050505015801561058c573d6000803e3d6000fd5b5060405181815233907f7fcf532c15f0a6db0bd6d0e038bea71d30d808c7d98cb3bf7268a95bf5081b659060200160405180910390a250565b600180546102ad90610747565b60006105df33848461039b565b9392505050565b60006020808352835180602085015260005b81811015610614578581018301518582016040015282016105f8565b506000604082860101526040601f19601f8301168501019250505092915050565b80356001600160a01b038116811461064c57600080fd5b919050565b6000806040838503121561066457600080fd5b61066d83610635565b946020939093013593505050565b60008060006060848603121561069057600080fd5b61069984610635565b92506106a760208501610635565b9150604084013590509250925092565b6000602082840312156106c957600080fd5b5035919050565b6000602082840312156106e257600080fd5b6105df82610635565b600080604083850312156106fe57600080fd5b61070783610635565b915061071560208401610635565b90509250929050565b634e487b7160e01b600052601160045260246000fd5b808201808211156103955761039561071e565b600181811c9082168061075b57607f821691505b60208210810361077b57634e487b7160e01b600052602260045260246000fd5b50919050565b818103818111156103955761039561071e56fea2646970667358221220a1dca85dfef96905d29674251275a3fa44e3baffcf803ce7afe28aac94f9dd4d64736f6c63430008180033",
"linkReferences": {},
"deployedLinkReferences": {}
}
Loading

0 comments on commit a21049c

Please sign in to comment.