Giter Site home page Giter Site logo

polkabot's Introduction

Polkabot

1. Intro

polkabot

You can see PolkaBOT in action in:

You can also run PolkaBOT yourself and the [docker] images that are available may help.

PolkaBOT is an extensible bot for Polkadot and other Substrate based chains. It is mainly running on Matrix.org but also handles notification with other networks such as twitter using dedicated plugins.

Note
PolkaBOT aims as being as silent as possible so don’t expect lots of fuzz and action!

2. Install & Run

git clone https://gitlab.com/chevdor/polkabot.git
cd polkabot
nvm use
yarn
yarn start
Note
For devs, the command is typically:
NODE_ENV=dev LOG_LEVEL=silly yarn start

3. Dev notes

You can find the API documentation at https://polkabot.gitlab.io/polkabot/

yarn
yarn-check
yarn upgrade

Start your substrate node:

docker run --rm -it --name polkadev -p 9944:9944 chevdor/polkadot:0.8.2 polkadot --dev --alice --rpc-cors all --unsafe-ws-external

then run:

nvm use

Before you got further you need to check your config. This is a .env file and all variables start with POLKABOT_. By default, the running mode is 'production' and will pick the .env file. The following to the same:

yarn start
NODE_ENV=production yarn start

If you want to use another file such as .env.dev, you may use:

NODE_ENV=dev y start

4. Settingg the bot account

Matrix is changing quickly and e2e is now enabled by default. You will need to make an account for the bot and login a to get your recovery key and define your recovery passphrase. After that, e2e should work.

Warning
If you use a browser to login as the bot, you will automatically signal that the bot is 2e2 capable.. which it is not. After that, all invitations from Riot will be with encryption turned on. There is a workaround which is to create a new room without encryption, invite the bot (it will join automatically) and change the conversation level to 'Direct Message'.

5. Encryption

Currently, Polkabot does NOT support encryption. If encryption is needed, https://github.com/matrix-org/pantalaimon could be used as proxy.

6. License

link:LICENSE[role=include]

polkabot's People

Contributors

chevdor avatar ltfschoen avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.