Update the multioutput example to support Bitcoin #113

lukema95 · 2024-01-11T07:40:27Z

Relevant PR: #101

omnichain/multioutput/contracts/MultiOutput.sol

omnichain/multioutput/tasks/destination.ts

fadeev · 2024-01-25T07:18:19Z

One final change request is to remove _doSwapAndWithdraw and _doWithdrawal. These functions are not reused within the contract and make it a bit harder to follow the flow. And it saves us about 20 lines of code making the tutorial a bit shorter.

So it would look something like this:

    function onCrossChainCall(
        zContext calldata context,
        address zrc20,
        uint256 amount,
        bytes calldata message
    ) external virtual override onlySystem {
        address btcToken = systemContract.gasCoinZRC20ByChainId(BITCOIN);
        if (btcToken == address(0)) revert FetchingBTCZRC20Failed();

        (
            address evmRecipient,
            bytes memory btcRecipient,
            address[] memory destinationTokens
        ) = parseMessage(context.chainID, message);

        uint256 totalTransfers = destinationTokens.length;
        if (totalTransfers == 0) revert NoAvailableTransfers();

        uint256 amountToTransfer = amount / totalTransfers;
        uint256 leftOver = amount - amountToTransfer * totalTransfers;

        uint256 lastTransferIndex = destinationTokens[
            destinationTokens.length - 1
        ] == zrc20
            ? destinationTokens.length - 2
            : destinationTokens.length - 1;

        for (uint256 i; i < destinationTokens.length; i++) {
            address targetZRC20 = destinationTokens[i];
            if (targetZRC20 == zrc20) continue;

            if (lastTransferIndex == i) {
                amountToTransfer += leftOver;
            }

            bytes memory recipient = abi.encodePacked(
                BytesHelperLib.addressToBytes(evmRecipient)
            );

            if (targetZRC20 == btcToken) {
                if (btcRecipient.length == 0) revert InvalidRecipient();
                recipient = abi.encodePacked(btcRecipient);
            }
            
            (address gasZRC20, uint256 gasFee) = IZRC20(targetZRC20)
                .withdrawGasFee();

            uint256 outputAmount = SwapHelperLib._doSwap(
                systemContract.wZetaContractAddress(),
                systemContract.uniswapv2FactoryAddress(),
                systemContract.uniswapv2Router02Address(),
                zrc20,
                amountToTransfer,
                targetZRC20,
                0
            );

            if (gasZRC20 != targetZRC20) revert WrongGasContract();
            if (gasFee >= amount) revert NotEnoughToPayGasFee();

            IZRC20(targetZRC20).approve(targetZRC20, gasFee);
            IZRC20(targetZRC20).withdraw(
                abi.encodePacked(recipient),
                amount - gasFee
            );
            emit Withdrawal(targetZRC20, outputAmount, recipient);
        }
    }

fadeev · 2024-01-25T07:18:39Z

Great work, @lukema95! 🎉

lukema95 · 2024-01-25T08:42:52Z

One final change request is to remove _doSwapAndWithdraw and _doWithdrawal. These functions are not reused within the contract and make it a bit harder to follow the flow. And it saves us about 20 lines of code making the tutorial a bit shorter.

So it would look something like this:

    function onCrossChainCall(
        zContext calldata context,
        address zrc20,
        uint256 amount,
        bytes calldata message
    ) external virtual override onlySystem {
        address btcToken = systemContract.gasCoinZRC20ByChainId(BITCOIN);
        if (btcToken == address(0)) revert FetchingBTCZRC20Failed();

        (
            address evmRecipient,
            bytes memory btcRecipient,
            address[] memory destinationTokens
        ) = parseMessage(context.chainID, message);

        uint256 totalTransfers = destinationTokens.length;
        if (totalTransfers == 0) revert NoAvailableTransfers();

        uint256 amountToTransfer = amount / totalTransfers;
        uint256 leftOver = amount - amountToTransfer * totalTransfers;

        uint256 lastTransferIndex = destinationTokens[
            destinationTokens.length - 1
        ] == zrc20
            ? destinationTokens.length - 2
            : destinationTokens.length - 1;

        for (uint256 i; i < destinationTokens.length; i++) {
            address targetZRC20 = destinationTokens[i];
            if (targetZRC20 == zrc20) continue;

            if (lastTransferIndex == i) {
                amountToTransfer += leftOver;
            }

            bytes memory recipient = abi.encodePacked(
                BytesHelperLib.addressToBytes(evmRecipient)
            );

            if (targetZRC20 == btcToken) {
                if (btcRecipient.length == 0) revert InvalidRecipient();
                recipient = abi.encodePacked(btcRecipient);
            }
            
            (address gasZRC20, uint256 gasFee) = IZRC20(targetZRC20)
                .withdrawGasFee();

            uint256 outputAmount = SwapHelperLib._doSwap(
                systemContract.wZetaContractAddress(),
                systemContract.uniswapv2FactoryAddress(),
                systemContract.uniswapv2Router02Address(),
                zrc20,
                amountToTransfer,
                targetZRC20,
                0
            );

            if (gasZRC20 != targetZRC20) revert WrongGasContract();
            if (gasFee >= amount) revert NotEnoughToPayGasFee();

            IZRC20(targetZRC20).approve(targetZRC20, gasFee);
            IZRC20(targetZRC20).withdraw(
                abi.encodePacked(recipient),
                amount - gasFee
            );
            emit Withdrawal(targetZRC20, outputAmount, recipient);
        }
    }

Hi @fadeev , I've extracted the _doSwapAndWithdraw and _doWithdrawal functions because the above will cause a deep stack error at compile time, looks like below:

npx hardhat compile --force
CompilerError: Stack too deep, try removing local variables.
   --> contracts/MultiOutput.sol:147:17:
    |
147 |                 zrc20,
    |                 ^^^^^

The error is the following function:

            uint256 outputAmount = SwapHelperLib._doSwap(
                systemContract.wZetaContractAddress(),
                systemContract.uniswapv2FactoryAddress(),
                systemContract.uniswapv2Router02Address(),
                zrc20,
                amountToTransfer,
                targetZRC20,
                0
            );

fadeev · 2024-01-25T08:57:35Z

@andresaiello please, review.

fadeev · 2024-01-25T08:58:16Z

@lukema95 ok, cool. Can you please resolve the yarn conflict, and we should be good to go 👍

fadeev · 2024-01-25T08:59:46Z

btw this PR doesn't add support for ERC-20s, so we might want to change the title.

socket-security · 2024-01-25T09:04:27Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@nomicfoundation/[email protected]	filesystem, shell Transitive: environment	`+7`	110 kB	fvictorio
npm/@zetachain/[email protected]	Transitive: environment, filesystem, network, shell	`+119`	94.1 MB	lucasjanon
npm/[email protected]	environment, filesystem, network, shell Transitive: eval	`+165`	40.2 MB	fvictorio

View full report↗︎

lukema95 · 2024-01-25T10:05:57Z

btw this PR doesn't add support for ERC-20s, so we might want to change the title.

Change to “Update the multioutput example to support Bitcoin ?”

fadeev · 2024-03-11T12:58:30Z

Removed the _doWithdrawal function, because it wasn't used anywhere in the code.

fadeev · 2024-03-11T13:01:14Z

Removed bytesMemoryToAddress, because it comes out of the box in the upcoming version of the toolkit, so we can import it instead like so: BytesHelperLib.bytesMemoryToAddress (the implementation of the function is the same).

fadeev · 2024-03-13T11:33:52Z

@lukema95 I'm having issues with the contract, can't get it to work.

npx hardhat interact --contract 0x2369A46C1EF38772e24cA2B3722E75d78bb7b322 --network mumbai_testnet  --target-token 0xd97B1de3619ed2c6BEb3860147E30cA8A7dC9891,0x13A0c5930C028511Dc02665E7285134B6d11A5f4 --amount 5 --recipient 0x4955a3F38ff86ae92A914445099caa8eA2B9bA32 --btc-recipient tb1q8shzf7afc3rhw8n6w6ec32s8h6e2mrw077d0gg 
🔑 Using account: 0x4955a3F38ff86ae92A914445099caa8eA2B9bA32

🚀 Successfully broadcasted a token transfer transaction on mumbai_testnet network.
📝 Transaction hash: 0x71a4a8acfa93fde13815fbcdddbb92991d75355c52771078b3f1a198b799575b

~/template npx hardhat cctx 0x71a4a8acfa93fde13815fbcdddbb92991d75355c52771078b3f1a198b799575b
^CCCTXs on ZetaChain found.

⠦ 0x99356aa7b2e8de671e7e25a8e24246149ae0d0b70c43734d62a45da69edf2f09: 80001 → 7001: PendingRevert
 (contract call failed: method 'depositAndCall', contract '0xEdf1c3275d13489aCdC6cD6eD246E72458B8
795B', args: [{[73 85 163 243 143 248 106 233 42 145 68 69 9 156 170 142 162 185 186 50] 0x000000
0000000000000000000000000000000000 80001} 0x48f80608B672DC30DC7e3dbBd0343c5F02C738Eb 500000000000
0000000 0x2369A46C1EF38772e24cA2B3722E75d78bb7b322 [0 0 0 0 0 0 0 0 0 0 0 0 73 85 163 243 143 248
 106 233 42 145 68 69 9 156 170 142 162 185 186 50 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 
0 0 0 0 0 0 0 0 96 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 192 0 0 0 0 0 0 
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 42 116 98 49 113 56 115 104 122 102 55 97 102 9
9 51 114 104 119 56 110 54 119 54 101 99 51 50 115 56 104 54 101 50 109 114 119 48 55 55 100 48 1
03 103 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 
0 0 0 0 0 0 0 0 64 0 0 0 0 0 0 0 0 0 0 0 0 217 123 29 227 97 158 210 198 190 179 134 1 71 227 12 
168 167 220 152 145 0 0 0 0 0 0 0 0 0 0 0 0 19 160 197 147 12 2 133 17 220 2 102 94 114 133 19 75
 109 17 165 244]]: execution reverted: ret 0x: evm transaction execution failed)

npx hardhat interact --contract 0x2369A46C1EF38772e24cA2B3722E75d78bb7b322 --network mumbai_testnet  --target-token 0xd97B1de3619ed2c6BEb3860147E30cA8A7dC9891,0x13A0c5930C028511Dc02665E7285134B6d11A5f4 --amount 50 --recipient 0x4955a3F38ff86ae92A914445099caa8eA2B9bA32 --btc-recipient tb1q8shzf7afc3rhw8n6w6ec32s8h6e2mrw077d0gg
🔑 Using account: 0x4955a3F38ff86ae92A914445099caa8eA2B9bA32

🚀 Successfully broadcasted a token transfer transaction on mumbai_testnet network.
📝 Transaction hash: 0x9cbc03bacf6b588fd72175bb8008c417df369355eb259f8894bd1753d20a78a9

~/template npx hardhat cctx 0x9cbc03bacf6b588fd72175bb8008c417df369355eb259f8894bd1753d20a78a9
✓ CCTXs on ZetaChain found.

⠴ 0xfcc7266f59af433cf612e072e4a579c9f4a29ee805452ae97c97effe006e8d2e: 80001 → 7001: PendingRevert
 (contract call failed: method 'depositAndCall', contract '0xEdf1c3275d13489aCdC6cD6eD246E72458B8
795B', args: [{[73 85 163 243 143 248 106 233 42 145 68 69 9 156 170 142 162 185 186 50] 0x000000
0000000000000000000000000000000000 80001} 0x48f80608B672DC30DC7e3dbBd0343c5F02C738Eb 500000000000
00000000 0x2369A46C1EF38772e24cA2B3722E75d78bb7b322 [0 0 0 0 0 0 0 0 0 0 0 0 73 85 163 243 143 24
8 106 233 42 145 68 69 9 156 170 142 162 185 186 50 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0^C0 0 0 0 0 0 0 0 96 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 192 0 0 0 0 0 0
 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 42 116 98 49 113 56 115 104 122 102 55 97 102 
99 51 114 104 119 56 110 54 119 54 101 99 51 50 115 56 104 54 101 50 109 114 119 48 55 55 100 48 
103 103 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
 0 0 0 0 0 0 0 0 64 0 0 0 0 0 0 0 0 0 0 0 0 217 123 29 227 97 158 210 198 190 179 134 1 71 227 12
 168 167 220 152 145 0 0 0 0 0 0 0 0 0 0 0 0 19 160 197 147 12 2 133 17 220 2 102 94 114 133 19 7
5 109 17 165 244]]: execution reverted: ret 0x: evm transaction execution failed)

npx hardhat interact --contract 0x2369A46C1EF38772e24cA2B3722E75d78bb7b322 --network bsc_testnet  --target-token 0x48f80608B672DC30DC7e3dbBd0343c5F02C738Eb,0x13A0c5930C028511Dc02665E7285134B6d11A5f4 --amount 2 --recipient 0x4955a3F38ff86ae92A914445099caa8eA2B9bA32                 
🔑 Using account: 0x4955a3F38ff86ae92A914445099caa8eA2B9bA32

🚀 Successfully broadcasted a token transfer transaction on bsc_testnet network.
📝 Transaction hash: 0x135b014f63fead4c3e6841e22e30aed2c258ad25e6c1d16ee140ea5f507c04ff

~/template npx hardhat cctx 0x135b014f63fead4c3e6841e22e30aed2c258ad25e6c1d16ee140ea5f507c04ff
^CCCTXs on ZetaChain found.

⠏ 0x6131f7991982f89400f2ae5bfbfc41439d68856ed4b658d9b01df7ef57625e92: 97 → 7001: PendingRevert (c
ontract call failed: method 'depositAndCall', contract '0xEdf1c3275d13489aCdC6cD6eD246E72458B8795
B', args: [{[73 85 163 243 143 248 106 233 42 145 68 69 9 156 170 142 162 185 186 50] 0x000000000
0000000000000000000000000000000 97} 0xd97B1de3619ed2c6BEb3860147E30cA8A7dC9891 200000000000000000
0 0x2369A46C1EF38772e24cA2B3722E75d78bb7b322 [0 0 0 0 0 0 0 0 0 0 0 0 73 85 163 243 143 248 106 2
33 42 145 68 69 9 156 170 142 162 185 186 50 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 
0 0 0 0 0 96 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 128 0 0 0 0 0 0 0 0 0 
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
 0 0 0 0 0 64 0 0 0 0 0 0 0 0 0 0 0 0 72 248 6 8 182 114 220 48 220 126 61 187 208 52 60 95 2 199
 56 235 0 0 0 0 0 0 0 0 0 0 0 0 19 160 197 147 12 2 133 17 220 2 102 94 114 133 19 75 109 17 165 
244]]: execution reverted: ret 0x: evm transaction execution failed)

npx hardhat interact --contract 0x2369A46C1EF38772e24cA2B3722E75d78bb7b322 --network bsc_testnet  --target-token 0x48f80608B672DC30DC7e3dbBd0343c5F02C738Eb --amount 2 --recipient 0x4955a3F38ff86ae92A914445099caa8eA2B9bA32                                          
🔑 Using account: 0x4955a3F38ff86ae92A914445099caa8eA2B9bA32

🚀 Successfully broadcasted a token transfer transaction on bsc_testnet network.
📝 Transaction hash: 0xb8f604f5c2c20c6180ef2f52b5ce6f9656f94bdd04842d7bf04546ffa3d39668

~/template npx hardhat cctx 0xb8f604f5c2c20c6180ef2f52b5ce6f9656f94bdd04842d7bf04546ffa3d39668
^CCCTXs on ZetaChain found.

⠋ 0xfa82f24252f08aa626ace1dda67d6331d37771291a1000f8f4f2081f66d55ce0: 97 → 7001: PendingRevert (c
ontract call failed: method 'depositAndCall', contract '0xEdf1c3275d13489aCdC6cD6eD246E72458B8795
B', args: [{[73 85 163 243 143 248 106 233 42 145 68 69 9 156 170 142 162 185 186 50] 0x000000000
0000000000000000000000000000000 97} 0xd97B1de3619ed2c6BEb3860147E30cA8A7dC9891 200000000000000000
0 0x2369A46C1EF38772e24cA2B3722E75d78bb7b322 [0 0 0 0 0 0 0 0 0 0 0 0 73 85 163 243 143 248 106 2
33 42 145 68 69 9 156 170 142 162 185 186 50 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 
0 0 0 0 0 96 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 128 0 0 0 0 0 0 0 0 0 
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
 0 0 0 0 0 32 0 0 0 0 0 0 0 0 0 0 0 0 72 248 6 8 182 114 220 48 220 126 61 187 208 52 60 95 2 199
 56 235]]: execution reverted: ret 0x: evm transaction execution failed)

fadeev

npx hardhat interact --contract 0xa573Df1F0729FE6F1BD69b0a5dbFE393e6e09f47 --network mumbai_testnet  --target-token 0xd97B1de3619ed2c6BEb3860147E30cA8A7dC9891,0x65a45c57636f9BcCeD4fe193A602008578BcA90b --amount 50 --recipient 0x4955a3F38ff86ae92A914445099caa8eA2B9bA32 --btc-recipient tb1q8shzf7afc3rhw8n6w6ec32s8h6e2mrw077d0gg

npx hardhat cctx 0x642446f8b3d20d12f58cbbf2de33377e3c92d016f043deb81c5b854e7a440cd0
✓ CCTXs on ZetaChain found.

✓ 0x7b54665297fb6779da417ca431dd764b15f2237e3d7efbc0881e3801cced4fce: 80001 → 7001: OutboundMined (Remote omnicha
in contract call completed)
✓ 0xbd97de12a390e767491d5d6cbeed30a08b9c69adac7becee0be8cbb46ced93d2: 7001 → 97: OutboundMined 
⠋ 0x468e11ea759a3683ec89467ee2c47dde3f8245c984c41886c7a3712e5956e349: 7001 → 18332: PendingOutbound

update multioutput contract

57649d1

fadeev reviewed Jan 11, 2024

View reviewed changes

omnichain/multioutput/contracts/MultiOutput.sol Outdated Show resolved Hide resolved

lukema95 added 2 commits January 13, 2024 23:53

update multioutput contract

76ffd4e

fix multioutput interact script

4ef75b1

fadeev reviewed Jan 16, 2024

View reviewed changes

omnichain/multioutput/contracts/MultiOutput.sol Outdated Show resolved Hide resolved

fadeev reviewed Jan 24, 2024

View reviewed changes

omnichain/multioutput/contracts/MultiOutput.sol Outdated Show resolved Hide resolved

fix btc withdraw

56f35d3

fadeev reviewed Jan 24, 2024

View reviewed changes

omnichain/multioutput/contracts/MultiOutput.sol Outdated Show resolved Hide resolved

remove destination cli

ea886e0

fadeev reviewed Jan 25, 2024

View reviewed changes

omnichain/multioutput/tasks/destination.ts Outdated Show resolved Hide resolved

fadeev marked this pull request as ready for review January 25, 2024 07:18

fadeev requested review from andresaiello and lucas-janon as code owners January 25, 2024 07:18

delete destination task

449964d

fadeev mentioned this pull request Jan 25, 2024

Update the multioutput example to support Bitcoin and ERC-20s #101

Closed

2 tasks

lukema95 added 2 commits January 25, 2024 17:00

resolve conflicts

52fad5d

resolve conflicts

1a5a32e

lukema95 changed the title ~~Update the multioutput example to support Bitcoin and ERC-20s~~ Update the multioutput example to support Bitcoin Jan 26, 2024

andresaiello approved these changes Feb 14, 2024

View reviewed changes

This was referenced Feb 19, 2024

Support foundry framework. zeta-chain/template#40

Open

Add tests to contracts #14

Closed

support erc20 swap (#140)

2611b7c

fadeev added 2 commits March 11, 2024 17:56

Merge branch 'main' into multi-output

7c90740

remove do withdrawal

6bb15eb

use BytesHelperLib.bytesMemoryToAddress

71d0a4e

fadeev added 7 commits March 11, 2024 18:01

formatting

663f7f6

tsconfig nodenext

b70b5b3

tsconfig

7456546

remove unused events

62cd330

lowercase multioutput: rename to foo

d9af1fe

lowercase multioutput: rename to Multioutput

0ab90a0

lowercase Multioutput

b3e6340

update toolkit version

fbd3a34

fadeev mentioned this pull request Mar 19, 2024

Update Multioutput to support BTC and ERC-20 zeta-chain/docs#290

Merged

fadeev self-requested a review March 19, 2024 11:22

fadeev approved these changes Mar 19, 2024

View reviewed changes

fadeev added 2 commits April 3, 2024 10:29

remove package json

2743c09

add package json back

6fc0d0e

andresaiello approved these changes Apr 3, 2024

View reviewed changes

fadeev merged commit ac4d2c7 into main Apr 4, 2024
5 checks passed

fadeev deleted the multi-output branch April 4, 2024 09:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update the multioutput example to support Bitcoin #113

Update the multioutput example to support Bitcoin #113

lukema95 commented Jan 11, 2024

fadeev commented Jan 25, 2024

fadeev commented Jan 25, 2024 •

edited

Loading

lukema95 commented Jan 25, 2024

fadeev commented Jan 25, 2024

fadeev commented Jan 25, 2024

fadeev commented Jan 25, 2024

socket-security bot commented Jan 25, 2024 •

edited

Loading

lukema95 commented Jan 25, 2024

fadeev commented Mar 11, 2024

fadeev commented Mar 11, 2024

fadeev commented Mar 13, 2024

fadeev left a comment

Update the multioutput example to support Bitcoin #113

Update the multioutput example to support Bitcoin #113

Conversation

lukema95 commented Jan 11, 2024

fadeev commented Jan 25, 2024

fadeev commented Jan 25, 2024 • edited Loading

lukema95 commented Jan 25, 2024

fadeev commented Jan 25, 2024

fadeev commented Jan 25, 2024

fadeev commented Jan 25, 2024

socket-security bot commented Jan 25, 2024 • edited Loading

lukema95 commented Jan 25, 2024

fadeev commented Mar 11, 2024

fadeev commented Mar 11, 2024

fadeev commented Mar 13, 2024

fadeev left a comment

Choose a reason for hiding this comment

fadeev commented Jan 25, 2024 •

edited

Loading

socket-security bot commented Jan 25, 2024 •

edited

Loading