first commit

.github/workflows/check-generate.yml

@@ -0,0 +1,48 @@
+name: Check make generate
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  check-make-generate:
+    name: Check make generate
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.21'  # Specify the Go version you're using
+
+      - name: Install protoc-gen-go and protoc-gen-go-grpc
+        run: |
+          go install google.golang.org/protobuf/cmd/[email protected]
+          go install google.golang.org/grpc/cmd/[email protected]
+          go install github.com/grpc-ecosystem/grpc-gateway/v2/[email protected]
+          go install github.com/grpc-ecosystem/grpc-gateway/v2/[email protected]
+          echo "${HOME}/go/bin" >> $GITHUB_PATH
+
+      - uses: bufbuild/[email protected]
+        with:
+          version: 1.32.1
+
+      - name: Check buf installation
+        run: buf --version
+
+      - name: Run make generate
+        run: make generate
+
+      - name: Check if make generate generated changes that should be committed
+        run: |
+          if [ -n "$(git status --porcelain)" ]; then
+            echo "Error: make generate generated changes that should be committed. Please run 'make generate' and commit the changes."
+            git diff
+            git status
+            exit 1
+          fi

LICENSE

@@ -0,0 +1,105 @@
+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:             Eigen Labs, Inc.
+
+Licensed Work:        cerberus-api
+                      The Licensed Work is (c) 2024 Eigen Labs, Inc.
+
+Additional Use Grant:
+
+You may additionally use any of the software included in the following repositories here, https://docs.google.com/spreadsheets/d/1PlJRow5C0GMqXZlIxRm5CEnkhH-gMV1wIdq1pCfbZco/edit?gid=0#gid=0, ("Additional Use Grant Software") for production commercial uses, but only if such uses are (i) built on or using the EigenLayer Protocol or EigenDA, and (ii) not Competing Uses.
+
+"Competing Use" means any use of the Additional Use Grant Software in any product, protocol, application or service that is made available to third parties and that (i) substitutes for use of EigenLayer Protocol or EigenDA, (i) offers the same or substantially similar functionality as the EigenLayer Protocol or EigenDA or (ili) is built on or using a protocol with substantially similar functionality as the EigenLayer Protocol.
+
+EigenLayer Protocol means the restaking protocol as further described in the documentation here, https://docs.eigenlayer.xyz, as updated from time to time.
+EigenDA means the data availability protocol built on top of the EigenLayer Protocol as further described in the documentation here, https://docs.eigenlayer.xyz, as updated from time to time.
+
+
+Change Date:         2026-10-15
+
+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.

Makefile

@@ -0,0 +1,5 @@
+.PHONY: generate
+generate:
+	@echo "Generating..."
+	cd proto && buf generate
+	@echo "Done"

README.md

@@ -0,0 +1,63 @@
+## cerberus-api
+This is the API spec of remote signer. 
+The spec currently only support BLS on bn254 signing. 
+
+## Supported Bindings
+### Go
+The go bindings resides in [pkg/api/vi](pkg/api/v1) directory.
+
+## Signing Quirks
+If you are implementing a version of this, please make sure to check [this code](https://github.com/Layr-Labs/remote-bls/blob/55a19a0386edcee1b5c2ecae116ae468a6b2b47b/internal/crypto/utils.go#L30-L36) 
+for implementation of sign and verify. If you use any other implementation, the signatures will not be compatible with EigenLayer contracts.
+Eventually we will support more `HashToCurve` algorithms.
+
+## Implementation
+* Go - https://github.com/Layr-Labs/cerberus (Coming Soon)
+
+## Usage
+### Signing Client
+```go
+package main
+
+import (
+    "context"
+    "fmt"
+    "log"
+    "time"
+
+    "github.com/Layr-Labs/cerberus-api/pkg/api/v1"
+
+    "google.golang.org/grpc"
+	"google.golang.org/grpc/credentials/insecure"
+)
+
+func main() {
+	conn, err := grpc.NewClient(
+		"localhost:50051", 
+		grpc.WithTransportCredentials(insecure.NewCredentials()),
+	)
+    if err != nil {
+        log.Fatalf("did not connect: %v", err)
+    }
+    defer conn.Close()
+
+    c := v1.NewSignerClient(conn)
+
+    ctx, cancel := context.WithTimeout(context.Background(), time.Second)
+    defer cancel()
+
+    req := &v1.SignGenericRequest{
+		PublicKey: "0xabcd",
+		Password:  "p@$$w0rd",
+		Data:      []byte{0x01, 0x02, 0x03},
+    }
+    resp, err := c.SignGeneric(ctx, req)
+    if err != nil {
+        log.Fatalf("could not sign: %v", err)
+    }
+    fmt.Printf("Signature: %v\n", resp.Signature)
+}
+```
+
+## Security Bugs
+Please report security vulnerabilities to [email protected]. Do NOT report security bugs via Github Issues.

go.mod

@@ -0,0 +1,19 @@
+module github.com/Layr-Labs/cerberus-api
+
+go 1.21
+
+toolchain go1.21.11
+
+require (
+	github.com/grpc-ecosystem/grpc-gateway/v2 v2.22.0
+	google.golang.org/grpc v1.64.1
+	google.golang.org/protobuf v1.34.2
+)
+
+require (
+	golang.org/x/net v0.26.0 // indirect
+	golang.org/x/sys v0.21.0 // indirect
+	golang.org/x/text v0.17.0 // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20240814211410-ddb44dafa142 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20240814211410-ddb44dafa142 // indirect
+)

go.sum

@@ -0,0 +1,18 @@
+github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/grpc-ecosystem/grpc-gateway/v2 v2.22.0 h1:asbCHRVmodnJTuQ3qamDwqVOIjwqUPTYmYuemVOx+Ys=
+github.com/grpc-ecosystem/grpc-gateway/v2 v2.22.0/go.mod h1:ggCgvZ2r7uOoQjOyu2Y1NhHmEPPzzuhWgcza5M1Ji1I=
+golang.org/x/net v0.26.0 h1:soB7SVo0PWrY4vPW/+ay0jKDNScG2X9wFeYlXIvJsOQ=
+golang.org/x/net v0.26.0/go.mod h1:5YKkiSynbBIh3p6iOc/vibscux0x38BZDkn8sCUPxHE=
+golang.org/x/sys v0.21.0 h1:rF+pYz3DAGSQAxAu1CbC7catZg4ebC4UIeIhKxBZvws=
+golang.org/x/sys v0.21.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/text v0.17.0 h1:XtiM5bkSOt+ewxlOE/aE/AKEHibwj/6gvWMl9Rsh0Qc=
+golang.org/x/text v0.17.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
+google.golang.org/genproto/googleapis/api v0.0.0-20240814211410-ddb44dafa142 h1:wKguEg1hsxI2/L3hUYrpo1RVi48K+uTyzKqprwLXsb8=
+google.golang.org/genproto/googleapis/api v0.0.0-20240814211410-ddb44dafa142/go.mod h1:d6be+8HhtEtucleCbxpPW9PA9XwISACu8nvpPqF0BVo=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20240814211410-ddb44dafa142 h1:e7S5W7MGGLaSu8j3YjdezkZ+m1/Nm0uRVRMEMGk26Xs=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20240814211410-ddb44dafa142/go.mod h1:UqMtugtsSgubUsoxbuAoiCXvqvErP7Gf0so0mK9tHxU=
+google.golang.org/grpc v1.64.1 h1:LKtvyfbX3UGVPFcGqJ9ItpVWW6oN/2XqTxfAnwRRXiA=
+google.golang.org/grpc v1.64.1/go.mod h1:hiQF4LFZelK2WKaP6W0L92zGHtiQdZxk8CrSdvyjeP0=
+google.golang.org/protobuf v1.34.2 h1:6xV6lTsCfpGD21XK49h7MhtcApnLqkfYgPcdHftf6hg=
+google.golang.org/protobuf v1.34.2/go.mod h1:qYOHts0dSfpeUzUFpOMr/WGzszTmLH+DiWniOlNbLDw=