README
¶
Go sdk for CESS network
The go sdk implementation of the CESS network, which provides RPC calls, status queries, block transactions and other functions.
📝 Reporting Vulnerability
If you find any system errors or you have better suggestions, please submit an issue or PR, or join the CESS discord to communicate with us.
📢 Announcement
CESS test network rpc endpoints
wss://testnet-rpc0.cess.cloud/ws/
wss://testnet-rpc1.cess.cloud/ws/
wss://testnet-rpc2.cess.cloud/ws/
CESS test network bootstrap node
_dnsaddr.boot-bucket-testnet.cess.cloud
🚰 CESS test network faucet
https://testnet-faucet.cess.cloud/
🏗 Usage
To get the package use the standard:
go get -u "github.com/CESSProject/cess-go-sdk"
✅ Testing
To run test:
-
Run a CESS node locally.
-
Run the command
go test -v
📖 Document
License
Licensed under Apache 2.0
Documentation
¶
Index ¶
Constants ¶
const Version = "0.5.0.25"
SDK Version
Variables ¶
var DefaultRpcAddrs = func(cfg *Config) error { rpcAddrs := []string{ "wss://testnet-rpc0.cess.cloud/ws/", "wss://testnet-rpc1.cess.cloud/ws/", "wss://testnet-rpc2.cess.cloud/ws/", } return cfg.Apply(ConnectRpcAddrs(rpcAddrs)) }
DefaultRpcAddrs configures the default rpc address
var DefaultTimeout = func(cfg *Config) error { return cfg.Apply(TransactionTimeout(pattern.BlockInterval)) }
DefaultTimeout configures the default transaction waiting timeout
Functions ¶
func New ¶
New constructs a new sdk client with the given options, falling back on reasonable defaults. The defaults are:
- If no rpc address is provided, the sdk client uses the default address "wss://testnet-rpc0.cess.cloud/ws/"" or "wss://testnet-rpc1.cess.cloud/ws/";
- If no transaction timeout is provided, the sdk client uses the default timeout: time.Duration(time.Second * 6)
- The serviceName is used to specify the name of your service Warning:
cess-bucket (cess storage service) must be set to bucket DeOSS (cess decentralized object storage service) must be set to deoss cess-cli (cess client) must be set to client
func NewWithoutDefaults ¶
NewWithoutDefaults constructs a new client with the given options but *without* falling back on reasonable defaults.
Warning: This function should not be considered a stable interface. We may choose to add required services at any time and, by using this function, you opt-out of any defaults we may provide.
Types ¶
type Option ¶
Option is a client config option that can be given to the client constructor
var FallbackDefaults Option = func(cfg *Config) error { for _, def := range defaults { if !def.fallback(cfg) { continue } if err := cfg.Apply(def.opt); err != nil { return err } } return nil }
FallbackDefaults applies default options to the libp2p node if and only if no other relevant options have been applied. will be appended to the options passed into New.
func ConnectRpcAddrs ¶
ConnectRpcAddrs configuration rpc address
func TransactionTimeout ¶
TransactionTimeout configures the waiting timeout for a transaction
Source Files
Directories