Sui Products
Guidance and FAQ for using our products.
Note:for questions specific to billing, see our Sui Billing page.
Node Service
What API metrics does Shinami provide?
We provide a rich set of API insights in your Shinami dashboard. These include request counts, error codes, and latency over time, broken down by method. This feature pairs well with our Error Reference to help you find and address any issues with your integration.
What is QPS?
QPS: "Queries Per Second" We define this as the count of the unique HTTP requests you send per second. This is a count of all requests, including those with any kind of error (e.g. a rate-limit error).
In your Shinami dashboard, you can...
- see if you hit any QPS rate limits. Look for rate-limit error codes for (JSON-RPC
-32010
for Sui). - get an approximation of recent QPS by looking at your Node Service API Insights in the dashboard and selecting a specific access key - or all keys on a network - and the time range "Last 60 minutes". Then, take your highest bar and divide it by 60 (since each bar represents 1 minute).
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. 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. To find your fund's address, click View
in the table (or + Add Gas Credits
above it). Below, we clicked View
because 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 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 for:
What Gas Station metrics does Shinami provide?
We provide a rich set of metrics and insights for you in your Shinami dashboard. The 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.
Wallet Services
How do I migrate my existing users to Invisible Wallets?
You can easily create an Invisible Wallet for them behind the scenes. There's no need for them to go through any authentication again. When you create an Invisible Wallet, you associate a walletID
with each of your users and use that in Invisible Wallet API requests. This can be their existing userID, or another ID you tie to their userID. Just make sure a walletID
- and is associated walletSecret
- never change. The steps are:
- Generate unique (
walletID
,walletSecret
) pairs for each user. - Make an API request to create a wallet for each user.
- If you are migrating from a pre-existing embedded wallet, you can transfer the contents to their new, Invisible Wallet.
How do I view my API requests and wallet activity?
We provide "API Insights" that break down request counts, error codes, and latency by method. We also provide "Wallet Insights" that show created wallets and active wallet over time by type (e.g. Invisible Wallets). Select the "Wallet Services" page on the left nav for your chain and then choose the set of Insights you want to look at:
Updated 11 days ago