Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add chain link test cases update guide #992

Merged
merged 11 commits into from
May 5, 2023
Merged

docs: add chain link test cases update guide #992

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
161fe2f
docs: added chain link test cases upgradation guide
dadamu Aug 10, 2022
800c98d
fix: typo and 3rd script
dadamu Aug 10, 2022
4694ead
fix: make bechmark error
dadamu Aug 10, 2022
ef9c650
Update docs/core/chain_link.md
dadamu Aug 17, 2022
065d24d
Update docs/core/chain_link.md
dadamu Aug 17, 2022
8d5de52
Merge branch 'master' of github.com:desmos-labs/desmos into paul/add-…
dadamu Sep 1, 2022
bf4c580
Merge branch 'paul/add-chain-link-test-upgradation-guide' of github.c…
dadamu Sep 1, 2022
ce60dff
fix: make benchmark command
dadamu Sep 1, 2022
cf31bf8
chore: remove unused txt file
dadamu Sep 1, 2022
9800e5f
docs: updated the guide
RiccardoM May 5, 2023
1f43fe4
docs: guide improvements
RiccardoM May 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ test-cover:

benchmark:
@go test -mod=readonly -bench=. -count=$(BENCH_COUNT) -run=^a ./... >bench-$(REF_NAME).txt
@test -s $(GOPATH)/bin/benchstat || GO111MODULE=off GOFLAGS= GOBIN=$(GOPATH)/bin go install -u golang.org/x/perf/cmd/benchstat
@test -s $(GOPATH)/bin/benchstat || GO111MODULE=off GOFLAGS= GOBIN=$(GOPATH)/bin go install golang.org/x/perf/cmd/benchstat
@test -e bench-master.txt && benchstat bench-master.txt bench-$(REF_NAME).txt || benchstat bench-$(REF_NAME).txt
.PHONY: benchmark

Expand Down
136 changes: 136 additions & 0 deletions docs/core/chain_link.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
# Chain link

## Upgradation guide of test cases

### Multisignature chain link account

After the proto version of `x/profiles` upgrades, the test case of multi signature chain link account test case must be updated to the specified version as well since the type uri of it will be `/desmos.profiles.{new-proto-version}.CosmosMultiSignature`. The process of upgrading is as follows:

#### 1. Create a tx.json with the content as follows:

```json
{
"body": {
"messages": [
{
"@type": "/cosmos.gov.v1beta1.MsgVote",
"proposal_id": "1",
"voter": "cosmos1exdjkfxud8yzqtvua3hdd93xu0gmek5l47r8ra",
"option": "VOTE_OPTION_YES"
}
],
"memo": "desmos1n8345tvzkg3jumkm859r2qz0v6xsc3henzddcj",
"timeout_height": "0",
"extension_options": [],
"non_critical_extension_options": []
},
"auth_info": {
"signer_infos": [
{
"public_key": {
"@type": "/cosmos.crypto.multisig.LegacyAminoPubKey",
"threshold": 2,
"public_keys": [
{
"@type": "/cosmos.crypto.secp256k1.PubKey",
"key": "A4k1o4weHTkMVXqzT0zKRkRmWTwQEh3JGiPkJvCQ4VO7"
},
{
"@type": "/cosmos.crypto.secp256k1.PubKey",
"key": "ApfZ2jzyWcRxzgCnKEKr+oIMyrGIJMp+1FjouYPovluE"
},
{
"@type": "/cosmos.crypto.secp256k1.PubKey",
"key": "AziL8Ly6QrMOr+V7Vf6XCBjDjLPTq0Dtxv7PPzDRnFQe"
}
]
},
"mode_info": {
"multi": {
"bitarray": {
"extra_bits_stored": 3,
"elems": "wA=="
},
"mode_infos": [
{
"single": {
"mode": "SIGN_MODE_LEGACY_AMINO_JSON"
}
},
{
"single": {
"mode": "SIGN_MODE_LEGACY_AMINO_JSON"
}
}
]
}
},
"sequence": "0"
}
],
"fee": {
"amount": [],
"gas_limit": "200000",
"payer": "",
"granter": ""
}
},
"signatures": [
"CkAn/EVngYopgD7BP0KUBMcTHIGKzBlU9RLz1xozeefsdB0l3osUL2EVFlKwbveKrv/VhwcCPm6N++mMmQGFAWR2CkCTlMhmMOevuWGJmt2PwaIR0UuMw4cCxTyqcBhRVX81gywR4RUQ2k1nZXihmzQoZTF1R1SbK0vXjN+Ana+lUEH3"
]
}
```

#### 2. Execute the latest desmos cli with the command `desmos create-link-json` with `tx.json` to create chain link proof data `data.json`.
Copy link
Contributor Author

@dadamu dadamu Aug 10, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am thinking that building a testutil command for it would be helpful, say:

desmos testutil profiles show-chain-link-signature data.json

What do you think? @RiccardoM @bragaz

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean a command to create both the data and the signature in one shot?

Copy link
Contributor Author

@dadamu dadamu Aug 17, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope, I mean the command to show chain link signature in hex encode from proof data.json for updating chain link test case.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh gotcha! Yeah I think it can be useful. @RiccardoM thoughts?


```bash
desmos create-chain-link-json
```

#### 3. Produce the `Any` value of `Signature` in hex encoding with the `data.json` produce at the 2nd step by the script:

```go
chainLinkJSON, err := os.ReadFile("path/data.json")
if err != nil {
panic(err)
}
cdc, legacyCdc := app.MakeCodecs()
var link profilescliutils.ChainLinkJSON
if err := cdc.UnmarshalJSON(chainLinkJSON, &link); err != nil {
panic(err)
}
var addrData profilestypes.AddressData
if err := cdc.UnpackAny(link.Address, &addrData); err != nil {
panic(err)
}
if err := link.Proof.Verify(cdc, legacyCdc, "desmos1n8345tvzkg3jumkm859r2qz0v6xsc3henzddcj", addrData); err != nil {
panic(err)
}
bz, err := link.Proof.Signature.Marshal()
if err != nil {
panic(err)
}
fmt.Println(hex.EncodeToString(bz))
```

output:
```bash
0a282f6465736d6f732e70726f66696c65732e76332e436f736d6f734d756c74695369676e617475726512ed010a0508031201c012710a292f6465736d6f732e70726f66696c65732e76332e436f736d6f7353696e676c655369676e61747572651244087f124027fc4567818a29803ec13f429404c7131c818acc1954f512f3d71a3379e7ec741d25de8b142f61151652b06ef78aaeffd58707023e6e8dfbe98c99018501647612710a292f6465736d6f732e70726f66696c65732e76332e436f736d6f7353696e676c655369676e61747572651244087f12409394c86630e7afb961899add8fc1a211d14b8cc38702c53caa701851557f35832c11e11510da4d676578a19b342865317547549b2b4bd78cdf809dafa55041f7
```

#### 4. Replace the signature field of the multisignature account test case with the 3rd output value

```go
expected := profilescliutils.NewChainLinkJSON(
profilestypes.NewBech32Address("cosmos1exdjkfxud8yzqtvua3hdd93xu0gmek5l47r8ra", "cosmos"),
profilestypes.NewProof(
suite.GetPubKeyFromTxFile(txFile),
profilestesting.MultiCosmosSignatureFromHex(
suite.Codec,
"output value of 3rd",
),
"7b226163636f756e745f6e756d626572223a2230222c22636861696e5f6964223a22636f736d6f73222c22666565223a7b22616d6f756e74223a5b5d2c22676173223a22323030303030227d2c226d656d6f223a226465736d6f73316e3833343574767a6b67336a756d6b6d3835397232717a3076367873633368656e7a6464636a222c226d736773223a5b7b2274797065223a22636f736d6f732d73646b2f4d7367566f7465222c2276616c7565223a7b226f7074696f6e223a312c2270726f706f73616c5f6964223a2231222c22766f746572223a22636f736d6f73316578646a6b6678756438797a7174767561336864643933787530676d656b356c343772387261227d7d5d2c2273657175656e6365223a2230227d",
),
profilestypes.NewChainConfig("cosmos"),
)
```