The ark-network-bot from maxknivets

ark-network-bot's Introduction

`@decentdotland/ark-network-bot`

For token-gated Telegram groups

Synopsis

Ark Network Bot is a Telegram bot that relies on the Ark Network and Telegram API to facilitate token-gated guilds on Telegram.

Status

Development: PoC - alpha release.
Desc: The current release supports only Arweave tokens standards: PSTs (Profit Sharing Tokens) and aNFTs (Atomic NFTs). The bot can be extended to support all of the protocols and chains integrated in the Ark Network.

Install

git clone https://github.com/decentldotland/ark-network-bot.git

cd ark-network-bot

npm install .

Contracts

The list of SmartWeave contract used by this bot

name	path	description
onchain requests cache	./contracts/cache-contract	encypted onchain cache for user's logs of joining a guild
guilds registry	./contracts/guilds	registry contract for the created guilds

Guild Creation

Creating a guild does not require an existing Telegram group to link it directly, instead, the guild can be bound to a group anytime after creation.

Supported token types

Tokens	KEY
BEP20	`BEP20`
ERC20 ETH	`ERC-ETH`
ERC20 AVAX	`ERC-AVAX`
ERC20 FTM	`ERC-FTM`
ERC20 MATIC	`ERC-POLYGON`
PSTs & aNFTS	`PST-ANFT`

Contract SWC ID (experimental): sWR6h_DrFHBS2P2-l1zYFo0R7ufJy32YINM1UVP7f5w

Creation interaction:

{
  "function": "createGuild",
  "name": "pancakessss",
  "description": "we love pancakes",
  "token_address": "0x0E09FaBB73Bd3Ade0a17ECC321fD13a19e81cE82", // BEP20 $CAKE contract address
  "token_decimals": 18, // token's decimals
  "token_type": "BEP20", // token type
  "token_threshold": 0.05 // min amount (inclusive) held by a user to be able to join the guild
}