Skip to content

Commit 68929c7

Browse files
authored
feat: rename (#198)
Signed-off-by: Chris Gianelloni <[email protected]>
1 parent df6f9cb commit 68929c7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+135
-136
lines changed

.dockerignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
.git/
22
.github/
3-
assets/
43
Dockerfile
5-
snek
4+
adder
65
README.md

.github/workflows/ci-docker.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ on:
66
paths: ['Dockerfile','cmd/**','docs/**','internal/**','go.*','.github/workflows/ci-docker.yml']
77

88
env:
9-
GHCR_IMAGE_NAME: ghcr.io/blinklabs-io/snek
9+
GHCR_IMAGE_NAME: ghcr.io/blinklabs-io/adder
1010

1111
jobs:
1212
docker:

.github/workflows/publish.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,16 @@ jobs:
5656
- name: Upload release asset
5757
if: startsWith(github.ref, 'refs/tags/')
5858
run: |
59-
_filename=snek-${{ env.RELEASE_TAG }}-${{ matrix.os }}-${{ matrix.arch }}
59+
_filename=adder-${{ env.RELEASE_TAG }}-${{ matrix.os }}-${{ matrix.arch }}
6060
if [[ ${{ matrix.os }} == windows ]]; then
6161
_filename=${_filename}.exe
6262
fi
63-
mv snek ${_filename}
63+
mv adder ${_filename}
6464
curl \
6565
-H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
6666
-H "Content-Type: application/octet-stream" \
6767
--data-binary @${_filename} \
68-
https://uploads.github.com/repos/${{ github.repository_owner }}/snek/releases/${{ needs.create-draft-release.outputs.RELEASE_ID }}/assets?name=${_filename}
68+
https://uploads.github.com/repos/${{ github.repository_owner }}/adder/releases/${{ needs.create-draft-release.outputs.RELEASE_ID }}/assets?name=${_filename}
6969
7070
build-images:
7171
runs-on: ubuntu-latest
@@ -92,7 +92,7 @@ jobs:
9292
uses: docker/metadata-action@v5
9393
with:
9494
images: |
95-
blinklabs/snek
95+
blinklabs/adder
9696
ghcr.io/${{ github.repository }}
9797
tags: |
9898
# Only version, no revision
@@ -114,9 +114,9 @@ jobs:
114114
with:
115115
username: blinklabs
116116
password: ${{ secrets.DOCKER_PASSWORD }}
117-
repository: blinklabs/snek
117+
repository: blinklabs/adder
118118
readme-filepath: ./README.md
119-
short-description: "Snek is a tool for tailing the Cardano blockchain and emitting events"
119+
short-description: "Adder is a tool for tailing the Cardano blockchain and emitting events"
120120

121121
finalize-release:
122122
runs-on: ubuntu-latest

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Binaries for programs and plugins
2-
/snek
2+
/adder
33

44
# Test binary, built with `go test -c`
55
*.test

Dockerfile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ WORKDIR /code
44
COPY . .
55
RUN make build
66

7-
FROM cgr.dev/chainguard/glibc-dynamic AS snek
8-
COPY --from=build /code/snek /bin/
9-
ENTRYPOINT ["snek"]
7+
FROM cgr.dev/chainguard/glibc-dynamic AS adder
8+
COPY --from=build /code/adder /bin/
9+
ENTRYPOINT ["adder"]

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# snek
1+
# Adder
22

33
<div align="center">
4-
<img src="./assets/snek-logo-with-text-horizontal.png" alt="snek Logo" width="640">
4+
<img src="./assets/adder-logo-with-text-horizontal.png" alt="Adder Logo" width="640">
55
</div>
66

7-
snek is a tool for tailing the Cardano blockchain and emitting events for each
7+
Adder is a tool for tailing the Cardano blockchain and emitting events for each
88
block and transaction that it sees.
99

1010
## How it works
@@ -101,14 +101,14 @@ using Uber's `Zap` logging library.
101101

102102
## Configuration
103103

104-
snek supports multiple configuration methods for versatility: commandline arguments, YAML config file,
104+
Adder supports multiple configuration methods for versatility: commandline arguments, YAML config file,
105105
and environment variables (in that order).
106106

107107
You can get a list of all available commandline arguments by using the `-h`/`-help` flag.
108108

109109
```bash
110-
$ ./snek -h
111-
Usage of snek:
110+
$ ./adder -h
111+
Usage of adder:
112112
-config string
113113
path to config file to load
114114
-input string
@@ -149,15 +149,15 @@ plugins:
149149
150150
## Filtering
151151
152-
snek supports filtering events before they are output using multiple criteria. An event must match all configured filters to be emitted.
152+
Adder supports filtering events before they are output using multiple criteria. An event must match all configured filters to be emitted.
153153
Each filter supports specifying multiple possible values separated by commas. When specifying multiple values for a filter, only one of
154154
the values specified must match an event.
155155
156156
You can get a list of all available filter options by using the `-h`/`-help` flag.
157157

158158
```bash
159-
$ ./snek -h
160-
Usage of snek:
159+
$ ./adder -h
160+
Usage of adder:
161161
...
162162
-filter-address string
163163
specifies address to filter on
@@ -178,13 +178,13 @@ Multiple filter options can be used together, and only events matching all filte
178178

179179
```bash
180180
export INPUT_CHAINSYNC_NETWORK=preview
181-
./snek
181+
./adder
182182
```
183183

184184
Alternatively using equivalent commandline options:
185185

186186
```bash
187-
./snek \
187+
./adder \
188188
-input-chainsync-network preview
189189
```
190190

@@ -197,7 +197,7 @@ in Docker.
197197
```bash
198198
docker run --rm -ti \
199199
-v node-ipc:/node-ipc \
200-
ghcr.io/blinklabs-io/snek:main
200+
ghcr.io/blinklabs-io/adder:main
201201
```
202202

203203
### Filtering
@@ -207,59 +207,59 @@ docker run --rm -ti \
207207
Only output `chainsync.transaction` event types
208208

209209
```bash
210-
$ snek -filter-type chainsync.transaction
210+
$ adder -filter-type chainsync.transaction
211211
```
212212

213213
Only output `chainsync.rollback` and `chainsync.block` event types
214214

215215
```bash
216-
$ snek -filter-type chainsync.transaction,chainsync.block
216+
$ adder -filter-type chainsync.transaction,chainsync.block
217217
```
218218

219219
#### Filtering on asset policy
220220

221221
Only output transactions involving an asset with a particular policy ID
222222

223223
```bash
224-
$ snek -filter-type chainsync.transaction -filter-policy 13aa2accf2e1561723aa26871e071fdf32c867cff7e7d50ad470d62f
224+
$ adder -filter-type chainsync.transaction -filter-policy 13aa2accf2e1561723aa26871e071fdf32c867cff7e7d50ad470d62f
225225
```
226226

227227
#### Filtering on asset fingerprint
228228

229229
Only output transactions involving a particular asset
230230

231231
```bash
232-
$ snek -filter-type chainsync.transaction -filter-asset asset108xu02ckwrfc8qs9d97mgyh4kn8gdu9w8f5sxk
232+
$ adder -filter-type chainsync.transaction -filter-asset asset108xu02ckwrfc8qs9d97mgyh4kn8gdu9w8f5sxk
233233
```
234234

235235
#### Filtering on a policy ID and asset fingerprint
236236

237237
Only output transactions involving both a particular policy ID and a particular asset (which do not need to be related)
238238

239239
```bash
240-
$ snek -filter-type chainsync.transaction -filter-asset asset108xu02ckwrfc8qs9d97mgyh4kn8gdu9w8f5sxk -filter-policy 13aa2accf2e1561723aa26871e071fdf32c867cff7e7d50ad470d62f
240+
$ adder -filter-type chainsync.transaction -filter-asset asset108xu02ckwrfc8qs9d97mgyh4kn8gdu9w8f5sxk -filter-policy 13aa2accf2e1561723aa26871e071fdf32c867cff7e7d50ad470d62f
241241
```
242242

243243
#### Filtering on an address
244244

245245
Only output transactions with outputs matching a particular address
246246

247247
```bash
248-
$ snek -filter-type chainsync.transaction -filter-address addr1qyht4ja0zcn45qvyx477qlyp6j5ftu5ng0prt9608dxp6l2j2c79gy9l76sdg0xwhd7r0c0kna0tycz4y5s6mlenh8pq4jxtdy
248+
$ adder -filter-type chainsync.transaction -filter-address addr1qyht4ja0zcn45qvyx477qlyp6j5ftu5ng0prt9608dxp6l2j2c79gy9l76sdg0xwhd7r0c0kna0tycz4y5s6mlenh8pq4jxtdy
249249
```
250250

251251
#### Filtering on a stake address
252252

253253
Only output transactions with outputs matching a particular stake address
254254

255255
```bash
256-
$ snek -filter-type chainsync.transaction -filter-address stake1u9f9v0z5zzlldgx58n8tklphu8mf7h4jvp2j2gddluemnssjfnkzz
256+
$ adder -filter-type chainsync.transaction -filter-address stake1u9f9v0z5zzlldgx58n8tklphu8mf7h4jvp2j2gddluemnssjfnkzz
257257
```
258258

259259
### Push notifications
260260

261-
The example shows how push notification output can be used with filtering options. In this example, push notifications will be sent to the block events. Push notifications will be sent to the specified project_id in the serviceAccount.json file. Please refer to https://github.com/blinklabs-io/snek-mobile for more details on how to send push notifications to snek-mobile.
261+
The example shows how push notification output can be used with filtering options. In this example, push notifications will be sent to the block events. Push notifications will be sent to the specified project_id in the serviceAccount.json file. Please refer to https://github.com/blinklabs-io/adder-mobile for more details on how to send push notifications to adder-mobile.
262262

263263
```bash
264-
$ snek -filter-type chainsync.block -output push -output-push-serviceAccountFilePath /path/to/serviceAccount.json
264+
$ adder -filter-type chainsync.block -output push -output-push-serviceAccountFilePath /path/to/serviceAccount.json
265265
```

api/api.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import (
77
"sync"
88
"time"
99

10-
_ "github.com/blinklabs-io/snek/docs"
10+
_ "github.com/blinklabs-io/adder/docs"
1111
"github.com/gin-gonic/gin"
1212
swaggerFiles "github.com/swaggo/files" // swagger embed files
1313
ginSwagger "github.com/swaggo/gin-swagger" // gin-swagger middleware
@@ -75,9 +75,9 @@ func (a *APIv1) Engine() *gin.Engine {
7575
return a.engine
7676
}
7777

78-
// @title Snek API
78+
// @title Adder API
7979
// @version v1
80-
// @description Snek API
80+
// @description Adder API
8181
// @Schemes http
8282
// @BasePath /v1
8383

api/api_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ import (
55
"net/http/httptest"
66
"testing"
77

8-
"github.com/blinklabs-io/snek/api"
9-
"github.com/blinklabs-io/snek/output/push"
8+
"github.com/blinklabs-io/adder/api"
9+
"github.com/blinklabs-io/adder/output/push"
1010
"github.com/stretchr/testify/assert"
1111
)
1212

assets/adder-icon.png

4.35 KB
Loading

assets/adder-illustration.png

29.6 KB
Loading

0 commit comments

Comments
 (0)