feat: support system to bridge txs #383

marshacb · 2024-03-14T21:49:13Z

Description

This PR introduces the SystemToBridge tx direction for constructing BridgeHub transactions from AssetHub.

Changes

adds support for the transferAssetsUsingTypeAndThen extrinsic.
adds SystemToBridge direction.
In addition to allowing Parachain IDs, the API now allows for a GlobalConsensus location (e.g. {"parents":"2","interior":{"X1":{"GlobalConsensus":{"Ethereum":{"chainId":"11155111"}}}}}) to be provided as a value for thedestChainId parameter in createTransferTransaction. If a destChainId is provided containing a known X1 GlobalConsensus junction it will be considered a Bridge tx. Currently known consensus junctions are set to polkadot, kusama, westend, rococo, and ethereum.
Allows for registered global consensus asset locations on AssetHub (e.g. {"parents":"2","interior":{"X2":[{"GlobalConsensus":{"Ethereum":{"chainId":"11155111"}}},{"AccountKey20":{"network":null,"key":"0xfff9976782d46cc05630d1f6ebab18b2324d6b14"}}]}} on AssetHub Rococo) to be provided as assetIds in createTransferTransaction.
Adds error validation checks for SystemToBridge direction
Adds unit and integration tests for SystemToBridge direction
Removed unnecessary check restricting generalKey locations to XCM version 2 in resolveMultiLocation

BridgeHub Snowbridge: (Rococo AssetHub WETH -> Ethereum Sepolia)

Example of constructing a transferAssets call sending Snowbridge WETH to Ethereum Sepolia from Rococo AssetHub:

	const { api, specName, chainName, safeXcmVersion } = await constructApiPromise(
		'wss://rococo-asset-hub-rpc.polkadot.io',
	);
	const assetApi = new AssetTransferApi(api, specName, safeXcmVersion, {
		chainName,
	});

	let callInfo = await assetApi.createTransferTransaction(
			`{"parents":"2","interior":{"X1":{"GlobalConsensus":{"Ethereum":{"chainId":"11155111"}}}}}`,
			'0x6E733286C3Dc52C67b8DAdFDd634eD9c3Fb05B5B',
			[
				`{"parents":"2","interior":{"X2":[{"GlobalConsensus":{"Ethereum":{"chainId":"11155111"}}},{"AccountKey20":{"network":null,"key":"0xfff9976782d46cc05630d1f6ebab18b2324d6b14"}}]}}`,
			],
			['1000000000000'],
			{
				format: 'call',
				xcmVersion: 4,
			},
		);

		console.log(callInfo);

Expected Output

{
  origin: 'statemine',
  dest: 'ethereum',
  direction: 'SystemToBridge',
  xcmVersion: 4,
  method: 'transferAssets',
  format: 'call',
  tx: '0x1f0b04020109079edaa80204000103006e733286c3dc52c67b8dadfdd634ed9c3fb05b5b0404020209079edaa8020300fff9976782d46cc05630d1f6ebab18b2324d6b1400070010a5d4e80000000000'
}

The following decoded tx:
 {
    "args": {
        "dest": {
            "V4": {
                "parents": "2",
                "interior": {
                    "X1": [
                        {
                            "GlobalConsensus": {
                                "Ethereum": {
                                    "chainId": "11,155,111"
                                }
                            }
                        }
                    ]
                }
            }
        },
        "beneficiary": {
            "V4": {
                "parents": "0",
                "interior": {
                    "X1": [
                        {
                            "AccountKey20": {
                                "network": null,
                                "key": "0x6e733286c3dc52c67b8dadfdd634ed9c3fb05b5b"
                            }
                        }
                    ]
                }
            }
        },
        "assets": {
            "V4": [
                {
                    "id": {
                        "parents": "2",
                        "interior": {
                            "X2": [
                                {
                                    "GlobalConsensus": {
                                        "Ethereum": {
                                            "chainId": "11,155,111"
                                        }
                                    }
                                },
                                {
                                    "AccountKey20": {
                                        "network": null,
                                        "key": "0xfff9976782d46cc05630d1f6ebab18b2324d6b14"
                                    }
                                }
                            ]
                        }
                    },
                    "fun": {
                        "Fungible": "1,000,000,000,000"
                    }
                }
            ]
        },
        "fee_asset_item": "0",
        "weight_limit": "Unlimited"
    },
    "method": "transferAssets",
    "section": "polkadotXcm"
}

BridgeHub Polkadot<>Kusama Bridge: (Kusama AssetHub KSM -> Polkadot AssetHub)

Example of constructing a transferAssets call sending KSM to Polkadot AssetHub from Kusama AssetHub:

const { api, specName, chainName, safeXcmVersion } = await constructApiPromise(
		'wss://kusama-asset-hub-rpc.polkadot.io',
	);
	const assetApi = new AssetTransferApi(api, specName, safeXcmVersion, {
		chainName,
	});

let callInfo = await assetApi.createTransferTransaction(
			`{"parents":"2","interior":{"X1":{"GlobalConsensus":"Polkadot"}}}`,
			'5EWNeodpcQ6iYibJ3jmWVe85nsok1EDG8Kk3aFg8ZzpfY1qX',
			[`{"parents":"1","interior":{"Here":""}}`],
			['1000000000000'],
			{
				format: 'call',
				xcmVersion: 4,
			},
		);

		console.log(callInfo);

Expected Output:

{
  origin: 'statemine',
  dest: 'polkadot',
  direction: 'SystemToBridge',
  xcmVersion: 4,
  method: 'transferAssets',
  format: 'call',
  tx: '0x1f0b040202090200a10f04000101006c0c32faf970eacb2d4d8e538ac0dab3642492561a1be6f241c645876c056c1d04040100000700e87648170000000000'
}

The following decoded tx:
 {
    "args": {
        "dest": {
            "V4": {
                "parents": "2",
                "interior": {
                    "X2": [
                        {
                            "GlobalConsensus": "Polkadot"
                        },
                        {
                            "Parachain": "1,000"
                        }
                    ]
                }
            }
        },
        "beneficiary": {
            "V4": {
                "parents": "0",
                "interior": {
                    "X1": [
                        {
                            "AccountId32": {
                                "network": null,
                                "id": "0x6c0c32faf970eacb2d4d8e538ac0dab3642492561a1be6f241c645876c056c1d"
                            }
                        }
                    ]
                }
            }
        },
        "assets": {
            "V4": [
                {
                    "id": {
                        "parents": "1",
                        "interior": "Here"
                    },
                    "fun": {
                        "Fungible": "100,000,000,000"
                    }
                }
            ]
        },
        "fee_asset_item": "0",
        "weight_limit": "Unlimited"
    },
    "method": "transferAssets",
    "section": "polkadotXcm"
}

Note

If a given asset location doesn’t exist in the ForeignAssets pallet of the origin chain the API will throw an AssetNotFound error
Currently assumes the user is sending an asset that is known/valid from the context of the destination chain (checks that the asset exists on chain for the origin)
Providing the assetTransferType option will resolve the call to transferAssetsUsingTypeAndThen if it is found in the runtime. When providing a value of RemoteReserve for assetTransferType or feesTransferType, a location value is expected for remoteReserveAssetTransferTypeLocation and/or remoteReserveFeesTransferTypeLocation respectively.

related issue: #382
closes: #400

add unit tests add util functions for determining direction based on asset and dest locations

IkerAlus · 2024-03-15T11:43:31Z

great to see this out already!

One request @marshacb : once this is ready for review, it would be really helpful if you add details to the original post of the differences in UX this feature implies (for example, destinations as multilocations and so on)

…ocations add SystemToBridge integration tests

updated getGlobalConsensusSystemName to check X1 junction rather than entire string for valid consensus name added consensus name check to xcm tx input checks for system to bridge direction

Polkadot-Forum · 2024-04-04T08:02:59Z

This pull request has been mentioned on Polkadot Forum. There might be relevant details there:

https://forum.polkadot.network/t/parity-tech-update-for-march/7226/1

add AssetTransferType and resolveTransferType util func

acatangiu

Output/result looks good 👍

Does it support P<>K bridge as well?

marshacb · 2024-05-09T15:33:14Z

Output/result looks good 👍

Does it support P<>K bridge as well?

Hey @acatangiu, thanks for checking this out! Yes, this feature will support P<>K bridge transaction construction as well.
Just to note, this is currently being reworked to support the newer transfer_assets_using_type_and_then call for bridge transfer cases where AssetHub is required to be treated as the remote reserve.

add util function for constructing beneficiary add util to construct versioned xcm asset id add ability to explicitly construct transferAssetsUsingTypeAndThen by providing transferAssetsType

update resolveCall to use assetTransferType

update resolveAssetTransferType and createXcmVersionedAssetId

update tests

…ransferType

IkerAlus

Couple of general comments:

Can we add an example where we send (bridge) the native token of another ecosystem back to its native ecosystem? For example ROC from Westend AH back to Rococo AH?
Any reason in particular to have the example with Trappist? In principle, it is normal foreign asset transfer from AH which is already covered in other examples.

bee344

Two nits but great work

README.md

fix comment spacing in readme

…ive chain removed trappist example added tests for customXcmMessageOnDest dest

marshacb · 2024-05-16T21:08:23Z

Couple of general comments:

Can we add an example where we send (bridge) the native token of another ecosystem back to its native ecosystem? For example ROC from Westend AH back to Rococo AH?

Any reason in particular to have the example with Trappist? In principle, it is normal foreign asset transfer from AH which is already covered in other examples.

I added examples of bridging DOT back to Polkadot from Kusama (and a similar one for Kusama).
No reason in particular so I removed the Trappist example

…o 1 asset outside of transferAssetsUsingTypeAndThen runtime calls

examples/rococo/assetHub/foreignAssetTransfers/teleport/assetHubWETHToBridgeHub.ts

IkerAlus

Superb work, I only have a comment about an example. The rest looks good to me.

PS: I found some not accurate error messages while testing different inputs, but I will open a different issue for them since they are not directly related to this PR.

acatangiu

Very nice!

Left some comments for some corrections.

examples/kusama/assetHub/bridgeTransfers/assetHubDOTToPolkadot.ts

examples/kusama/assetHub/bridgeTransfers/assetHubKSMToPolkadot.ts

examples/polkadot/assetHub/bridgeTransfers/assetHubDOTToKusama.ts

examples/polkadot/assetHub/bridgeTransfers/assetHubKSMToKusama.ts

examples/rococo/assetHub/bridgeTransfers/assetHubROCToWestend.ts

examples/rococo/assetHub/bridgeTransfers/assetHubWNDToWestend.ts

examples/rococo/assetHub/foreignAssetTransfers/reserve/assetHubMUSEToBifrostRemoteReserve.ts

examples/rococo/assetHub/foreignAssetTransfers/reserve/assetHubMUSEToRhala.ts

examples/rococo/assetHub/foreignAssetTransfers/reserve/assetHubWETHToRhala.ts

marshacb added 4 commits March 7, 2024 09:18

test bridge tx interface

c200fb6

add system to bridge direction

66d5ca8

add unit tests add util functions for determining direction based on asset and dest locations

update rococo bridge tx example

7dfb859

remove unused const

fc38d48

marshacb added 7 commits March 18, 2024 22:52

update resolveMultilocation to account for XCM V4 X1 junction asset l…

b10f6bc

…ocations add SystemToBridge integration tests

revert polkadot local transfer example changes

c288c8a

update dest address in rococo bridge example

56d8495

updated getGlobalConsensusSystemName to check X1 junction rather than entire string for valid consensus name added consensus name check to xcm tx input checks for system to bridge direction

lint

eee0347

add error validation tests

ca8136c

lint

e93abdd

test teleports

fd3429f

update assethub metadata

5cb9fc0

add AssetTransferType and resolveTransferType util func

acatangiu reviewed May 9, 2024

View reviewed changes

marshacb added 14 commits May 9, 2024 23:01

add tests for transferAssetsUsingTypeAndThen

d437df2

add util function for constructing beneficiary add util to construct versioned xcm asset id add ability to explicitly construct transferAssetsUsingTypeAndThen by providing transferAssetsType

update example text

0b69a73

revert fetchCallType naming

16758d8

lint

69d9e9d

update default xcm on dest to account for assets length

961ad43

update examples

d067eff

update resolveCall to use assetTransferType

add tests for checkSystemToBridgeInputs

cda636e

update system to bridge integration tests

95489ee

update resolveAssetTransferType and createXcmVersionedAssetId

update chainDestIsBridge check

2f15edc

add interior check to chainDestIsBridge

6582115

update README

b08e7a5

update global consensus destination location creation

63d0931

update tests

update assetHubROCToWestend example to create transferAssets call

16efb17

update assetHubROCToWestend example

6b1b9a3

marshacb added 3 commits May 15, 2024 18:08

update assetHubROCToWestend example to use LocalReserve as the assetT…

20b59e1

…ransferType

lint

dc75c00

update example

8e53456

marshacb changed the title ~~feat: support system to bridge txs[WIP]~~ feat: support system to bridge txs May 16, 2024

marshacb requested review from TarikGul and bee344 May 16, 2024 12:27

IkerAlus requested changes May 16, 2024

View reviewed changes

bee344 approved these changes May 16, 2024

View reviewed changes

bee344 reviewed May 16, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

bee344 reviewed May 16, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

marshacb added 3 commits May 16, 2024 13:37

fix bug where toLocalLowerCase was used instead of toLowerCase

e35390f

update spacing of system to parachain support chart

171d0e1

fix comment spacing in readme

add examples sending a global consensus foreign asset back to its nat…

c3d66b6

…ive chain removed trappist example added tests for customXcmMessageOnDest dest

marshacb added 3 commits May 16, 2024 17:14

update wnd to westend example

cd2785d

add check to ensure polkadotXcm and xcmPallet transfers are limited t…

092c18a

…o 1 asset outside of transferAssetsUsingTypeAndThen runtime calls

update checkXcmInputs checkAssetIdsLengthIsValid tests

95d38a4

IkerAlus reviewed May 20, 2024

View reviewed changes

examples/rococo/assetHub/foreignAssetTransfers/teleport/assetHubWETHToBridgeHub.ts Outdated Show resolved Hide resolved

IkerAlus approved these changes May 20, 2024

View reviewed changes

removed foreign asset to bridgehub example

a4dd286

marshacb merged commit 311ecd9 into main May 20, 2024
6 checks passed

marshacb mentioned this pull request May 20, 2024

Overarching feature: Asset Hub to handle any kind of transfers of bridged assets from Snowbridge #371

Open

acatangiu reviewed May 21, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support system to bridge txs #383

feat: support system to bridge txs #383

marshacb commented Mar 14, 2024 •

edited

IkerAlus commented Mar 15, 2024

Polkadot-Forum commented Apr 4, 2024

acatangiu left a comment

marshacb commented May 9, 2024

IkerAlus left a comment

bee344 left a comment

marshacb commented May 16, 2024

IkerAlus left a comment

acatangiu left a comment

feat: support system to bridge txs #383

feat: support system to bridge txs #383

Conversation

marshacb commented Mar 14, 2024 • edited

Description

Changes

BridgeHub Snowbridge: (Rococo AssetHub WETH -> Ethereum Sepolia)

BridgeHub Polkadot<>Kusama Bridge: (Kusama AssetHub KSM -> Polkadot AssetHub)

Note

IkerAlus commented Mar 15, 2024

Polkadot-Forum commented Apr 4, 2024

acatangiu left a comment

Choose a reason for hiding this comment

marshacb commented May 9, 2024

IkerAlus left a comment

Choose a reason for hiding this comment

bee344 left a comment

Choose a reason for hiding this comment

marshacb commented May 16, 2024

IkerAlus left a comment

Choose a reason for hiding this comment

acatangiu left a comment

Choose a reason for hiding this comment

marshacb commented Mar 14, 2024 •

edited