We refreshed our doc site!
Bookmarked links may have changed
Read release notesA policy is your configuration on a blockchain network for using Circle’s Gas Station. You must set up a policy to use the Gas Station on Mainnet. Here, you will configure what you are willing to sponsor on behalf of your users. Circle’s Gas Station will pay the fees if a transaction meets your configuration.
To activate a Mainnet Policy, follow these steps:
Gas Station auto-sponsors after Policy is set
When you create a policy on a chain, Circle sponsors gas fees for all accounts that meet your configuration. You do not need to pass the policy ID in each transaction request.
A policy consists of the following configurations:
Policy Name: Provide a descriptive name for the policy to identify it in the policy list. The policy name displays only in the console.
Network: Refers to the specific blockchain network where the Gas Station will cover gas fees. Each policy supports only one blockchain network, ensuring clarity and ease of management.
Default Policy: The policy sponsors gas fees for any transaction on a specific network, including wallet creation and contract execution. You can set only one default policy per network. We recommend designating this as the first policy for the specified network.
Note: Transactions use only default policies. If you want to use a non-default policy, update it to default and activate it.
Maximum spend per day* (optional): Specify the maximum allowance for gas fees in USD that you are willing to sponsor within a 24-hour period. This restriction provides control over the allocated budget for gas fee sponsorship.
Maximum spend per transaction* (optional): The maximum allowance for gas fees in USD that you are willing to sponsor for a single transaction.
Note: Maximum spend per transaction limit does not apply to the first transaction made from any Smart Contract Account (SCA) wallet. This includes SCA-type wallets as well as Console Wallets.
Maximum operations per day* (optional): The maximum number of supported operations (such as transactions) per day.
Blocked addresses (optional): A configurable list of blockchain addresses that will not receive sponsored gas fees. This feature allows you to exclude specific addresses from benefiting from gas fee coverage.
*Daily limits reset once every 24 hours at 0:00 UTC.
By leveraging these configurations within a policy, you can fine-tune the gas fee sponsorship parameters to your specific requirements and financial considerations. Note that any limits left blank will not be applied.
If you need to deactivate the Mainnet policy at any given time, it can be done conveniently from the developer console. To deactivate the Mainnet policy, follow these simple steps:
CAUTION: Deactivating a policy will stop all Mainnet transaction sponsorships and end-users wallet transactions will be rejected effectively unusable.
Following these steps, you can easily deactivate the Mainnet policy, granting you control and flexibility over the gas fee sponsorship within your application.
When it comes to using Gas Station on Testnets, the setup process is hassle-free. Circle takes care of the initial configuration by automatically generating a default policy upon signing up for an account. This default policy is specially designed for developers leveraging Programmable Wallets during the testing phase. With this default policy in place, you can seamlessly sponsor Testnet tokens while building your applications.
It's important to note the gas fee sponsorship limits applicable for different Testnet networks:
We provide a dashboard and APIs to monitor and analyze these gas sponsorship transactions.
To view gas-sponsored transactions in Testnet or Mainnet:
View sponsored transactions table: On the policy page, you will find a table view listing the transactions that have been sponsored. You also have the option to apply filters to refine the view, enabling you to focus on the relevant data that meets your specific requirements.
WHAT'S NEXT