Preview

Transaction Preview

Preview a transaction against the latest network state, and returns the preview receipt.

post

/transaction/preview

Body

networkstringrequired

The logical name of the network

Example: {{network}}

at_ledger_stateobject

An optional specification of a historical ledger state at which to execute the request. The "historical state" feature (see the db.historical_substate_values.enable flag) must be enabled on the Node, and the requested point in history must be recent enough (in accordance with the Node's configured state_hash_tree.state_version_history_length).

manifeststringrequired

A text-representation of a transaction manifest

blobs_hexstring[]

An array of hex-encoded blob data (optional)

start_epoch_inclusiveinteger int64required

An integer between 0 and 10^10, marking the epoch at which the transaction starts being valid

end_epoch_exclusiveinteger int64required

An integer between 0 and 10^10, marking the epoch at which the transaction is no longer valid

notary_public_keyobject

The notary public key to use (optional)

notary_is_signatoryboolean

Whether the notary should count as a signatory (optional, default false)

tip_percentageinteger int32required

An integer between 0 and 65535, giving the validator tip as a percentage amount. A value of 1 corresponds to 1% of the fee.

nonceinteger int64required

An integer between 0 and 2^32 - 1, chosen to allow a unique intent to be created (to enable submitting an otherwise identical/duplicate intent).

signer_public_keysobject[]required

A list of public keys to be used as transaction signers

messageobject

An optional transaction message. Only affects the costing.

flagsobjectrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xrd.nownodes.io/core/transaction/preview' \
  --header 'Content-Type: application/json' \
  --data '{"network":"{{network}}","at_ledger_state":{"type":"ByStateVersion"},"manifest":"text","blobs_hex":[null],"start_epoch_inclusive":1,"end_epoch_exclusive":1,"notary_public_key":{"key_type":"EcdsaSecp256k1"},"tip_percentage":1,"nonce":1,"signer_public_keys":[{"key_type":"EcdsaSecp256k1"}],"message":{"type":"Plaintext"},"flags":{"use_free_credit":true,"assume_all_signature_proofs":true,"skip_epoch_check":true}}'

200

400

500

200

{
  "at_ledger_state": {
    "state_version": 1,
    "header_summary": {
      "epoch_round": {
        "epoch": 1,
        "round": 1
      },
      "ledger_hashes": {
        "state_tree_hash": "text",
        "transaction_tree_hash": "text",
        "receipt_tree_hash": "text"
      },
      "proposer_timestamp": {
        "unix_timestamp_ms": 1,
        "date_time": "text"
      }
    }
  },
  "encoded_receipt": "text",
  "receipt": {
    "status": "Succeeded",
    "fee_summary": {
      "execution_cost_units_consumed": 1,
      "finalization_cost_units_consumed": 1,
      "xrd_total_execution_cost": "text",
      "xrd_total_finalization_cost": "text",
      "xrd_total_royalty_cost": "text",
      "xrd_total_storage_cost": "text",
      "xrd_total_tipping_cost": "text"
    },
    "costing_parameters": {
      "execution_cost_unit_price": "text",
      "execution_cost_unit_limit": 1,
      "execution_cost_unit_loan": 1,
      "finalization_cost_unit_price": "text",
      "finalization_cost_unit_limit": 1,
      "xrd_usd_price": "text",
      "xrd_storage_price": "text",
      "xrd_archive_storage_price": "text",
      "tip_percentage": 1
    },
    "fee_source": {
      "from_vaults": [
        {
          "vault_entity": {
            "entity_type": "GlobalPackage",
            "is_global": true,
            "entity_address": "text"
          },
          "xrd_amount": "text"
        }
      ]
    },
    "fee_destination": {
      "to_proposer": "text",
      "to_validator_set": "text",
      "to_burn": "text",
      "to_royalty_recipients": [
        {
          "royalty_recipient": {
            "entity_type": "GlobalPackage",
            "is_global": true,
            "entity_address": "text"
          },
          "xrd_amount": "text"
        }
      ]
    },
    "state_updates": {
      "deleted_partitions": [
        {
          "entity_type": "GlobalPackage",
          "entity_address": "text",
          "entity_module": "TypeInfo",
          "partition_kind": "Field",
          "partition_number": 1
        }
      ],
      "created_substates": [
        {
          "substate_id": {
            "entity_type": "GlobalPackage",
            "entity_address": "text",
            "entity_module": "TypeInfo",
            "partition_kind": "Field",
            "partition_number": 1,
            "substate_type": "BootLoaderModuleFieldVmBoot",
            "substate_key": {
              "key_type": "Field",
              "db_sort_key_hex": "text"
            }
          },
          "value": {
            "substate_hex": "text",
            "substate_data_hash": "text",
            "substate_data": {
              "substate_type": "BootLoaderModuleFieldVmBoot",
              "is_locked": true
            }
          },
          "system_structure": {
            "type": "SystemField"
          }
        }
      ],
      "updated_substates": [
        {
          "substate_id": {
            "entity_type": "GlobalPackage",
            "entity_address": "text",
            "entity_module": "TypeInfo",
            "partition_kind": "Field",
            "partition_number": 1,
            "substate_type": "BootLoaderModuleFieldVmBoot",
            "substate_key": {
              "key_type": "Field",
              "db_sort_key_hex": "text"
            }
          },
          "new_value": {
            "substate_hex": "text",
            "substate_data_hash": "text",
            "substate_data": {
              "substate_type": "BootLoaderModuleFieldVmBoot",
              "is_locked": true
            }
          },
          "previous_value": {
            "substate_hex": "text",
            "substate_data_hash": "text",
            "substate_data": {
              "substate_type": "BootLoaderModuleFieldVmBoot",
              "is_locked": true
            }
          },
          "system_structure": {
            "type": "SystemField"
          }
        }
      ],
      "deleted_substates": [
        {
          "substate_id": {
            "entity_type": "GlobalPackage",
            "entity_address": "text",
            "entity_module": "TypeInfo",
            "partition_kind": "Field",
            "partition_number": 1,
            "substate_type": "BootLoaderModuleFieldVmBoot",
            "substate_key": {
              "key_type": "Field",
              "db_sort_key_hex": "text"
            }
          },
          "previous_value": {
            "substate_hex": "text",
            "substate_data_hash": "text",
            "substate_data": {
              "substate_type": "BootLoaderModuleFieldVmBoot",
              "is_locked": true
            }
          },
          "system_structure": {
            "type": "SystemField"
          }
        }
      ],
      "new_global_entities": [
        {
          "entity_type": "GlobalPackage",
          "is_global": true,
          "entity_address": "text"
        }
      ]
    },
    "events": [
      {
        "type": {
          "emitter": {
            "type": "Function"
          },
          "type_reference": {
            "full_type_id": {
              "entity_address": "text",
              "schema_hash": "text",
              "local_type_id": {
                "kind": "WellKnown",
                "id": 1,
                "as_sbor": {
                  "hex": "text",
                  "programmatic_json": null
                }
              }
            }
          },
          "name": "text"
        },
        "data": {
          "hex": "text",
          "programmatic_json": null
        }
      }
    ],
    "next_epoch": {
      "epoch": 1,
      "validators": [
        {
          "address": "text",
          "key": {
            "key_type": "EcdsaSecp256k1",
            "key_hex": "text"
          },
          "stake": "text"
        }
      ],
      "significant_protocol_update_readiness": [
        {
          "readiness_signal_name": "text",
          "signalled_stake": "text"
        }
      ]
    },
    "output": [
      {
        "hex": "text",
        "programmatic_json": null
      }
    ],
    "error_message": "text"
  },
  "instruction_resource_changes": [
    {
      "index": 1,
      "resource_changes": [
        {
          "resource_address": "text",
          "component_entity": {
            "entity_type": "GlobalPackage",
            "is_global": true,
            "entity_address": "text"
          },
          "vault_entity": {
            "entity_type": "GlobalPackage",
            "is_global": true,
            "entity_address": "text"
          },
          "amount": "text"
        }
      ]
    }
  ],
  "logs": [
    {
      "level": "text",
      "message": "text"
    }
  ]
}

Transaction preview response