Skip to content

Commit

Permalink
rename status-api to system-api
Browse files Browse the repository at this point in the history
  • Loading branch information
metachris committed Oct 9, 2024
1 parent 09a642a commit 9636c2c
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ clean:
.PHONY: build-cli
build:
@mkdir -p ./build
go build -trimpath -ldflags "-X github.com/flashbots/builder-tools/common.Version=${VERSION}" -v -o ./build/status-api cmd/status-api/*.go
go build -trimpath -ldflags "-X github.com/flashbots/builder-tools/common.Version=${VERSION}" -v -o ./build/system-api cmd/system-api/*.go

# .PHONY: build-httpserver
# build-httpserver:
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ WIP Toolbox
- [Create TLS certificate + key (PEM format)](cmd/tls-gen/main.go)
- [Server using custom TLS certificate](cmd/https-server/main.go)
- [Client allowing only server using the custom TLS certificate](cmd/https-client/main.go)
- [Status API server, with ability for recording and querying events](cmd/status-api/)
- [Status API server, with ability for recording and querying events](cmd/system-api/)

---

Expand Down Expand Up @@ -37,13 +37,13 @@ $ curl --cacert cert.pem https://127.0.0.1:8080
$ go run cmd/https-client/main.go
```

### Status API server
### System API server

The status api server is used to record and query events. Events can be added through local named pipe (file `pipe.fifo`), or through HTTP API.
The system api server is used to record and query events. Events can be added through local named pipe (file `pipe.fifo`), or through HTTP API.

```bash
# Start the server
$ go run cmd/status-api/*
$ go run cmd/system-api/*

# Add events
$ echo "hello world" > pipe.fifo
Expand Down
2 changes: 1 addition & 1 deletion cmd/status-api/main.go → cmd/system-api/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ var flags []cli.Flag = []cli.Flag{

func main() {
app := &cli.App{
Name: "status-api",
Name: "system-api",
Usage: "HTTP API for status events",
Flags: flags,
Action: runCli,
Expand Down
File renamed without changes.

0 comments on commit 9636c2c

Please sign in to comment.