Note: for billing questions see our Sui Billing FAQ.

FAQ

How do I create a fund?

You create funds on the Sui Gas Station page of your Shinami dashboard. A fund is tied to one network (Testnet, Mainnet) and you can have up to 10 funds per network. Visit one of the pages below and click + Create fund:

How do I generate and find the deposit address of a fund?

Once your fund has been created, you can make deposits in order to start sponsoring transactions. Visit the Sui Gas Station page of your dashboard. To find your fund's address, click View in the table (or + Add Gas Credits above it). Below, we clicked Viewbecause it take you directly to the fund summary):

In the modal that pops up, you will be able to see fund details and deposit history. When you do this the first time, a deposit address is generated. So, you need to do this at least once. This is the address you will make deposits to. Your address will be different than the example shown, and will be different for each of your Gas Station funds. Click the copy button (highlighted) to copy the address.

Note: Gas Station fund deposits can only be used to sponsor transactions and cannot be withdrawn. That said, you don't need to deposit an amount that will last you for months. You can deposit a smaller amount and monitor your balance in your Shinami dashboard or via the API with our gas_getFund request. When the balance gets low, you can add enough to last another week or two (or whatever works best for you).

How do I view a fund's deposit history?

On the "funds" tab of your Sui Gas Station page, click "View" in the "Details" column next to the fund:

Then, click the "Deposit history" tab of the modal that comes up. Below, we show a brand new fund with no deposits:

How do I use a fund for sponsorship?

When you set up an API access key with Gas Station rights for a network, you link it to a fund on that network. Then, whenever you make an API request to sponsor a transaction, we use the fund linked to the API key you use. See our Authentication and API Keys guide for an example of setting up a Gas Station API access key.

How do I check which fund an access key is tied to?

On the Access Keys page of your Shinami dashboard, click on the + next to the key in the "Access keys" table to expand the key editor tray. Once you click the + it becomes a - you can use to close the tray. If the key has Gas Station rights, we show the fund it's connected to.

How do I get free Testnet funds for testing?

Here are some options.

How do I monitor my fund balance and recent spend?

Fund balance:

There are two main ways to do this:

Manually in your Shinami Dashboard on the Sui Gas Station page, by looking at the "Funds" table in the "Funds" tab. The "Gas Credits Available" column is the total amount in a fund, and the "Gas Credits in Flight" column is the portion of that being held for active sponsorships. So, the amount you can use for new sponsorships is "Gas Credits Available" - "Gas Credits in Flight"
Through the API with a gas_getFund request.

Recent spend

in your Shinami Dashboard on the Sui Gas Station page, choose the "Sponsorship Insights" tab. Make sure to choose the network and time range you prefer - for example "Sui Mainnet" + "Last 30 days". In the summary metrics at the top, you can see your "Total sponsorship cost", as well as the "Average sponsorship cost" over the time range. If you scroll down, the "Total sponsorship spend" graph, whose title is at the very bottom of the image, shows your spend over time by fund.

What Gas Station metrics does Shinami provide?

We provide a rich set of metrics and insights for you in your Shinami dashboard. The Sui Gas Station page has the following tabs:

Funds: Create and view your Gas Station funds. Generate and find their deposit addresses.
API Insights: See a break down request counts, error codes, and latency by method over time
Sponsorship Insights: See how much you're spending per fund, which can help you budget for the future. Also, see what percentage of your sponsorships are successfully used over time. A large amount of expired sponsorships could mean you need to update your sponsorship flow.
In flight transactions: See your active but unused sponsorships. Note that sponsorships can sometimes take a minute or two to show up in this list or to move out of it into the "completed transactions" list.
Completed transactions: See your sponsorships that have been used or that went unused.