In case you are questioning methods to arrange automated Web3 notification emails however need assistance determining the place to begin, this text is for you! Even if you happen to’re an entire newbie in blockchain improvement, we’ll aid you catch up. In any case, we’ll begin by explaining what Python and Flask are. As soon as we be sure you’re all in control, 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 software if you wish to create decentralized functions (dapps) shortly 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 a part of the Web3 revolution utilizing the legacy instruments you’re acquainted with. Whereas we’ll give attention to utilizing Python on this article, Moralis helps all main legacy dev platforms, frameworks, and languages. Primarily, Moralis allows you to construct quicker and smarter with APIs that bridge the event hole between Web2 and Web3.
Apart from its Streams API, which we’ll use to arrange automated Web3 notification emails, Moralis presents a full scope of Web3 APIs. This contains the last word NFT API, Web3 Auth API, Token API, and extra. So, create your free Moralis account and comply with our lead!
What’s Python and Flask?
Python is a transparent and highly effective object-oriented programming language. In some ways, it’s secure to match Python to a number of different coding languages. These embody Ruby, Scheme, Perl, and Java.
It’s value declaring that Python isn’t as well-liked and as extensively used as JavaScript. Nevertheless, it’s nonetheless among the many main programming languages, and Python has a protracted historical past. In any case, it first appeared on the scene again in 1991, because of its developer Guido van Rossum. The principle purpose of Python was to make issues as easy as attainable for builders. Primarily based on the opinions of those that know and use this language, Python is somewhat simple to get began with, study, and straightforward to make use of. Nonetheless, as “python.org” places it, Python is a programming language that permits you to work shortly and combine programs extra successfully.
Flask is an internet framework, a Python module that permits you to develop internet 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. As an example, it contains URL routing and a template engine. As well as, notice that Flask is an internet server gateway interface (WSGI) internet app framework. Furthermore, this Python framework was developed by Armin Ronacher, who led Poocco – a crew of worldwide Python fans. Therefore, it’s not shocking that Flask is predicated on two different Poocco initiatives – the Werkzeg WSGI toolkit and the Jinja2 template engine.
Set Up Automated Web3 Notification Emails with Python and Moralis’ Streams API – Instance Challenge
Now that you recognize what Python and Flask are, it’s time we present you the automated Web3 notification e mail setup course of. Nevertheless, we consider it is just truthful if you happen to first see the tip results of utilizing Python and Moralis for this goal. Therefore, let’s do a fast demo of our instance backend dapp earlier than illustrating methods to arrange automated Web3 notification emails!
Setup of Automated Web3 Notification Emails – Demo
To reveal 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 take 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 sensible contract lives. As you might know, blockchain explorers additionally allow you to work together with deployed sensible contracts. Therefore, we open the web page for our instance sensible contract’s handle and choose the “Write Contract” possibility contained in the “Contract” tab:
Then, as you’ll be able to see within the above screenshot, we enter “2” (this could possibly be any quantity our steadiness can cowl) within the “newDonation” discipline and hit the “Write” button. This button triggers our MetaMask extension, which is related to the Polygon Mumbai testnet. As you’ll be able to see above, we have to verify 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 will 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’ll be able to 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).
In case you’d prefer to arrange this type of e mail notification automation for on-chain occasions, make certain to roll up your sleeves and comply with our lead all through the sections beneath.
The best way to Set Up Automated Web3 Notification Emails with Python and Moralis’ Streams API – Step-by-Step Tutorial
On this a part of as we speak’s article, you’ll have an opportunity to comply with our lead as we information you thru the next 4 levels:
- Set Up Flask
- Preliminary Setup of Moralis and the Streams API
- Obtain Web3 Webhooks
- Automate Emails
We’ll offer you screenshots that will help you correctly full every of the above 4 levels. Nevertheless, on the backside of this text, you may as well discover a detailed video tutorial on methods to arrange automated Web3 notification emails. Notice that we’ll often check with particular timestamps of that video transferring ahead.
Set Up Flask
For readability, we encourage you to comply with 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 setting 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 setting, it’s best to see “(venv)” in your terminal:
Along with your digital setting working, proceed by putting in the most recent 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 at liberty to name it as you please. Nevertheless, to keep away from any confusion, it may be safer to make use of the identical identify as we – “backend.py”:
Then, import a pattern Flask app utilizing the next traces 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 contains an endpoint you should use as a webhook URL. As such, you’ll be able to 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). Nevertheless, first, it’s essential 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 should use the hyperlink acknowledged on the outset or click on on the “Begin for Free” button on Moralis’ homepage:
Along with your Moralis account prepared, you’ll be capable of entry your admin space. There, you’ll need to choose the “Streams” tab from the aspect 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 out one of many stream templates or create one from scratch, which is what we’ll do to arrange automated Web3 notification emails. Therefore, make certain to click on on the “Create From Scratch” button:
Subsequent, you’ll must enter the main points for the sensible contract in query. In fact, you should use any sensible contract you would like. Nevertheless, for the sake of this instance mission, we advocate you give attention to the above-presented “donationExample” sensible contract (4:39). You’ll be able to get hold of all the main points concerning this sensible contract by utilizing the above-seen PolygonScan web page. On the high, it’s essential paste the contract’s handle:
As you’ll be able to see above, you additionally want to provide your stream an outline. Then, you additionally want to offer your webhook URL, add a tag, and choose networks. With all the main points in place, you’ll be capable of hit the “Create Stream” button. For extra particulars, use the video beneath, beginning at 5:26.
Obtain Web3 Webhooks
With the above stream created, you’ll be capable of begin receiving Web3 webhooks mechanically. To see this in motion, make certain to comply with the video beneath (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 may get utilizing the Polygon faucet. Primarily, you’ll get to execute the identical steps as offered within the above demonstration.
Because you haven’t arrange automated Web3 notification emails but, you’ll solely view the leads to your terminal. Nevertheless, 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 may as well learn to pause your streams whereas nonetheless creating your dapp:
Automate Emails: The Setup of Automated Web3 Notification Emails
To finish the ultimate stage of as we speak’s tutorial, it’s essential refocus on the “backend.py” script. First, it’s essential import “EmailMessage“, “ssl“, and “smtlib” on the high. Subsequent, you will need to initialize some key variables. In the end, that is how the highest twelve traces of “backend.py” ought to appear to be:
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 traces of code above, you’ll be able to see that it’s essential 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 record of addresses) you need. Nonetheless, make certain to make use of the video beneath, beginning at 13:13, and learn to get hold of your “emailPass” from Gmail.
Lastly, it’s time so as to add the required traces 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 employ the video beneath for a extra detailed code walkthrough. Furthermore, you’ll be able to 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 best way to Set Up Automated Web3 Notification Emails with Python – Abstract
We lined fairly a distance in as we speak’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 principal levels it’s essential full to arrange automated Web3 notification emails. Because of this, you now know methods to simply hearken to sensible contract occasions and make sure that these occasions set off notification emails.
If , use the Web3 Python SDK documentation, our blockchain-development movies, and our crypto weblog to develop your information of blockchain improvement additional. These shops offer you numerous tutorials and blockchain improvement matters. As an example, a number of the newest articles cowl Web3 Python improvement, blockchain infrastructure firms, blockchain infrastructure as a service, and rather 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, take a look at our articles exploring the Palm community and the next-gen L2 blockchain for Ethereum – Optimism. You can even enroll in Moralis Academy to grow to be blockchain licensed. You can begin with blockchain fundamentals on the academy or give attention to extra superior programs, resembling Ethereum dapp programming.