broadcast

README

broadcast

A plugin for IOTA's GoShimmer Node to broadcast every message on the message layer an write it to active tcp connections over port 5050

Installation

Move the project's folder into your goshimmer/plugins/ folder.

In goshimmer/plugins/research.go add the following line:

broadcast.Plugin(),

in the node.Plugins(...) list and add this in the import statement:

"github.com/iotaledger/goshimmer/plugins/broadcast"

You may need to recompile the goshimmer software.

In the config.json you need to add "broadcast" to the "node" sections as followed:

"node": {
    "disablePlugins": [],
    "enablePlugins": ["broadcast"]
},

You also want to configure the plugin in the same file. You need to paste this config between the other plugins:

"broadcast": {
    "bindAddress": "127.0.0.1:5050"
    },

Please notice, that you can only connect locally with this ip. If you want it to be reachable from the outside you need to use 0.0.0.0.

If you get a compile error while buidling your goshimmer software, it is mostly because of missing libraries. If so, do the following: Go to

~/go/src/github.com/iotaledger/goshimmer/plugins

and paste in the broadcast folder so go can access the missing files.

Usage

Just connect to the plugin's port 5050 and you get the messages in real time as long as you are connected. A maximum of 256 Connections are possible before it throws errors.

The structure of the messages can be extracted here:

https://github.com/iotaledger/goshimmer/blob/43a764bf8234e1729eb1068d53d638ac5e453872/packages/ledgerstate/transaction.go#L157

https://github.com/iotaledger/goshimmer/blob/61f62443d85cd7bf62356b174af5c73bef94e67d/packages/tangle/message.go#L184

Donations

If you want to keep me motivated to do more open source stuff you can donate me some IOTA's. Even very small amounts makes me happy:

iota1qqvrqjfscx5ax7vnt8mmtmzj30af3xf7zfm8t7lnaxyrt73awgqckz02upv

Documentation

Index

• func Plugin() *node.Plugin
• type ParametersDefinition

Functions

func Plugin

func Plugin() *node.Plugin

Plugin gets the plugin instance.

Types

type ParametersDefinition

type ParametersDefinition struct {
	Port int `default:"5050" usage:"port for broadcast plugin connections"`
}

ParametersDefinition contains the configuration parameters used by the plugin