Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename project to Oasis Rosetta Gateway #281

Merged
merged 3 commits into from
Feb 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changelog/281.breaking.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Rename project to Oasis Rosetta Gateway

Previous name was quite long and we were already shortening it in some places.
Take the opportunity of doing a breaking 2.0.0 release to shorten the name to
Oasis Rosetta Gateway.
4 changes: 2 additions & 2 deletions .github/workflows/docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,14 @@ jobs:
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1

- name: "Rebuild oasisprotocol/oasis-core-rosetta-gateway:${{ steps.branch_tag.outputs.tag }}"
- name: "Rebuild oasisprotocol/oasis-rosetta-gateway:${{ steps.branch_tag.outputs.tag }}"
uses: docker/[email protected]
with:
context: docker
file: docker/Dockerfile
build-args: |
GATEWAY_BRANCH=${{ steps.branch_tag.outputs.branch }}
tags: oasisprotocol/oasis-core-rosetta-gateway:${{ steps.branch_tag.outputs.tag }}
tags: oasisprotocol/oasis-rosetta-gateway:${{ steps.branch_tag.outputs.tag }}
pull: true
labels: |
org.opencontainers.image.source=${{ github.event.repository.html_url }}
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
# A push occurs to one of the matched tags.
push:
tags:
# Pattern that roughly matches Oasis Core Rosetta Gateway's version tags.
# Pattern that roughly matches Oasis Rosetta Gateway's version tags.
# For more details on GitHub Actions' pattern match syntax, see:
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#patterns-to-match-branches-and-tags.
- 'v[0-9]+.[0-9]+*'
Expand Down Expand Up @@ -59,7 +59,7 @@ jobs:
make release-build
env:
# Instruct Make to create a real release.
OASIS_CORE_ROSETTA_GATEWAY_REAL_RELEASE: "true"
OASIS_ROSETTA_GATEWAY_REAL_RELEASE: "true"
# Pass automatically created GitHub App installation token to the action.
# For more info, see:
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token.
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*.a
*.o
*.so
oasis-core-rosetta-gateway
oasis-rosetta-gateway
tests/oasis-net-runner
tests/oasis-node
tests/oasis_core_release.tar.gz
Expand Down
9 changes: 5 additions & 4 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,23 @@
# NOTE: The GoReleaser is not meant to be run directly, but rather through
# Make's release-build target.

project_name: Oasis Core Rosetta Gateway
project_name: Oasis Rosetta Gateway

env:
# Require use of Go modules.
- GO111MODULE=on

builds:
- id: oasis-core-rosetta-gateway
binary: oasis-core-rosetta-gateway
- id: oasis-rosetta-gateway
binary: oasis-rosetta-gateway
flags:
- -trimpath
ldflags:
# NOTE: At the moment, GoReleaser produces different binaries when
# releases are built from different git paths, unless -buildid= is added
# to ldflags.
# For more details, see: https://github.com/oasislabs/goreleaser/issues/1.
# For more details, see:
# https://github.com/oasisprotocol/oasis-core/issues/4124.
- -buildid=
- "{{.Env.GOLDFLAGS_VERSION}}"
goos:
Expand Down
94 changes: 47 additions & 47 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ The format is inspired by [Keep a Changelog].
### Features

- Bump Oasis Core to 21.3.5
([#241](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/241))
([#241](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/241))

### Internal Changes

- go: bump github.com/ethereum/go-ethereum to 1.10.9
([#241](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/241))
([#241](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/241))

It fixes a DoS issue via a maliciously crafted p2p message.
For more details, see [GHSA-59hh-656j-3p7v].
Expand All @@ -53,47 +53,47 @@ The format is inspired by [Keep a Changelog].
### Features

- Bump Oasis Core to 21.2.8
([#217](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/217),
[#232](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/232))
([#217](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/217),
[#232](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/232))

### Bug Fixes

- Fix possible `nil` pointer dereference in `GetStatus`
([#196](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/196))
([#196](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/196))

### Documentation Improvements

- Note that `RELEASE_BRANCH` variable needs to be exported in [Release Process]
([#198](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/198),
[#200](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/200))
([#198](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/198),
[#200](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/200))

[Release Process]: docs/release-process.md

### Internal Changes

- changelog: Automatically add important versions table
([#198](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/198))
([#198](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/198))

- go: bump github.com/vmihailenco/msgpack/v5 from 5.0.0-beta.1 to 5.3.4
([#210](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/210))
([#210](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/210))

- docker: Improve build steps and ignore everything in .dockerignore
([#222](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/222))
([#222](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/222))

- github: Add [docker workflow] for testing building Docker images
([#222](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/222))
([#222](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/222))

[docker workflow]:
https://github.com/oasisprotocol/oasis-core/actions?query=workflow:docker
https://github.com/oasisprotocol/oasis-rosetta-gateway/actions?query=workflow:docker

- ci: bump docker/build-push-action from 2.5.0 to 2.6.1
([#223](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/223))
([#223](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/223))

- ci: bump actions/setup-node from 2.1.5 to 2.4.0
([#229](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/229))
([#229](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/229))

- go: bump google.golang.org/grpc from 1.38.0 to 1.39.1
([#230](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/230))
([#230](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/230))

## 1.1.0 (2021-04-22)

Expand All @@ -105,39 +105,39 @@ The format is inspired by [Keep a Changelog].
### Features

- Add epoch number to block metadata
([#188](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/188))
([#188](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/188))

### Documentation Improvements

- Add Oasis Core version to important versions listed in the Change Log
([#191](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/191))
([#191](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/191))

### Internal Changes

- ci: bump actions/setup-node from v2.1.2 to v2.1.3
([#139](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/139))
([#139](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/139))

- ci: bump actions/setup-node from v2.1.3 to v2.1.5
([#166](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/166))
([#166](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/166))

- oasis: Use GetChainContext method instead of fetching genesis document
([#180](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/180))
([#180](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/180))

- ci: bump golangci/golangci-lint-action from v2.3.0 to v2.5.2
([#183](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/183))
([#183](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/183))

- go: bump google.golang.org/grpc from 1.36.0 to 1.37.0
([#185](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/185))
([#185](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/185))

- ci: bump actions/setup-python from v2.1.4 to v2.2.2
([#186](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/186))
([#186](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/186))

- Bump Oasis Core version to 21.1
([#175](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/175),
[#187](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/187))
([#175](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/175),
[#187](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/187))

- ci: Bump golangci-lint version in *ci-lint* GitHub Actions workflow to 1.39
([#190](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/190))
([#190](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/190))

## 1.0.0 (2020-12-14)

Expand All @@ -148,15 +148,15 @@ The format is inspired by [Keep a Changelog].
### Process

- Define project's release process
([#55](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/55))
([#55](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/55))

For more details, see [Release Process]

[Release Process]: docs/release-process.md

- Add Change Log and the Change Log fragments process for assembling it
([#120](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/120),
[#140](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/140))
([#120](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/120),
[#140](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/140))

This follows the same Change Log fragments process as is used by [Oasis Core].

Expand All @@ -166,7 +166,7 @@ The format is inspired by [Keep a Changelog].
[Change Log fragments]: .changelog/README.md

- Define project's versioning
([#122](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/122))
([#122](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/122))

Adopt a [Semantic Versioning 2.0.0].

Expand All @@ -178,60 +178,60 @@ The format is inspired by [Keep a Changelog].
### Features

- common: Add package implementing common things for Oasis Core Rosetta Gateway
([#128](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/128))
([#128](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/128))

Initially, it stores the versions of the Rosetta API, Go toolchain and the
Oasis Core Rosetta Gateway itself.

- cli: Add `-version` flag to `oasis-core-rosetta-gateway` binary
([#128](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/128),
[#134](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/134))
([#128](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/128),
[#134](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/134))

- common: Add `GetOasisCoreVersion()` helper for obtaining Oasis Core's version
([#134](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/134))
([#134](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/134))

### Internal Changes

- ci: bump golangci/golangci-lint-action from v2.2.0 to v2.3.0
([#90](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/90))
([#90](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/90))

- Add linting for Change Log fragments
([#120](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/120))
([#120](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/120))

Add `lint-changelog` Make target and *Lint Change Log fragments* step to the
*ci-lint* GitHub Actions workflow.

- Use [Punch] tool for tracking and bumping project's version
([#122](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/122))
([#122](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/122))

[Punch]: https://github.com/lgiordani/punch

- Make: Add `changelog` target for assembling the Change Log
([#122](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/122))
([#122](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/122))

- Make: Add `fetch-git` target for fetching changes from the canonical git repo
([#122](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/122))
([#122](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/122))

- go: bump google.golang.org/grpc from 1.32.0 to 1.34.0
([#126](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/126))
([#126](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/126))

- cli: Extract port setting steps to `getPortOrExit()` function
([#128](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/128))
([#128](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/128))

- Make: Add reproducibility and version info flags to Go builds
([#128](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/128))
([#128](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/128))

- go: Bump Oasis Core dependency to 20.12.3
([#131](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/131))
([#131](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/131))

- github: Add [*release* GitHub Actions workflow]
([#138](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/138))
([#138](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/138))

[*release* GitHub Actions workflow]:
https://github.com/oasisprotocol/oasis-core-rosetta-gateway/actions?query=workflow:release
https://github.com/oasisprotocol/oasis-rosetta-gateway/actions?query=workflow:release

- Make: Add `release-tag`, `release-stable-branch` and `release-build` targets
([#138](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/138))
([#138](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/138))

They can be used for:

Expand All @@ -241,6 +241,6 @@ The format is inspired by [Keep a Changelog].
- `release-build`: building and publishing a release.

- Use [GoReleaser] tool for building and publishing releases
([#138](https://github.com/oasisprotocol/oasis-core-rosetta-gateway/issues/138))
([#138](https://github.com/oasisprotocol/oasis-rosetta-gateway/issues/138))

[GoReleaser]: https://goreleaser.com/
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ test: build build-tests tests/oasis-net-runner tests/oasis-node tests/rosetta-cl
fmt:
@$(ECHO) "$(CYAN)*** Running Go formatters...$(OFF)"
@gofumpt -s -w .
@gofumports -w -local github.com/oasisprotocol/oasis-core-rosetta-gateway .
@gofumports -w -local github.com/oasisprotocol/oasis-rosetta-gateway .

# Lint code, commits and documentation.
lint-targets := lint-go lint-docs lint-changelog lint-git lint-go-mod-tidy
Expand Down Expand Up @@ -159,7 +159,7 @@ release-stable-branch: fetch-git
# Build and publish the next release.
release-build:
@$(ENSURE_VALID_RELEASE_BRANCH_NAME)
ifeq ($(OASIS_CORE_ROSETTA_GATEWAY_REAL_RELEASE), true)
ifeq ($(OASIS_ROSETTA_GATEWAY_REAL_RELEASE), true)
@$(ENSURE_GIT_VERSION_EQUALS_PUNCH_VERSION)
endif
@$(ECHO) "$(CYAN)*** Creating release for version $(PUNCH_VERSION)...$(OFF)"
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Oasis Core Rosetta Gateway
# Oasis Rosetta Gateway

[![CI test status][github-ci-tests-badge]][github-ci-tests-link]
[![CI lint status][github-ci-lint-badge]][github-ci-lint-link]
[![Docker status][github-docker-badge]][github-docker-link]
[![Release status][github-release-badge]][github-release-link]

<!-- markdownlint-disable line-length -->
[github-ci-tests-badge]: https://github.com/oasisprotocol/oasis-core-rosetta-gateway/workflows/ci-tests/badge.svg
[github-ci-tests-link]: https://github.com/oasisprotocol/oasis-core-rosetta-gateway/actions?query=workflow:ci-tests+branch:master
[github-ci-lint-badge]: https://github.com/oasisprotocol/oasis-core-rosetta-gateway/workflows/ci-lint/badge.svg
[github-ci-lint-link]: https://github.com/oasisprotocol/oasis-core-rosetta-gateway/actions?query=workflow:ci-lint+branch:master
[github-docker-badge]: https://github.com/oasisprotocol/oasis-core-rosetta-gateway/workflows/docker/badge.svg
[github-docker-link]: https://github.com/oasisprotocol/oasis-core-rosetta-gateway/actions?query=workflow:docker
[github-release-badge]: https://github.com/oasisprotocol/oasis-core-rosetta-gateway/workflows/release/badge.svg
[github-release-link]: https://github.com/oasisprotocol/oasis-core-rosetta-gateway/actions?query=workflow:release
[github-ci-tests-badge]: https://github.com/oasisprotocol/oasis-rosetta-gateway/workflows/ci-tests/badge.svg
[github-ci-tests-link]: https://github.com/oasisprotocol/oasis-rosetta-gateway/actions?query=workflow:ci-tests+branch:master
[github-ci-lint-badge]: https://github.com/oasisprotocol/oasis-rosetta-gateway/workflows/ci-lint/badge.svg
[github-ci-lint-link]: https://github.com/oasisprotocol/oasis-rosetta-gateway/actions?query=workflow:ci-lint+branch:master
[github-docker-badge]: https://github.com/oasisprotocol/oasis-rosetta-gateway/workflows/docker/badge.svg
[github-docker-link]: https://github.com/oasisprotocol/oasis-rosetta-gateway/actions?query=workflow:docker
[github-release-badge]: https://github.com/oasisprotocol/oasis-rosetta-gateway/workflows/release/badge.svg
[github-release-link]: https://github.com/oasisprotocol/oasis-rosetta-gateway/actions?query=workflow:release
<!-- markdownlint-enable line-length -->

This repository implements the [Rosetta] server for the [Oasis Network].
Expand Down Expand Up @@ -80,7 +80,7 @@ address (e.g. `unix:/path/to/node/internal.sock`).
Optionally, set the `OASIS_ROSETTA_GATEWAY_PORT` environment variable to the
port that you want the gateway to listen on (default is 8080).

Start the gateway simply by running the executable `oasis-core-rosetta-gateway`.
Start the gateway simply by running the executable `oasis-rosetta-gateway`.

<!-- markdownlint-disable line-length -->
[Run a Non-validator Node]:
Expand Down
Loading