Skip to content

Commit 2fbad80

Browse files
authored
updated web3-api to engine everywhere for docker & readme (#138)
1 parent 39f1ab9 commit 2fbad80

File tree

10 files changed

+16
-16
lines changed

10 files changed

+16
-16
lines changed

.github/aws_kms_how_to.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Web3-API supports AWS KMS for signing & sending transactions over any EVM chain. This is a guide on how to set up AWS KMS for Web3-API.
1+
Thirdweb Engine supports AWS KMS for signing & sending transactions over any EVM chain. This is a guide on how to set up AWS KMS.
22

33
### Steps to set up AWS KMS
44

.github/google_kms_how_to.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Web3-API supports Google KMS for signing & sending transactions over any EVM chain. This is a guide on how to set up Google KMS for Web3-API.
1+
Thirdweb Engine supports Google KMS for signing & sending transactions over any EVM chain. This is a guide on how to set up Google KMS for.
22

33
### Steps to set up Google KMS
44

@@ -19,7 +19,7 @@ Cloud KMS CryptoKey Signer/Verifier
1919

2020
Optional: Create a key in the keyring, see [here](https://cloud.google.com/kms/docs/create-key) for more details. or, you can use the `/wallet/create` to create a key in the keyring.
2121

22-
### Set up Web3-API with Google KMS
22+
### Set up with Google KMS
2323

2424
Create a `.env` file in the root directory of the project and add the below details.
2525

.github/websocket_usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ For listening for updates on your requests, you can either poll using the `get`
1414
- `<host>`: Hostname of the server
1515
- `<port>`: Port of the server
1616
- `<queueId>`: Queue ID of the request
17-
- `<w3a_thirdweb_secret_key>`: Web3-API Thirdweb secret key
17+
- `<thirdweb_api_secret_key>`: Thirdweb api secret key
1818

1919
```js
2020
const socket = new WebSocket(
21-
"ws://<host>:<port>/transaction/status/<queueId>?token=<w3a_thirdweb_secret_key>",
21+
"ws://<host>:<port>/transaction/status/<queueId>?token=<thirdweb_api_secret_key>",
2222
);
2323

2424
socket.onopen = (event) => {

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ jobs:
3232
target: prod
3333
platforms: linux/amd64,linux/arm64
3434
push: true
35-
tags: thirdweb/web3-api:nightly
35+
tags: thirdweb/engine:nightly

.github/workflows/promote.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ jobs:
3030
target: prod
3131
platforms: linux/amd64,linux/arm64
3232
push: true
33-
tags: thirdweb/web3-api:latest
33+
tags: thirdweb/engine:latest

.github/workflows/tagBasedImageBuild.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ jobs:
2828
target: prod
2929
platforms: linux/amd64,linux/arm64
3030
push: true
31-
tags: thirdweb/web3-api:${{ github.ref_name }} # Set the docker tag to the Git tag name
31+
tags: thirdweb/engine:${{ github.ref_name }} # Set the docker tag to the Git tag name

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Set these variables in the .env file (copy .env.example to get started)
6767
Docker
6868

6969
```
70-
docker run -e .env -p 3005:3005 thirdweb/web3-api
70+
docker run -e .env -p 3005:3005 thirdweb/engine:latest
7171
```
7272

7373
### Using the server

docker-compose-prod.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
version: '3.8'
1+
version: "3.8"
22
services:
3-
web3-api:
3+
engine:
44
build:
55
context: .
66
target: prod
7-
image: thirdweb/web3-api:0.1.0
7+
image: thirdweb/engine:0.1.0

docker-compose.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ services:
2020
volumes:
2121
- pgadmin:/var/lib/pgadmin
2222

23-
web3-api:
23+
engine-api:
2424
build:
2525
dockerfile: Dockerfile
2626
context: .
@@ -31,7 +31,7 @@ services:
3131
- ./:/app
3232
- node_modules:/app/node_modules
3333

34-
web3-worker:
34+
engine-worker:
3535
build:
3636
dockerfile: Dockerfile
3737
context: .

docs/UserGuide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ For updates on your requests, you can either poll using the `get` (`/tranasction
8080
3. Run the below command
8181
<br />
8282
```
83-
docker run -e .env -p 3005:3005 thirdweb/web3-api:nightly
84-
# check other images at https://hub.docker.com/r/thirdweb/web3-api/tags
83+
docker run -e .env -p 3005:3005 thirdweb/engine:nightly
84+
# check other images at https://hub.docker.com/r/thirdweb/engine/tags
8585
```
8686

8787
### Note:

0 commit comments

Comments
 (0)