Overview

Shinami APIs generally use the JSON-RPC 2.0 standard, with the exception of Aptos Fullnode REST and Indexer GraphQL APIs. HTTP and JSON-RPC error codes you may receive when interacting with our services are listed below, along with service-specific errors. We have a lot of helpful content below, but if you don't find an answer to your question you can reach out to us.

General Error Codes

HTTP Errors

All of our services return standard HTTP codes including (but not limited to):

JSON-RPC Errors

For JSON-RPC errors, Shinami returns HTTP 200 with the JSON-RPC error in the JSON response. Common errors across our services include:

Other Errors

You may see the following errors when using our Shinami Clients SDK.

Aptos: Service-Specific Error Codes

Aptos Full node REST API

Our Aptos Full node REST API returns standard HTTP codes as mentioned above. Full node error responses will often also include Aptos errors, which can be found here. Read more about Aptos Errors, including possible vm_error cases in this doc. Make sure to check for all error codes and messages returned so that you have a better sense of the issue and how to resolve it.

Aptos REST API specific errors

Note: you may see additional errors beyond what's listed below.

Example error response

Here is an example of a partial error response where an invalid signature is used when submitting a transaction. You can see that the HTTP status is a 400 because it's a client-side error for submitting an invalid request. We also see a vm_error for an INVALID_SIGNATURE.

{ 
  ...
  status: 400,
  statusText: 'Bad Request',
  data: {
    message: 'Invalid transaction: Type: Validation Code: INVALID_SIGNATURE',
    error_code: 'vm_error',
    vm_error_code: 1
  },

Aptos Indexer GraphQL API

Our Aptos Indexer GraphQL API returns standard HTTP codes. A response that contains one or more GraphQL errors is considered a successful response and will have a HTTP 200 status code. Responses will contain GraphQL errors if any of the operations you provided ran into an issue.

Example error response

Here is an example of a partial error response where a current_coin_balances operation's selection set included a field that does not exist, called this_field_does_not_exist). Note that only the message field is required -extensions may or may not be present on an error; and, if present, may or may not contain a path or code field.

// The query
await aptosClient.queryIndexer({
  query: {
    query: `query MyQuery {
              current_coin_balances(limit: 10, where: {owner_address: {_eq: "0x239589c5cfb0cc96f76fa59165a7cbb6ef99ad50d0acc34cf3a2585d861511be"}}) {
              coin_type
              amount
              this_field_does_not_exist
            }
          }`
  }
});

// The partial error response:
...
  status: 200,
  statusText: 'OK',
  data: {
    errors: [
      {
        message: "field 'this_field_does_not_exist' not found in type: 'current_coin_balances'",
        extensions: {
          path: '$.selectionSet.current_coin_balances.selectionSet.this_field_does_not_exist',
          code: 'validation-failed'
        }
      }
    ]
  },
...

Aptos Gas Station API

In addition to the general error codes listed above, the following codes are returned by our Gas Station API. Note: you may see additional errors beyond what's listed below.

JSON-RPC errors

Other errors

Aptos Invisible Wallet API

In addition to the general error codes listed above, the following codes are returned by our Invisible Wallet API. Invisible Wallet requests that require an access key with Gas Station rights can also return any of the Aptos Gas Station errors, as we'll propagate those back to you if there is a Gas Station error as a part of processing your request.

Note: you may see additional errors beyond what's listed below.

JSON-RPC errors

Example JSON-RPC Errors

Below are two example requests and their assocaited JSON-RPC error responses, one using cURL and one using our Shinami Clients TypeScript SDK.

Replace all instances of {{name}} with the actual value for that name

curl https://api.shinami.com/aptos/gas/v1 \
-X POST \
-H 'X-API-Key: {{gasStationAccessKey}}' \
-H 'Content-Type: application/json' \
-d '{
        "jsonrpc":"2.0",
        "method":"getAMilkshakeAndFries",
        "params":[
            "0x397020433ff4fd6446d9ac73b7d3fb210840168e6bfe146d1bbea21ff5b425cf00000000000000000075a11ceb0b0600000007010002030206040802050a0707110c081d20063d0a0000000101020100000001030106090000056465627567057072696e74000000000000000000000000000000000000000000000000000000000000000103080100000000000000000000070b000700160c010e013800020001010100000000000000400d03000000000064000000000000005ee543660000000002"
        ],
        "id":1
}'


// Response:
{
   "error" : {
      "code" : -32601,
      "message" : "Method not found"
   },
   "id" : 1,
   "jsonrpc" : "2.0"
}

import { GasStationClient } from "@shinami/clients/aptos";
const gasStationClient = new GasStationClient("{{gasStationAccessKey}}");

const transaction = // build a tranasaction where 
                    // transaction.rawTransaction.expiration_timestamp_secs 
                    // is set in the past, or more than an hour in the future

await gasStationClient.sponsorTransaction(transaction);

// Response:
JSONRPCError: Invalid params
    at new JSONRPCError ... {
  code: -32602,
  data: { details: 'expirationTimestampSecs out of range' }

Sui: Service-Specific Error Codes

Sui Node Service: JSON-RPC API

In addition to the general error codes listed above, the following codes are returned by our Sui JSON_RPC API. Note: you may see additional errors beyond what's listed below.

Sui Node Service: WebSocket API (deprecated)

Note: websocket service is being retired by Mysten very soon. See the note at the top of the API doc.

In addition to the general error codes listed above, the following codes are returned by our WebSocket API. Note: you may see additional errors beyond what's listed below.

HTTP Codes

This is the one Shinami service that returns HTTP 429 for rate-limit errors. It connotes that you cannot create additional connections to the service because you have reached your maximum allowed.

JSON-RPC Errors

Sui Gas Station API

In addition to the general error codes listed above, the following codes are returned by our Gas Station API. Note: you may see additional errors beyond what's listed below.

JSON-RPC errors

Other errors

Sui Invisible Wallet API

In addition to the general error codes listed above, the following codes are returned by our Invisible Wallet API. Invisible Wallet requests that require an access key with Gas Station rights can also return any of the Sui Gas Station errors, as we'll propagate those back to you if there is a Gas Station error as a part of processing your request.

Note: you may see additional errors beyond what's listed below.

JSON-RPC errors

Sui zkLogin wallet API

In addition to the general error codes listed above, the following codes are returned by our zkLogin wallet API. Note: you may see additional errors beyond what's listed below.

JSON-RPC errors

Example JSON-RPC errors

Below are two example JSON-RPC error responses - one using cURL and one using our Shinami Clients TypeScript SDK.
Replace all instances of {{name}} with the actual value for that name

// Here, we've mistyped the name of the suix_getReferenceGasPrice method
curl https://api.shinami.com/node/v1 \
-X POST \
-H 'X-API-Key: {{nodeServiceAccessKey}}' \
-H 'Content-Type: application/json' \
-d '{ 
        "jsonrpc":"2.0", 
        "method":"getAMilkshakeAndFries", 
        "params":[], 
        "id":1
    }'

// Response:
{
   "error" : {
      "code" : -32601,
      "message" : "Method not found"
   },
   "id" : 1,
   "jsonrpc" : "2.0"
}

// Here, we are making a request to Shinami Gas Station for transaction 
//  sponsorship with a value of 1 MIST. This is too low to have a chance 
//  of success, so we get a -32602 Invalid params error
import { GasStationClient } from "@shinami/clients/sui";

const gasClient = new GasStationClient({{gasStationAccessKey}});

await gasClient.sponsorTransaction(
  {{transactionToSponsor}},
  {{senderAddress}},
  1 // 1 MIST 
);

// Response:
JSONRPCError: Invalid params
    at new JSONRPCError... {
  code: -32602,
  data: { details: 'gasBudget: 1 out of range' }
}