parameter hookData in v4 universal router v4 pool swaps.

[snarflakes]

Can we add hookData as a parameter for V4 universal router v4 pool swaps?
It was unclear if that is already available in the demonstration example. I've added it into the example to show where I would imagine it would go.

thanks!
Snar

pool_key = codec.encode.v4_pool_key(
eth_address, # "0x0000000000000000000000000000000000000000"
token_address,
pool_fee, # ex: 3000
tick_spacing, # ex: 60
)

trx_params = (
codec.
encode.
chain().
v4_swap().
swap_exact_in_single(
pool_key=pool_key,
zero_for_one=True,
amount_in=eth_amount,
amount_out_min=token_amount_min,
hookData
).
take_all(token_address, Wei(0)).
settle_all(eth_address, eth_amount). # with eth_address = "0x0000000000000000000000000000000000000000"
build_v4_swap().
build_transaction(account.address, eth_amount, ur_address=ur_address)
)

raw_transaction = w3.eth.account.sign_transaction(trx_params, account.key).raw_transaction
trx_hash = w3.eth.send_raw_transaction(raw_transaction)

thanks,
Snar

[Elnaril]

@snarflakes
The hook data can already be passed to the v4 function swap_exact_in_single(), exactly where you imagine it would go.

I agree that the README/doc does not show all possibilities. It's intentional as this page is already a bit overloaded. But there is a docstring for each function that is part of the lib API, clarifying their purpose and arguments.
Here for swap_exact_in_single() :

>>> help(codec.encode.chain().v4_swap().swap_exact_in_single)

Help on method swap_exact_in_single in module uniswap_universal_router_decoder._encoder:

swap_exact_in_single(pool_key: 'PoolKey', zero_for_one: 'bool', amount_in: 'Wei', amount_out_min: 'Wei', hook_data: 'bytes' = b'') -> '_V4ChainedSwapFunctionBuilder' method of uniswap_universal_router_decoder._encoder._V4ChainedSwapFunctionBuilder instance
    Swap - Encode the call to the V4_SWAP function SWAP_EXACT_IN_SINGLE.
    :param pool_key: the target pool key returned by encode.v4_pool_key()
    :param zero_for_one: the swap direction, true for currency_0 to currency_1, false for currency_1 to currency_0
    :param amount_in: the exact amount of the sold currency in Wei
    :param amount_out_min: the minimum accepted bought currency
    :param hook_data: encoded data sent to the pool's hook, if any.
    :return: The chain link corresponding to this function call.

Also, I'll probably write a tutorial and/or recipes when I have some spare time.

On a side note, I'll probably consider adding encoding facilities for some hooks in a future version, and in this case the hook data parameter will be shown in a doc example.

[Elnaril]

@snarflakes : if this answers your question, would you mind marking it as such ? :)

[snarflakes]

i figured you already did this, as you are so thorough! So hook_data bearing a ECDSA would just be in "bytes" and no need for further encoding by the router-decoder library?

[Elnaril]

Yes, with the current lib version, developers have to figure out how to encode hook data by themselves, and pass it directly as bytes through the hook_data parameter.

[VladmirB332]

good