docs: document Paymaster for gasless transactions #4499
Conversation
Added Paymaster functionality for gasless transactions, including configuration details, use cases, and best practices. Signed-off-by: Keith Kowal <keith.kowal@hashgraph.com>
Reccetech
requested review from
arianejasuwienas,
jeromy-cannon and
konstantinabl
quiet-node
added
the
internal
quiet-node
changed the title
| | ---------- | ------------ | ---- | -------- | | ||
| | PAYMASTER_ENABLED | Enables Paymaster functionality. | Boolean | false | | ||
| | PAYMASTER_WHITELIST | Whitelisted addresses eligible for sponsorship. Use `*` for all. | String | "" | | ||
| | MAX_GAS_ALLOWANCE_HBAR | Max HBAR subsidy per transaction. | Decimal | 0 | |
There was a problem hiding this comment.
Regarding the codebase https://github.com/hiero-ledger/hiero-json-rpc-relay/blob/main/packages/relay/src/lib/clients/sdkClient.ts#L182, this is not a decimal. Here is the official doc https://docs.hedera.com/hedera/sdks-and-apis/sdks/smart-contracts/ethereum-transaction.
This value is denominated in tinybars, and yeah, the config name is a little bit misleading.
| # Demo / testnet | ||
| PAYMASTER_ENABLED=true | ||
| PAYMASTER_WHITELIST=* | ||
| MAX_GAS_ALLOWANCE_HBAR=0.15 |
| ``` | ||
| --- | ||
|
|
||
| ## Paymaster (Gasless Transactions) |
There was a problem hiding this comment.
Since Paymaster is still in the experimental stage, could you please add a short disclaimer section to mention that?
There was a problem hiding this comment.
What is meant by experimental? Isn't it deployed and anyone deploying their own JSON-RPC relay can use it?
There was a problem hiding this comment.
Hey Keith sorry for the late response. So by experimental I meant that the Paymaster was implemented based on a POC and hasn’t gone through a full acceptance criteria review yet. It was built for a specific experimental use case requested previously, and only validated against successful (“happy path”) scenarios, not failure cases. So it might be unstable or prone to failure for now. That's why we should put a disclaimer for the section.
4 participants
Added Paymaster functionality for gasless transactions, including configuration details, use cases, and best practices.
Fixes: #4477