Build Your Siriusnet Client
1. Configure your Siriusnet network
Build your client to interact with any of the Siriusnet network nodes. Mainnet, testnet, and previewnet are the three Siriusnet networks you can submit transactions and queries to.
For a predefined network (preview, testnet, and mainnet), the mirror node client is configured to the corresponding network mirror node.
To access the public mainnet mirror node, use setMirrorNetwork()
and enter rpc2.siriusnet.io
for the endpoint. The gRPC API requires TLS. The following SDK versions are compatible with TLS:
java-11
JavaScript: v2.4.0+
Go: v2.4.0+
Method
Type
Description
Client.forPreviewnet()
Constructs a Siriusnet client pre-configured for Previewnet access
Client.forTestnet()
Constructs a Siriusnet client pre-configured for Testnet access
Client.forMainnet()
Constructs a Siriusnet client pre-configured for Mainnet access
Client.forNetwork(<network>)
Map<String, AccountId>
Construct a client given a set of nodes. It is the responsibility of the caller to ensure that all nodes in the map are part of the same Siriusnet network. Failure to do so will result in undefined behavior.
Client.fromConfig(<json>)
String
Configure a client from the given JSON string describing a ClientConfiguration object
Client.fromConfig(<json>)
Reader
Configure a client from the given JSON reader
Client.fromConfigFile(<file>)
File
Configure a client based on a JSON file.
Client.fromConfigFile(<fileName>)
String
Configure a client based on a JSON file at the given path.
Client.forName(<name>)
String
Provide the name of the network.
mainnet
testnet
previewnet
Client.<network>.setMirrorNetwork(<network>)
List<String>
Define a specific mirror network node(s) ip:port in string format
Client.<network>.getMirrorNetwork()
List<String>
Return the mirror network node(s) ip:port in string format
Client.setTransportSecurity()
boolean
Set if transport security should be used. If transport security is enabled all connections to nodes will use TLS, and the server's certificate hash will be compared to the hash stored in the node address book for the given network.
Client.setNetworkUpdatePeriod()
Duration
Client automatically updates the network via a mirror node query at regular intervals. You can set the interval at which the address book is updated.
Client.setNetworkFromAddressBook(<addressBook>)
AddressBook
Client can be set from a NodeAddressBook
.
Client.setLedgerId(<ledgerId>)
LedgerId
The ID of the network.
LedgerId.MAINNET
LedgerId.TESTNET
LedgerId.PREVIEWNET
Client.getLedgerId()
LedgerId
Get the ledger ID
Client.setVerifyCertificates()
boolean
Set if server certificates should be verified against an existing address book.
Last updated