-
Notifications
You must be signed in to change notification settings - Fork 5
/
help_docs.py
146 lines (116 loc) · 5.75 KB
/
help_docs.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
import grcconf as g
import emotes as e
import discord
def help_main():
topics = '\n'.join(f'- {topic}' for topic in help_dict)
return discord.Embed(
title='GRC Wallet Bot Help',
colour=discord.Colour.orange(),
description=f'''
Type `%help [topic]` for more detailed information about the following:
{topics}
''')
new = discord.Embed(title='Create a new account: %new', colour=discord.Colour.orange(),
description='''
Creates an account for you to use the bot. (No personal details required)
Be sure to also read the %rules and %terms.''')
bal = discord.Embed(title='Check your balance: %bal %balance %b', colour=discord.Colour.orange(),
description='''
Checks your current balance and shows your deposit address.
To get a clipboard friendly address, use %addr.
If the bot is offline, you are still safe to make deposits.''')
stake = discord.Embed(title='Check your stake earnings: %stake %stk', colour=discord.Colour.orange(),
description=f'''
Shows your staking rewards.
Any rewards earned go directly to your balance.
The bigger of a balance you have, the more stake you will earn.
You must have a minimum of {g.min_deposit} GRC to stake using your balance''')
wdr = discord.Embed(title='Withdraw your funds: %wdr %withdraw %send', colour=discord.Colour.orange(),
description=f'''
**Format: %wdr [address to send to] [amount-GRC]**
Takes your GRC out of the bot's wallet.
Fee for withdraw is {g.tx_fee} GRC and is automatically deducted.
If you wish to transfer to another user, use %give instead.''')
donate = discord.Embed(title='Donate to someone: %donate', colour=discord.Colour.orange(),
description='''
**Format: %donate [selection no.] [amount-GRC]**
Type just %donate to see a list of possible donation options.
Choose a number from the list and then choose the amount to donate.
Regular network fees apply.''')
rdonate = discord.Embed(title='Donate to a random contributor: %rdonate', colour=discord.Colour.orange(),
description='''
**Format: %rdonate [amount-GRC]**
Same as %donate but a random person on the bot's donation list is chosen for you.''')
give = discord.Embed(title='Give funds to another user: %give %tip', colour=discord.Colour.orange(),
description='''
**Format: %give [discord mention of user] [amount-GRC]**
Give some GRC to another person within the server. (no fees apply)
Requires the other user to also have an account with the bot through %new.''')
rain = discord.Embed(title='Rain on active users: %rain', colour=discord.Colour.orange(),
description='''
**Format: %rain [amount-GRC]**
Typing %rain on its own will display the current rain balance and threshold.
Once the balance of the rainbot exceeds the threshold, it will rain on **all online users with accounts on the bot**.''')
faucet = discord.Embed(title='Get some free GRC: %faucet %get %fct', colour=discord.Colour.orange(),
description=f'''
Type this command to get some free Gridcoins.
Amounts are random and you can only request once per {g.FCT_REQ_LIM} hours.
To help fund the faucet, you can type `%fgive [amount-GRC]`.''')
qr = discord.Embed(title='Generate a QR code: %qr', colour=discord.Colour.orange(),
description='''
**Format: %qr [optional data]**
Generates a qr code. If no data is given, it will send a QR code of your
wallet address. Any data given must contain no spaces.''')
faq = discord.Embed(title='Read answers to frequently asked questions: %faq', colour=discord.Colour.orange(),
description='''
**Format: %faq [selection no.]**
This is a repository of question-answer responses relating to Gridcoin.
All answers are formulated by Delta, Foxifi and LavRadis, and checked by
community members and developers.''')
block = discord.Embed(title='Explore blocks on the Gridcoin network: %block', colour=discord.Colour.orange(),
description='''
**Format: %block [height]**
Fetches information about a particular block on the Gridcoin blockchain.
If no height is provided, it will show the latest block information''')
status = discord.Embed(title='Bot and network status: %status', colour=discord.Colour.orange(),
description='''
Check the bot status to see whether it is online and observe some basic stats.
You can also find the faucet and rain statuses here.''')
time = discord.Embed(title='Show your timeouts: %time', colour=discord.Colour.orange(),
description='''
Shows when you are able to use %faucet, %donate and %withdraw again.''')
dm = discord.Embed(title='Toggle rain DM messages: %dm %messages', colour=discord.Colour.orange(),
description='''
Changes whether the bot should DM you during a rain.''')
invite = discord.Embed(title='Get the link to the main server: %invite', colour=discord.Colour.orange(),
description='''Shows the invite link to the official Gridcoin server.''')
rules_help = discord.Embed(title='Show the bot rules: %rules', colour=discord.Colour.orange(),
description='''
Rules about using the bot and what may result in a ban.''')
terms_help = discord.Embed(title='Show the bot terms: %terms', colour=discord.Colour.orange(),
description='''
Terms and conditions for making an account with the bot that you automatically accept by typing %new.''')
info_help = discord.Embed(title='Information about the bot: %info', colour=discord.Colour.orange(),
description='''
Shows information about authors, contributors and how to contact the bot owner.''')
help_dict = {
'new' : new,
'balance' : bal,
'stake' : stake,
'withdraw' : wdr,
'donate' : donate,
'rdonate' : rdonate,
'give' : give,
'rain' : rain,
'faucet' : faucet,
'qr' : qr,
'faq' : faq,
'block' : block,
'status' : status,
'time' : time,
'dm' : dm,
'invite' : invite,
'rules' : rules_help,
'terms' : terms_help,
'info' : info_help
}