Repo la Mono

ensdomains · May 25, 2024 · 4687881 · 4687881
1 parent 194993f
commit 4687881
Show file tree

Hide file tree

Showing 44 changed files with 82 additions and 73 deletions.
diff --git a/README.md b/README.md
@@ -3,78 +3,7 @@
 > [!WARNING]
 > This repository is under construction 🚧. We are actively improving it hackathon-style.
 
-This is a Rust implementation of the [CCIP gateway](https://alpha-docs.ens.domains/resolvers/ccip). It allows you to issue unlimited gasless subdomains for your name, as well as to create, manage, and moderate namespaces.
+## Offchain Gateway Example
 
-> [!NOTE]
-> This gateway is built to be an **Opinionated ENS Subname Issuer**, if youre looking for something more generic, please checkout [ensdomains/offchain-resolver](https://github.com/ensdomains/offchain-resolver), and [ensdomains/offchain-resolver-example](https://github.com/ensdomains/offchain-resolver-example).
+If you are looking for the original code that was in this repository please see [examples/full](examples/full).
 
-## Features
-
-- CCIP Spec Compliant Gateway Endpoint
-- `postgres` - Transparent Database backend.
-- `self-service` - Authentication-based updating records.
-- `eoa-self-service` - EOA-based Authentication. (TODO)
-- Modular authentication for EOA, Admin API, & more.
-- View endpoint for profile data.
-
-## Setup
-
-### Run the gateway
-The gateway is just a docker container / standalone binary. You can run it with docker-compose or just run the binary.
-
-```yaml
-cargo run
-```
-
-### Deploy a Resolver
-
-Using a CCIP Gateway requires a resolver contract to be acting on behalf of the name. Although you could write your own contract, we recommend you deploy a proxy contract through [ccip.tools](https://ccip.tools/).
-
-[![](.github/ccip-tools.png)](https://ccip.tools/)
-
-(Source for the contracts can be found at [ensdomains/ccip-tools](https://github.com/ensdomains/ccip-tools/tree/master/contracts))
-
-When asked for the `Gateway URL` supply your gateway's url (for eg: `https://gateway.example.com/{sender}.json`), and for the `Signers` field supply the address of your gateway (for eg: `[0x225f137127d9067788314bc7fcc1f36746a3c3B5]`), you can find this in the logs of your gateway.
-
-> [!NOTE]
-> There are gas costs associated with deploying a resolver, at the time of writing this (30 gwei), it costs ~0.004 ETH (8 USD) to deploy a resolver (see [txs](https://etherscan.io/tx/0x0c90da0a122f38125a8ad1f48ef23cf5f7d399846bd5369b664ff288a31f797c)).
-
-### Set your Resolver
-
-Finally you need to instruct the onchain registry to use your resolver. You can do this by visiting your name in the [ENS Manager App](https://ens.app/) and under the `More` tab, set the `Resolver` field to the address of your resolver.
-
-## Fork this 🍴
-Don't like the implementation? Fork this repo and make it your own!
-
-You might also be interested in the [resolution logic](https://github.com/ensdomains/offchain-gateway-rs/blob/main/src/gateway/resolution.rs) and [database modularity](https://github.com/ensdomains/offchain-gateway-rs/blob/main/src/database/mod.rs).
-
-## Integration
-
-This gateway implementation is designed to be modular, light, and easy to integrate. It comes with the abstract Datastore idea, (by default implemented with postgres), authentication, simple resolution logic, and a self-service API.
-
-This means that depending on your use case you can easily swap out the database, the resolution logic, and customize authentication.
-
-### Issuing a name
-
-To issue a name from an trusted server, you can simply `POST` to `example.com/update` with a JSON body such as
-
-```json
-{
-    "name": "luc.willbreak.eth",
-    "records": {
-        "name": "Luc",
-        "text": "hello world",
-        "avatar": "https://avatars.githubusercontent.com/u/11744586?v=4",
-    },
-    "addresses": {
-        "60": "0x225f137127d9067788314bc7fcc1f36746a3c3B5"
-    },
-    "auth": "yes"
-}
-```
-
-In a similar fashion users could self-service their names by using this api endpoint and custom authentication logic.
-
-### Viewing a name
-
-In events were our app might not have access to ethereum specific tooling, we can use the `GET` endpoint `example.com/view/luc.willbreak.eth` to view the data of a name. This endpoint can be helpful for showing profile editing pages and more.
diff --git a/.env.example → examples/full/.env.example b/.env.example → examples/full/.env.example
diff --git a/.gitignore → examples/full/.gitignore b/.gitignore → examples/full/.gitignore
diff --git a/Cargo.lock → examples/full/Cargo.lock b/Cargo.lock → examples/full/Cargo.lock
diff --git a/Cargo.toml → examples/full/Cargo.toml b/Cargo.toml → examples/full/Cargo.toml
diff --git a/Dockerfile → examples/full/Dockerfile b/Dockerfile → examples/full/Dockerfile
diff --git a/examples/full/README.md b/examples/full/README.md
@@ -0,0 +1,80 @@
+# Offchain Gateway (Rust)
+
+> [!WARNING]
+> This repository is under construction 🚧. We are actively improving it hackathon-style.
+
+This is a Rust implementation of the [CCIP gateway](https://alpha-docs.ens.domains/resolvers/ccip). It allows you to issue unlimited gasless subdomains for your name, as well as to create, manage, and moderate namespaces.
+
+> [!NOTE]
+> This gateway is built to be an **Opinionated ENS Subname Issuer**, if youre looking for something more generic, please checkout [ensdomains/offchain-resolver](https://github.com/ensdomains/offchain-resolver), and [ensdomains/offchain-resolver-example](https://github.com/ensdomains/offchain-resolver-example).
+
+## Features
+
+- CCIP Spec Compliant Gateway Endpoint
+- `postgres` - Transparent Database backend.
+- `self-service` - Authentication-based updating records.
+- `eoa-self-service` - EOA-based Authentication. (TODO)
+- Modular authentication for EOA, Admin API, & more.
+- View endpoint for profile data.
+
+## Setup
+
+### Run the gateway
+The gateway is just a docker container / standalone binary. You can run it with docker-compose or just run the binary.
+
+```yaml
+cargo run
+```
+
+### Deploy a Resolver
+
+Using a CCIP Gateway requires a resolver contract to be acting on behalf of the name. Although you could write your own contract, we recommend you deploy a proxy contract through [ccip.tools](https://ccip.tools/).
+
+[![](.github/ccip-tools.png)](https://ccip.tools/)
+
+(Source for the contracts can be found at [ensdomains/ccip-tools](https://github.com/ensdomains/ccip-tools/tree/master/contracts))
+
+When asked for the `Gateway URL` supply your gateway's url (for eg: `https://gateway.example.com/{sender}.json`), and for the `Signers` field supply the address of your gateway (for eg: `[0x225f137127d9067788314bc7fcc1f36746a3c3B5]`), you can find this in the logs of your gateway.
+
+> [!NOTE]
+> There are gas costs associated with deploying a resolver, at the time of writing this (30 gwei), it costs ~0.004 ETH (8 USD) to deploy a resolver (see [txs](https://etherscan.io/tx/0x0c90da0a122f38125a8ad1f48ef23cf5f7d399846bd5369b664ff288a31f797c)).
+
+### Set your Resolver
+
+Finally you need to instruct the onchain registry to use your resolver. You can do this by visiting your name in the [ENS Manager App](https://ens.app/) and under the `More` tab, set the `Resolver` field to the address of your resolver.
+
+## Fork this 🍴
+Don't like the implementation? Fork this repo and make it your own!
+
+You might also be interested in the [resolution logic](https://github.com/ensdomains/offchain-gateway-rs/blob/main/src/gateway/resolution.rs) and [database modularity](https://github.com/ensdomains/offchain-gateway-rs/blob/main/src/database/mod.rs).
+
+## Integration
+
+This gateway implementation is designed to be modular, light, and easy to integrate. It comes with the abstract Datastore idea, (by default implemented with postgres), authentication, simple resolution logic, and a self-service API.
+
+This means that depending on your use case you can easily swap out the database, the resolution logic, and customize authentication.
+
+### Issuing a name
+
+To issue a name from an trusted server, you can simply `POST` to `example.com/update` with a JSON body such as
+
+```json
+{
+    "name": "luc.willbreak.eth",
+    "records": {
+        "name": "Luc",
+        "text": "hello world",
+        "avatar": "https://avatars.githubusercontent.com/u/11744586?v=4",
+    },
+    "addresses": {
+        "60": "0x225f137127d9067788314bc7fcc1f36746a3c3B5"
+    },
+    "auth": "yes"
+}
+```
+
+In a similar fashion users could self-service their names by using this api endpoint and custom authentication logic.
+
+### Viewing a name
+
+In events were our app might not have access to ethereum specific tooling, we can use the `GET` endpoint `example.com/view/luc.willbreak.eth` to view the data of a name. This endpoint can be helpful for showing profile editing pages and more.
diff --git a/docker-compose.yaml → examples/full/docker-compose.yaml b/docker-compose.yaml → examples/full/docker-compose.yaml
diff --git a/src/ccip/lookup/mod.rs → examples/full/src/ccip/lookup/mod.rs b/src/ccip/lookup/mod.rs → examples/full/src/ccip/lookup/mod.rs
diff --git a/src/ccip/mod.rs → examples/full/src/ccip/mod.rs b/src/ccip/mod.rs → examples/full/src/ccip/mod.rs
diff --git a/src/database/mod.rs → examples/full/src/database/mod.rs b/src/database/mod.rs → examples/full/src/database/mod.rs
diff --git a/src/gateway/endpoint.rs → examples/full/src/gateway/endpoint.rs b/src/gateway/endpoint.rs → examples/full/src/gateway/endpoint.rs
diff --git a/src/gateway/mod.rs → examples/full/src/gateway/mod.rs b/src/gateway/mod.rs → examples/full/src/gateway/mod.rs
diff --git a/src/gateway/payload.rs → examples/full/src/gateway/payload.rs b/src/gateway/payload.rs → examples/full/src/gateway/payload.rs
diff --git a/src/gateway/resolution.rs → examples/full/src/gateway/resolution.rs b/src/gateway/resolution.rs → examples/full/src/gateway/resolution.rs
diff --git a/src/gateway/response.rs → examples/full/src/gateway/response.rs b/src/gateway/response.rs → examples/full/src/gateway/response.rs
diff --git a/src/gateway/signing.rs → examples/full/src/gateway/signing.rs b/src/gateway/signing.rs → examples/full/src/gateway/signing.rs
diff --git a/src/http.rs → examples/full/src/http.rs b/src/http.rs → examples/full/src/http.rs
diff --git a/src/main.rs → examples/full/src/main.rs b/src/main.rs → examples/full/src/main.rs
diff --git a/src/multicoin/cointype/coins.rs → ...ples/full/src/multicoin/cointype/coins.rs b/src/multicoin/cointype/coins.rs → ...ples/full/src/multicoin/cointype/coins.rs
diff --git a/src/multicoin/cointype/mod.rs → examples/full/src/multicoin/cointype/mod.rs b/src/multicoin/cointype/mod.rs → examples/full/src/multicoin/cointype/mod.rs
diff --git a/src/multicoin/cointype/slip44.rs → ...les/full/src/multicoin/cointype/slip44.rs b/src/multicoin/cointype/slip44.rs → ...les/full/src/multicoin/cointype/slip44.rs
diff --git a/src/multicoin/encoding/binance.rs → ...es/full/src/multicoin/encoding/binance.rs b/src/multicoin/encoding/binance.rs → ...es/full/src/multicoin/encoding/binance.rs
diff --git a/src/multicoin/encoding/bitcoin.rs → ...es/full/src/multicoin/encoding/bitcoin.rs b/src/multicoin/encoding/bitcoin.rs → ...es/full/src/multicoin/encoding/bitcoin.rs
diff --git a/src/multicoin/encoding/cardano.rs → ...es/full/src/multicoin/encoding/cardano.rs b/src/multicoin/encoding/cardano.rs → ...es/full/src/multicoin/encoding/cardano.rs
diff --git a/src/multicoin/encoding/checksum_address.rs → ...rc/multicoin/encoding/checksum_address.rs b/src/multicoin/encoding/checksum_address.rs → ...rc/multicoin/encoding/checksum_address.rs
diff --git a/src/multicoin/encoding/hedera.rs → ...les/full/src/multicoin/encoding/hedera.rs b/src/multicoin/encoding/hedera.rs → ...les/full/src/multicoin/encoding/hedera.rs
diff --git a/src/multicoin/encoding/mod.rs → examples/full/src/multicoin/encoding/mod.rs b/src/multicoin/encoding/mod.rs → examples/full/src/multicoin/encoding/mod.rs
diff --git a/src/multicoin/encoding/p2pkh.rs → ...ples/full/src/multicoin/encoding/p2pkh.rs b/src/multicoin/encoding/p2pkh.rs → ...ples/full/src/multicoin/encoding/p2pkh.rs
diff --git a/src/multicoin/encoding/p2sh.rs → examples/full/src/multicoin/encoding/p2sh.rs b/src/multicoin/encoding/p2sh.rs → examples/full/src/multicoin/encoding/p2sh.rs
diff --git a/src/multicoin/encoding/polkadot.rs → ...s/full/src/multicoin/encoding/polkadot.rs b/src/multicoin/encoding/polkadot.rs → ...s/full/src/multicoin/encoding/polkadot.rs
diff --git a/src/multicoin/encoding/ripple.rs → ...les/full/src/multicoin/encoding/ripple.rs b/src/multicoin/encoding/ripple.rs → ...les/full/src/multicoin/encoding/ripple.rs
diff --git a/src/multicoin/encoding/segwit.rs → ...les/full/src/multicoin/encoding/segwit.rs b/src/multicoin/encoding/segwit.rs → ...les/full/src/multicoin/encoding/segwit.rs
diff --git a/src/multicoin/encoding/solana.rs → ...les/full/src/multicoin/encoding/solana.rs b/src/multicoin/encoding/solana.rs → ...les/full/src/multicoin/encoding/solana.rs
diff --git a/src/multicoin/encoding/stellar.rs → ...es/full/src/multicoin/encoding/stellar.rs b/src/multicoin/encoding/stellar.rs → ...es/full/src/multicoin/encoding/stellar.rs
diff --git a/src/multicoin/mod.rs → examples/full/src/multicoin/mod.rs b/src/multicoin/mod.rs → examples/full/src/multicoin/mod.rs
diff --git a/src/selfservice/endpoint.rs → examples/full/src/selfservice/endpoint.rs b/src/selfservice/endpoint.rs → examples/full/src/selfservice/endpoint.rs
diff --git a/src/selfservice/mod.rs → examples/full/src/selfservice/mod.rs b/src/selfservice/mod.rs → examples/full/src/selfservice/mod.rs
diff --git a/src/selfservice/view.rs → examples/full/src/selfservice/view.rs b/src/selfservice/view.rs → examples/full/src/selfservice/view.rs
diff --git a/src/state.rs → examples/full/src/state.rs b/src/state.rs → examples/full/src/state.rs
diff --git a/src/utils/axum_json.rs → examples/full/src/utils/axum_json.rs b/src/utils/axum_json.rs → examples/full/src/utils/axum_json.rs
diff --git a/src/utils/dns.rs → examples/full/src/utils/dns.rs b/src/utils/dns.rs → examples/full/src/utils/dns.rs
diff --git a/src/utils/mod.rs → examples/full/src/utils/mod.rs b/src/utils/mod.rs → examples/full/src/utils/mod.rs
diff --git a/src/utils/sha256.rs → examples/full/src/utils/sha256.rs b/src/utils/sha256.rs → examples/full/src/utils/sha256.rs