Frequently asked questions about using Shinami's products

What's in this doc?

Frequently asked questions about Shinami's products that don't fit neatly into our other guides and tutorials. We try to include common integration questions about specific APIs in the relevant API docs. We have a lot of helpful content below, but if you don't find an answer to your question you can reach out to [email protected].

Using Gas Station

How do I create a fund?

You create Gas Station funds within the Shinami dashboard. A fund is tied to one network (Testnet, Mainnet) and you can have multiple funds per network.

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

Once your fund has been created, you can add gas credits to it by sending Sui to its address. To find your fund's address, either click the "View" button in its row in the Funds table, or click the "+ Add Gas Credits" button above the table:

Here, we clicked "View". In the modal that pops up, you will be able to see fund details and deposit history. Copy your fund wallet address and send SUI to it so you can start sponsoring transactions. When you do this the first time, a deposit address is generated. So, you need to do this at least once.

How do I use SUI from 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 pull SUI from 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. If the key has Gas Station rights, we show the fund it's connected to. You connect a Gas Station access key to a fund when you create the key .

First, click the `+` next to the key.

First, click the + next to the key.

Then find the "GAS FUND" section.

Then find the "GAS FUND" section.

How do I get free Testnet SUI?

You can get free Testnet Sui using one of the following methods and then transfer them to your Gas Station fund address.

Mysten Discord Testnet faucet

Here's an image of requesting Testnet Sui from the #testnet-faucet channel of the Mysten Discord server. - just type !faucet {{SuiAddressOfYourGasStationFund}} for 1 Sui (which might not seem like much, but gas is cheap so one SUI gets you a lot of test transactions).

Ethos Wallet Testnet faucet

Ethos wallet also has a button to request 1 SUI at a time (make sure you've selected Testnet in your settings for the wallet).

Then, you can send that SUI to your fund address:

How do I view my in-flight sponsored transactions?

On the Gas Station page of your Shinami dashboard, click on the "In flight transactions" tab:

How do I view my recently sponsored transactions?

On the Gas Station page of your Shinami dashboard, click on the "Completed transactions" tab. We show you sponsorships from the last 14 days. We show the most recent first, with a cap of 10,000. In the next section on Gas Station billing statements, we explain how to download a CSV file with all sponsored transactions from previous months if desired. The Completed transactions table has a lot of useful columns, so make sure to use the horizontal scroll bar at the bottom to see them all.

What fee does Shinami charge for sponsorships?

We charge a small fee per sponsorship, as well as a fee if your sponsorship expires at our 1 hour TTL without being used (due to non-use or an equivocation error). For full details, see the Billing page in your Shinami dashboard, click on the "Gas Station" tab, and then click the ^ next to "See how Gas Station billing works". We breakdown the fees and include examples to help make it clear. Here's the top part of the page, showing you how to find it:

How do I view my Gas Station billing statements?

On the Billing page of your Shinami dashboard, click the Gas Station tab to show the "Mainnet Statements" table. You'll find an entry for each month you've been sponsoring transactions on Mainnet. The Shinami Fees column will show 0 prior to February 2024, since we turned on Gas Station billing in the middle of that month.

We add an entry for a new month 3-4 days after it ends. You can see a summary of your total sponsorships, as well as the total Sui transaction fees and Shinami fees for those transactions. You can also download a full report for the month, which is a CSV file containing each transaction sponsorship you made.

Using Wallet Services

Should I use Invisible Wallets or zkLogin wallets for my app?

Check out our Sui Wallet Services - High-Level Guide, which compares the two!

Using Node Service and WebSockets

How can I see my requests and errors?

The Node Service page of the Shinami dashboard has metrics that break down requests and errors by request name. You can view stats for a network or an individual API access key on that network. You can also select the time period: from just the last hour all the way to the last 12 weeks. The metrics are presented in UTC.

How can I get more requests per second and lower latency?

We offer Enterprise plans that start at 400 QPS per network and can easily scale higher to accommodate your needs. We can also deploy infrastructure in your region for the quickest read latency possible (write latency may improve as well, but is dependent on validator location). If this sounds right for you, contact us at [email protected].

Which Node Service requests am I billed for?

Free plan customers are not charged for requests but have a daily request limit per network (Devnet, Testnet, Mainnet). If you hit the daily limit, all subsequent requests are rate-limited until the next day. Growth plan customers have no daily request limit and are just limited by their 200 QPS per network allotment. Growth plan customers get the same daily free allotment and are then charged for all requests above that (including all errors and all WebSocket requests). We expect your error rate to be very low, outside of heavy rate limiting. To see our daily limits and per-request pricing, and upgrade to Growth, see the Billing page of your dashboard. If you think rate limiting will be an issue for you, reach out to us at [email protected] to discuss Enterprise plans, which start at 400QPS per network and can go much higher if needed.

Errors and API Access Keys

What does this error code mean?

See our Error Reference for guidance on the general errors you may see, as well as service-specific errors.

How do I adjust my API key settings?

See our Authentication and API Keys guide for info on how to create API access keys, edit Node Service rate limits and Websocket connection and subscription limits, how to set sender domain or IP address allowlists, and how to delete or disable a access key.

Team management

How can I give another person access to my account?

Currently, we only support one user per account. So, you'll need to share the login credentials with anyone else who needs to manage your account.