Skip to content

Commit

Permalink
docs: add chain link test cases update guide (#992)
Browse files Browse the repository at this point in the history 
## Description

This PR creates the guide on how to properly update multi-signature
account chain link tests after the Proto version of profiles change.

<!-- Add a description of the changes that this PR introduces and the
files that
are the most critical to review. -->

---

### Author Checklist

*All items are required. Please add a note to the item if the item is
not applicable and
please add links to any relevant follow up issues.*

I have...

- [x] included the correct [type
prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json)
in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR
Targeting](https://github.com/desmos-labs/desmos/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building
modules](https://docs.cosmos.network/v0.44/building-modules/intro.html)
- [ ] included the necessary unit and integration
[tests](https://github.com/desmos-labs/desmos/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go
code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable
and please add
your handle next to the items reviewed if you only reviewed selected
items.*

I have...

- [ ] confirmed the correct [type
prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json)
in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)

---------

Co-authored-by: Leonardo Bragagnolo <leo.braga95@gmail.com>
Co-authored-by: Riccardo Montagnin <riccardo.montagnin@gmail.com>
  • Loading branch information
@dadamu @leobragaz @RiccardoM
3 people authored May 5, 2023
1 parent cd2a1bb commit 8bf1d89
Show file tree
Hide file tree
Showing 3 changed files with 260 additions and 0 deletions.
146 changes: 146 additions & 0 deletions docs/core/chain_link.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
# Chain link

## How to update unit tests

### Multi-signature account chain link

After upgrading the Proto version of `x/profiles`, the multi-signature account chain link test case will fail.
This is due to the fact that the type uri of the new type will now be `/desmos.profiles.{new-proto-version}.CosmosMultiSignature` instead of `/desmos.profiles.{old-proto-version}.CosmosMultiSignature`, which will make the signature verification process fail.

In order to update this test case properly, you need to follow the steps below.

#### 1. Create the transaction file
First of all, create a file named `tx.json` with the following contents:

```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. Create the chain link JSON file
Now, run the following command using the latest Desmos version:

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

Use the following data when running that command:
- Owner use to create the link: `desmos1n8345tvzkg3jumkm859r2qz0v6xsc3henzddcj`
- Chain ID: `cosmos`
- Path of multi-signed tx file: path to the `tx.json` file created at the previous step

#### 3. Export the signature
Run the `export-signature.go` script in order to produce the hex-encoded signature value:

```bash
go run docs/core/export-signature.go /path/to/data.json
```

This script should output something similar to this:

```bash
0a282f6465736d6f732e70726f66696c65732e76332e436f736d6f734d756c74695369676e617475726512ed010a0508031201c012710a292f6465736d6f732e70726f66696c65732e76332e436f736d6f7353696e676c655369676e61747572651244087f124027fc4567818a29803ec13f429404c7131c818acc1954f512f3d71a3379e7ec741d25de8b142f61151652b06ef78aaeffd58707023e6e8dfbe98c99018501647612710a292f6465736d6f732e70726f66696c65732e76332e436f736d6f7353696e676c655369676e61747572651244087f12409394c86630e7afb961899add8fc1a211d14b8cc38702c53caa701851557f35832c11e11510da4d676578a19b342865317547549b2b4bd78cdf809dafa55041f7
```

#### 4. Replace the signature
Finally, replace the signature value of the multi-signature account test case with the newly produced hex-encoded value:

```go
expected := profilescliutils.NewChainLinkJSON(
profilestypes.NewBech32Address("cosmos1exdjkfxud8yzqtvua3hdd93xu0gmek5l47r8ra", "cosmos"),
profilestypes.NewProof(
suite.GetPubKeyFromTxFile(txFile),
profilestesting.MultiCosmosSignatureFromHex(
suite.Codec,
"<Place the new output here>",
),
"7b226163636f756e745f6e756d626572223a2230222c22636861696e5f6964223a22636f736d6f73222c22666565223a7b22616d6f756e74223a5b5d2c22676173223a22323030303030227d2c226d656d6f223a226465736d6f73316e3833343574767a6b67336a756d6b6d3835397232717a3076367873633368656e7a6464636a222c226d736773223a5b7b2274797065223a22636f736d6f732d73646b2f4d7367566f7465222c2276616c7565223a7b226f7074696f6e223a312c2270726f706f73616c5f6964223a2231222c22766f746572223a22636f736d6f73316578646a6b6678756438797a7174767561336864643933787530676d656b356c343772387261227d7d5d2c2273657175656e6365223a2230227d",
),
profilestypes.NewChainConfig("cosmos"),
)
```

Example

```go
expected := profilescliutils.NewChainLinkJSON(
profilestypes.NewBech32Address("cosmos1exdjkfxud8yzqtvua3hdd93xu0gmek5l47r8ra", "cosmos"),
profilestypes.NewProof(
suite.GetPubKeyFromTxFile(txFile),
profilestesting.MultiCosmosSignatureFromHex(
suite.Codec,
"0a282f6465736d6f732e70726f66696c65732e76332e436f736d6f734d756c74695369676e617475726512ed010a0508031201c012710a292f6465736d6f732e70726f66696c65732e76332e436f736d6f7353696e676c655369676e61747572651244087f124027fc4567818a29803ec13f429404c7131c818acc1954f512f3d71a3379e7ec741d25de8b142f61151652b06ef78aaeffd58707023e6e8dfbe98c99018501647612710a292f6465736d6f732e70726f66696c65732e76332e436f736d6f7353696e676c655369676e61747572651244087f12409394c86630e7afb961899add8fc1a211d14b8cc38702c53caa701851557f35832c11e11510da4d676578a19b342865317547549b2b4bd78cdf809dafa55041f7",
),
"7b226163636f756e745f6e756d626572223a2230222c22636861696e5f6964223a22636f736d6f73222c22666565223a7b22616d6f756e74223a5b5d2c22676173223a22323030303030227d2c226d656d6f223a226465736d6f73316e3833343574767a6b67336a756d6b6d3835397232717a3076367873633368656e7a6464636a222c226d736773223a5b7b2274797065223a22636f736d6f732d73646b2f4d7367566f7465222c2276616c7565223a7b226f7074696f6e223a312c2270726f706f73616c5f6964223a2231222c22766f746572223a22636f736d6f73316578646a6b6678756438797a7174767561336864643933787530676d656b356c343772387261227d7d5d2c2273657175656e6365223a2230227d",
),
profilestypes.NewChainConfig("cosmos"),
)
```
44 changes: 44 additions & 0 deletions docs/core/export-signature.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
package main

import (
"encoding/hex"
"fmt"
"os"

"github.com/desmos-labs/desmos/v4/app"
profilescliutils "github.com/desmos-labs/desmos/v4/x/profiles/client/utils"
profilestypes "github.com/desmos-labs/desmos/v4/x/profiles/types"
)

func main() {
dataFilePath := os.Args[1]
chainLinkJSON, err := os.ReadFile(dataFilePath)
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
err = cdc.UnpackAny(link.Address, &addrData)
if err != nil {
panic(err)
}

err = link.Proof.Verify(cdc, legacyCdc, "desmos1n8345tvzkg3jumkm859r2qz0v6xsc3henzddcj", addrData)
if err != nil {
panic(err)
}

bz, err := link.Proof.Signature.Marshal()
if err != nil {
panic(err)
}

fmt.Println(hex.EncodeToString(bz))
}
70 changes: 70 additions & 0 deletions tx.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
{
"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"
]
}

0 comments on commit 8bf1d89

Please sign in to comment.