Estimates gas for a given on-ledger ISC request

POST 
//v1/chain/estimategas-onledger

Estimates gas for a given on-ledger ISC request

Request

application/json

Bodyrequired

Request

outputBytesstringrequired

Serialized Output (Hex)

Responses

200

ReceiptResponse

application/json

Schema

Schema

blockIndexint32required

Possible values: >= 1

errorMessagestring

gasBudgetstringrequired

The gas budget (uint64 as string)

gasBurnLog BurnRecord[]required

Array [

codeint32required

gasBurnedint64required

]

gasBurnedstringrequired

The burned gas (uint64 as string)

gasFeeChargedstringrequired

The charged gas fee (uint64 as string)

rawError UnresolvedVMErrorJSON

codestring

paramsstring[]

request RequestJSONrequired

allowance AssetsJSONrequired

coins CoinJSON[]required

Array [

balancestringrequired

The balance (uint64 as string)

coinTypestringrequired

]

objects IotaObject[]required

Array [

idint32[]required

type ObjectTyperequired

sstring

]

assets AssetsJSONrequired

coins CoinJSON[]required

Array [

balancestringrequired

The balance (uint64 as string)

coinTypestringrequired

]

objects IotaObject[]required

Array [

idint32[]required

type ObjectTyperequired

sstring

]

callTarget CallTargetJSONrequired

contractHNamestringrequired

The contract name as HName (Hex)

functionHNamestringrequired

The function name as HName (Hex)

gasBudgetstringrequired

The gas budget (uint64 as string)

isEVMbooleanrequired

isOffLedgerbooleanrequired

paramsstring[]required

requestIdstringrequired

senderAccountstringrequired

requestIndexint32required

Possible values: >= 1

storageDepositChargedstringrequired

Storage deposit charged (uint64 as string)

Example (auto)

{
  "gasBurnLog": [
    {
      "code": 6,
      "gasBurned": 1
    },
    {
      "code": 6,
      "gasBurned": 1
    }
  ],
  "request": {
    "senderAccount": "senderAccount",
    "assets": {
      "coins": [
        {
          "coinType": "coinType",
          "balance": "balance"
        },
        {
          "coinType": "coinType",
          "balance": "balance"
        }
      ],
      "objects": [
        {
          "id": [
            5,
            5
          ],
          "type": {
            "s": "s"
          }
        },
        {
          "id": [
            5,
            5
          ],
          "type": {
            "s": "s"
          }
        }
      ]
    },
    "isOffLedger": true,
    "requestId": "requestId",
    "callTarget": {
      "contractHName": "contractHName",
      "functionHName": "functionHName"
    },
    "gasBudget": "gasBudget",
    "allowance": {
      "coins": [
        {
          "coinType": "coinType",
          "balance": "balance"
        },
        {
          "coinType": "coinType",
          "balance": "balance"
        }
      ],
      "objects": [
        {
          "id": [
            5,
            5
          ],
          "type": {
            "s": "s"
          }
        },
        {
          "id": [
            5,
            5
          ],
          "type": {
            "s": "s"
          }
        }
      ]
    },
    "params": [
      "params",
      "params"
    ],
    "isEVM": true
  },
  "blockIndex": 1,
  "rawError": {
    "code": "code",
    "params": [
      "params",
      "params"
    ]
  },
  "requestIndex": 1,
  "storageDepositCharged": "storageDepositCharged",
  "gasFeeCharged": "gasFeeCharged",
  "errorMessage": "errorMessage",
  "gasBudget": "gasBudget",
  "gasBurned": "gasBurned"
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "/v1/chain/estimategas-onledger");
request.Headers.Add("Accept", "application/json");
var content = new StringContent("{\n  \"outputBytes\": \"outputBytes\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

Body required

{
  "outputBytes": "outputBytes"
}

ResponseClear

Click the Send API Request button above and see the response here!