Create no_std example for extrinsic creation #556

Niederb · 2023-04-28T07:28:05Z

Adjusted copy of compose_extrinsic_offline.
Closing #543

Niederb · 2023-04-28T07:34:11Z

@haerdib Not finished yet but can you have a look if this is the functionality you imagined?

Next step would be to extract the extrinsic creation into a separate function (see issue Provide an example for async requests #543 )
- Will be a bit involved because lots of types will have to be made explicit
- It would be nice to actually compile this part in no_std mode but I don't see an easy way to do it.
If possible merging the code into compose_extrinsic_offline to avoid redundancy
- Check how easy it is once the function is ready

haerdib

This definitely goes into the right direction.

Regarding the comment:

Next step would be to extract the extrinsic creation into a separate function

While I wrote that in the issue, that's just a thought on how to make it clear what's std and not. If you have a better idea or if it's too complicated, then feel free to adapt.

It would be nice to actually compile this part in no_std mode but I don't see an easy way to do it.

Neither do I... move it to another crate and everything is an overkill I believe. So let's do it with best effort. That should suffice.

haerdib · 2023-04-28T08:53:09Z

examples/examples/compose_extrinsic_no_std.rs

+
+	// Construct extrinsic without using Api (no_std).
+	let additional_extrinsic_params: GenericAdditionalParams<
+		AssetTip<AssetBalanceFor<Runtime>>,


This won't work, as importing the Runtime into no_std is tricky. So I'd use hardcoded Balance type here.

/// Get the balance type from your node runtime and adapt it if necessary. type Balance = u128; /// We need AssetTip here, because the kitchensink runtime uses the asset pallet. Change to PlainTip if your node uses the balance pallet only. type AdditionalParams = GenericAdditionalParams<AssetTip<Balance>, Hash>

haerdib · 2023-04-28T09:06:17Z

examples/examples/compose_extrinsic_no_std.rs

+		additional_extrinsic_params,
+	);
+	let call =
+		RuntimeCall::Balances(BalancesCall::transfer_allow_death { dest: recipient, value: 42 });


Same here for the RuntimeCall: In no_std the runtime compiles to wasm, so tricky to import in no_std environments. Better to go without it. That's the fun part now: To get the Call you need the metadata.

Check out how it's done in the worker:
metadata call: https://github.com/integritee-network/worker/blob/master/core-primitives/node-api/metadata/src/lib.rs#L72-L88
Retrieve indexes for a specific pallet: https://github.com/integritee-network/worker/blob/master/core-primitives/node-api/metadata/src/pallet_teeracle.rs

haerdib

Cool, thanks a lot for the effort!

Two more things:

Can you integrate this example into CI?
Any chance of merging the code into compose_extrinsic_offline to avoid redundancy, as you've mentioned?

haerdib · 2023-06-29T12:28:01Z

examples/examples/compose_extrinsic_no_std.rs

+type KitchensinkExtrinsicSigner = ExtrinsicSigner<SubstrateKitchensinkConfig>;
+type ExtrinsicAddressOf<Signer> = <Signer as SignExtrinsic<AccountId32>>::ExtrinsicAddress;
+
+type Hash = H256; //<Runtime as FrameSystemConfig>::Hash;


The situation has changed a little since my last comment - sorry about that. But now you could take the type directly from the Config:

substrate-api-client/primitives/src/config/substrate_kitchensink.rs

Line 25 in bb24966

type Hash = H256;

(same for Balance).

haerdib · 2023-06-29T12:30:43Z

examples/examples/compose_extrinsic_no_std.rs

+	// If this is not acceptable, use the Api::new_offline(..) function instead. There are no examples for this,
+	// because of the constantly changing substrate node. But check out our unit tests - there are Apis created with `new_offline`.
+	//
+	// ! Careful: AssetTipExtrinsicParams is used here, because the substrate kitchensink runtime uses assets as tips. But for most


Outdated comment

haerdib · 2023-06-29T12:38:57Z

examples/examples/compose_extrinsic_no_std.rs

+	// runtimes, the PlainTipExtrinsicParams needs to be used.
+	let mut api = Api::<SubstrateKitchensinkConfig, _>::new(client).unwrap();
+	let extrinsic_signer = ExtrinsicSigner::<_>::new(signer);
+	// Signer is needed to get the nonce


Suggested change

// Signer is needed to get the nonce

// Signer is needed to set the nonce and sign the extrinsic.

haerdib · 2023-06-29T12:46:38Z

examples/examples/compose_extrinsic_no_std.rs

+		MultiAddress::Id(AccountKeyring::Bob.to_account_id());
+
+	// Construct extrinsic without using Api (no_std).
+	let additional_extrinsic_params: AdditionalParams = GenericAdditionalParams::new()


Extracting the no_std part in a separate function is not possible? I think that would be rather important, because in actual use cases (just like in Integritee) the std and no_std part will be separate.

haerdib · 2023-06-29T12:53:59Z

examples/examples/compose_extrinsic_no_std.rs

+		.era(Era::mortal(period, header.number.into()), last_finalized_header_hash)
+		.tip(0);
+	let extrinsic_params =
+		GenericExtrinsicParams::<SubstrateKitchensinkConfig, AssetTip<u128>>::new(


I think this type could be taken directly from the SubstrateKitchensinkConfig as well:

substrate-api-client/primitives/src/config/substrate_kitchensink.rs

Line 32 in bb24966

type ExtrinsicParams = AssetTipExtrinsicParams<Self>;

haerdib · 2023-06-29T13:10:14Z

examples/examples/compose_extrinsic_no_std.rs

+	let header = api.get_header(Some(last_finalized_header_hash)).unwrap().unwrap();
+	let period = 5;
+
+	// Get information out of Api (online).


Suggested change

// Get information out of Api (online).

// Get information out of Api (online). This information could also be set offline in the `no_std`, but that would need to be static and adapted whenever the node changes. You can get the information directly from the node runtime file or the api of https://polkadot.js.org.

haerdib · 2023-06-29T13:10:51Z

examples/examples/compose_extrinsic_no_std.rs

+	// Signer is needed to get the nonce
+	api.set_signer(extrinsic_signer.clone());
+
+	// Information for Era for mortal transactions (online).


Suggested change

// Information for Era for mortal transactions (online).

// Get the last finalized header to retrieve information for Era for mortal transactions (online).

haerdib · 2023-09-14T13:27:40Z

Is this PR open for Review btw?

Niederb · 2023-09-21T05:17:54Z

Is this PR open for Review btw?

@haerdib Unfortunately still not quite... I merged the examples but I'm still not quite happy how the code looks. Also the CI integration is missing.

Niederb · 2023-11-28T12:51:49Z

The two examples are now merged into a single one. Both approaches are in the main(), extracting separate functions would need more type annotations. There is also still some code duplication which is due to use of different generic types, but overall I think the code is relative straightforward.

haerdib · 2023-11-28T17:30:14Z

examples/examples/compose_extrinsic.rs

+	println!("Compose extrinsic in no_std environment (No Api instance)");
+	{
+		let signer_nonce = api.get_nonce().unwrap();
+		println!("[+] Alice's Account Nonce is {}", signer_nonce);


Would it be possible to move the api part outside of this environment? That would make it clearer, that really no api client is needed (given the information is availbale).
E.g.

let spec_version = api.runtime_version().spec_version; let transaction_version = api.runtime_version().transaction_version; let genesis_hash = api.genesis_hash .. let mut xt = ...; { let extrinsic_params = <AssetRuntimeConfig as Config>::ExtrinsicParams::new( spec_version, transaction_version, signer_nonce, genesis_hash, additional_extrinsic_params, ); let recipients_extrinsic_address: ExtrinsicAddressOf<AssetExtrinsicSigner> = recipient.clone().into(); let call = compose_call!( metadata, "Balances", "transfer_allow_death", recipients_extrinsic_address, Compact(4u32) ); xt = compose_extrinsic_offline!(extrinsic_signer, call, extrinsic_params); } // Test created extrinsic via api call to the node (online) let hash = api .submit_and_watch_extrinsic_until(xt, XtStatus::InBlock) .unwrap() .block_hash .unwrap();

Same for the api (offline) part - move the online part outside?

Does that make sense?

…and compose_extrinsic_no_std.rs)

haerdib

Cool, I think it makes more sense now. Thanks for the adaptions! Few last nitpicks, other than that it's great :)

examples/examples/compose_extrinsic.rs

haerdib · 2023-12-04T09:15:57Z

examples/examples/compose_extrinsic.rs

+		.tip(0);
+
+	println!("Compose extrinsic in no_std environment (No Api instance)");
+	let signer_nonce = api.get_nonce().unwrap();


Can you move this below the descriptive comment below? I think this belongs to the same category.

examples/examples/compose_extrinsic.rs

Co-authored-by: Bigna Härdi <[email protected]>

haerdib

Cool, thanks a lot!

Niederb added the E1-breaksnothing label Apr 28, 2023

Niederb requested a review from haerdib April 28, 2023 07:34

haerdib reviewed Apr 28, 2023

View reviewed changes

Niederb force-pushed the tn/no-std-example branch 2 times, most recently from 82c7825 to b4e4657 Compare June 28, 2023 11:00

Niederb marked this pull request as ready for review June 29, 2023 11:52

Niederb added the Z3-example Add or fix an example label Jun 29, 2023

Niederb requested a review from haerdib June 29, 2023 11:52

haerdib reviewed Jun 29, 2023

View reviewed changes

Niederb linked an issue Aug 4, 2023 that may be closed by this pull request

Introduce no-std example for extrinsic creation #501

Closed

Niederb force-pushed the tn/no-std-example branch from e6d5652 to c4a570e Compare November 28, 2023 08:08

Niederb added the F0-miscellaneous label Nov 28, 2023

Niederb force-pushed the tn/no-std-example branch from 766028c to 65da9db Compare November 28, 2023 11:54

Niederb requested a review from haerdib November 28, 2023 12:51

haerdib reviewed Nov 28, 2023

View reviewed changes

Niederb added 11 commits November 30, 2023 08:33

Start version of example

509e711

Start moving code from Api into example

be2bd8a

Move more code into example

8404d58

Make some progress with types

0c5ae59

Cleanup

28834af

Cleanup

aa04767

Documentation

ffd47e5

Some cleanup

c0bf080

Make it compile again

2630b79

Use compose_call

d170c20

Create call differently

7d83c3a

Niederb added 9 commits November 30, 2023 08:33

Switch to using AssetTip

5b16b4a

Cleanup

e677305

Cleanup

5aa714b

Merge compose_extrinsic_offline into compose_extrinsic_no_std

fe624b3

Incorporate review feedback

706c0b8

Cleanup of merging of the two examples (compose_extrinsic_offline.rs …

63dc8e8

…and compose_extrinsic_no_std.rs)

Just run both approaches to create an extrinsic

8ee45ef

Remove duplicated example

b27c54c

Have only extrinsic related code in the construction blocks

62e11a7

Niederb force-pushed the tn/no-std-example branch from b9c8a3b to 62e11a7 Compare November 30, 2023 07:33

Niederb requested a review from haerdib November 30, 2023 07:34

haerdib reviewed Dec 4, 2023

View reviewed changes

Apply suggestions from code review

7b2ecf1

Co-authored-by: Bigna Härdi <[email protected]>

Niederb requested a review from haerdib December 4, 2023 14:50

Move code below comment

e8ea140

haerdib approved these changes Dec 5, 2023

View reviewed changes

Niederb merged commit e83aee9 into master Dec 5, 2023
51 checks passed

haerdib deleted the tn/no-std-example branch February 5, 2024 15:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create no_std example for extrinsic creation #556

Create no_std example for extrinsic creation #556

Niederb commented Apr 28, 2023 •

edited

Loading

Niederb commented Apr 28, 2023

haerdib left a comment

haerdib Apr 28, 2023

haerdib Apr 28, 2023

haerdib left a comment

haerdib Jun 29, 2023

haerdib Jun 29, 2023

haerdib Jun 29, 2023

haerdib Jun 29, 2023

haerdib Jun 29, 2023

haerdib Jun 29, 2023

haerdib Jun 29, 2023

haerdib commented Sep 14, 2023

Niederb commented Sep 21, 2023

Niederb commented Nov 28, 2023

haerdib Nov 28, 2023

haerdib Nov 28, 2023

haerdib left a comment

haerdib Dec 4, 2023

haerdib left a comment

	// Signer is needed to get the nonce
	// Signer is needed to set the nonce and sign the extrinsic.

	// Get information out of Api (online).
	// Get information out of Api (online). This information could also be set offline in the `no_std`, but that would need to be static and adapted whenever the node changes. You can get the information directly from the node runtime file or the api of https://polkadot.js.org.

	// Information for Era for mortal transactions (online).
	// Get the last finalized header to retrieve information for Era for mortal transactions (online).

Create no_std example for extrinsic creation #556

Create no_std example for extrinsic creation #556

Conversation

Niederb commented Apr 28, 2023 • edited Loading

Niederb commented Apr 28, 2023

haerdib left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

haerdib left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

haerdib commented Sep 14, 2023

Niederb commented Sep 21, 2023

Niederb commented Nov 28, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

haerdib left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

haerdib left a comment

Choose a reason for hiding this comment

Niederb commented Apr 28, 2023 •

edited

Loading