Class: PaymasterInterface
Implemented by
Constructors
constructor
• new PaymasterInterface(): PaymasterInterface
Returns
Properties
nodeUrl
• Abstract nodeUrl: string
Defined in
headers
• Abstract headers: object
Defined in
baseFetch
• Readonly Abstract baseFetch: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>
Type declaration
▸ (input, init?): Promise<Response>
Parameters
| Name | Type |
|---|---|
input | RequestInfo | URL |
init? | RequestInit |
Returns
Promise<Response>
Defined in
Methods
isAvailable
▸ isAvailable(): Promise<boolean>
Returns the status of the paymaster service
Returns
Promise<boolean>
If the paymaster service is correctly functioning, return true. Else, return false
Defined in
buildTransaction
▸ buildTransaction(transaction, parameters): Promise<PreparedTransaction>
Receives the transaction the user wants to execute. Returns the typed data along with the estimated gas cost and the maximum gas cost suggested to ensure execution
Parameters
| Name | Type | Description |
|---|---|---|
transaction | UserTransaction | Transaction to be executed by the paymaster |
parameters | ExecutionParameters | Execution parameters to be used when executing the transaction |
Returns
Promise<PreparedTransaction>
The transaction data required for execution along with an estimation of the fee
Defined in
executeTransaction
▸ executeTransaction(transaction, parameters): Promise<ExecuteResponse>
Sends the signed typed data to the paymaster service for execution
Parameters
| Name | Type | Description |
|---|---|---|
transaction | ExecutableUserTransaction | Typed data build by calling paymaster_buildTransaction signed by the user to be executed by the paymaster service |
parameters | ExecutionParameters | Execution parameters to be used when executing the transaction |
Returns
Promise<ExecuteResponse>
The hash of the transaction broadcasted by the paymaster and the tracking ID corresponding to the user execute request
Defined in
getSupportedTokens
▸ getSupportedTokens(): Promise<TokenData[]>
Get a list of the tokens that the paymaster supports, together with their prices in STRK
Returns
Promise<TokenData[]>
An array of token data