Connects Slack and IRC channels by sending messages back and forth. Read more here.

This is modified version of slack-irc bot, that includes NEM tipbot.

tipbot's code is far from being pretty, it should be treated AS A TOY, but it's purpose is to show how one can VERY easily interact with NIS API.

There's also a pretty serious issue, it's using (unencrypted) json file to store information about private/public keys, additionally synchronization sux.

Proper version should use some kind of db, node-sqlite should be enough for this purpose.

Few words about API.

• Nemdb - this is dumb fs wrapper
• Nem - that is part that interacts with NIS (more below)
• Bot - some new methods/modifications to let it run on slack

Nem() api:

• .chainHeight(cb) -> returns current height of the blockchain
• `.accountGenerate(cb) -> creates new account (public key, private key, address)
• .balanceGen(address, back, cb) -> method that abuses bigalice3 node, to get account data //back// blocks behind, you can change it to your own node, but it needs to support HISTORICAL\_ACCOUNT\_DATA in nis.optionalFeatures inside config.properties
• .nodeExtendedInfo(cb) -> get node extended info (required to get current NEM network time)
• .makeTransfer(depositData, destinationAddress, amountInNem, transactionFee, cb) -> make a transfer transaction (http://bob.nem.ninja/docs/#initiating-transactions)
• .get / .post -> convenient wrappers for GET/POST NIS request (see the docs for all APIs (http://bob.nem.ninja/docs/)

Both Nem, and Nemdb should be extracted into separate modules, feel free to do that and make a pull request.

(you can test it on testnet, just remebmer to set proper version inside .makeTransfer)

Either by installing through npm:

$ npm install -g slack-irc
$ slack-irc --config /path/to/config.json

or by cloning the repository:

In the repository folder:
$ npm install
$ node index.js --config /path/to/config.json

It can also be used as a node module:

var slackIRC = require('slack-irc');
var config = require('./config.json');
slackIRC(config);

slack-irc uses Slack's bot users. This means you'll have to set up a bot user as a Slack integration, and invite it to the Slack channels you want it to listen in on. This can be done using Slack's /invite <botname> command. This has to be done manually as there's no way to do it through the Slack bot user API at the moment.

slack-irc requires a JSON-configuration file, whose path can be given either through the CLI-option --config or the environment variable CONFIG_FILE. The configuration file needs to be an object or an array, depending on the number of IRC bots you want to run.

This allows you to use one instance of slack-irc for multiple Slack teams if wanted, even if the IRC channels are on different networks.

To set the log level to debug, export the environment variable NODE_ENV as development.

slack-irc also supports invite-only IRC channels, and will join any channels it's invited to as long as they're present in the channel mapping.

[
  // Bot 1 (minimal configuration):
  {
    "nickname": "test2",
    "server": "irc.testbot.org",
    "token": "slacktoken2",
    "channelMapping": {
      "#other-slack": "#new-irc-channel"
    }
  },

  // Bot 2 (advanced options):
  {
    "nickname": "test",
    "server": "irc.bottest.org",
    "token": "slacktoken", // Your bot user's token
    "autoSendCommands": [ // Commands that will be sent on connect
      ["PRIVMSG", "NickServ", "IDENTIFY password"],
      ["MODE", "test", "+x"],
      ["AUTH", "test", "password"]
    ],
    "channelMapping": { // Maps each Slack-channel to an IRC-channel, used to direct messages to the correct place
      "#slack": "#irc channel-password", // Add channel keys after the channel name
      "privategroup": "#other-channel" // No hash in front of private groups
    },
    "ircOptions": { // Optional node-irc options
      "floodProtection": false, // On by default
      "floodProtectionDelay": 1000 // 500 by default
    }
  }
]

ircOptions is passed directly to node-irc (available options).

Run the tests with:

$ make test

A third-party Docker container can be found here.

(The MIT License)

Copyright (c) 2015 Martin Ek [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.