Skip to content

Commit

Permalink
refactor: clean cosmos/btcutil to strict minimum (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
julienrbrt authored Dec 6, 2022
1 parent a68c44d commit 3986eec
Show file tree
Hide file tree
Showing 89 changed files with 46 additions and 16,079 deletions.
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# CODEOWNERS: <https://help.github.com/articles/about-codeowners/>

* @tac0turtle @Julienrbrt
19 changes: 3 additions & 16 deletions .github/workflows/go.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,15 @@ jobs:
build:
name: Go CI
runs-on: ubuntu-latest
strategy:
matrix:
go: [1.14, 1.15]
steps:
- name: Set up Go
uses: actions/setup-go@v2
with:
go-version: ${{ matrix.go }}
go-version: 1.19
- name: Check out source
uses: actions/checkout@v2
- name: Install Linters
run: "curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b $(go env GOPATH)/bin v1.31.0"
uses: actions/checkout@v3
- name: Build
env:
GO111MODULE: "on"
run: go build ./...
- name: Test
env:
GO111MODULE: "on"
run: |
sh ./goclean.sh
- name: Send btcutil coverage
uses: shogo82148/actions-goveralls@v1
with:
path-to-profile: profile.cov
go test -v ./...
56 changes: 28 additions & 28 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# Temp files
*~

# Log files
*.log

# Compiled Object files, Static and Dynamic libs (Shared Objects)
*.o
*.a
*.so

# Folders
_obj
_test

# Architecture specific extensions/prefixes
*.[568vq]
[568vq].out

*.cgo1.go
*.cgo2.c
_cgo_defun.c
_cgo_gotypes.go
_cgo_export.*

_testmain.go

*.exe
# Temp files
*~

# Log files
*.log

# Compiled Object files, Static and Dynamic libs (Shared Objects)
*.o
*.a
*.so

# Folders
_obj
_test

# Architecture specific extensions/prefixes
*.[568vq]
[568vq].out

*.cgo1.go
*.cgo2.c
_cgo_defun.c
_cgo_gotypes.go
_cgo_export.*

_testmain.go

*.exe
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Changelog

## [Unreleased]

* Clean-up the repository and its dependencies.
1 change: 1 addition & 0 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ ISC License

Copyright (c) 2013-2017 The btcsuite developers
Copyright (c) 2016-2017 The Lightning Network Developers
Copyright (c) 2022 The Cosmos SDK Developers

Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
Expand Down
51 changes: 4 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,6 @@
btcutil
=======
# cosmos/btcutil

[![Build Status](https://github.com/cosmos/btcutil/workflows/Build%20and%20Test/badge.svg)](https://github.com/cosmos/btcutil/actions)
[![ISC License](https://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://godoc.org/github.com/cosmos/btcutil)
This repo is a fork of [btcsuite/btcutil](https://github.com/btcsuite/btcutil), limited to the package required by the Cosmos SDK.

Package btcutil provides bitcoin-specific convenience functions and types.
A comprehensive suite of tests is provided to ensure proper functionality. See
`test_coverage.txt` for the gocov coverage report. Alternatively, if you are
running a POSIX OS, you can run the `cov_report.sh` script for a real-time
report.

This package was developed for btcd, an alternative full-node implementation of
bitcoin which is under active development by Conformal. Although it was
primarily written for btcd, this package has intentionally been designed so it
can be used as a standalone package for any projects needing the functionality
provided.

## Installation and Updating

```bash
$ go get -u github.com/cosmos/btcutil
```

## GPG Verification Key

All official release tags are signed by Conformal so users can ensure the code
has not been tampered with and is coming from the btcsuite developers. To
verify the signature perform the following:

- Download the public key from the Conformal website at
https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt

- Import the public key into your GPG keyring:
```bash
gpg --import GIT-GPG-KEY-conformal.txt
```

- Verify the release tag with the following command where `TAG_NAME` is a
placeholder for the specific tag:
```bash
git tag -v TAG_NAME
```

## License

Package btcutil is licensed under the [copyfree](http://copyfree.org) ISC
License.
- base58 (unchanged)
- bech32 (API change in `Decode`)
Loading

0 comments on commit 3986eec

Please sign in to comment.