Merge pull request #86 from blinklabs-io/chore/rename

chore: rename repo to blinklabs-io/tx-submit-api

Author: wolf31o2

.github/workflows/ci-docker.yml

@@ -7,7 +7,7 @@ on:
 
 env:
   REGISTRY: ghcr.io
-  IMAGE_NAME: cloudstruct/cardano-submit-api
+  IMAGE_NAME: blinklabs-io/tx-submit-api
 
 jobs:
   docker:

.github/workflows/publish-binaries.yml

@@ -7,7 +7,7 @@ on:
 concurrency: ${{ github.ref }}
 
 env:
-  BIN_NAME: cardano-submit-api
+  BIN_NAME: tx-submit-api
 
 jobs:
   release:

.github/workflows/publish-docker-images.yml

@@ -8,7 +8,7 @@ on:
 concurrency: ${{ github.ref }}
 
 env:
-  IMAGE_NAME: cloudstruct/cardano-submit-api
+  IMAGE_NAME: blinklabs/tx-submit-api
 
 jobs:
   build-and-push-image:
@@ -37,7 +37,7 @@ jobs:
         with:
           images: |
             ${{ env.IMAGE_NAME }}
-            ghcr.io/${{ env.IMAGE_NAME }}
+            ghcr.io/${{ github.repository }}
           tags: |
             # Only version, no revision
             type=match,pattern=v(.*)-(.*),group=1

.gitignore

@@ -15,4 +15,4 @@
 # vendor/
 
 # Binary
-/cardano-submit-api
+/tx-submit-api

Dockerfile

@@ -4,6 +4,6 @@ WORKDIR /code
 COPY . .
 RUN make build
 
-FROM cgr.dev/chainguard/glibc-dynamic AS cardano-submit-api
-COPY --from=build /code/cardano-submit-api /bin/
-ENTRYPOINT ["/bin/cardano-submit-api"]
+FROM cgr.dev/chainguard/glibc-dynamic AS tx-submit-api
+COPY --from=build /code/tx-submit-api /bin/
+ENTRYPOINT ["tx-submit-api"]

LICENSE

@@ -187,6 +187,7 @@
       identification within third-party archives.
 
    Copyright 2022 CloudStruct, LLC.
+   Copyright 2023 Blink Labs, Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

Makefile

@@ -1,4 +1,4 @@
-BINARY=cardano-submit-api
+BINARY=tx-submit-api
 
 # Determine root directory
 ROOT_DIR=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
@@ -23,6 +23,10 @@ build: $(BINARY)
 clean:
 	rm -f $(BINARY)
 
+swagger:
+	swag f -g api.go -d internal/api
+	swag i -g api.go -d internal/api
+
 # Build docker image
 image: build
 	docker build -t $(BINARY) .

README.md

@@ -1,4 +1,5 @@
-# go-cardano-submit-api
+# tx-submit-api
+
 Cardano Transaction Submission API
 
 A simple HTTP API which accepts a CBOR encoded Cardano transaction as a
@@ -10,13 +11,13 @@ The recommended method of using this application is via the published
 container images.
 
 ```
-docker run -p 8090 ghcr.io/cloudstruct/cardano-submit-api:0.11.0
+docker run -p 8090 ghcr.io/blinklabs-io/tx-submit-api:0.11.0
 ```
 
 Binaries can be executed directly.
 
 ```
-./cardano-submit-api
+./tx-submit-api
 ```
 
 ### Configuration
@@ -70,12 +71,12 @@ Cardano node configuration:
 
 You can connect to either a cardano-node running locally on the host or a
 container running either `inputoutput/cardano-node` or
-`cloudstruct/cardano-node` by mapping in the correct paths and setting the
+`blinklabs-io/cardano-node` by mapping in the correct paths and setting the
 environment variables or configuration options to match.
 
-#### Together with cloudstruct/cardano-node in Docker
+#### Together with blinklabs-io/cardano-node in Docker
 
-Use Docker to run both cardano-node and go-cardano-submit-api with Docker
+Use Docker to run both cardano-node and tx-submit-api with Docker
 volumes for blockchain storage and node-ipc.
 
 ```
@@ -85,14 +86,14 @@ docker run --detach \
   -v node-data:/opt/cardano/data \
   -v node-ipc:/opt/cardano/ipc \
   -p 3001:3001 \
-  ghcr.io/cloudstruct/cardano-node run
+  ghcr.io/blinklabs-io/cardano-node run
 
 # Start submit-api
 docker run --detach \
-  --name cardano-submit-api
+  --name tx-submit-api
   -v node-ipc:/node-ipc \
   -p 8090:8090 \
-  ghcr.io/cloudstruct/cardano-submit-api
+  ghcr.io/blinklabs-io/tx-submit-api
 ```
 
 #### Using a local cardano-node
@@ -103,10 +104,10 @@ a local cardano-node.
 ```
 # Start submit-api
 docker run --detach \
-  --name cardano-submit-api \
+  --name tx-submit-api \
   -v /opt/cardano/ipc:/node-ipc \
   -p 8090:8090 \
-  ghcr.io/cloudstruct/cardano-submit-api
+  ghcr.io/blinklabs-io/tx-submit-api
 ```
 
 ### Sending transactions

cmd/cardano-submit-api/main.go cmd/tx-submit-api/main.gocmd/cardano-submit-api/main.go renamed to cmd/tx-submit-api/main.go

@@ -3,9 +3,9 @@ package main
 import (
 	"flag"
 	"fmt"
-	"github.com/cloudstruct/go-cardano-submit-api/internal/api"
-	"github.com/cloudstruct/go-cardano-submit-api/internal/config"
-	"github.com/cloudstruct/go-cardano-submit-api/internal/logging"
+	"github.com/blinklabs-io/tx-submit-api/internal/api"
+	"github.com/blinklabs-io/tx-submit-api/internal/config"
+	"github.com/blinklabs-io/tx-submit-api/internal/logging"
 	"net/http"
 	_ "net/http/pprof"
 	"os"

config.yaml.example

@@ -1,5 +1,5 @@
 ---
-# Example config file for cardano-submit-api
+# Example config file for tx-submit-api
 # The values shown below correspond to the in-code defaults
 
 logging: