@tenderly/actions-test 0.2.0 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +61 -5
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,9 +1,65 @@
|
|
|
1
|
-
# Web3 Actions Local Development
|
|
1
|
+
# Tenderly Web3 Actions Local Development
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<div align="center">
|
|
4
|
+
<a href="https://tenderly.co">
|
|
5
|
+
<img src="https://storage.googleapis.com/tenderly-public-assets/tenderly-logo-purple.png" alt="Tenderly" width="100%" height="auto" style="background-color: #ffffffb2; padding: 10px 20px; margin-bottom: 20px; box-sizing: border-box; max-width:200px;" />
|
|
6
|
+
</a>
|
|
7
|
+
</div>
|
|
4
8
|
|
|
5
|
-
|
|
9
|
+
<div align="center">
|
|
6
10
|
|
|
7
|
-
|
|
11
|
+
[](https://www.npmjs.org/package/@tenderly/actions-test)
|
|
12
|
+
[](https://twitter.com/intent/follow?screen_name=TenderlyApp)
|
|
13
|
+
[](https://github.com/Tenderly/tenderly-actions)
|
|
8
14
|
|
|
9
|
-
|
|
15
|
+
</div>
|
|
16
|
+
|
|
17
|
+
## Introduction
|
|
18
|
+
|
|
19
|
+
[Tenderly](https://tenderly.co) Web3 Actions are programmable hooks for smart contract and chain events. They can also
|
|
20
|
+
be serverless backends for your dapps. A Web3 Action is a regular TypeScript/JavaScript function that runs on Tenderly
|
|
21
|
+
infrastructure.
|
|
22
|
+
|
|
23
|
+
A Web3 Action comes with key-value storage for data you need to persist and secrets management for sensitive information
|
|
24
|
+
such as API keys. You can think of Web3 Actions as infrastructure building a Web3 version of IFTTT/Zapier automation,
|
|
25
|
+
allowing you to glue together your smart contracts, on-chain events, dapp frontends, APIs, and other services.
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
Based on the trigger rules you define, external on-chain or off-chain events will trigger your Web3 Action and your
|
|
30
|
+
TypeScript/JavaScript code will handle the event instantly.
|
|
31
|
+
|
|
32
|
+
With Web3 Actions, you can build systems that let you be timely informed about non-trivial events. This way, you can
|
|
33
|
+
improve your dapp in terms of UX and interactivity and enhance your project through the depth of information you can
|
|
34
|
+
collect or share through notifications.
|
|
35
|
+
|
|
36
|
+
> The code Web3 Actions run is called a **function**. Function must be written in TypeScript/JavaScript and runs in
|
|
37
|
+
**Node** runtime. Specification of events that your action listens to is called a **trigger**.
|
|
38
|
+
|
|
39
|
+
## Getting Started
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
yarn add -D @tenderly/actions-test
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Follow these guides to quickly get started with building Web3 Actions via the browser or command line tools.
|
|
46
|
+
|
|
47
|
+
Read our [documentation](https://docs.tenderly.co/web3-actions/intro-to-web3-actions) to get started with Tenderly Web3 Actions.
|
|
48
|
+
|
|
49
|
+
Setting up Web3 Actions requires you to write TypeScript/JavaScript code for your functions. Building your Web3 Actions
|
|
50
|
+
using Tenderly CLI includes defining triggers in a [yaml configuration file](https://docs.tenderly.co/web3-actions/references/project-structure#the-tenderly.yaml-file-structure).
|
|
51
|
+
The defined trigger and yaml configuration become an integral part of your project’s codebase.
|
|
52
|
+
|
|
53
|
+
- [Deploy Web3 Actions via Tenderly Dashboard](https://docs.tenderly.co/web3-actions/tutorials-and-quickstarts/deploy-web3-actions-via-dashboard) - Learn how to set up and deploy Web3 Actions directly in your browser.
|
|
54
|
+
- [Deploy Web3 Actions via Tenderly CLI](https://docs.tenderly.co/web3-actions/tutorials-and-quickstarts/deploy-web3-action-via-cli) - Learn how to install the Tenderly CLI, define triggers using the YAML configuration, and set up and deploy Web3 Actions through the command line.
|
|
55
|
+
- [Local Development and Testing](https://docs.tenderly.co/web3-actions/references/local-development-and-testing) - Learn how to test your Web3 Actions locally before deploying them to Tenderly.
|
|
56
|
+
|
|
57
|
+
### Supported Networks
|
|
58
|
+
|
|
59
|
+
Tenderly Web3 Actions are currently supported on the [following networks](https://docs.tenderly.co/web3-actions/references/networks).
|
|
60
|
+
|
|
61
|
+
## Contributors
|
|
62
|
+
|
|
63
|
+
<a href="https://github.com/Tenderly/tenderly-actions/graphs/contributors">
|
|
64
|
+
<img src="https://contrib.rocks/image?repo=Tenderly/tenderly-actions&max=100&columns=20" alt="tenderly-contributors" />
|
|
65
|
+
</a>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tenderly/actions-test",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
4
4
|
"description": "Helper library for testing Web3 Actions.",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"types": "lib/index.d.ts",
|
|
@@ -28,6 +28,6 @@
|
|
|
28
28
|
"typescript": "^4.4.3"
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@tenderly/actions": "^0.2.
|
|
31
|
+
"@tenderly/actions": "^0.2.2"
|
|
32
32
|
}
|
|
33
33
|
}
|