Convex

Convex

FieldValue
Nameprepare
TitlePrepare Transaction
DescriptionPrepare (but do not send) a Convex transaction. This mirrors the /api/v1/transaction/prepare endpoint and returns the encoded transaction along with the sequence that should be signed.
Input Schema
{
  "type": "object",
  "required": ["source",
               "address"],
  "properties": {
                  "sequence": {
                                "type": "integer",
                                "description": "Optional explicit sequence number; defaults to current account sequence + 1"
                              },
                  "source": {
                              "type": "string",
                              "description": "CVM source code for the transaction (e.g. \"(* 2 3)\")"
                            },
                  "address": {
                               "type": "string",
                               "description": "Origin account address for the transaction (e.g. \"#11\")"
                             }
                }
}
Output Schema
{
  "type": "object",
  "properties": {
                  "sequence": {
                                "type": "integer",
                                "description": "Sequence number used when preparing the transaction"
                              },
                  "data": {
                            "type": "string",
                            "description": "Hex-encoded transaction bytes suitable for signing"
                          },
                  "source": {
                              "type": "string",
                              "description": "Original source expression that was prepared"
                            },
                  "hash": {
                            "type": "string",
                            "description": "Hash of the prepared transaction payload"
                          },
                  "address": {
                               "type": "string",
                               "description": "Address that will execute the transaction"
                             }
                }
}