Tg4 spec and uses

contracts/tg4-group/.cargo/config

@@ -0,0 +1,5 @@
+[alias]
+wasm = "build --release --target wasm32-unknown-unknown"
+wasm-debug = "build --target wasm32-unknown-unknown"
+unit-test = "test --lib"
+schema = "run --example schema"

contracts/tg4-group/Cargo.toml

@@ -0,0 +1,33 @@
+[package]
+name = "tg4-group"
+version = "0.1.0"
+authors = ["Ethan Frey <[email protected]>"]
+edition = "2018"
+description = "Simple TG4 implementation of group membership controlled by an admin"
+repository = "https://github.com/confio/tgrade-contracts"
+homepage = "https://tgrade.finance"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[lib]
+crate-type = ["cdylib", "rlib"]
+
+[features]
+# for more explicit tests, cargo test --features=backtraces
+backtraces = ["cosmwasm-std/backtraces"]
+# use library feature to disable all instantiate/execute/query exports
+library = []
+
+[dependencies]
+cw0 = { version = "0.6.0-beta2" }
+cw2 = { version = "0.6.0-beta2" }
+cw-controllers = { version = "0.6.0-beta2" }
+cw-storage-plus = { version = "0.6.0-beta2", features = ["iterator"] }
+tg4 = { path = "../../packages/tg4", version = "0.1.0" }
+cosmwasm-std = { version = "=0.14.0-beta3" }
+schemars = "0.8"
+serde = { version = "1.0.103", default-features = false, features = ["derive"] }
+thiserror = { version = "1.0.21" }
+
+[dev-dependencies]
+cosmwasm-schema = { version = "=0.14.0-beta3" }

contracts/tg4-group/README.md

@@ -0,0 +1,51 @@
+# TG4 Group
+
+This is a basic implementation of the [tg4 spec](../../packages/tg4/README.md).
+It fulfills all elements of the spec, including the raw query lookups,
+and it designed to be used as a backing storage for
+[cw3 compliant contracts](https://github.com/CosmWasm/cosmwasm-plus/blob/master/packages/cw3/README.mdl).
+
+It stores a set of members along with an admin, and allows the admin to
+update the state. Raw queries (intended for cross-contract queries)
+can check a given member address and the total weight. Smart queries (designed
+for client API) can do the same, and also query the admin address as well as
+paginate over all members.
+
+## Init
+
+To create it, you must pass in a list of members, as well as an optional
+`admin`, if you wish it to be mutable.
+
+```rust
+pub struct InitMsg {
+    pub admin: Option<HumanAddr>,
+    pub members: Vec<Member>,
+}
+
+pub struct Member {
+    pub addr: HumanAddr,
+    pub weight: u64,
+}
+```
+
+Members are defined by an address and a weight. This is transformed
+and stored under their `CanonicalAddr`, in a format defined in
+[tg4 raw queries](../../packages/tg4/README.md#raw).
+
+Note that 0 *is an allowed weight*. This doesn't give any voting rights, but
+it does define this address is part of the group. This could be used in
+e.g. a KYC whitelist to say they are allowed, but cannot participate in
+decision-making.
+
+## Messages
+
+Basic update messages, queries, and hooks are defined by the
+[tg4 spec](../../packages/tg4/README.md). Please refer to it for more info.
+
+`tg4-group` adds one message to control the group membership:
+
+`UpdateMembers{add, remove}` - takes a membership diff and adds/updates the
+members, as well as removing any provided addresses. If an address is on both
+lists, it will be removed. If it appears multiple times in `add`, only the
+last occurrence will be used.
+

contracts/tg4-group/examples/schema.rs

@@ -0,0 +1,22 @@
+use std::env::current_dir;
+use std::fs::create_dir_all;
+
+use cosmwasm_schema::{export_schema, export_schema_with_title, remove_schemas, schema_for};
+
+pub use tg4::{AdminResponse, MemberListResponse, MemberResponse, TotalWeightResponse};
+pub use tg4_group::msg::{ExecuteMsg, InstantiateMsg, QueryMsg};
+
+fn main() {
+    let mut out_dir = current_dir().unwrap();
+    out_dir.push("schema");
+    create_dir_all(&out_dir).unwrap();
+    remove_schemas(&out_dir).unwrap();
+
+    export_schema_with_title(&mut schema_for!(InstantiateMsg), &out_dir, "InstantiateMsg");
+    export_schema_with_title(&mut schema_for!(ExecuteMsg), &out_dir, "ExecuteMsg");
+    export_schema_with_title(&mut schema_for!(QueryMsg), &out_dir, "QueryMsg");
+    export_schema(&schema_for!(AdminResponse), &out_dir);
+    export_schema(&schema_for!(MemberListResponse), &out_dir);
+    export_schema(&schema_for!(MemberResponse), &out_dir);
+    export_schema(&schema_for!(TotalWeightResponse), &out_dir);
+}

contracts/tg4-group/schema/admin_response.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "AdminResponse",
+  "type": "object",
+  "properties": {
+    "admin": {
+      "type": [
+        "string",
+        "null"
+      ]
+    }
+  }
+}