Merge branch 'main' into dev

mycel-labs · Nov 5, 2024 · a2aee7c · a2aee7c
2 parents bd86eaa + 06bcee4
commit a2aee7c
Show file tree

Hide file tree

Showing 7 changed files with 2,262 additions and 12 deletions.
diff --git a/Makefile b/Makefile
@@ -40,6 +40,9 @@ run-go:
 build-go:
 	go build ./src/go
 
+vet-go:
+	go vet ./src/go
+
 test-go:
 	go test ./src/go/... ./test/... -count=1 
 
@@ -56,7 +59,6 @@ check-fmt-go:
 .PHONY: run-proto
 run-proto:
 	@docker build -t $(PROTOBUF_DOCKER_IMAGE) -f $(PROTOBUF_DOCKERFILE) .
-	@rm -f docs/api.md
 	@docker run --rm -v $(PWD):/workspace \
 		$(PROTOBUF_DOCKER_IMAGE) \
 		generate
@@ -74,8 +76,11 @@ check-fmt-proto:
 	buf format -d src/proto
 
 # General
-.PHONY: build test lint fmt check-fmt
-build: build-solidity build-go compile-proto
+.PHONY: install build test lint fmt check-fmt
+install:
+	forge install
+
+build: build-solidity vet-go compile-proto
 
 test: test-solidity test-go
 

diff --git a/README.md b/README.md
@@ -10,6 +10,7 @@ This project implements a transferable account system using smart contracts.
 ### Prerequisites
 
 - [Foundry](https://book.getfoundry.sh/getting-started/installation)
+- Docker 
 
 ### Installation
 
@@ -21,12 +22,12 @@ This project implements a transferable account system using smart contracts.
 
 2. Install dependencies:
    ```
-   forge install
+   make install
    ```
 
 3. Compile the contracts:
    ```
-   forge build
+   make build
    ```
 
 ## Getting Started
@@ -84,7 +85,7 @@ If you do not have these tokens, you can obtain them from the [Toliman Testnet F
    }
    ```
 
-5. **Create Account Request to API Server**
+6. **Create Account Request to API Server**
 
    Execute the request to create a TA. Use the output from step 4 in the `proof` section:
 
@@ -129,7 +130,6 @@ If you do not have these tokens, you can obtain them from the [Toliman Testnet F
 
    This operation will be conducted on the Sepolia Testnet, not on the Suave Toliman Testnet, so please be careful.
 
-
 7. **Approve Address Request to API Server**
 
    Approve the transfer of TA ownership from the current account to another account.

diff --git a/buf.gen.yaml b/buf.gen.yaml
@@ -9,6 +9,7 @@ plugins:
   - name: grpc-gateway
     out: src/go/pb
     opt: paths=source_relative
-  - name: doc
+  - plugin: buf.build/community/pseudomuto-doc:v1.5.1
+    out: docs
+  - plugin: buf.build/community/google-gnostic-openapi:v0.7.0
     out: docs
-    opt: markdown,api.md