Merge pull request #38 from firstbatchxyz/erhant/perf-rfks

feat: repo performance refactors

Author: erhant

Cargo.lock

@@ -1,15 +1,16 @@
-[package]
-name = "dria-oracle"
-description = "Dria Knowledge Network Oracle Node"
-version = "0.2.2"
+[workspace]
+resolver = "2"
+members = ["core", "contracts", "storage"]
+default-members = ["core"]
+
+[workspace.package]
 edition = "2021"
+version = "0.2.32"
 license = "Apache-2.0"
 readme = "README.md"
+authors = ["erhant"]
 
-[features]
-anvil = ["alloy/node-bindings"]
-
-[dependencies]
+[workspace.dependencies]
 # core
 alloy = { version = "0.8.0", features = ["full", "node-bindings"] }
 alloy-chains = "0.1.24"
@@ -42,11 +43,3 @@ hex = "0.4.3"
 hex-literal = "0.4.1"
 serde = "1.0.204"
 serde_json = "1.0.122"
-
-# cli
-clap = { version = "4.5.13", features = ["derive", "env"] }
-
-# arweave uploader
-# TODO: there are many unused stuff here, but everything breaks if you use the minimal set
-# because Bundlr SDK is not maintained at all
-bundlr-sdk = { version = "0.5.0" }

Cargo.toml

@@ -7,15 +7,15 @@ endif
 ###############################################################################
 .PHONY: launch #       | Run with INFO logging & release mode
 launch:
-		cargo run --release start 
+		cargo run --release serve 
 
 .PHONY: run #          | Run with INFO logging
 run:
-		cargo run start
+		cargo run serve
 
 .PHONY: debug #        | Run with crate-level DEBUG logging & info-level workflows
 debug:
-		RUST_LOG=none,dria_oracle=debug,dkn_workflows=debug,ollama_workflows=info cargo run start
+		RUST_LOG=none,dria_oracle=debug,dkn_workflows=debug,ollama_workflows=info cargo run serve
 
 ###############################################################################
 .PHONY: install #        | Install to path

Makefile

@@ -31,6 +31,18 @@ Create an `.env` file by copying `.env.example`. You have to fill the following
 > The contract addresses are determined with respect to the chain connected via RPC URL, but you can override it via `COORDINATOR_ADDRESS` environment variable.
 > In any case, you should not need to do this.
 
+> [!TIP]
+>
+> You can have multiple environment files, and specify them explicitly with the `-e` argument, e.g.
+>
+> ```sh
+> # base sepolia
+> dria-oracle -e ./.env.base-sepolia registrations
+>
+> # base mainnet
+> dria-oracle -e ./.env.base-mainnet registrations
+> ```
+
 ### Arweave
 
 You can save gas costs using [Arweave](https://arweave.org/):
@@ -66,8 +78,7 @@ The CLI provides several methods to interact with the oracle contracts.
 
 > [!TIP]
 >
-> By default logs will be `info` level, but you can add a `DEBUG=1` env variable and it will use `debug` level instead.
-> You can set `RUST_LOG` variable yourself as well.
+> You can enable debug-level logs with the `-d` option.
 
 ### Registration
 
@@ -92,11 +103,11 @@ dria-oracle unregister validator
 
 ### Launching the Node
 
-We launch our node using the `start` command, followed by models of our choice and the oracle type that we would like to serve.
+We launch our node using the `serve` command, followed by models of our choice and the oracle type that we would like to serve.
 If we provide no oracle types, it will default to the ones that we are registered to.
 
 ```sh
-dria-oracle start -m=gpt-4o-mini -m=llama3.1:latest
+dria-oracle serve -m=gpt-4o-mini -m=llama3.1:latest
 ```
 
 You can terminate the application from the terminal as usual (e.g. CTRL+C) to quit the node.
@@ -109,20 +120,20 @@ Following the same logic, the Oracle node can read task inputs from Arweave as w
 
 ### Viewing Tasks
 
-You can view the status of a task by its task id:
+You can `view` the details of a task by its task id:
 
 ```sh
 dria-oracle view <task-id>
 ```
 
-You can also view the task status updates between blocks with the `tasks` command.
-It accepts `--from` and `--to` arguments to indicate block numbers or tags, defaults from `earliest` block to `latest` block.
+You can also view the task status updates between blocks with the same command, by providing `from` and `to` blocks,
+which defaults from `earliest` block to `latest` block if none is provided.
 
 ```sh
-dria-oracle tasks                      # earliest to latest
-dria-oracle tasks --from=100           # 100      to latest
-dria-oracle tasks --to=100             # earliest to 100
-dria-oracle tasks --from=100 --to=200  # 100      to 200
+dria-oracle view                      # earliest to latest
+dria-oracle view --from=100           # 100      to latest
+dria-oracle view --to=100             # earliest to 100
+dria-oracle view --from=100 --to=200  # 100      to 200
 ```
 
 ### Balance & Rewards
@@ -157,22 +168,6 @@ It mainly takes an input argument, followed by multiple model arguments:
 dria-oracle request "What is 2+2?" gpt-4o-mini phi3:3.8b
 ```
 
-The `request` command takes the following options:
-
-- `--difficulty` for the proof-of-work difficulty for oracles that are responding to this request; the higher this is the more fees it will take to make the request.
-- `--num-gens` number of generations requested.
-- `--num-vals` number of validations required per request.
-
-> [!NOTE]
->
-> Making a request from the Oracle node is mainly for testing purposes, and you are not expected to use this command at all. Furthermore, it is only used to make plaintext requests, instead of larger ones via Arweave or more complex ones via Workflows.
-
-There are 3 types of requests:
-
-- **String**: simple text
-- **Chat**: an object of the form `{history_id: number, content: string}` which uses a previous task as history; TODO: history > nextTaskId handled?
-- **Workflow**: a stringified Workflow object
-
 ## Development
 
 If you would like to contribute, please create an issue first! To start developing, clone the repository:

README.md

@@ -0,0 +1,12 @@
+[package]
+name = "dria-oracle-contracts"
+description = "Dria Oracle Contract Interfaces"
+version.workspace = true
+edition.workspace = true
+license.workspace = true
+authors.workspace = true
+
+[dependencies]
+alloy.workspace = true
+alloy-chains.workspace = true
+eyre.workspace = true

contracts/Cargo.toml

@@ -29,7 +29,6 @@ impl std::fmt::Display for ContractAddresses {
 /// Will return an error if the chain is not supported, i.e. a coordinator address
 /// is not deployed there.
 pub fn get_coordinator_address(chain: NamedChain) -> eyre::Result<Address> {
-    
     let addresses = match chain {
         NamedChain::AnvilHardhat => address!("9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0"),
         NamedChain::BaseSepolia => address!("13f977bde221b470d3ae055cde7e1f84debfe202"),