worldcoin / developer-portal

The Worldcoin Developer Portal provides tools to interact with the Worldcoin SDK. Easiest way to get started with World ID.
https://developer.worldcoin.org
MIT License
66 stars 35 forks source link

Feat: Transaction Endpoint for Mini Apps #737

Closed andy-t-wang closed 4 months ago

andy-t-wang commented 4 months ago

This endpoint is used by web2 apps to confirm the transaction was successfully mined on chain. Developers will use their api key in the dev portal in order to call this endpoint. Developers will only be able to see transaction data for apps that they own the API key for.

Developers will call this via developer.worldcoin.org/v1/minikit/transactions/transaction_id?app_id=12312. Upon successful completion this will return a singular transaction object back to the user in the form of [transaction_data]

0xPenryn commented 4 months ago

@andy-t-wang what's the reasoning behind gating tx status with an api key when the tx is publicly viewable on-chain?

andy-t-wang commented 4 months ago

@0xPenryn

We only want people using this if they are web2 apps and don't want to set up an RPC all web3 apps should just query on chain. We are emitting an event.

API Key is meant to enforce that you only query your own transactions. We don't want people using this endpoint outside of that use case since it will add load to our app-backend.

TLDR: Reduce backend load