Skip to content

Websocket

Jump to bottom
Alexander Popov edited this page May 17, 2019 · 9 revisions

WebSockets make possible receiving notifications when a transaction or event occurs in the blockchain. The notification is received in real time without having to poll the API waiting for a reply.

Subscribe block

The block channel notifies for every new block. The message contains the block information.

package main

import (
    "fmt"
    "context"
    "github.com/proximax-storage/go-xpx-catapult-sdk/sdk"
	"github.com/proximax-storage/go-xpx-catapult-sdk/sdk/websocket"
)

const (
    // Catapult-api-rest server.
    baseUrl = "ws://localhost:3000/ws"

    // Types of network.
    // MainNet:   104
    // TestNet:   152
    // Mijin:     96
    // MijinTest: 144
    networkType = sdk.MijinTest
)

func main() {

    // Testnet config default
    conf, err := sdk.NewConfig(baseUrl,networkType)
    if err != nil {
        panic(err)
    }

    // Create websocket client
    wsClient, err := websocket.NewClient(context.Background(), conf)
    if err != nil {
        panic(err)
    }

    // add handler
    err = wsClient.AddBlockHandler(func (info *sdk.BlockInfo) bool {
        fmt.Printf("Block received with height: %v \n", info.Height)
        return true
    })
    if err != nil {
        panic(err)
    }

}

Subscribe confirmed added

The confirmed added channel notifies when a transaction related to an address is included in a block. The message contains the transaction.

package main

import (
    "fmt"
    "context"
    "github.com/proximax-storage/go-xpx-catapult-sdk/sdk"
	"github.com/proximax-storage/go-xpx-catapult-sdk/sdk/websocket"
)

const (
    // Catapult-api-rest server.
    baseUrl = "ws://localhost:3000/ws"

    // Types of network.
    // MainNet:   104
    // TestNet:   152
    // Mijin:     96
    // MijinTest: 144
    networkType = sdk.MijinTest
    // Valid private key
    privateKey  = "24CEC4F2DD1A28EBB2C0CF6D4D181BA2C0F1E215C42B9059EEFB65B1FAEE1B99"
)

func main() {

    // Create account from private key
    acc, err := sdk.NewAccount(privateKey, networkType)
    if err != nil {
        panic(err)
    }

    // Testnet config default
    config, err := sdk.NewConfig(baseUrl, networkType)
    if err != nil {
        panic(err)
    }

    // Create websocket client
    wsClient, err := websocket.NewClient(context.Background(), config)
    if err != nil {
        panic(err)
    }

    // add handler
    err = wsClient.AddConfirmedAddedHandlers(account.Address, func (info sdk.Transaction) bool {
        fmt.Printf("ConfirmedAdded Tx Hash: %v \n", info.GetAbstractTransaction().Hash)
        return true
    })
    if err != nil {
        panic(err)
    }

}

Subscribe unconfirmed added

The unconfirmed added channel notifies when a transaction related to an address is in unconfirmed state and waiting to be included in a block. The message contains the transaction.

package main

import (
    "fmt"
    "context"
    "github.com/proximax-storage/go-xpx-catapult-sdk/sdk"
	"github.com/proximax-storage/go-xpx-catapult-sdk/sdk/websocket"
)

const (
    // Catapult-api-rest server.
    baseUrl = "ws://localhost:3000/ws"

    // Types of network.
    // MainNet:   104
    // TestNet:   152
    // Mijin:     96
    // MijinTest: 144
    networkType = sdk.MijinTest
    // Valid private key
    privateKey  = "24CEC4F2DD1A28EBB2C0CF6D4D181BA2C0F1E215C42B9059EEFB65B1FAEE1B99"
)

func main() {

    // Create account from private key
    acc, err := sdk.NewAccount(privateKey, networkType)
    if err != nil {
        panic(err)
    }

    // Testnet config default
    config, err := sdk.NewConfig(baseUrl, networkType)
    if err != nil {
        panic(err)
    }

    // Create websocket client
    wsClient, err := websocket.NewClient(context.Background(), config)
    if err != nil {
        panic(err)
    }

    // add handler
    err = wsClient.AddUnconfirmedAddedHandlers(account.Address, func (info sdk.Transaction) bool {
        fmt.Printf("UnconfirmedAdded Tx Hash: %v \n", info.GetAbstractTransaction().Hash)
        return true
    })
    if err != nil {
        panic(err)
    }

}

Subscribe partial added

The partial added channel notifies when an aggregate bonded transaction related to an address is in partial state and waiting to have all required cosigners. The message contains a transaction.

package main

import (
    "fmt"
    "context"
    "github.com/proximax-storage/go-xpx-catapult-sdk/sdk"
	"github.com/proximax-storage/go-xpx-catapult-sdk/sdk/websocket"
)

const (
    // Catapult-api-rest server.
    baseUrl = "ws://localhost:3000/ws"

    // Types of network.
    // MainNet:   104
    // TestNet:   152
    // Mijin:     96
    // MijinTest: 144
    networkType = sdk.MijinTest
    // Valid private key
    privateKey  = "24CEC4F2DD1A28EBB2C0CF6D4D181BA2C0F1E215C42B9059EEFB65B1FAEE1B99"
)

func main() {

    // Create account from private key
    acc, err := sdk.NewAccount(privateKey, networkType)
    if err != nil {
        panic(err)
    }

    // Testnet config default
    config, err := sdk.NewConfig(baseUrl, networkType)
    if err != nil {
        panic(err)
    }

    // Create websocket client
    wsClient, err := websocket.NewClient(context.Background(), config)
    if err != nil {
        panic(err)
    }

    // add handler
    err = wsClient.AddPartialAddedHandlers(account.Address, func (info sdk.Transaction) bool {
        fmt.Printf("PartialAdded Tx Hash: %v \n", info.GetAbstractTransaction().Hash)
        return true
    })
    if err != nil {
        panic(err)
    }

}

Subscribe partial removed

The partial removed channel notifies when a transaction related to an address was in partial state but not anymore. The message contains the transaction hash.

package main

import (
    "fmt"
    "context"
    "github.com/proximax-storage/go-xpx-catapult-sdk/sdk"
	"github.com/proximax-storage/go-xpx-catapult-sdk/sdk/websocket"
)

const (
    // Catapult-api-rest server.
    baseUrl = "ws://localhost:3000/ws"

    // Types of network.
    // MainNet:   104
    // TestNet:   152
    // Mijin:     96
    // MijinTest: 144
    networkType = sdk.MijinTest
    // Valid private key
    privateKey  = "24CEC4F2DD1A28EBB2C0CF6D4D181BA2C0F1E215C42B9059EEFB65B1FAEE1B99"
)

func main() {

    // Create account from private key
    acc, err := sdk.NewAccount(privateKey, networkType)
    if err != nil {
        panic(err)
    }

    // Testnet config default
    config, err := sdk.NewConfig(baseUrl, networkType)
    if err != nil {
        panic(err)
    }

    // Create websocket client
    wsClient, err := websocket.NewClient(context.Background(), config)
    if err != nil {
        panic(err)
    }

    // add handler
    err = wsClient.AddPartialRemovedHandlers(account.Address, func (info sdk.Transaction) bool {
        fmt.Printf("PartialRemoved Tx Hash: %v \n", info.Meta.Hash)
        return true
    })
    if err != nil {
        panic(err)
    }

}

Subscribe cosignature

The cosignature channel notifies when a cosignature signed transaction related to an address is added to an aggregate bonded transaction with partial state. The message contains the cosignature signed transaction.

package main

import (
    "fmt"
    "context"
    "github.com/proximax-storage/go-xpx-catapult-sdk/sdk"
	"github.com/proximax-storage/go-xpx-catapult-sdk/sdk/websocket"
)

const (
    // Catapult-api-rest server.
    baseUrl = "ws://localhost:3000/ws"

    // Types of network.
    // MainNet:   104
    // TestNet:   152
    // Mijin:     96
    // MijinTest: 144
    networkType = sdk.MijinTest
    // Valid private key
    privateKey  = "24CEC4F2DD1A28EBB2C0CF6D4D181BA2C0F1E215C42B9059EEFB65B1FAEE1B99"
)

func main() {

    // Create account from private key
    acc, err := sdk.NewAccount(privateKey, networkType)
    if err != nil {
        panic(err)
    }

    // Testnet config default
    config, err := sdk.NewConfig(baseUrl, networkType)
    if err != nil {
        panic(err)
    }

    // Create websocket client
    wsClient, err := websocket.NewClient(context.Background(), config)
    if err != nil {
        panic(err)
    }

    // add handler
    err = wsClient.AddCosignatureHandlers(account.Address, func (info *sdk.SignerInfo) bool {
        fmt.Printf("Cosignature PublicKey: %v \n", info.Signer)
        fmt.Printf("Cosignature Tx Hash: %v \n", info.ParentHash)
        return true
    })
    if err != nil {
        panic(err)
    }

}

Subscribe status

The status channel notifies when a transaction related to an address rises an error. The message contains the error message and the transaction hash.

package main

import (
    "fmt"
    "context"
    "github.com/proximax-storage/go-xpx-catapult-sdk/sdk"
	"github.com/proximax-storage/go-xpx-catapult-sdk/sdk/websocket"
)

const (
    // Catapult-api-rest server.
    baseUrl = "ws://localhost:3000/ws"

    // Types of network.
    // MainNet:   104
    // TestNet:   152
    // Mijin:     96
    // MijinTest: 144
    networkType = sdk.MijinTest
    // Valid private key
    privateKey  = "24CEC4F2DD1A28EBB2C0CF6D4D181BA2C0F1E215C42B9059EEFB65B1FAEE1B99"
)

func main() {

    // Create account from private key
    acc, err := sdk.NewAccount(privateKey, networkType)
    if err != nil {
        panic(err)
    }

    // Testnet config default
    config, err := sdk.NewConfig(baseUrl, networkType)
    if err != nil {
        panic(err)
    }

    // Create websocket client
    wsClient, err := websocket.NewClient(context.Background(), config)
    if err != nil {
        panic(err)
    }

    // add handler
    err = wsClient.AddStatusHandlers(account.Address, func (info *sdk.StatusInfo) bool {
        fmt.Printf("Status: %v \n", info.Status)
        fmt.Printf("Hash: %v \n", info.Hash)
        return true
    })
    if err != nil {
        panic(err)
    }

}

Proximax Sirius SDK for Golang

Clone this wiki locally