tonicpow / go-handcash-connect

Unofficial golang implementation for the HandCash Connect SDK

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

go-handcash-connect

The unofficial golang implementation for the HandCash Connect SDK

Release Build Status Report codecov Go
Mergify Status Gitpod Ready-to-Code


Table of Contents


Installation

go-handcash-connect requires a supported release of Go.

go get -u github.com/tonicpow/go-handcash-connect

Documentation

View the generated documentation

GoDoc

Features

  • Current coverage for the HandCash Connect SDK
    • GetProfile
    • Pay
    • GetPayment
    • GetEncryptionKeypair
    • GetFriends
    • GetPermissions
    • GetPublicProfiles
    • GetSpendableBalance
    • SignData
Library Deployment

goreleaser for easy binary or library deployment to GitHub and can be installed via: brew install goreleaser.

The .goreleaser.yml file is used to configure goreleaser.

Use make release-snap to create a snapshot version of the release, and finally make release to ship to production.

Makefile Commands

View all makefile commands

make help

List of all current commands:

all                  Runs lint, test-short and vet
clean                Remove previous builds and any test cache data
clean-mods           Remove all the Go mod cache
coverage             Shows the test coverage
diff                 Show the git diff
generate             Runs the go generate command in the base of the repo
godocs               Sync the latest tag with GoDocs
help                 Show this help message
install              Install the application
install-go           Install the application (Using Native Go)
lint                 Run the golangci-lint application (install if not found)
release              Full production release (creates release in GitHub)
release              Runs common.release then runs godocs
release-snap         Test the full release (build binaries)
release-test         Full production test release (everything except deploy)
replace-version      Replaces the version in HTML/JS (pre-deploy)
tag                  Generate a new tag and push (tag version=0.0.0)
tag-remove           Remove a tag if found (tag-remove version=0.0.0)
tag-update           Update an existing tag to current commit (tag-update version=0.0.0)
test                 Runs lint and ALL tests
test-ci              Runs all tests via CI (exports coverage)
test-ci-no-race      Runs all tests via CI (no race) (exports coverage)
test-ci-short        Runs unit tests via CI (exports coverage)
test-no-lint         Runs just tests
test-short           Runs vet, lint and tests (excludes integration tests)
test-unit            Runs tests and outputs coverage
uninstall            Uninstall the application (and remove files)
update-linter        Update the golangci-lint package (macOS only)
vet                  Run the Go vet application

Examples & Tests

All unit tests and examples run via GitHub Actions and uses Go version 1.18.x. View the configuration file.

Run all tests (including integration tests)

make test

Run tests (excluding integration tests)

make test-short

Benchmarks

Run the Go benchmarks:

make bench

Code Standards

Read more about this Go project's code standards.


Usage

View the examples


Maintainers

MrZ Satchmo
MrZ Satchmo

Contributing

View the contributing guidelines and please follow the code of conduct.

Stars

Credits

HandCash for their hard work on the HandCash Connect SDK


License

License

About

Unofficial golang implementation for the HandCash Connect SDK

License:MIT License


Languages

Language:Go 88.3%Language:Makefile 11.7%