Skip to content

Commit c33c250

Browse files
authored
Update README.md with x-wallet-address, table of contents, engine (#136)
* Update README.md * Update README.md * Update README.md * Update README.md
1 parent 0ef2d20 commit c33c250

File tree

1 file changed

+36
-21
lines changed

1 file changed

+36
-21
lines changed

README.md

Lines changed: 36 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,44 +5,55 @@
55
<br />
66
</p>
77

8-
<h1 align="center"><a href='https://thirdweb.com/'>thirdweb</a> Web3-API Repo</h1>
8+
<h1 align="center"><a href='https://thirdweb.com/'>thirdweb</a> Engine</h1>
99

1010
<p align="center">
11-
<a href="https://github.com/thirdweb-dev/web3-api/actions/workflows/e2eTest.yml">
12-
<img alt="Build Status" src="https://github.com/thirdweb-dev/web3-api/actions/workflows/e2eTest.yml/badge.svg"/>
13-
</a>
1411
<a href="https://discord.gg/thirdweb">
1512
<img alt="Join our Discord!" src="https://img.shields.io/discord/834227967404146718.svg?color=7289da&label=discord&logo=discord&style=flat"/>
1613
</a>
1714
</p>
1815

19-
<p align="center"><strong>Best in class web3 SDKs for Browser, Node and Mobile apps</strong></p>
16+
<p align="center"><strong>The most powerful backend engine for web3 apps.</strong></p>
17+
18+
## Table of contents
19+
20+
- [Introduction](#introduction)
21+
- [Getting started](#getting-started)
22+
- [Setup environment variables](#setup-environment-variables)
23+
- [Run the server](#run-the-server)
24+
- [Using the server](#using-the-server)
25+
- [Local development](#local-development)
26+
- [User guide](#user-guide)
27+
- [Documentation](#api-documentation)
28+
- [Contributing](#contributing)
29+
30+
## Introduction
2031

21-
## Web3API
32+
thirdweb engine is a powerful backend service that offers all the tools needed to build apps & games on the blockchain.
2233

23-
Production-grade HTTP server that provides scalable web3 functionality:
34+
It abstracts away all the complexities of building blockchain applications behind a familiar HTTP API interface and handles high throughput & scale out-of-the box.
2435

25-
- http interface with server and client authentication
26-
- create & interface with backend web3 wallets (local, aws kms, google kms, smart wallets, etc)
27-
- automatic wallet nonce management
28-
- built in high performance transaction queueing
29-
- intelligent transaction retry and gas management
30-
- read, write and deploy any smart contract on any evm blockchain
31-
- create gasless relayers
32-
- fine grained controls over user access
33-
- run in your own cloud or managed service (coming soon)
34-
- full server-side sdks for many languages & client-side sdks for many frameworks (coming soon)
36+
Some of the best features of thirdweb engine:
3537

36-
The server is meant to facilitate blockchain transactions within your existing architecture. It provides a high performance, production grade method to interact with smart contracts on any evm blockchain. The project is still early so if you're looking for specific features, have bugs, or want to give feedback, reach out to us!
38+
- Create & transact with **managed backend wallets** ([erc-4337](https://eips.ethereum.org/EIPS/eip-4337) smart wallets, AWS KMS, Google KMS, etc.)
39+
- High reliability transaction queuing with **wallet nonce management** and **automatic transaction retrying**
40+
- Deploy and send transactions to smart contracts on any EVM blockchain
41+
- Caching and indexing for high performance onchain data access
42+
- Find-grained user access controls & wallet based client-side authentication
43+
- Full gasless relayer, bundler, and paymaster for gasless transactions [Coming Soon]
44+
- Run in your own cloud or run as a managed service [Coming Soon]
45+
- Full server & client-side SDKs for popular languages [Coming Soon]
46+
47+
This project is in `alpha` - if you're looking for specific features & or want to give feedback, reach out to us!
3748

3849
## Requirements
3950

4051
1. Docker
4152
2. PostgreSQL DB
4253

43-
## Getting Started
54+
## Getting started
4455

45-
### Set up required Environment Variables
56+
### Setup environment variables
4657

4758
Set these variables in the .env file (copy .env.example to get started)
4859

@@ -62,8 +73,12 @@ docker run -e .env -p 3005:3005 thirdweb/web3-api
6273
### Using the server
6374

6475
- In development mode, go to the server url to see an admin interface
65-
- Every request to the server requires an authentication token, for admin actions use the thirdweb SecretKey. Use the `Authorization` Header to set the value shown below:
76+
- Every request to the server requires an authentication token for admin actions use the thirdweb SecretKey. Use the `Authorization` Header to set the value shown below:
6677
- `Authorization: Bearer: <thirdweb SecretKey>`
78+
- Every write request to the server also requires the `X-Wallet-Address` header to specify which admin wallet to send a transaction with. Use the following format to set this header:
79+
80+
- `X-Wallet-Address: 0x3ecdbf3b911d0e9052b64850693888b008e18373`
81+
6782
- Contract API
6883

6984
- Read from any contract

0 commit comments

Comments
 (0)