You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/en/developers/guides/canvas-badge-integration.mdx
+15-7Lines changed: 15 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -152,7 +152,14 @@ Since **badges are permissionless**, Scroll Foundation may not troubleshoot indi
152
152
153
153
## Step 3 `Test`: Sanity Check
154
154
155
-
1. Please visit `https://scroll.io/canvas/badge-contract/{{badgeContractAddress}}` to ensure that the badge is functioning correctly.
155
+
1. Once your badge has been deployed on Scroll, you can auto-check some of these requirements by running `yarn check-badge`.([link to check badge script](https://github.com/scroll-tech/canvas-contracts/blob/master/script/CheckBadge.s.sol))
156
+
- If your badge minting transaction reverts, we recommend debugging using `cast`:
157
+
158
+
```bash
159
+
cast run --rpc-url https://rpc.scroll.io [txhash]
160
+
```
161
+
162
+
This call will simulate the transaction in a local environment and show you the call stack and revert reason.
156
163
- For `badgeTokenURI` link returned, ensure correct cross-origin configuration
157
164
<ToggleElementanchor="reference-cors">
158
165
<divslot="title">Reference: CORS</div>
@@ -171,11 +178,12 @@ Since **badges are permissionless**, Scroll Foundation may not troubleshoot indi
171
178
172
179
- **`scroll.io` domain**: requests originating from **`scroll.io`** are permitted.
173
180
</ToggleElement>
174
-
2. Review the information on the badge detail page: Confirm that all basic badge information and redirect links are correct and match the information you provided.
175
-
3. Verify that the check API is operational. Test it with 2-4 wallet addresses eligible/ineligible to mint this badge and confirm that the claim API is functioning properly.
176
-
4. If you have created a badge that can be upgraded, please use wallets that meet different level requirements to attempt minting it. Ideally, find at least one wallet per level requirement to ensure the badge mints correctly.
177
-
5. To maintain the availability of the check API and claim API, Scroll recommends maintaining a TPS of approximately 300. Adjust this rate accordingly if your API handles multiple badges simultaneously.
178
-
6. If your badge image is stored on IPFS, due to the distributed nature of IPFS, the request time for users in different regions to access content on IPFS can be unpredictable. If they want a better user experience, they can self-host the content.
181
+
2.**Review the information on the badge detail page**:
182
+
- Confirm that all basic badge information and redirect links are correct and match the information you provided.
183
+
- Verify that the check API is operational. Test it with 2-4 wallet addresses eligible/ineligible to mint this badge and confirm that the claim API is functioning properly.
184
+
- If you have created a badge that can be upgraded, please use wallets that meet different level requirements to attempt minting it. Ideally, find at least one wallet per level requirement to ensure the badge mints correctly.
185
+
3. To maintain the availability of the check API and claim API, Scroll recommends maintaining a TPS of approximately 300. Adjust this rate accordingly if your API handles multiple badges simultaneously.
186
+
4. If your badge image is stored on IPFS, due to the distributed nature of IPFS, the request time for users in different regions to access content on IPFS can be unpredictable. If they want a better user experience, they can self-host the content.
179
187
180
188
<Aside>
181
189
At this stage, your Badge is live on Scroll Canvas. Badge launch is permissionless. You can deploy as many badges as needed. **Scroll does not need to approve your badge deployment.**
@@ -205,7 +213,7 @@ Regularly monitor server logs to stay informed of any potential issues, especial
205
213
<divslot="title">Get listed on [Canvas & Badges](https://scroll.io/canvas-and-badges)</div>
206
214
207
215
<Aside>
208
-
You can display **all of the badges** in your own product permissionlessly. Discover Badges page serves as an additional discovery channel for your badges.
216
+
You can display **all of the badges** in your own product permissionlessly. Canvas and Badges display page serves as an additional discovery channel for your badges.
209
217
</Aside>
210
218
<Asidetype="caution">
211
219
Please be careful when submitting your application. We’re eager to introduce useful and creative badges for the Scroll ecosystem. The Scroll team is thoroughly reviewing each badge listing, which means the process might take a bit longer. Thank you for your patience.
0 commit comments