BCI-1511: Gauntlet Test Link #355

augustbleeds · 2023-08-15T18:27:03Z

UPDATE: This PR has been enveloped into #364

Most of the line code changes are from modifying the generated json schemas

Please filter out .json files to better review the PR

Write in-line github comments for easier code review

Couple of changes for this

schema fixes to be able to use codegen for typescript clients
fix schema scripts to use improved write_api macro to generate json api
add typescript clients
changes to gauntlet-cosmos to be able to support invocation via jest
setup and teardown wasmd functionality + debug mode for quick local dev / testing
fix wasmd.nix and shell.nix by adding packages to support mac and ledger
augment Github CI/CD to run gauntlet tests and cache the artifacts/ dir
modify jest configs to support running just on yarn workspaces from the root folder

augustbleeds · 2023-08-17T18:21:43Z

.github/workflows/gauntlet.yml

@@ -61,5 +61,18 @@ jobs:
        with:
          name: chainlink-cosmos
          authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
+      - name: Cache Wasmd Artifacts


cache the root dir "artifacts/" folder which contains the optimized .wasm bytecode files. This usually takes a while to compile

augustbleeds · 2023-08-17T18:22:42Z

.gitignore

@@ -24,6 +24,8 @@ integration-tests/logs
 integration-tests/smoke/logs
 integration-tests/soak/logs
 tmp-manifest-*
-artifacts
+/artifacts


only cache the root directory artifacts folder (we commit to source other artifacts/ folders for cw-plus contracts)

augustbleeds · 2023-08-17T18:23:28Z

.gitignore

 .local-mock-server
+codegen
+devAccounts.json


json file that contains test accounts for local wasmd -- is created everytime local wasmd is setup in the script (see other code below)

augustbleeds · 2023-08-17T18:23:58Z

.gitignore

 .local-mock-server
+codegen


folder that is auto-generated by https://github.com/CosmWasm/ts-codegen

augustbleeds · 2023-08-17T18:24:30Z

contracts/access-controller/Cargo.toml

@@ -22,6 +22,7 @@ backtraces = ["cosmwasm-std/backtraces"]
 library = []

 [dependencies]
+cosmwasm-schema = { version = "1.1.5" }


we have to move cosmwasm-schema from dev-dependency to dependency to use the new write_api! macro

augustbleeds · 2023-08-17T18:25:38Z

contracts/access-controller/examples/schema.rs

-    export_schema(&schema_for!(InstantiateMsg), &out_dir);
-    export_schema(&schema_for!(ExecuteMsg), &out_dir);
-    export_schema(&schema_for!(QueryMsg), &out_dir);
+    write_api! {


Instead of individually, writing the schema for instantiate, execute, and query messages, the write_api! macro generates all of them + a centralized json file that contains all the json fields necessary to describe the entire contract.

can you move contracts/rust/non-gauntlet changes into a separate PR? 🙏

augustbleeds · 2023-08-17T18:26:38Z

contracts/access-controller/src/msg.rs


-#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
+#[cw_serde]


cw_serde macro includes all of the commonly used macros besides Eq

augustbleeds · 2023-08-17T18:27:23Z

contracts/access-controller/src/msg.rs

-#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
-#[serde(rename_all = "snake_case")]
+#[cw_serde]
+#[derive(Eq, QueryResponses)]


QueryResponses allows you to associate the return type with the query message. This is a must have for ts-codegen

augustbleeds · 2023-08-17T18:29:45Z

contracts/deviation-flagging-validator/examples/schema.rs

+    let mut other_dir = out_dir.clone();
+    other_dir.push("other");
+    create_dir_all(&other_dir).unwrap();
+    export_schema(&schema_for!(State), &other_dir);


I don't know if we actually use this State schema but I kept it here in case we do. I'll remove it if I find it's unused after all gauntlet tests are finished

augustbleeds · 2023-08-17T19:21:05Z

jest.config.js

@@ -23,5 +23,16 @@ module.exports = {
        },
      },
    },
+    {


add gauntlet-cosmos-cw-plus to be discoverable as a jest project

augustbleeds · 2023-08-17T19:22:02Z

packages-ts/gauntlet-cosmos-contracts/networks/.env.local

@@ -1,4 +1,4 @@
-NODE_URL=http://localhost:26657


for some reason, wasmd does not support ipv6 so you have to specify the ipv4 address

augustbleeds · 2023-08-17T19:24:01Z

packages-ts/gauntlet-cosmos-contracts/src/lib/contracts.ts

@@ -58,7 +58,9 @@ export abstract class Contract {
    if (version === 'local') {
      // Possible paths depending on how/where gauntlet is being executed
      const possibleContractPaths = [
+        path.join(__dirname, '../../../../artifacts'),


make artifacts discoverable using __dirname

augustbleeds · 2023-08-17T19:25:49Z

packages-ts/gauntlet-cosmos-contracts/src/lib/contracts.ts

@@ -95,19 +101,14 @@ export abstract class Contract {
    const abi = possibleContractPaths
      .filter((path) => existsSync(`${path}/${this.dirName}/schema`))
      .map((contractPath) => {
-        const toPath = (type) => {


simply contract path logic

augustbleeds · 2023-08-17T19:26:26Z

packages-ts/gauntlet-cosmos-contracts/src/scripts/codegen.js

@@ -0,0 +1,61 @@
+const codegen = require('@cosmwasm/ts-codegen').default


codegen reads the json api from each path to generate the typed client

augustbleeds · 2023-08-17T19:27:04Z

scripts/wasmd.sh

@@ -4,7 +4,7 @@ container_name="chainlink-cosmos.wasmd"
 container_version="v0.40.1"
 genesis_account="wasm1lsagfzrm4gz28he4wunt63sts5xzmczwda8vl6"

-set -euo pipefail
+set -euox pipefail


augustbleeds · 2023-08-17T19:27:21Z

scripts/wasmd.sh

@@ -35,7 +35,8 @@ docker run \
 	--name "${container_name}" \
 	"cosmwasm/wasmd:${container_version}" \
 	"./setup_and_run.sh" \
-	"${genesis_account}"
+	"${genesis_account}" \
+	"$@"


pass in more account addresses to be created

augustbleeds · 2023-08-17T19:27:52Z

wasmd.nix

@@ -13,7 +13,7 @@ stdenv.mkDerivation rec {
    sha256 = "sha256-KBchSnIETM+HPngqHeajiqLYrhHhXY531C+Q/aSDzl4=";
  };

-  buildInputs = with pkgs; [ gnumake git go_1_20 which openssl cacert ];
+  buildInputs = with pkgs; [ gnumake git go_1_20 which openssl cacert gcc ];


fix wasmd build on mac

cfal

looks good, added some initial comments!

cfal · 2023-08-21T09:32:43Z

.github/workflows/gauntlet.yml

+          cache-name: cache-wasmd-artifacts
+        with:
+          path: artifacts
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('contracts') }}


this is a great optimization, the wasmd artifacts build step is also pretty slow in some other workflows. i'm not sure this key is sufficient though - what if the Makefile or packages-ts changes? couldn't that affect artifacts output?
for example, some .wasm artifacts are directly downloaded in packages-ts:

chainlink-cosmos/packages-ts/gauntlet-cosmos-contracts/src/lib/contracts.ts

Line 128 in 861c937

readonly downloadUrl = `https://github.com/CosmWasm/cw-plus/releases/download/`

This is just for the chainlink contracts that we write (since it is just calling build-contracts.sh at the end of the day). the cosmos base contracts will always be downloaded I believe the way things are written now

please double check, but i believe the caching step occurs at the end of your workflow - which means it would store everything that's been placed in the artifacts/ path, and then restore everything, including downloaded wasm code. there is then a file exists check here which would stop a download of a new wasm file from happening:

chainlink-cosmos/packages-ts/gauntlet-cosmos-contracts/src/lib/contracts.ts

Line 69 in 861c937

.filter((contractPath) => existsSync(`${contractPath}/${this.id}.wasm`))

ideally, the caching should only cache the compiled contracts. perhaps it can be moved into a subdirectory/isolated from artifacts/.

Here's what my root artifacts/ folder looks like after running local tests ~

I'm pretty confident that the cw-plus contracts are never stored in the artifacts/ folder in the default workflow because it is read as an array buffer.

The way it's written, I think the original author intended for cw-plus contracts to be downloaded (

chainlink-cosmos/packages-ts/gauntlet-cosmos-contracts/src/lib/contracts.ts

Line 130 in 861c937

constructor(id, dirName, defaultVersion = DEFAULT_CWPLUS_VERSION) {

) whereas chainlink contracts are found locally because cw-plus contracts never have the version set to 'local'

cfal · 2023-08-21T09:37:32Z

packages-ts/gauntlet-cosmos-contracts/test/utils.ts

+  const otherAddresses = accounts.map((a) => a.address).join(' ')
+  const wasmdScript = path.join(__dirname, '../../../scripts/wasmd.sh')
+
+  execSync(`${wasmdScript} ${otherAddresses}`)


i'm curious if we should be adding other addresses as validators. if these are meant to be normal addresses that only require some tokens (link/native) - could we just send it to them from the deployer address instead?

we actually do this in the integration test:

chainlink-cosmos/integration-tests/ocr2_test.go

Line 65 in 861c937

for i, nodeAddr := range chainlinkClient.GetNodeAddresses() {

but reconsidering that implementation - this would be nice to have as a gauntlet action to use here and in these tests as well

cc @calvwang9

Yeah that's a good point, I think the original validator already has enough token as it is so I'll just create new accounts within the test

cfal · 2023-08-21T09:39:35Z

contracts/access-controller/examples/schema.rs

-    export_schema(&schema_for!(InstantiateMsg), &out_dir);
-    export_schema(&schema_for!(ExecuteMsg), &out_dir);
-    export_schema(&schema_for!(QueryMsg), &out_dir);
+    write_api! {


can you move contracts/rust/non-gauntlet changes into a separate PR? 🙏

calvwang9

looks great! just small nits from me

calvwang9 · 2023-08-23T13:55:10Z

packages-ts/gauntlet-cosmos-contracts/test/command/link.test.ts

+const MNEMONIC =
+  'surround miss nominee dream gap cross assault thank captain prosper drop duty group candy wealth weather scale put'
+const NODE_URL = 'http://127.0.0.1:26657'
+const DEFAULT_GAS_PRICE = '0.025ucosm'
+const NETWORK = 'local'
+const TIMEOUT = 90000


nit: not all of these consts are used and some are already defined in utils.ts

calvwang9 · 2023-08-23T13:57:13Z

packages-ts/gauntlet-cosmos-contracts/test/utils.ts

+ *
+ * @returns {string[]} Initialized account addresses
+ */
+export const maybeInitWasmd = async () => {


nit: 'maybeInitWasmd' seems kinda confusing semantically (is wasmd initialized or not?)- perhaps just 'initWasmd' would suffice?

initial

7d3c79a

augustbleeds had a problem deploying to integration August 15, 2023 18:27 — with GitHub Actions Error

remove unnecessary file

588c4b0

augustbleeds had a problem deploying to integration August 15, 2023 18:29 — with GitHub Actions Failure

augustbleeds had a problem deploying to integration August 15, 2023 18:29 — with GitHub Actions Error

add back ci

8b84a8a

augustbleeds temporarily deployed to integration August 15, 2023 18:33 — with GitHub Actions Inactive

augustbleeds had a problem deploying to integration August 15, 2023 18:33 — with GitHub Actions Failure

augustbleeds added 3 commits August 17, 2023 10:57

modify gitignore to exclue cw-plus artifacts and lint

197e503

add back rust override and remove debugging statements

0ed2402

cargo fmt

7a17a96

augustbleeds commented Aug 17, 2023

View reviewed changes

.gitignore

.local-mock-server

codegen

Copy link

Contributor Author

augustbleeds Aug 17, 2023

Choose a reason for hiding this comment

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

folder that is auto-generated by https://github.com/CosmWasm/ts-codegen

augustbleeds commented Aug 17, 2023

View reviewed changes

dont use cw_serde

c6cce19

augustbleeds added 6 commits August 17, 2023 12:47

regen schemas + fix hashFile

d699d11

remove Eq and Addr import

0d314cf

add back Addr

54c79e8

remove duplicate import

da98771

remove imports + rerun schema generation

d32a4b7

lint ts files

3961079

cfal requested changes Aug 21, 2023

View reviewed changes

cfal requested a review from calvwang9 August 21, 2023 09:40

augustbleeds mentioned this pull request Aug 21, 2023

BCI-1511: only contract schema changes #359

Merged

send tokens to accounts

aa56519

calvwang9 approved these changes Aug 23, 2023

View reviewed changes

augustbleeds closed this Aug 29, 2023

augustbleeds mentioned this pull request Aug 29, 2023

BCI-1511: more gauntlet tests #364

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BCI-1511: Gauntlet Test Link #355

BCI-1511: Gauntlet Test Link #355

augustbleeds commented Aug 15, 2023 •

edited

Loading

augustbleeds Aug 17, 2023

augustbleeds Aug 17, 2023 •

edited

Loading

augustbleeds Aug 17, 2023

augustbleeds Aug 17, 2023

augustbleeds Aug 17, 2023

augustbleeds Aug 17, 2023

cfal Aug 21, 2023

augustbleeds Aug 17, 2023

augustbleeds Aug 17, 2023

augustbleeds Aug 17, 2023

augustbleeds Aug 17, 2023

augustbleeds Aug 17, 2023

augustbleeds Aug 17, 2023

augustbleeds Aug 17, 2023

augustbleeds Aug 17, 2023

augustbleeds Aug 17, 2023

augustbleeds Aug 17, 2023

augustbleeds Aug 17, 2023

cfal left a comment

cfal Aug 21, 2023

augustbleeds Aug 21, 2023

cfal Aug 22, 2023

augustbleeds Aug 22, 2023

cfal Aug 21, 2023

augustbleeds Aug 21, 2023

cfal Aug 21, 2023

calvwang9 left a comment

calvwang9 Aug 23, 2023

calvwang9 Aug 23, 2023


		#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
		#[cw_serde]

@@ @@ -23,5 +23,16 @@ module.exports = { @@
                       },
                     },
                   },
+                  {

		@@ -0,0 +1,61 @@
		const codegen = require('@cosmwasm/ts-codegen').default

BCI-1511: Gauntlet Test Link #355

BCI-1511: Gauntlet Test Link #355

Conversation

augustbleeds commented Aug 15, 2023 • edited Loading

Choose a reason for hiding this comment

augustbleeds Aug 17, 2023 • edited Loading

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

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

Choose a reason for hiding this comment

cfal 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

calvwang9 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

augustbleeds commented Aug 15, 2023 •

edited

Loading

augustbleeds Aug 17, 2023 •

edited

Loading