Merge pull request #1339 from CosmWasm/idl-ux

Better UX for defining query response types and schema generation

.circleci/config.yml

@@ -10,6 +10,7 @@ workflows:
       - arm64
       - package_crypto
       - package_schema
+      - package_schema_derive
       - package_std
       - package_storage
       - package_vm
@@ -186,6 +187,33 @@ jobs:
             - target/debug/deps
           key: cargocache-v2-package_schema-rust:1.56.1-{{ checksum "Cargo.lock" }}
 
+  package_schema_derive:
+    docker:
+      - image: rust:1.56.1
+    steps:
+      - checkout
+      - run:
+          name: Version information
+          command: rustc --version; cargo --version; rustup --version; rustup target list --installed
+      - restore_cache:
+          keys:
+            - cargocache-v2-package_schema_derive-rust:1.56.1-{{ checksum "Cargo.lock" }}
+      - run:
+          name: Build
+          working_directory: ~/project/packages/schema-derive
+          command: cargo build --locked
+      - run:
+          name: Run tests
+          working_directory: ~/project/packages/schema-derive
+          command: cargo test --locked
+      - save_cache:
+          paths:
+            - /usr/local/cargo/registry
+            - target/debug/.fingerprint
+            - target/debug/build
+            - target/debug/deps
+          key: cargocache-v2-package_schema_derive-rust:1.56.1-{{ checksum "Cargo.lock" }}
+
   package_std:
     docker:
       - image: rust:1.56.1
@@ -938,6 +966,10 @@ jobs:
           name: Clippy linting on schema
           working_directory: ~/project/packages/schema
           command: cargo clippy --all-targets -- -D warnings
+      - run:
+          name: Clippy linting on schema-derive
+          working_directory: ~/project/packages/schema-derive
+          command: cargo clippy --all-targets -- -D warnings
       - run:
           name: Clippy linting on std (no feature flags)
           working_directory: ~/project/packages/std

codecov.yml

@@ -25,6 +25,9 @@ flags:
   cosmwasm-schema:
     paths:
       - packages/schema/
+  cosmwasm-schema-derive:
+    paths:
+      - packages/schema-derive/
   cosmwasm-std:
     paths:
       - packages/std/

contracts/hackatom/Cargo.toml

@@ -31,6 +31,7 @@ cranelift = ["cosmwasm-vm/cranelift"]
 backtraces = ["cosmwasm-std/backtraces", "cosmwasm-vm/backtraces"]
 
 [dependencies]
+cosmwasm-schema = { path = "../../packages/schema" }
 cosmwasm-std = { path = "../../packages/std", default-features = false, features = ["abort"] }
 rust-argon2 = "0.8"
 schemars = "0.8.1"
@@ -39,6 +40,5 @@ sha2 = "0.9.1"
 thiserror = "1.0"
 
 [dev-dependencies]
-cosmwasm-schema = { path = "../../packages/schema" }
 cosmwasm-storage = { path = "../../packages/storage", default-features = false }
 cosmwasm-vm = { path = "../../packages/vm", default-features = false }

contracts/hackatom/examples/schema.rs

@@ -1,56 +1,13 @@
-use std::collections::BTreeMap;
-use std::env::current_dir;
-use std::fs::{create_dir_all, write};
+use cosmwasm_schema::write_api;
 
-use cosmwasm_schema::{export_schema, remove_schemas, schema_for, Api};
-use cosmwasm_std::{AllBalanceResponse, BalanceResponse};
-
-use hackatom::msg::{
-    ExecuteMsg, InstantiateMsg, IntResponse, MigrateMsg, QueryMsg, RecurseResponse, SudoMsg,
-    VerifierResponse,
-};
-use hackatom::state::State;
+use hackatom::msg::{ExecuteMsg, InstantiateMsg, MigrateMsg, QueryMsg, SudoMsg};
 
 fn main() {
-    let mut out_dir = current_dir().unwrap();
-    out_dir.push("schema");
-    create_dir_all(&out_dir).unwrap();
-    remove_schemas(&out_dir).unwrap();
-
-    // messages
-    export_schema(&schema_for!(InstantiateMsg), &out_dir);
-    export_schema(&schema_for!(ExecuteMsg), &out_dir);
-    export_schema(&schema_for!(MigrateMsg), &out_dir);
-    export_schema(&schema_for!(SudoMsg), &out_dir);
-    export_schema(&schema_for!(QueryMsg), &out_dir);
-    export_schema(&schema_for!(VerifierResponse), &out_dir);
-    export_schema(&schema_for!(BalanceResponse), &out_dir);
-
-    // state
-    export_schema(&schema_for!(State), &out_dir);
-
-    let contract_name = env!("CARGO_PKG_NAME");
-    let contract_version = env!("CARGO_PKG_VERSION");
-
-    // The new IDL
-    let path = out_dir.join(format!("{}.json", contract_name));
-    let api = Api {
-        contract_name: contract_name.to_string(),
-        contract_version: contract_version.to_string(),
-        instantiate: schema_for!(InstantiateMsg),
-        execute: Some(schema_for!(ExecuteMsg)),
-        query: Some(schema_for!(QueryMsg)),
-        migrate: Some(schema_for!(MigrateMsg)),
-        sudo: Some(schema_for!(SudoMsg)),
-        responses: BTreeMap::from([
-            ("verifier".to_string(), schema_for!(VerifierResponse)),
-            ("other_balance".to_string(), schema_for!(AllBalanceResponse)),
-            ("recurse".to_string(), schema_for!(RecurseResponse)),
-            ("get_int".to_string(), schema_for!(IntResponse)),
-        ]),
+    write_api! {
+        instantiate: InstantiateMsg,
+        query: QueryMsg,
+        execute: ExecuteMsg,
+        sudo: SudoMsg,
+        migrate: MigrateMsg,
     }
-    .render();
-    let json = api.to_string().unwrap();
-    write(&path, json + "\n").unwrap();
-    println!("Exported the full API as {}", path.to_str().unwrap());
 }