Skip to content

Commit e06cc9b

Browse files
committed
chore: New Engine Docs link, add some AA issues to troubleshooting guide (#4982)
<!-- start pr-codex --> ## PR-Codex overview This PR updates the API documentation links throughout the application to point to the new `thirdweb-engine.apidocumentation.com` URLs, ensuring that users access the correct and up-to-date API references. ### Detailed summary - Updated `API Reference` link in `sidebar.tsx`. - Changed API reference links in `page.mdx` files for: - `See API reference` section. - `Update Chain Configuration` instructions. - `Cancel Transaction` references. - `Contract Subscriptions` references. - `Retry Transaction` and `Cancel` instructions. - `Reset Nonce` instructions. - Added new content regarding `UserOps` and error handling. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex -->
1 parent ec53366 commit e06cc9b

File tree

6 files changed

+37
-12
lines changed

6 files changed

+37
-12
lines changed

apps/portal/src/app/engine/faq/page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Here's an example of a 2-hour timeout:
109109

110110
### How do I customize my RPC?
111111

112-
Use [Update Chain Configuration](https://redocly.github.io/redoc/?url=https://demo.web3api.thirdweb.com/json#tag/Configuration/operation/updateChainsConfiguration) to override a chain's settings.
112+
Use [Update Chain Configuration](https://thirdweb-engine.apidocumentation.com/reference#tag/configuration/POST/configuration/chains) to override a chain's settings.
113113

114114
**Example**
115115

apps/portal/src/app/engine/features/cancelling-transactions/page.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ When Engine receives a cancellation request:
2424

2525
**When canceled, the transaction will not be re-attempted.** Your backend may safely re-attempt this transaction.
2626

27-
_Note: Use [Retry Transaction](https://redocly.github.io/redoc/?url=https://demo.web3api.thirdweb.com/json#tag/Transaction/operation/retry) instead to increase the gas settings for a queued transaction._
28-
2927
## Cancel a transaction from the API
3028

3129
```typescript
@@ -44,7 +42,7 @@ if (resp.status === 200) {
4442
}
4543
```
4644

47-
Reference: [`Cancel Transaction`](https://redocly.github.io/redoc/?url=https://demo.web3api.thirdweb.com/json#tag/Transaction/operation/cancel)
45+
Reference: [`Cancel Transaction`](https://thirdweb-engine.apidocumentation.com/reference#tag/transaction/POST/transaction/cancel)
4846

4947
## Cancel a transaction from the dashboard
5048

apps/portal/src/app/engine/features/contract-subscriptions/page.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,15 @@ Your app may trigger an action when an onchain event occurs, such as:
3838
1. Select **Add Contract Subscription**.
3939
1. Provide a webhook URL.
4040

41-
API reference: [`POST /contract-subscriptions/add`](https://redocly.github.io/redoc/?url=https://demo.web3api.thirdweb.com/json#tag/Contract-Subscriptions/operation/addContractSubscription)
41+
API reference: [`POST /contract-subscriptions/add`](https://thirdweb-engine.apidocumentation.com/reference#tag/contract-subscriptions/POST/contract-subscriptions/add)
4242

4343
#### Remove a Contract Subscription
4444

4545
1. Navigate to the [thirdweb dashboard](https://thirdweb.com/dashboard/engine).
4646
1. Select **Contract Subscriptions**.
4747
1. Select **... > Remove** next to an existing subscription.
4848

49-
API reference: [`POST /contract-subscriptions/remove`](https://redocly.github.io/redoc/?url=https://demo.web3api.thirdweb.com/json#tag/Contract-Subscriptions/operation/removeContractSubscription)
49+
API reference: [`POST /contract-subscriptions/remove`](https://thirdweb-engine.apidocumentation.com/reference#tag/contract-subscriptions/POST/contract-subscriptions/remove)
5050

5151
## Handling webhooks
5252

apps/portal/src/app/engine/features/contracts/page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ This is the request body to call the second function:
6767

6868
</Details>
6969

70-
[See API reference](https://redocly.github.io/redoc/?url=https://demo.web3api.thirdweb.com/json#tag/Contract/operation/write)
70+
[See API reference](https://thirdweb-engine.apidocumentation.com/reference#tag/contract/POST/contract/{chain}/{contractAddress}/write)
7171

7272
### Call a payable method
7373

apps/portal/src/app/engine/sidebar.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ export const sidebar: SideBar = {
8787
},
8888
{
8989
name: "API Reference",
90-
href: "https://redocly.github.io/redoc/?url=https://demo.web3api.thirdweb.com/json",
90+
href: "https://thirdweb-engine.apidocumentation.com/",
9191
},
9292
{
9393
name: "Typescript SDK",

apps/portal/src/app/engine/troubleshooting/page.mdx

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ Engine automatically manages nonces so this error typically should not occur.
6060

6161
It's possible the transactions are not being accepted by the mempool. To remediate this issue, you can retry a transaction, cancel it, or reset all backend wallet nonces.
6262

63-
To retry a transaction, use [`POST /transaction/sync-retry`](https://redocly.github.io/redoc/?url=https://demo.web3api.thirdweb.com/json#tag/Transaction/operation/syncRetry) and provide the `queueId`. You may also provide a higher gas value to increase the likelihood of the transaction being mined.
63+
To retry a transaction, use [`POST /transaction/sync-retry`](https://thirdweb-engine.apidocumentation.com/reference#tag/transaction/POST/transaction/sync-retry) and provide the `queueId`. You may also provide a higher gas value to increase the likelihood of the transaction being mined.
6464

65-
To cancel a transaction, use [`POST /transaction/cancel`](https://redocly.github.io/redoc/?url=https://demo.web3api.thirdweb.com/json#tag/Transaction/operation/cancel) and provide the `queueId`.
65+
To cancel a transaction, use [`POST /transaction/cancel`](https://thirdweb-engine.apidocumentation.com/reference#tag/transaction/POST/transaction/cancel) and provide the `queueId`.
6666

6767

6868
<Callout
@@ -72,7 +72,7 @@ To cancel a transaction, use [`POST /transaction/cancel`](https://redocly.github
7272
Transactions that were sent but not yet mined may fail because new transactions will use the same nonce values as previously sent transactions.
7373
</Callout>
7474

75-
To reset the nonce, use [`POST /backend-wallet/reset-nonce`](https://redocly.github.io/redoc/?url=https://demo.web3api.thirdweb.com/json#tag/Backend-Wallet/operation/resetNonces) to sync the Engine nonce with the onchain value. This step resets all nonce values tracked in Engine, and the next sent transaction will use the next available onchain nonce.
75+
To reset the nonce for all backend wallets, use [`POST /backend-wallet/reset-nonce`](https://thirdweb-engine.apidocumentation.com/reference#tag/backend-wallet/POST/backend-wallet/reset-nonces) to force-sync the Engine nonces with the onchain values.
7676

7777
### Received "Insufficient funds for gas * price + value" error
7878

@@ -93,4 +93,31 @@ Even though the transaction is expected to consume less gas, the transaction wil
9393

9494
**How to resolve**
9595

96-
Add more funds to your backend wallet. Or wait until the gas fees on the chain are lower and try again.
96+
Add more funds to your backend wallet. Or wait until the gas fees on the chain are lower and try again.
97+
98+
## Sending UserOps
99+
100+
UserOps are **User Op**erations sent by a backend wallet on behalf of smart accounts, used in the Account Abstraction pattern.
101+
102+
### Received "Invalid UserOperation signature or paymaster signature" error
103+
104+
*Also known as: code -32507*
105+
106+
**What it means**
107+
108+
The backend wallet you are sending the transaction with does not have sufficient permissions to send a userOp for this account address.
109+
110+
**How to resolve**
111+
112+
Confirm if the backend wallet is a valid admin for this account.
113+
If you are using Session Keys, confirm they are not close to or already expired.
114+
115+
### Received "AA21 didn’t pay prefund" error
116+
117+
**What it means**
118+
119+
Your thirdweb API key used by Engine is not properly configured to use Account Abstraction, or you have a [sponsorship rule](https://portal.thirdweb.com/connect/account-abstraction/sponsorship-rules) that has been exceeded.
120+
121+
**How to resolve**
122+
123+
Confirm if the API key is tied to an account with valid payment. Also confirm if there are any sponsorship rule for the Engine API key.

0 commit comments

Comments
 (0)