Merge pull request #4 from Eoracle/develop

updating README and LICENSE files

LICENSE

@@ -0,0 +1,98 @@
+Business Source License 1.1
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
+"Business Source License" is a trademark of MariaDB Corporation Ab.
+
+-----------------------------------------------------------------------------
+
+Parameters
+
+Licensor:             Lightblocks Ltd.
+
+Licensed Work:        eoracle/operator-setup
+                      The Licensed Work is (c) 2024 Lightblocks Ltd.
+
+Additional Use Grant:
+
+Change Date:          2025-12-11 (Dec 11th, 2025)
+
+Change License:       MIT
+
+-----------------------------------------------------------------------------
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+MariaDB hereby grants you permission to use this License's text to license
+your works, and to refer to it using the trademark "Business Source License",
+as long as you comply with the Covenants of Licensor below.
+
+-----------------------------------------------------------------------------
+
+Covenants of Licensor
+
+In consideration of the right to use this License's text and the "Business
+Source License" name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where "compatible" means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text "None".
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.
+
+-----------------------------------------------------------------------------
+
+Notice
+
+The Business Source License (this document, or the "License") is not an Open
+Source license. However, the Licensed Work will eventually be made available
+under an Open Source License, as stated in this License.

README.md

@@ -1 +1,93 @@
-# core-go
+# Eoracle Operator Setup
+This guide will walk you through the process of registering as an operator to Eoracle AVS.
+
+## Prerequisites
+1. **Registered Eigenlayer Operator Account:** Ensure you have a fully registered Eigenlayer operator account. If you don't have one, follow the steps in the [Eigenlayer User Guide](https://docs.eigenlayer.xyz/restaking-guides/restaking-user-guide) to create and fund your account.
+
+## Software/Hardware Requirement 
+* Operating System: linux amd x64
+* vCPUs: 2
+* Memory: 4GiB 
+* Storage: 100GB
+* EC2 Equivalent: m5.large
+* Expected Network Utilization:
+  * Total download bandwidth usage: 1 Mbps
+  * Upload bandwidth usage: 1 Mbps 
+* Open Ports:
+  * 3000 Grafana dashboards
+  * 9090 Prometheus 
+
+## Operator Setup
+### ​Prepare Local Eoracle data validator files
+Clone this [repo](https://github.com/Eoracle/Eoracle-operator-setup) and execute the following commands
+```bash
+git clone https://github.com/Eoracle/Eoracle-operator-setup.git
+cd Eoracle-operator-setup
+cp data-validator/.example_env data-validator/.env
+```
+Copy `Eoracle-operator-setup/data-validator/.example_env` into `Eoracle-operator-setup/data-validator/.env`.  
+Edit the `Eoracle-operator-setup/data-validator/.env` and update the values for your setup
+
+### Generate a BLS pair (recommended)
+The register process requires two sets of private keys: an ecdsa private key and a bls private key,  
+We recommend creating a new BLS pair for security reasons.
+If you want to create a new BLS pair, you can generate a new BLS pair that will be dedicated to Eoracle
+```bash
+./run.sh generate-bls-key
+```
+
+### Encrypt your private keys (recommended)
+Encrypt your private keys. The encrypted private keys will be stored using the `EO_KEYSTORE_PATH` field.
+This is the recommended approach. if you encrypt a pasted private key it will never be saved as is anywhere.
+```bash
+./run.sh encrypt <your ecdsa private key> <your bls private key>
+```
+
+### Work with plain text private keys (discouraged)
+If you don't want to encrypt your private keys, update them in the `data-validator/.env` file  
+This approach is highly discouraged. We recommend encrypting the private keys and never saving them anywhere on any machine.  
+```bash
+EO_BLS_PRIVATE_KEY=<your ecdsa private key>
+EO_ECDSA_PRIVATE_KEY=<your bls private key>
+```
+
+### Register with Eoracle AVS
+Operators need to have a minimum of 32 ETH delegated to them to opt-in to Eoracle. Execute the following command 
+```bash
+./run.sh register
+```
+
+The output should look like
+```
+Registering operator with address <your address> 
+Opted into slashing with Service Manager at address 0x9546536FdAb1903e9c263923106eA5a4A44C4159
+Registered Operator with Coordinator at address 0xd8eA2939cE17316b7CA2F86b121EB9c7c94c39c0 with tx hash 0x28b4b463762d917c514b0e0a5b6b8e65187a4ea43f2ab146672ba22d6b7aaa81
+Awaiting finalization of registration
+Awaiting finalization of registration
+.
+.
+.
+Awaiting finalization of registration
+Successfully registered operator
+```
+
+### Troubleshooting the register command.
+salt already spent - if you get the following error:
+```
+Failed to create RegisterOperator transaction execution reverted: AVSDirectory.registerOperatorToAVS: salt already spent
+```
+Please add EO_SALT=<salt_in_hex> field to your .env file and retry runnning register.  
+(*) the EO_SALT should be in the following format EO_SALT=0x04 (even length hex number, and could be any number but must be even length)
+
+### Checking the status of Eoracle operator AVS
+The following command will print the status of the operator
+```bash
+./run.sh print-status
+```
+
+The output should look like
+```
+docker-entrypoint-oprcli.sh: Starting oprcli print-status 
+{"level":"info","ts":1712824061.311895,"caller":"logging/zap_logger.go:49","msg":"Operator Status","status":"REGISTERED"}
+{"level":"info","ts":1712824061.3466434,"caller":"logging/zap_logger.go:49","msg":"Operator stake update","stake":"1000","block number":1253026}
+```