In case you are questioning arrange automated Web3 notification emails however need assistance determining the place to begin, this text is for you! Even for those who’re a whole newbie in blockchain growth, we’ll provide help to catch up. In any case, we’ll begin by explaining what Python and Flask are. As soon as we be sure you’re all up to the mark, we’ll tackle an instance mission the place you’ll have an opportunity to arrange automated Web3 notification emails with Python and Web3 webhooks.
Moralis is the last word Web3 supplier of blockchain APIs. As such, it’s an indispensable instrument if you wish to create decentralized functions (dapps) rapidly and simply. Moreover, Moralis’ cross-chain interoperability allows you to create multi-chain dapps. You solely must tweak a single line of code to focus on one other chain. As well as, Moralis allows you to be part of the Web3 revolution utilizing the legacy instruments you might be conversant in. Whereas we’ll deal with utilizing Python on this article, Moralis helps all main legacy dev platforms, frameworks, and languages. Basically, Moralis allows you to construct sooner and smarter with APIs that bridge the event hole between Web2 and Web3.
Except for its Streams API, which we’ll use to arrange automated Web3 notification emails, Moralis gives a full scope of Web3 APIs. This consists of the last word NFT API, Web3 Auth API, Token API, and extra. So, create your free Moralis account and observe our lead!
What’s Python and Flask?
Python is a transparent and highly effective object-oriented programming language. In some ways, it’s protected to check Python to a number of different coding languages. These embody Ruby, Scheme, Perl, and Java.
It’s value declaring that Python shouldn’t be as widespread and as broadly used as JavaScript. Nonetheless, it’s nonetheless among the many main programming languages, and Python has an extended historical past. In any case, it first appeared on the scene again in 1991, because of its developer Guido van Rossum. The primary purpose of Python was to make issues as simple as doable for builders. Primarily based on the opinions of those that know and use this language, Python is somewhat straightforward to get began with, be taught, and straightforward to make use of. Nonetheless, as “python.org” places it, Python is a programming language that permits you to work rapidly and combine methods extra successfully.
Flask is an online framework, a Python module that permits you to develop net functions simply. Additional, Flask has a small and easy-to-extend core. In any case, it’s a microframework that doesn’t embody an ORM (object relational supervisor) or options associated to ORM. Nonetheless, Flask has many wonderful options. For example, it consists of URL routing and a template engine. As well as, observe that Flask is an online server gateway interface (WSGI) net app framework. Furthermore, this Python framework was developed by Armin Ronacher, who led Poocco – a staff of worldwide Python lovers. Therefore, it’s not shocking that Flask is predicated on two different Poocco tasks – the Werkzeg WSGI toolkit and the Jinja2 template engine.
Set Up Automated Web3 Notification Emails with Python and Moralis’ Streams API – Instance Venture
Now that you recognize what Python and Flask are, it’s time we present you the automated Web3 notification e mail setup course of. Nonetheless, we consider it is just honest for those who first see the tip results of utilizing Python and Moralis for this objective. Therefore, let’s do a fast demo of our instance backend dapp earlier than illustrating arrange automated Web3 notification emails!
Setup of Automated Web3 Notification Emails – Demo
To show the outcomes of automated Web3 notification emails, we’ll use a Gmail account, a blockchain explorer (PolygonScan), and the preferred Web3 pockets – MetaMask.
First, let’s have a look at the next screenshot, which demonstrates that we’re beginning with an empty e mail inbox:
We open the PolygonScan (for the Mumbai testnet) explorer since Mumbai is the testnet the place our good contract lives. As chances are you’ll know, blockchain explorers additionally allow you to work together with deployed good contracts. Therefore, we open the web page for our instance good contract’s handle and choose the “Write Contract” choice contained in the “Contract” tab:
Then, as you may see within the above screenshot, we enter “2” (this may very well be any quantity our stability can cowl) within the “newDonation” subject and hit the “Write” button. This button triggers our MetaMask extension, which is linked to the Polygon Mumbai testnet. As you may see above, we have to affirm the transaction notification by clicking on the “Verify” button. After this motion, our terminal notifies us that an e mail has been despatched:
After we return to our e mail inbox, we are able to see the “New Donation” e mail:
Lastly, let’s additionally examine the main points of this instance notification e mail:
Trying on the above screenshot, you may see that we’ve arrange automated Web3 notification emails that embody donors’ pockets addresses and the quantity they donated in MATIC (native foreign money for the Polygon chain).
For those who’d wish to arrange this sort of e mail notification automation for on-chain occasions, be certain that to roll up your sleeves and observe our lead all through the sections under.
The way to Set Up Automated Web3 Notification Emails with Python and Moralis’ Streams API – Step-by-Step Tutorial
On this a part of right now’s article, you’ll have an opportunity to observe our lead as we information you thru the next 4 levels:
Set Up FlaskInitial Setup of Moralis and the Streams APIReceive Web3 WebhooksAutomate Emails
We’ll give you screenshots that will help you correctly full every of the above 4 levels. Nonetheless, on the backside of this text, you can too discover a detailed video tutorial on arrange automated Web3 notification emails. Notice that we’ll often confer with particular timestamps of that video shifting ahead.
Set Up Flask
For readability, we encourage you to observe our instance and use Visible Studio Code (VSC). Subsequent, create the “automateEmails” folder and open it in VSC. Then, you can begin your Python digital atmosphere by getting into the next command:
python3 -m venv venv
The above command will create a “venv” folder contained in the “automateEmails” folder:
Transferring on, you need to run this command line:
Supply venv/bin/activate
As a affirmation that you simply’ve efficiently activated your digital atmosphere, it’s best to see “(venv)” in your terminal:
Together with your digital atmosphere working, proceed by putting in the newest model of “pip” with the next command:
pip set up –upgrade pip
Subsequent, it’s time to put in all dependencies. Therefore, enter this command:
pip set up flask flask_cors
With the dependencies put in, go to your mission tree and create a brand new Python file. Be happy to name it as you please. Nonetheless, to keep away from any confusion, it may be safer to make use of the identical title as we – “backend.py”:
Then, import a pattern Flask app utilizing the next strains of code:
from flask import Flask
from flask import request
from flask import jsonify
from flask_cors import CORS
app = Flask(__name__)
CORS(app)
@app.route(‘/streams’, strategies=[“POST”])
def streams():
return jsonify(success=True)
if __name__ == “__main__”:
app.run(host=”127.0.0.1″, port=3000, debug=True)
The above template code consists of an endpoint you need to use as a webhook URL. As such, you may ship blockchain occasions as webhooks to that endpoint utilizing Moralis’ Streams API. By this level, you recognize that the latter is the important thing to setup automated Web3 notification emails the simple manner.
Preliminary Setup of Moralis and the Streams API
Transferring on, you’ll want so as to add correct performance to deal with the Web3 webhook you’ll obtain from Moralis. As such, you’ll be including a lot of the further code inside “@app.route” (see above). Nonetheless, first, it’s worthwhile to full the preliminary Moralis setup. Thus, be sure you have your Moralis account up and working. In case you haven’t created it but, you need to use the hyperlink said on the outset or click on on the “Begin for Free” button on Moralis’ homepage:
Together with your Moralis account prepared, you’ll be capable to entry your admin space. There, you’ll need to choose the “Streams” tab from the facet menu. As soon as on the “Streams” web page, you need to click on on the “New Stream” button:
Within the subsequent step, you get to pick one of many stream templates or create one from scratch, which is what we’ll do to arrange automated Web3 notification emails. Therefore, be certain that to click on on the “Create From Scratch” button:
Subsequent, you’ll must enter the main points for the good contract in query. In fact, you need to use any good contract you would like. Nonetheless, for the sake of this instance mission, we advocate you deal with the above-presented “donationExample” good contract (4:39). You may get hold of all the main points concerning this good contract by utilizing the above-seen PolygonScan web page. On the prime, it’s worthwhile to paste the contract’s handle:
As you may see above, you additionally want to offer your stream an outline. Then, you additionally want to supply your webhook URL, add a tag, and choose networks. With all the main points in place, you’ll be capable to hit the “Create Stream” button. For extra particulars, use the video under, beginning at 5:26.
Obtain Web3 Webhooks
With the above stream created, you’ll be capable to begin receiving Web3 webhooks robotically. To see this in motion, be certain that to observe the video under (9:12) and execute an instance donation. If you wish to do that, you’ll want a MetaMask extension and a few take a look at MATIC, which you will get utilizing the Polygon faucet. Basically, you’ll get to execute the identical steps as introduced within the above demonstration.
Because you haven’t arrange automated Web3 notification emails but, you’ll solely view the ends in your terminal. Nonetheless, you’ll see that you simply get all the data you want. Therefore, you solely must set off “e mail sending” and embody the specified particulars (donor’s handle and donated quantity) in these notification emails.
At 11:57 of the video, you can too learn to pause your streams whereas nonetheless growing your dapp:
Automate Emails: The Setup of Automated Web3 Notification Emails
To finish the ultimate stage of right now’s tutorial, it’s worthwhile to refocus on the “backend.py” script. First, it’s worthwhile to import “EmailMessage“, “ssl“, and “smtlib” on the prime. Subsequent, you could initialize some key variables. Finally, that is how the highest twelve strains of “backend.py” ought to seem like:
from flask import Flask
from flask import request
from flask import jsonify
from flask_cors import CORS
from e mail.message import EmailMessage
import ssl
import smtplib
emailPass = “”
e mail = “”
emailReceiver = “”
topic=”New Donation”
Trying on the strains of code above, you may see that it’s worthwhile to present your e mail handle subsequent to “e mail” and “emailReceiver”, like so:
In fact, you could possibly ship notification emails to any e mail handle (or checklist of addresses) you need. Nonetheless, be certain that to make use of the video under, beginning at 13:13, and learn to get hold of your “emailPass” from Gmail.
Lastly, it’s time so as to add the mandatory strains of code inside “@app.route”:
@app.route(‘/streams’, strategies=[“POST”])
def streams():
if (request.json[‘confirmed’]):
return jsonify(success=True)
particulars = request.json[“txs”]
for donation in particulars:
quantity = int(donation[‘value’])/1000000000000000000
em = EmailMessage()
em[‘From’] = e mail
em[‘To’] = emailReceiver
em[‘Subject’] = topic
em.set_content(donation[‘fromAddress’] + ” has simply despatched you ” + str(quantity) + ” in MATIC!”)
context = ssl.create_default_context()
with smtplib.SMTP_SSL(‘smtp.gmail.com’, 465, context=context) as smtp:
smtp.login(e mail, emailPass)
smtp.sendmail(e mail, emailReceiver, em.as_string())
print(“Electronic mail Despatched”)
return jsonify(success=True)
Once more, we advocate you utilize the video under for a extra detailed code walkthrough. Furthermore, you may entry the ultimate code on GitHub. Final however not least, right here’s the video tutorial containing all the main points required to efficiently arrange automated Web3 notification emails:
The way to Set Up Automated Web3 Notification Emails with Python – Abstract
We lined fairly a distance in right now’s article. Beginning with the fundamentals, we answered the “what’s Python and Flask?” query. Then, we dove proper into the method of organising automated Web3 notification emails. As such, you noticed that an e mail is shipped informing us about that on-chain occasion as quickly as an on-chain transaction is executed. Lastly, we additionally took you thru the 4 primary levels it’s worthwhile to full to arrange automated Web3 notification emails. In consequence, you now know simply take heed to good contract occasions and be sure that these occasions set off notification emails.
If , use the Web3 Python SDK documentation, our blockchain-development movies, and our crypto weblog to increase your data of blockchain growth additional. These retailers give you numerous tutorials and blockchain growth matters. For example, among the newest articles cowl Web3 Python growth, blockchain infrastructure firms, blockchain infrastructure as a service, and far more. Plus, the weblog additionally covers newly launched blockchain networks. With newly launched blockchain networks, many are questioning if one other chain will push Ethereum off the leaderboard amongst programmable blockchains. In case you are a kind of, try our articles exploring the Palm community and the next-gen L2 blockchain for Ethereum – Optimism. You may as well enroll in Moralis Academy to develop into blockchain licensed. You can begin with blockchain fundamentals on the academy or deal with extra superior programs, equivalent to Ethereum dapp programming.
