Skip to content

Commit b299ff0

Browse files
oedoed
authored
Merge pull request #18 from hokunet/feat/axelar-support
feat: axelar support
2 parents 80beb37 + 8e6a515 commit b299ff0

9 files changed

+549
-41
lines changed

‎.gitmodules

+7-1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@
1717
[submodule "lib/openzeppelin-contracts-upgradeable"]
1818
path = lib/openzeppelin-contracts-upgradeable
1919
url = https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable
20+
[submodule "lib/interchain-token-service"]
21+
path = lib/interchain-token-service
22+
url = https://github.com/axelarnetwork/interchain-token-service
2023
[submodule "lib/openzeppelin-foundry-upgrades"]
2124
path = lib/openzeppelin-foundry-upgrades
22-
url = https://github.com/OpenZeppelin/openzeppelin-foundry-upgrades
25+
url = https://github.com/OpenZeppelin/openzeppelin-foundry-upgrades
26+
[submodule "lib/axelar-gmp-sdk-solidity"]
27+
path = lib/axelar-gmp-sdk-solidity
28+
url = https://github.com/axelarnetwork/axelar-gmp-sdk-solidity

‎README.md

+54
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,60 @@ forge install
5656
forge build
5757
```
5858

59+
## Clean
60+
```shell
61+
forge clean
62+
```
63+
64+
## Deploy
65+
66+
To deploy the contract you need the following:
67+
- Select an environment prefix: `l` = Local, `t` = Testnet, "" = Mainnet
68+
- The address of the Axelar Interchain Token Service on chain you are deploying to
69+
- A private key with funds on the target chain
70+
- An rpc endpoint for the target chain
71+
72+
### Local
73+
Start a local network using anvil,
74+
```shell
75+
anvil
76+
```
77+
Anvil will output an address and private key, copy one of the private keys for the step below.
78+
79+
Deploy the contract, in this case we just use the zero-address for the Axelar Interchain Token Service.
80+
```shell
81+
forge script script/Hoku.s.sol:DeployScript --sig 'run(string)' local --broadcast -vv --rpc-url http://localhost:8545 --private-key <0x...>
82+
```
83+
84+
### Testnet
85+
```shell
86+
forge script script/Hoku.s.sol:DeployScript --sig 'run(string)' testnet --broadcast -vv --rpc-url <...> --private-key <0x...>
87+
```
88+
89+
### Ethereum Mainnet
90+
```shell
91+
forge script script/Hoku.s.sol:DeployScript --sig 'run(string)' ethereum --broadcast -vv --rpc-url https://eth.merkle.io --private-key <0x...>
92+
```
93+
94+
### Filecoin mainnet
95+
RPC copied from https://docs.filecoin.io/networks/mainnet/rpcs
96+
```shell
97+
forge script script/Hoku.s.sol:DeployScript --sig 'run(string)' filecoin --broadcast -vv -g 100000 --rpc-url https://api.node.glif.io/rpc/v1 --private-key <0x...>
98+
```
99+
The `-g` flag is a multiplier on the estimated gas price. In this case 100000 is 1000x the estimated gas price. Unclear why filecoin requires such a large multiplier.
100+
101+
## Deployments
102+
103+
|chain | address|
104+
| -----| ------|
105+
|calibration |0xEa944dEf4fd96A70f0B53D98E6945f643491B960|
106+
|base sepolia|0xd02Bc370Ac6D40B57B8D64578c85132dF59f0109|
107+
108+
109+
## [Faucet](https://github.com/hokunet/faucet) Usage
110+
111+
To get 5e18 tokens on a given address:
112+
59113
### Deploying contracts
60114

61115
The scripts for deploying contracts are in `script/` directory:

‎lib/axelar-gmp-sdk-solidity

Submodule axelar-gmp-sdk-solidity added at 3157ba4

‎lib/interchain-token-service

‎remappings.txt

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,6 @@ forge-std/=lib/forge-std/src/
33
@filecoin-solidity/v0.8/=lib/filecoin-solidity/contracts/v0.8/
44
@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/
55
@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/
6-
@openzeppelin/foundry-upgrades/=lib/openzeppelin-foundry-upgrades/src/
6+
@openzeppelin/foundry-upgrades/=lib/openzeppelin-foundry-upgrades/src/
7+
@axelar-network/interchain-token-service/=lib/interchain-token-service/
8+
@axelar-network/axelar-gmp-sdk-solidity/=lib/axelar-gmp-sdk-solidity/

‎script/Bridge.s.sol

+211
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,211 @@
1+
// SPDX-License-Identifier: UNLICENSED
2+
pragma solidity ^0.8.23;
3+
4+
import {Hoku} from "../src/Hoku.sol";
5+
import {IInterchainTokenService} from
6+
"@axelar-network/interchain-token-service/contracts/interfaces/IInterchainTokenService.sol";
7+
import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
8+
import {Script, console} from "forge-std/Script.sol";
9+
10+
address constant INTERCHAIN_TOKEN_SERVICE = 0xB5FB4BE02232B1bBA4dC8f81dc24C26980dE9e3C;
11+
string constant FILECOIN = "filecoin";
12+
string constant ETHEREUM = "Ethereum";
13+
14+
/*
15+
Examples of how to call each function using forge script
16+
17+
Command prefixes:
18+
Ethereum:
19+
forge script script/Bridge.s.sol:BridgeOps -vvv --rpc-url https://eth.merkle.io
20+
21+
Filecoin:
22+
forge script script/Bridge.s.sol:BridgeOps -vvv -g 100000 --rpc-url https://api.node.glif.io/rpc/v1
23+
24+
To check if an address is a minter:
25+
--sig "isMinter(address,address)" <proxy_address> <address_to_check>
26+
27+
To check the balance of an address:
28+
--sig "checkBalance(address,address)" <proxy_address> <address_to_check>
29+
30+
To mint funds:
31+
--broadcast --sig "mintFunds(address,address,uint256)" <proxy_address> <recipient_address> <amount> --private-key
32+
<your_private_key>
33+
34+
To perform a cross-chain transfer:
35+
--broadcast --sig "xChainTransfer(address,string,address,uint256)" <proxy_address> <destination_chain>
36+
<recipient_address> <amount> --private-key <your_private_key>
37+
38+
To burn tokens:
39+
--broadcast --sig "burnTokens(address,address,uint256)" <proxy_address> <account> <amount> --private-key
40+
<your_private_key>
41+
42+
Note: Replace <proxy_address>, <address_to_check>, <recipient_address>, <amount>, <your_private_key>, and
43+
<destination_chain> with actual values.
44+
The --broadcast flag is used for functions that modify state (mintFunds and xChainTransfer).
45+
For Filecoin, we add the -g 100000 flag due to gas price estimation issues. Adjust this value as needed.
46+
The -vvv flag increases verbosity for more detailed output.
47+
For <amount>, use the full token amount including decimal places. For example, if the token has 18 decimal places and
48+
you want to transfer 1 token, use 1000000000000000000.*/
49+
50+
contract BridgeOps is Script {
51+
using Strings for string;
52+
53+
function setUp() public {}
54+
55+
function isMinter(address proxyAddress, address addressToCheck) public view {
56+
console.log("Proxy address: ", proxyAddress);
57+
58+
// Create Hoku instance
59+
Hoku hoku = Hoku(proxyAddress);
60+
61+
// Check if the given address has the MINTER_ROLE
62+
bool hasMinterRole = hoku.hasRole(hoku.MINTER_ROLE(), addressToCheck);
63+
64+
console.log("Address to check: ", addressToCheck);
65+
console.log("Has MINTER_ROLE: ", hasMinterRole);
66+
}
67+
68+
function mintFunds(address proxyAddress, address recipient, uint256 amount) public {
69+
console.log("Minting funds to address: ", recipient);
70+
console.log("Amount: ", amount);
71+
72+
Hoku hoku = Hoku(proxyAddress);
73+
vm.startBroadcast();
74+
// Ensure the caller has the MINTER_ROLE
75+
require(hoku.hasRole(hoku.MINTER_ROLE(), msg.sender), "Caller is not a minter");
76+
77+
// Mint tokens to the recipient
78+
hoku.mint(recipient, amount);
79+
vm.stopBroadcast();
80+
81+
console.log("Minting successful");
82+
}
83+
84+
function estimateGas(string memory destinationChain) public returns (uint256) {
85+
string memory sourceChain = destinationChain.equal(FILECOIN) ? ETHEREUM : FILECOIN;
86+
string[] memory inputs = new string[](3);
87+
inputs[0] = "bash";
88+
inputs[1] = "-c";
89+
// axelar api docs: https://docs.axelarscan.io/gmp#estimateGasFee
90+
inputs[2] = string(
91+
abi.encodePacked(
92+
"curl -s \'https://api.gmp.axelarscan.io?method=estimateGasFee&destinationChain=",
93+
destinationChain,
94+
"&sourceChain=",
95+
sourceChain,
96+
destinationChain.equal(FILECOIN) ? "&gasLimit=700000&gasMultiplier=1000\'" : "&gasLimit=70000\'"
97+
)
98+
);
99+
// Uncomment if you need to debug the curl command
100+
// console.log('Curl command:', inputs[2]);
101+
bytes memory res = vm.ffi(inputs);
102+
string memory resString = string(res);
103+
104+
uint256 estimatedGas;
105+
// this party is pretty hacky. For some reason vm.ffi interprets the string containing
106+
// the integer as a hex if it's smaller than a certain size. 12 is just a guess.
107+
if (res.length < 12) {
108+
// Compressed/encoded value
109+
estimatedGas = decodeBytes(res);
110+
} else {
111+
// Plain string number
112+
estimatedGas = parseInt(resString);
113+
}
114+
115+
console.log("Estimated gas:", estimatedGas);
116+
return estimatedGas;
117+
}
118+
119+
function decodeBytes(bytes memory data) internal pure returns (uint256) {
120+
uint256 result = 0;
121+
for (uint256 i = 0; i < data.length; i++) {
122+
uint8 value = uint8(data[i]);
123+
uint8 tens = value / 16;
124+
uint8 ones = value % 16;
125+
result = result * 100 + tens * 10 + ones;
126+
}
127+
return result;
128+
}
129+
130+
function parseInt(string memory _value) internal pure returns (uint256) {
131+
bytes memory b = bytes(_value);
132+
uint256 result = 0;
133+
for (uint256 i = 0; i < b.length; i++) {
134+
uint8 c = uint8(b[i]);
135+
if (c >= 48 && c <= 57) {
136+
result = result * 10 + (c - 48);
137+
}
138+
}
139+
return result;
140+
}
141+
142+
function xChainTransfer(address proxyAddress, string memory destinationChain, address recipient, uint256 amount)
143+
public
144+
payable
145+
{
146+
console.log("Making cross-chain transfer");
147+
console.log("Destination chain: ", destinationChain);
148+
console.log("Recipient: ", recipient);
149+
console.log("Amount: ", amount);
150+
151+
Hoku hoku = Hoku(proxyAddress);
152+
153+
uint256 gasEstimate = estimateGas(destinationChain);
154+
console.log("Gas estimate result: ", gasEstimate);
155+
156+
// Convert recipient address to bytes
157+
// bytes memory recipientBytes = abi.encode(recipient);
158+
bytes memory recipientBytes = abi.encodePacked(recipient);
159+
160+
vm.startBroadcast();
161+
162+
// Log balance of the sender
163+
uint256 senderBalance = hoku.balanceOf(msg.sender);
164+
console.log("Sender balance: ", senderBalance);
165+
166+
// Approve the token manager to spend tokens on behalf of the sender
167+
hoku.approve(INTERCHAIN_TOKEN_SERVICE, amount);
168+
// Log the currently approved amount for the its
169+
uint256 currentApproval = hoku.allowance(msg.sender, INTERCHAIN_TOKEN_SERVICE);
170+
console.log("Current approval for ITS: ", currentApproval);
171+
172+
vm.breakpoint("a");
173+
// Perform the interchain transfer with empty metadata
174+
hoku.interchainTransfer{value: gasEstimate}(destinationChain, recipientBytes, amount, "");
175+
176+
vm.stopBroadcast();
177+
178+
console.log("Interchain transfer initiated");
179+
}
180+
181+
function checkBalance(address proxyAddress, address accountToCheck) public view {
182+
console.log("Checking balance for address: ", accountToCheck);
183+
184+
Hoku hoku = Hoku(proxyAddress);
185+
// Get the balance of the account
186+
uint256 balance = hoku.balanceOf(accountToCheck);
187+
188+
console.log("Balance: ", balance);
189+
}
190+
191+
function setApproval(address proxyAddress, address account, uint256 amount) public {
192+
console.log("Setting approval for address: ", account);
193+
console.log("Amount: ", amount);
194+
195+
Hoku hoku = Hoku(proxyAddress);
196+
197+
vm.startBroadcast();
198+
199+
uint256 currentApproval = hoku.allowance(msg.sender, account);
200+
console.log("Current approval: ", currentApproval);
201+
202+
hoku.approve(account, amount + 1);
203+
204+
currentApproval = hoku.allowance(msg.sender, account);
205+
console.log("Current approval: ", currentApproval);
206+
207+
vm.stopBroadcast();
208+
209+
console.log("Approval set successfully");
210+
}
211+
}

‎script/Hoku.s.sol

+39-23
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
// SPDX-License-Identifier: UNLICENSED
22
pragma solidity ^0.8.23;
33

4+
import {Hoku} from "../src/Hoku.sol";
5+
import {IInterchainTokenService} from
6+
"@axelar-network/interchain-token-service/contracts/interfaces/IInterchainTokenService.sol";
7+
import {ITokenManagerType} from "@axelar-network/interchain-token-service/contracts/interfaces/ITokenManagerType.sol";
8+
import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
49
import {Options, Upgrades} from "@openzeppelin/foundry-upgrades/Upgrades.sol";
5-
import {Script} from "forge-std/Script.sol";
6-
import {console2 as console} from "forge-std/console2.sol";
10+
import {Script, console} from "forge-std/Script.sol";
711

8-
import {Hoku} from "../src/Hoku.sol";
9-
import {Environment} from "../src/types/CommonTypes.sol";
12+
address constant INTERCHAIN_TOKEN_SERVICE = 0xB5FB4BE02232B1bBA4dC8f81dc24C26980dE9e3C;
1013

1114
contract DeployScript is Script {
12-
string constant PRIVATE_KEY = "PRIVATE_KEY";
1315
address public proxyAddress;
1416

1517
function setUp() public {}
@@ -18,32 +20,46 @@ contract DeployScript is Script {
1820
return proxyAddress;
1921
}
2022

21-
function run(Environment env) public returns (Hoku) {
22-
if (vm.envExists(PRIVATE_KEY)) {
23-
uint256 privateKey = vm.envUint(PRIVATE_KEY);
24-
if (env == Environment.Local) {
25-
console.log("Deploying to local network");
26-
} else if (env == Environment.Testnet) {
27-
console.log("Deploying to testnet network");
28-
} else {
29-
revert("Mainnet is not supported");
30-
}
31-
vm.startBroadcast(privateKey);
32-
} else if (env == Environment.Foundry) {
33-
console.log("Deploying to foundry");
34-
vm.startBroadcast();
35-
} else {
36-
revert("PRIVATE_KEY not set");
23+
function run(string memory network) public returns (Hoku) {
24+
string memory prefix = "";
25+
if (Strings.equal(network, "local")) {
26+
prefix = "l";
27+
} else if (Strings.equal(network, "testnet")) {
28+
prefix = "t";
29+
} else if (!Strings.equal(network, "ethereum") && !Strings.equal(network, "filecoin")) {
30+
revert("Unsupported network.");
3731
}
32+
vm.startBroadcast();
3833

39-
proxyAddress = Upgrades.deployUUPSProxy("Hoku.sol", abi.encodeCall(Hoku.initialize, (env)));
40-
vm.stopBroadcast();
34+
bytes32 itsSalt = keccak256("HOKU_SALT");
35+
proxyAddress = Upgrades.deployUUPSProxy(
36+
"Hoku.sol", abi.encodeCall(Hoku.initialize, (prefix, INTERCHAIN_TOKEN_SERVICE, itsSalt))
37+
);
4138

4239
// Check implementation
4340
address implAddr = Upgrades.getImplementationAddress(proxyAddress);
4441
console.log("Implementation address: ", implAddr);
4542

4643
Hoku hoku = Hoku(proxyAddress);
44+
45+
console.log("Deployer: ", hoku.deployer());
46+
47+
if (Strings.equal(network, "filecoin") || Strings.equal(network, "ethereum")) {
48+
console.log("Deploying token manager");
49+
IInterchainTokenService itsContract = IInterchainTokenService(INTERCHAIN_TOKEN_SERVICE);
50+
bytes memory params = abi.encode(abi.encodePacked(hoku.deployer()), address(hoku));
51+
itsContract.deployTokenManager(itsSalt, "", ITokenManagerType.TokenManagerType.MINT_BURN_FROM, params, 0);
52+
bytes32 itsTokenId = hoku.interchainTokenId();
53+
54+
console.log("Hoku Interchain Token ID: ", Strings.toHexString(uint256(itsTokenId), 32));
55+
address tokenManager = itsContract.tokenManagerAddress(itsTokenId);
56+
console.log("Token manager: ", tokenManager);
57+
58+
// Grant minter role to token manager
59+
hoku.grantRole(hoku.MINTER_ROLE(), tokenManager);
60+
}
61+
vm.stopBroadcast();
62+
4763
return hoku;
4864
}
4965
}

0 commit comments

Comments
 (0)