Isolate Python SDK snippets from PR #6356 #6788

alnoki · 2023-02-27T00:26:08Z

Per request of @davidiw in #6356 , isolates multisig Python SDK snippets from AMEE content.

The following commands were run in below paths:

aptos-core/:

pre-commit run --all-files

aptos-core/developer-docs-site/:

prettier '**/*.(tsx|ts|js)'
pnpm spellcheck
pnpm lint

aptos-core/ecosystem/python/sdk:

make fmt
make test

Modifications to bcs.py as a result of make fmt were disregarded since the file's contents were not modified per this PR.

davidiw

Thanks! @clay-aptos want to do a quick run through of the documentation?

davidiw · 2023-02-27T01:16:06Z

aptos-move/move-examples/upgrade_and_govern/v1_0_0/Move.toml

+# :!:>manifest
+[package]
+name = 'UpgradeAndGovern'
+version = '1.0.0'


rather than versioning, could we just label these with more expressive names?

Since the tutorial demonstrates upgrading a package with a multisig, it looks like both need to have the same package.name field in the manifest (otherwise it wouldn't be an upgrade, just publishing two packages with different names that happen to have similar code).

I did experiment with setting package.version to a non-SemVer schema, e.g. version = 'Genesis' and version = 'Upgrade', but the compiler threw:

{ "Error": "Move compilation failed: Error parsing '[package]' section of manifest: Version is malformed. Versions must be of the form <u64>.<u64>.<u64>, but found 'Genesis'" }

So I settled on simply placing the packages in the two directories:

move-examples/upgrade_and_govern/genesis

move-examples/upgrade_and_govern/upgrade

How does this sound?

davidiw · 2023-02-27T01:16:46Z

aptos-move/move-examples/upgrade_and_govern/v1_1_0/scripts/set_and_transfer.move

@@ -0,0 +1,18 @@
+// :!:>script
+script {
+    use upgrade_and_govern::parameters;


I would avoid placing multiple scripts in the same package and entirely from modules, reason being, they don't keep their names as they get compiled, so you don't know which script is which.

they don't keep their names as they get compiled, so you don't know which script is which

@davidiw I'm a bit confused by this guidance, as the upgrade package has two scripts, set_and_transfer.move and set_only.move, which respectively compile into set_and_transfer.mv and set_only.mv as expected.

I suspect the hypothetical name loss you refer to is a result of using main as the main function name for every script in a Move package:

script { fun main( // <- main function name // ^ this PR uses either `set_only` or `set_and_transfer`, but // name loss would result if both had `main` ... ) { ... } }

This is analogous to using the same module definition block across multiple module .move files

module named_address::a_repeated_module_name { // ^ this compiles into `a_repeated_module_name.mv` // regardless of the `.move` filename ... }

What are your thoughts?

davidiw · 2023-02-27T01:23:36Z

ecosystem/python/sdk/aptos_sdk/account.py

@@ -79,6 +80,37 @@ def public_key(self) -> ed25519.PublicKey:
        return self.private_key.public_key()


+class RotationProofChallenge:


so I was suggesting that we emit out a chunk of bytes from say

aptos-core/aptos-move/e2e-move-tests/src/tests/rotate_auth_key.rs

Line 162 in 58214fc

let rotation_msg = bcs::to_bytes(&rotation_proof).unwrap();

and dumping this to hex and importing that hex string here... that way we can be confident that it works as expected.

@davidiw how does this look?

https://github.com/alnoki/aptos-core/blob/dc8ac59fe89ecf04f2b6187a7e2ae83179cde23a/ecosystem/python/sdk/aptos_sdk/account.py#L131-L160

The classes have been verified e2e on devnet using the example script broken down in the tutorial, so I just emitted some bytes and made a test for it.

ecosystem/python/sdk/aptos_sdk/ed25519.py

ecosystem/python/sdk/examples/multisig.py

clay-aptos

Thanks so much, Al. The docs LGTM with some tiny changes I made in direct commits and a fix to the examples directory I flag in a comment here. Thanks again! I look forward to adding this to our Community Highlights list!

developer-docs-site/docs/tutorials/first-multisig.md

clay-aptos · 2023-02-27T20:02:30Z

Thanks! @clay-aptos want to do a quick run through of the documentation?

Definitely! All done. Thanks again, @alnoki !

clay-aptos · 2023-03-07T20:35:15Z

Hi @alnoki , I am noting we launched this:
https://aptos.dev/community/contributions/community-highlights

And would love to have this online. Please let me know how O can help. Thanks!

alnoki · 2023-03-08T17:27:33Z

Hi @alnoki , I am noting we launched this: https://aptos.dev/community/contributions/community-highlights

And would love to have this online. Please let me know how O can help. Thanks!

@clay-aptos thank you for your patience during all of the delays during Aptos Week at Mountain DAO and then ETH Denver. I've about 80% done with a commit that addresses comments from you and @davidiw above and am hoping to push in the next few days or so.

alnoki · 2023-03-16T18:23:48Z

@davidiw @clay-aptos I believe I've addressed your review comments above: is there anything else you need to move this along?

clay-aptos · 2023-03-16T23:06:22Z

@davidiw @clay-aptos I believe I've addressed your review comments above: is there anything else you need to move this along?

Hi @alnoki , this LGTM! Thank you. @davidiw ?

davidiw

thanks!!

davidiw · 2023-03-19T16:26:16Z

ecosystem/python/sdk/aptos_sdk/account.py

@@ -79,6 +80,37 @@ def public_key(self) -> ed25519.PublicKey:
        return self.private_key.public_key()


+class RotationProofChallenge:


davidiw · 2023-03-19T16:28:36Z

ecosystem/python/sdk/examples/multisig.py

+    print(f"Bob:   {bob.public_key()}")
+    print(f"Chad:  {chad.public_key()}")  # <:!:section_1
+
+    wait()


what's the point of these waits? we want these to run in a test environment... we need to quickly follow up this PR with something that validates this on every PR -- these quickly bitrot or start failing due to other ninjas

davidiw · 2023-03-19T16:41:10Z

realized the tutorial is interactive... this will bitrot, we need to consider some other means, even if that is that we keep pre-compiled versions around.

github-actions · 2023-03-19T17:27:23Z

✅ Forge suite `land_blocking` success on `3bbd3f3c4aa6a1d7eca5137e1c45f3f72c45d2e5`

performance benchmark with full nodes : 5664 TPS, 7016 ms latency, 12000 ms p99 latency,no expired txns
Test Ok

github-actions · 2023-03-19T17:30:09Z

✅ Forge suite `framework_upgrade` success on `cb4ba0a57c998c60cbab65af31a64875d2588ca5` ==> `3bbd3f3c4aa6a1d7eca5137e1c45f3f72c45d2e5`

Compatibility test results for cb4ba0a57c998c60cbab65af31a64875d2588ca5 ==> 3bbd3f3c4aa6a1d7eca5137e1c45f3f72c45d2e5 (PR)
Upgrade the nodes to version: 3bbd3f3c4aa6a1d7eca5137e1c45f3f72c45d2e5
framework_upgrade::framework-upgrade::full-framework-upgrade : 6671 TPS, 5850 ms latency, 8600 ms p99 latency,no expired txns
5. check swarm health
Compatibility test for cb4ba0a57c998c60cbab65af31a64875d2588ca5 ==> 3bbd3f3c4aa6a1d7eca5137e1c45f3f72c45d2e5 passed
Test Ok

github-actions · 2023-03-19T17:31:03Z

✅ Forge suite `compat` success on `testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b` ==> `3bbd3f3c4aa6a1d7eca5137e1c45f3f72c45d2e5`

Compatibility test results for testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 3bbd3f3c4aa6a1d7eca5137e1c45f3f72c45d2e5 (PR)
1. Check liveness of validators at old version: testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b
compatibility::simple-validator-upgrade::liveness-check : 7916 TPS, 4852 ms latency, 6500 ms p99 latency,no expired txns
2. Upgrading first Validator to new version: 3bbd3f3c4aa6a1d7eca5137e1c45f3f72c45d2e5
compatibility::simple-validator-upgrade::single-validator-upgrade : 4924 TPS, 8117 ms latency, 11800 ms p99 latency,no expired txns
3. Upgrading rest of first batch to new version: 3bbd3f3c4aa6a1d7eca5137e1c45f3f72c45d2e5
compatibility::simple-validator-upgrade::half-validator-upgrade : 4531 TPS, 9277 ms latency, 12200 ms p99 latency,no expired txns
4. upgrading second batch to new version: 3bbd3f3c4aa6a1d7eca5137e1c45f3f72c45d2e5
compatibility::simple-validator-upgrade::rest-validator-upgrade : 6572 TPS, 5807 ms latency, 10500 ms p99 latency,no expired txns
5. check swarm health
Compatibility test for testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 3bbd3f3c4aa6a1d7eca5137e1c45f3f72c45d2e5 passed
Test Ok

clay-aptos · 2023-03-21T16:29:35Z

Just noting we are announcing and linking in:
#7308 (comment)

alnoki requested review from davidiw, gregnazario, banool, 0xmaayan, areshand, clay-aptos and saharct as code owners February 27, 2023 00:26

alnoki mentioned this pull request Feb 27, 2023

Add multisig Python SDK tooling, tutorial #6356

Closed

davidiw reviewed Feb 27, 2023

View reviewed changes

clay-aptos approved these changes Feb 27, 2023

View reviewed changes

developer-docs-site/docs/tutorials/first-multisig.md Outdated Show resolved Hide resolved

clay-aptos mentioned this pull request Mar 6, 2023

[Docs] Create Contribute section and highlight internal and external contributions #6311

Closed

davidiw approved these changes Mar 19, 2023

View reviewed changes

alnoki and others added 8 commits March 19, 2023 09:32

Isolate Python SDK snippets from PR aptos-labs#6356

5eb948d

Standardize on correct capitalization of TypeScript

f94b8af

Make direct edits to first multisig tutorial

8f15c62

Fix link into multi-signer named anchor of Accounts from tutorial index

06c53c5

Adding link to Unity SDK in SDKs plea

609e6c2

Clarify package versions, add SDK asserts/tests

93b933f

Clarify main script function name

c40895a

f

3bbd3f3

davidiw force-pushed the multisig-snippets-squashed branch from 124bf3c to 3bbd3f3 Compare March 19, 2023 16:40

davidiw enabled auto-merge (rebase) March 19, 2023 16:40

This comment has been minimized.

Sign in to view

davidiw merged commit d2464b8 into aptos-labs:main Mar 19, 2023

alnoki mentioned this pull request Mar 21, 2023

Extend multisig tutorial/SDK with automation tool #7297

Closed

clay-aptos mentioned this pull request Mar 21, 2023

[Docs] Document use of scripts in Aptos #6318

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Isolate Python SDK snippets from PR #6356 #6788

Isolate Python SDK snippets from PR #6356 #6788

alnoki commented Feb 27, 2023

davidiw left a comment

davidiw Feb 27, 2023

alnoki Mar 8, 2023

davidiw Feb 27, 2023

alnoki Mar 8, 2023

davidiw Feb 27, 2023

alnoki Mar 8, 2023

davidiw Mar 19, 2023

clay-aptos left a comment

clay-aptos commented Feb 27, 2023

clay-aptos commented Mar 7, 2023

alnoki commented Mar 8, 2023

alnoki commented Mar 16, 2023

clay-aptos commented Mar 16, 2023

davidiw left a comment

davidiw Mar 19, 2023

davidiw Mar 19, 2023

davidiw commented Mar 19, 2023

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

github-actions bot commented Mar 19, 2023

github-actions bot commented Mar 19, 2023

github-actions bot commented Mar 19, 2023

clay-aptos commented Mar 21, 2023

		@@ -79,6 +80,37 @@ def public_key(self) -> ed25519.PublicKey:
		return self.private_key.public_key()


		class RotationProofChallenge:

Isolate Python SDK snippets from PR #6356 #6788

Isolate Python SDK snippets from PR #6356 #6788

Conversation

alnoki commented Feb 27, 2023

davidiw 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

clay-aptos left a comment

Choose a reason for hiding this comment

clay-aptos commented Feb 27, 2023

clay-aptos commented Mar 7, 2023

alnoki commented Mar 8, 2023

alnoki commented Mar 16, 2023

clay-aptos commented Mar 16, 2023

davidiw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidiw commented Mar 19, 2023

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

github-actions bot commented Mar 19, 2023

✅ Forge suite land_blocking success on 3bbd3f3c4aa6a1d7eca5137e1c45f3f72c45d2e5

github-actions bot commented Mar 19, 2023

✅ Forge suite framework_upgrade success on cb4ba0a57c998c60cbab65af31a64875d2588ca5 ==> 3bbd3f3c4aa6a1d7eca5137e1c45f3f72c45d2e5

github-actions bot commented Mar 19, 2023

✅ Forge suite compat success on testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 3bbd3f3c4aa6a1d7eca5137e1c45f3f72c45d2e5

clay-aptos commented Mar 21, 2023

✅ Forge suite `land_blocking` success on `3bbd3f3c4aa6a1d7eca5137e1c45f3f72c45d2e5`

✅ Forge suite `framework_upgrade` success on `cb4ba0a57c998c60cbab65af31a64875d2588ca5` ==> `3bbd3f3c4aa6a1d7eca5137e1c45f3f72c45d2e5`

✅ Forge suite `compat` success on `testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b` ==> `3bbd3f3c4aa6a1d7eca5137e1c45f3f72c45d2e5`