Categorygithub.com/meshplus/go-bitxhub-client
modulepackage
1.28.0
Repository: https://github.com/meshplus/go-bitxhub-client.git
Documentation: pkg.go.dev

# README

Go Bitxhub Client

build codecov Go Report Card

This SDK enables Go developers to build solutions that interact with BitXHub.

Getting started

Obtain the client SDK packages for BitXHub.

go get github.com/meshplus/go-bitxhub-client

You're good to go, happy coding! Check out the examples for usage demonstrations.

Documentation

SDK documentation can be viewed at GoDoc.

Examples

  • RPC Test: Basic example that uses SDK to query and execute transaction.
  • Block Test: Basic example that uses SDK to query blocks.
  • Contract Test: Basic example that uses SDK to deploy and invoke contract.
  • Subscribe Test: An example that uses SDK to subscribe the block event.
  • Sync Test: An example that uses SDK to sync the merkle wrapper.

Client SDK

You should start BitXHub before using SDK.

Running the test

Obtain the client SDK packages for BitXHub.

git clone https://github.com/meshplus/go-bitxhub-client.git
# In the BitXHub SDK Go directory
cd go-bitxhub-client/

# make depend
go mod tidy

# Running test
make test

Contributing

See CONTRIBUTING.md.

License

Apache-2.0

# Packages

Package mock_client is a generated GoMock package.

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewIPFSClient .
init a connection.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WithAPIAddrs returns ipfs client e.g []string{"http://localhost:5001"}.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

network problem received from grpc.
set ibtp and normal nonce at the same time.
error type which tx format is invalid to send.
error type which can be fixed by retrying.
signature for tx is invalid.

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IPFSClient .
IPFSResponse describes ipfs add response.
No description provided by the author
No description provided by the author

# Interfaces

go:generate mockgen -destination mock_client/mock_client.go -package mock_client -source client.go.
The FieldLogger interface generalizes the Entry and logger types.

# Type aliases

No description provided by the author
No description provided by the author