Getting started
API Endpoints
TaaS WebSocket - subscribing from clients
TaaS WebSocket Sample Clients
Clients - Docker
If you are using TezPusher.Web in Docker or as a stand-alone ASP.Net Core Application.
Sample Client
1. Connect to SignalR Hub
You need a SignalR client library. In this sample we are using https://www.npmjs.com/package/@aspnet/signalr.
Your usage may vary depending on your programming language and used client library.
1
private connect(): Observable<any> {
2
this.hubConnection = new signalR.HubConnectionBuilder()
3
.withUrl(`${this._baseUrl}/tezosHub`)
4
.configureLogging(signalR.LogLevel.Information)
5
.build();
6
return from(this.hubConnection.start());
7
}
Copied!
2. Subscribe to updates
You can then subscribe to events like this. You can only specify the event types you are interested in.
1
this.hubConnection.send("subscribe", {
2
transactionAddresses: ['all'],
3
delegationAddresses: ['all'],
4
originationAddresses: ['all'],
5
fromBlockLevel: 744190,
6
blockHeaders: true
7
});
Copied!
Note:
transactionAddresses, delegationAddresses and originationAdresses are string[].If your client missed some blocks and you want to continue where you left off, you can optionally specify fromBlockLevel parameter. This will first send all the subscribed information from the blocks starting at the specified block level.
- Specifying 'all' will subscribe the client to all transactions/delegations/originations respectively.
- Using specific addresses in the arrays will only subscribe to events happening on these addresses.
For reference please take a look at AgileVentures.TezPusher.SampleClient.Web specifically
signalr.service.ts.3. Unsubscribe from updates
You can unsubscribe from events similarly to subscribing.
1
this.hubConnection.send("unsubscribe", {
2
transactionAddresses: ['all'],
3
delegationAddresses: ['all'],
4
originationAddresses: ['all']
5
});
Copied!