Merge pull request #8 from jeje/feat/gateway-lib

feat(lib): introduced ENS gateway library

.github/workflows/release.yml

@@ -89,7 +89,7 @@ jobs:
       - name: "Upload Binaries"
         uses: "taiki-e/upload-rust-binary-action@v1"
         with:
-          bin: "offchain-resolver-gateway"
+          bin: "ens-gateway"
           target: ${{ matrix.target }}
           archive: $bin-${{ matrix.target }}
           ref: refs/tags/v${{ needs.get-tag.outputs.pkg-version }}

Cargo.toml

@@ -1,8 +1,16 @@
 [package]
-name = "offchain-resolver-gateway"
-version = "0.1.1"
+name = "ens-offchain-resolver-gateway"
+version = "0.1.2"
 edition = "2021"
 
+[lib]
+name = "ens_gateway_server"
+path = "src/lib.rs"
+
+[[bin]]
+name = "ens-gateway"
+path = "src/main.rs"
+
 [dependencies]
 ccip-read-server = "0.1.0"
 

Dockerfile

@@ -5,17 +5,17 @@ WORKDIR /opt/
 RUN apk add curl protoc musl-dev gzip git
 
 # offchain-resolver-gateway
-RUN curl -sLO https://github.com/jeje/ens-offchain-resolver-gateway-rs/releases/latest/download/offchain-resolver-gateway-x86_64-unknown-linux-musl.tar.gz \
-  && tar -xvf offchain-resolver-gateway-x86_64-unknown-linux-musl.tar.gz \
-  && chmod +x offchain-resolver-gateway
+RUN curl -sLO https://github.com/jeje/ens-offchain-resolver-gateway-rs/releases/latest/download/ens-gateway-x86_64-unknown-linux-musl.tar.gz \
+  && tar -xvf ens-gateway-x86_64-unknown-linux-musl.tar.gz \
+  && chmod +x ens-gateway
 
 #########################################################
 
 FROM alpine:3.16.2
 
 RUN apk add tmux
 
-COPY --from=builder /opt/offchain-resolver-gateway /opt/offchain-resolver-gateway
+COPY --from=builder /opt/ens-gateway /opt/ens-gateway
 
 RUN chown -R root:root /opt/
 
@@ -24,4 +24,4 @@ ENV TTL 300
 ENV LISTEN_IP 0.0.0.0
 ENV LISTEN_PORT 8080
 
-ENTRYPOINT [ "/opt/offchain-resolver-gateway" ]
+ENTRYPOINT [ "/opt/ens-gateway" ]

README.md

@@ -24,12 +24,15 @@ Precompiled ENS gateways are available in [releases page](https://github.com/jej
 
 A Docker image is also available: https://hub.docker.com/r/jeje/ens-offchain-resolver-gateway-rs
 
+Lastly a library is provided to ease implementation of custom gateways without duplicating much code.
+A good sample is the [default implementation provided](src/main.rs).
+
 ### CLI Usage
 
 ```
 ENS Offchain Gateway server answering requests from CCIP-READ protocol (aka ERC-3668)
 
-Usage: offchain-resolver-gateway [OPTIONS] --privatekey <VALUE> <--json <FILE>>
+Usage: ens-gateway [OPTIONS] --privatekey <VALUE> <--json <FILE>>
 
 Options:
   -k, --privatekey <VALUE>  private key of the wallet allowed to sign offchain ENS record results [env: PRIVATE_KEY]

src/errors.rs

@@ -1,17 +1,24 @@
 use thiserror::Error;
 
+/// ENS gateway errors
 #[derive(Error, Debug)]
 pub enum GatewayErrors {
-    #[error("invalid dns name")]
+    /// Invalid ENS name error
+    #[error("invalid ENS name")]
     InvalidName,
+    /// ABI error
     #[error("ABI error {0}")]
     Abi(#[from] ethers::contract::AbiError),
+    /// ABI Parsing error
     #[error("ABI parse error {0}")]
     AbiParse(#[from] ethers::abi::ParseError),
+    /// CCIP-Read server error
     #[error("CCIP Read error {0}")]
     CCIPReadMiddleware(#[from] ccip_read_server::CCIPReadMiddlewareError),
+    /// Unknown ENS record type error
     #[error("unknown record type")]
     UnknownRecordType,
+    /// Invalid signature error
     #[error("signature error")]
     Signature(#[from] ethers::types::SignatureError),
 }

src/lib.rs

@@ -0,0 +1,18 @@
+//! ENS offchain resolver gateway framework
+
+/// Various offchain database storage options
+pub mod db;
+/// Errors
+pub mod errors;
+/// Gateway framework
+pub mod gateway;
+/// Utils
+pub mod utils;
+
+use ethers::prelude::abigen;
+
+abigen!(
+    Resolver,
+    "./res/Resolver.json",
+    event_derives(serde::Deserialize, serde::Serialize)
+);

src/main.rs

@@ -1,8 +1,7 @@
-use crate::db::{Database, JsonDatabase};
-use crate::gateway::Gateway;
 use clap::{arg, command, value_parser, ArgGroup};
 use color_eyre::Report;
-use ethers::prelude::abigen;
+use ens_gateway_server::db::{Database, JsonDatabase};
+use ens_gateway_server::gateway::Gateway;
 use ethers::signers::{LocalWallet, Signer};
 use eyre::Result;
 use std::env;
@@ -13,17 +12,6 @@ use tracing::info;
 use tracing_subscriber::prelude::*;
 use tracing_subscriber::EnvFilter;
 
-mod db;
-mod errors;
-mod gateway;
-mod utils;
-
-abigen!(
-    Resolver,
-    "./res/Resolver.json",
-    event_derives(serde::Deserialize, serde::Serialize)
-);
-
 #[tokio::main]
 async fn main() -> Result<(), Report> {
     let matches = command!()

src/utils.rs

@@ -2,6 +2,7 @@ use crate::errors::GatewayErrors;
 use ethers::abi::{AbiEncode, Token};
 use ethers::types::Signature;
 
+/// Decode DNS name from call data, parsing ENS labels
 pub fn decode_dns_name(dns_name: &Token) -> Result<String, GatewayErrors> {
     if let Some(dns_name) = dns_name.clone().into_bytes() {
         let mut labels = vec![];
@@ -20,6 +21,9 @@ pub fn decode_dns_name(dns_name: &Token) -> Result<String, GatewayErrors> {
     }
 }
 
+/// Compute `yParityAndS` from a signature
+///
+/// EIP-2098: <https://eips.ethereum.org/EIPS/eip-2098>
 pub fn compact_y_parity_and_s(sig: &Signature) -> Result<Vec<u8>, GatewayErrors> {
     let mut y_parity_and_s = sig.s.encode();
     if sig.recovery_id()?.is_y_odd() {