NESTRedEnvelopesBot icon indicating copy to clipboard operation
NESTRedEnvelopesBot copied to clipboard

The NEST Prize Bot is a tool for the activity of the NEST community.

trafficstars

NEST Prize Bot

The NEST Prize Bot is a tool developed by our team for the activity of the NEST community. It can record the receipt of Prize and export them.

This repository contains:

  1. The bot main program
  2. The contract interface used by the bot
  3. Get the function source code of the condition interface

Table of Contents

  • Background
  • Install
  • Usage
  • Example Bot
  • Related Efforts
  • Maintainers
  • Contributing
  • License

Background

Our development team has developed countless telegram bots for rewarding active users, which is a very exhausting job. Therefore, we decided to develop a general-purpose bot that can help members of the NEST community to distribute and receive NEST red packets in Telegram groups.

The goals for this repository are:

  1. Record the receipt of NEST Prize
  2. Export all the receipt data
  3. Reduce the cost of reward distribution and reduce transaction errors
  4. Anti cheating

Install

This project uses a serverless architecture design, so you need to be familiar with AWS related services, including: Lambda, DynamoDB, IAM, CloudWatch, etc.

$ npm install

Usage

You need to replace some configuration in the source code, including:

  1. Create a new Telegram bot account and configure its token in Lambda's environment variables
  2. Modify the whitelist of administrators in the original code, WHITELIST
  3. Need to create a DynamoDB database

DynamoDB Design

Table: nest-prize

Attribute Name Type Description
chat_id Number pk of table
message_id Number sk of table
status String pk of GSI(status-index)

Table: nest-prize-users

Attribute Name Type Description
user_id Number pk
wallet Number pk of GSI(wallet-index)

Example Bot

NEST Prize Bot

Related Efforts

Maintainers

@tunogya.

Contributing

Feel free to dive in! Open an issue or submit PRs.

Contributors

This project exists thanks to all the people who contribute.

@kitty-tin, @wll2143

License

MIT © NEST Protocol