4 governed contracts for whitelisting cw721 contracts and ICS721 channels.

Cargo.toml

@@ -1,5 +1,43 @@
 [workspace]
-members = ["contracts/*", "packages/*", "debug/*"]
+members   = ["contracts/*", "packages/*", "debug/*"]
+
+[workspace.package]
+authors   = ["Mr T <mr-t@arkprotocol.io>"]
+edition    = "2021"
+homepage   = "https://arkprotocol.io"
+repository = "https://github.com/arkprotocol/cw721-proxy/"
+license   = "Apache-2.0"
+keywords   = ["cosmos", "cosmwasm"]
+
+[workspace.dependencies]
+cosmwasm-std = "1.1"
+cosmwasm-schema = "1.1"
+cw-storage-plus = "0.16"
+cw2 = "0.16"
+cw721 = "0.16"
+cw721-proxy = { path = "./packages/cw721-proxy", version = "*" }
+cw721-proxy-derive = { path = "./packages/cw721-proxy-derive", version = "*" }
+cw721-whitelist = { path = "./packages/cw721-whitelist", version = "*" }
+cw721-whitelist-map = { path = "./packages/cw721-whitelist-map", version = "*" }
+cw721-governed-proxy = { path = "./contracts/cw721-governed-proxy", version = "*" }
+cw-ics721-governance = { path = "./packages/cw-ics721-governance", version = "*" }
+cw-ics721-governance-derive = { path = "./packages/cw-ics721-governance/derive", version = "*" }
+cw-rate-limiter = { path = "./packages/cw-rate-limiter", version = "*" }
+cw-utils = "0.16.0"
+ibc-outgoing-msg = { path = "./packages/ibc-outgoing-msg", version = "*" }
+cw721-proxy-multi-test = { path = "./packages/cw721-proxy-multi-test", version = "*" }
+schemars = "0.8.11"
+proc-macro2 = "1.0"
+quote = "1.0"
+serde = "1.0"
+syn = { version = "1.0", features = ["derive"] }
+thiserror = "1"
+# dev dependencies
+cw-multi-test = "0.16.4"
+cw721-base = "0.16"
+cw721-proxy-tester = { path = "./debug/cw721-proxy-tester", version = "*" }
+rand = "0.8"
+anyhow = "1.0"
 
 [profile.release]
 codegen-units = 1

README.md

@@ -1,9 +1,98 @@
 # CW 721 Proxy
 
-1. `packages/cw721-proxy` An interface for proxying cw721 send messages.
-3. `contracts/cw721-rate-limited-proxy` An implementation of this
+1. `contracts/cw721-rate-limited-proxy` An implementation of this
    proxy interface to rate limit incoming cw721 send messages.
-2. `packages/cw-rate-limiter` package for rate limiting in CosmWasm
+2. `contracts/cw721-governed-proxy` A a governed proxy with an optional transfer fee
+   being eligible to `bridge_nft`s to origin contract.
+3. `contracts/cw721-governed-rate-limited-proxy` A `cw721-governed-proxy` extension of above rate limited proxy.
+4. `contracts/cw721-governed-channel-proxy` A `cw721-governed-proxy` extension with a channel whitelist
+   being eligible to `send_nft`s to origin contract.
+5. `contracts/cw721-governed-code-id-proxy` A `cw721-governed-proxy` extension with a code id whitelist
+   being eligible to `send_nft`s to origin contract.
+6. `contracts/cw721-governed-collection-proxy` A `cw721-governed-proxy` extension with a collection (cw721/sender) whitelist
+   being eligible to `send_nft`s to origin contract.
+7. `contracts/cw721-governed-collection-channels-proxy` A `cw721-governed-proxy` extension with a sender and channels whitelist
+   being eligible to `send_nft`s to origin contract.
+8. `packages/cw721-proxy` An interface for proxying cw721 send messages.
+9. `packages/cw-rate-limiter` package for rate limiting in CosmWasm
    contracts.
-4. `packages/cw721-proxy-derive` Procedural macros for deriving the
+10. `packages/cw721-proxy-derive` Procedural macros for deriving the
    proxy receiver message types on an existing enum.
+11. `packages/cw-governed-proxy-multitest` Test app with helper functions for testing governed proxies.
+12. `packages/cw721-whitelist` An `Item<'a, Vec<T>>` store for whitelisting in CosmWasm contracts.
+13. `packages/cw721-whitelist-map` A `Map<'a, K, T>` store for whitelisting in CosmWasm contracts.
+   contracts.
+14. `packages/ibc-outgoing-msg` An `IbcOutgoingMsg` struct, required by [ICS721](https://github.com/public-awesome/ics721/blob/main/contracts/cw-ics721-bridge/src/msg.rs#L84-L95).
+
+# Proxies
+
+## Rate Limited Proxy
+
+A simple proxy to rate limit incoming cw721 send messages. A rate limit can be set based on `Blocks` or `PerBlocks` as defined in [Rate](.packages/cw-rate-limiter/src/lib.rs#L15).
+
+An incoming `receive_nft` message is forwarded to a given `origin` (ics721 contract).
+
+## Governed Proxy
+
+A simple governed proxy. There are 2 possibilities NFTs can be transferred to another chain:
+
+1. `receive_nft`: NFT is send from collection to proxy. Proxy gets a `receive_nft` from collection, transfer ownership to ics721 (escrowed) and __forwards receive msg__ to ics721, which then handles inter-chain transfer.
+2. `bridge_nft`: NFT is send by calling `bridge_nft` directly on proxy. Proxy is allowed and have approval to transfer nft to ics721 and __sends a receive msg__ to ics721, which then handles inter-chain transfer.
+
+A governed proxy stores this:
+
+- `origin`: required ics721 contract for handling inter-chain transfers.
+- `owner`: optional, if given only owner is authorized changing `origin`, `owner`, `transfer_fee` and execute `send_funds`.
+- `transfer_fee`: optional, if provided it will be checked whether funds have been send on `receive_nft` and `bridge_nft` is called. This means pratically only `bridge_nft` is eligible to call ics721, since `send_nft` is called by collection - and in case of base cw721 it doesn't send funds!
+
+IMPORTANT: in case `owner` is not set, above stores (`origin`, `owner` and `transfer_fee`) are immutable. Also `send_funds` is disabled then. The only way of changing these is via migration!
+
+## Governed Rate Limited Proxy
+
+A `cw721-governed-proxy` extension of above rate limited proxy.
+
+## Governed Channel Proxy
+
+A `cw721-governed-proxy` extension with a channel whitelist being eligible to `send_nft`s to origin contract.
+
+## Governed Code Id Proxy
+
+A `cw721-governed-proxy` extension with a code id whitelist being eligible to `send_nft`s to origin contract.
+
+## Governed Collection Proxy
+
+A `cw721-governed-proxy` extension with a collection (cw721/sender) whitelist being eligible to `send_nft`s to origin contract.
+
+## Governed Collection Channels Proxy
+
+A `cw721-governed-proxy` extension with a sender and channels whitelist being eligible to `send_nft`s to origin contract.
+
+# Packages
+
+## cw721-proxy
+
+An interface for proxying cw721 send messages.
+
+## cw-rate-limiter
+
+Package for rate limiting in CosmWasm contracts.
+
+## cw721-proxy-derive
+
+Procedural macros for deriving the proxy receiver message types on an existing enum.
+
+## cw-governed-proxy-multitest
+
+Test app with helper functions for testing governed proxies.
+
+## cw721-whitelist
+
+An `Item<'a, Vec<T>>` store for whitelisting in CosmWasm contracts.
+
+## cw721-whitelist-map
+
+A `Map<'a, K, T>` store for whitelisting in CosmWasm contracts.
+
+## ibc-outgoing-msg
+
+An `IbcOutgoingMsg` struct, required by [ICS721](https://github.com/public-awesome/ics721/blob/main/contracts/cw-ics721-bridge/src/msg.rs#L84-L95).

build.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+## Compiles and optimizes contracts
+
+set -o errexit -o nounset -o pipefail
+command -v shellcheck >/dev/null && shellcheck "$0"
+
+cd "$(git rev-parse --show-toplevel)"
+
+docker run --rm -v "$(pwd)":/code --platform linux/amd64 \
+	--mount type=volume,source="$(basename "$(pwd)")_cache",target=/code/target \
+	--mount type=volume,source=registry_cache,target=/usr/local/cargo/registry \
+	cosmwasm/workspace-optimizer:0.12.9
+
+ls -al ./artifacts/*wasm

contracts/cw721-governed-channel-proxy/.cargo/config

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

contracts/cw721-governed-channel-proxy/.gitignore

@@ -0,0 +1,15 @@
+# Build results
+/target
+
+# Cargo+Git helper file (https://github.com/rust-lang/cargo/blob/0.44.1/src/cargo/sources/git/utils.rs#L320-L327)
+.cargo-ok
+
+# Text file backups
+**/*.rs.bk
+
+# macOS
+.DS_Store
+
+# IDEs
+*.iml
+.idea

contracts/cw721-governed-channel-proxy/Cargo.toml

@@ -0,0 +1,41 @@
+[package]
+name        = "cw721-governed-channel-proxy"
+version     = "0.0.1"
+description = "TODO"
+license     = { workspace = true }
+authors     = { workspace = true }
+edition     = { workspace = true }
+homepage    = { workspace = true }
+repository  = { workspace = true }
+keywords    = { workspace = true }
+
+[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]
+cosmwasm-std = { workspace = true }
+cosmwasm-schema = { workspace = true }
+cw-storage-plus = { workspace = true }
+cw2 = { workspace = true }
+cw721 = { workspace = true }
+cw721-proxy = { workspace = true }
+cw721-proxy-derive = { workspace = true }
+cw721-whitelist = { workspace = true }
+cw721-governed-proxy = { workspace = true, features = ["library"] }
+cw-ics721-governance = { workspace = true}
+ibc-outgoing-msg = { workspace = true }
+thiserror = { workspace = true }
+
+[dev-dependencies]
+cw-multi-test = { workspace = true }
+cw721-base = { workspace = true }
+cw721-proxy-tester = { workspace = true }
+cw721-proxy-multi-test = { workspace = true }
+rand = { workspace = true }
+anyhow = { workspace = true }