Endpoint reference

POST /api/v1/operations/prepare_721_launch/plans

Parameters

NameLocationDetails
X-Juicebox-Accountheader / requiredEnrolled account identity, including authority chain and lowercase owner address. Enrollment derives this identity before the account exists.
X-Juicebox-Signerheader / requiredOwner wallet or authorized bot address that signed this request.
X-Juicebox-Issued-Atheader / requiredUnix seconds, sent as 1–13 decimal digits without leading zeros; at most 30 seconds ahead of server time.
X-Juicebox-Expires-Atheader / requiredUnix seconds, sent as 1–13 decimal digits without leading zeros; in the future and within 300 seconds of issuedAt.
X-Juicebox-Nonceheader / requiredFresh random 32-byte lowercase nonce. A consumed nonce cannot be retried.
X-Juicebox-Signatureheader / requiredEIP-712 CenterRequest signature over every signed field. Contract-owner signatures may vary in length. This is a computed request proof, not a reusable API key.
X-Juicebox-Grantheader / optionalAuthorized bot grant ID. Required for a bot; omit for the owner, signing grantId as the empty string.
Idempotency-Keyheader / requiredSigned retry identity. Required on plan creation and transaction submission. Preserve exact method, target, Content-Type, and body bytes; use a fresh request nonce and signature.

Request body

FieldTypeDetails
chainIdone of
required
accountstring
required
ownerstring
required
deployTiersHookConfigobject
required
Fields
FieldTypeDetails
namestring
required
symbolstring
required
baseUristring
required
tokenUriResolverstring
required
contractUristring
required
tiersConfigobject
required
Fields
FieldTypeDetails
tiersarray
required
currencyone of
required
JB currency ID: uint32(uint160(token)) for a token (native ETH is 0x000000000000000000000000000000000000EEEe, currency 61166), or 1 = ETH and 2 = USD.
decimalsone of
required
Decimals of tier prices.
flagsobject
required
Fields
FieldTypeDetails
noNewTiersWithReservesboolean
required
noNewTiersWithVotesboolean
required
noNewTiersWithOwnerMintingboolean
required
preventOverspendingboolean
required
issueTokensForSplitsboolean
required
projectUristring
required
rulesetConfigurationsarray
required
Fields
FieldTypeDetails
mustStartAtOrAfterone of
required
Unix seconds. A lower bound, not a promised start; 0 asks the contract to resolve timing.
durationone of
required
Seconds per cycle. Zero has no automatic cycles.
weightstring
required
Tokens issued per one unit of baseCurrency, with 18 decimals: 1000000000000000000000 = 1,000 tokens. 0 means zero issuance; 1 inherits decayed weight when a prior ruleset exists.
weightCutPercentone of
required
Issuance cut applied each cycle, out of 1,000,000,000. 100,000,000 = 10%.
approvalHookstring
required
Gates the next ruleset, not this ruleset.
metadataobject
required
Fields
FieldTypeDetails
reservedPercentone of
required
Share of new tokens reserved for splits, out of 10,000. 2500 = 25%.
cashOutTaxRateone of
required
Cash-out tax out of 10,000. 0 = no tax; 10,000 = cash outs return nothing.
baseCurrencyone of
required
Currency that issuance is priced in: 1 = ETH, 2 = USD. Use 1 for ETH, not 61166 (native ETH's accounting currency). A token's own currency, uint32(uint160(token)), applies only when payments come in that token or JBPrices has a feed for it.
pausePayboolean
required
pauseCreditTransfersboolean
required
allowOwnerMintingboolean
required
allowSetCustomTokenboolean
required
allowTerminalMigrationboolean
required
allowSetTerminalsboolean
required
allowSetControllerboolean
required
allowAddAccountingContextboolean
required
allowAddPriceFeedboolean
required
ownerMustSendPayoutsboolean
required
holdFeesboolean
required
scopeCashOutsToLocalBalancesboolean
required
false: cash outs count every chain's supply and surplus (through the suckers). true: only this chain's. Recommended: false, which is what revnet.money sends.
useDataHookForCashOutboolean
required
metadataone of
required
splitGroupsarray
required
Fields
FieldTypeDetails
groupIdstring
required
Payout splits: uint256(uint160(token)) as a decimal string (native ETH is 0x000000000000000000000000000000000000EEEe, group 61166). Reserved token splits: 1.
splitsarray
required
fundAccessLimitGroupsarray
required
Fields
FieldTypeDetails
terminalstring
required
tokenstring
required
Token address; native ETH is 0x000000000000000000000000000000000000EEEe.
payoutLimitsarray
required
surplusAllowancesarray
required
terminalConfigurationsarray
required
Fields
FieldTypeDetails
terminalstring
required
accountingContextsToAcceptarray
required
Fields
FieldTypeDetails
tokenstring
required
Token address; native ETH is 0x000000000000000000000000000000000000EEEe.
decimalsone of
required
Token decimals. Native ETH uses 18.
currencyone of
required
Usually uint32(uint160(token)); native ETH is 0x000000000000000000000000000000000000EEEe, currency 61166.
memostring
optional

Default: ""

saltstring
required
JSON schema
{
  "type": "object",
  "properties": {
    "chainId": {
      "anyOf": [
        {
          "type": "number",
          "const": 1
        },
        {
          "type": "number",
          "const": 10
        },
        {
          "type": "number",
          "const": 8453
        },
        {
          "type": "number",
          "const": 42161
        },
        {
          "type": "number",
          "const": 11155111
        },
        {
          "type": "number",
          "const": 11155420
        },
        {
          "type": "number",
          "const": 84532
        },
        {
          "type": "number",
          "const": 421614
        }
      ]
    },
    "account": {
      "type": "string"
    },
    "owner": {
      "type": "string"
    },
    "deployTiersHookConfig": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 256
        },
        "symbol": {
          "type": "string",
          "minLength": 1,
          "maxLength": 32
        },
        "baseUri": {
          "type": "string",
          "maxLength": 4096
        },
        "tokenUriResolver": {
          "type": "string"
        },
        "contractUri": {
          "type": "string",
          "maxLength": 4096
        },
        "tiersConfig": {
          "type": "object",
          "properties": {
            "tiers": {
              "maxItems": 32,
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "price": {
                    "description": "Tier price in the tiers currency, with the tiers decimals.",
                    "type": "string",
                    "maxLength": 78,
                    "pattern": "^(0|[1-9][0-9]*)$"
                  },
                  "initialSupply": {
                    "anyOf": [
                      {
                        "type": "number"
                      },
                      {
                        "type": "string",
                        "pattern": "^(0|[1-9][0-9]*)$",
                        "maxLength": 78
                      }
                    ]
                  },
                  "votingUnits": {
                    "anyOf": [
                      {
                        "type": "number"
                      },
                      {
                        "type": "string",
                        "pattern": "^(0|[1-9][0-9]*)$",
                        "maxLength": 78
                      }
                    ]
                  },
                  "reserveFrequency": {
                    "anyOf": [
                      {
                        "type": "number"
                      },
                      {
                        "type": "string",
                        "pattern": "^(0|[1-9][0-9]*)$",
                        "maxLength": 78
                      }
                    ]
                  },
                  "reserveBeneficiary": {
                    "type": "string"
                  },
                  "encodedIpfsUri": {
                    "type": "string",
                    "pattern": "^0x[a-fA-F0-9]{64}$"
                  },
                  "category": {
                    "anyOf": [
                      {
                        "type": "number"
                      },
                      {
                        "type": "string",
                        "pattern": "^(0|[1-9][0-9]*)$",
                        "maxLength": 78
                      }
                    ]
                  },
                  "discountPercent": {
                    "description": "Tier price discount, out of 200. 200 = free.",
                    "anyOf": [
                      {
                        "type": "number"
                      },
                      {
                        "type": "string",
                        "pattern": "^(0|[1-9][0-9]*)$",
                        "maxLength": 78
                      }
                    ]
                  },
                  "flags": {
                    "type": "object",
                    "properties": {
                      "allowOwnerMint": {
                        "type": "boolean"
                      },
                      "useReserveBeneficiaryAsDefault": {
                        "type": "boolean"
                      },
                      "transfersPausable": {
                        "type": "boolean"
                      },
                      "useVotingUnits": {
                        "type": "boolean"
                      },
                      "cantBeRemoved": {
                        "type": "boolean"
                      },
                      "cantIncreaseDiscountPercent": {
                        "type": "boolean"
                      },
                      "cantBuyWithCredits": {
                        "type": "boolean"
                      }
                    },
                    "required": [
                      "allowOwnerMint",
                      "useReserveBeneficiaryAsDefault",
                      "transfersPausable",
                      "useVotingUnits",
                      "cantBeRemoved",
                      "cantIncreaseDiscountPercent",
                      "cantBuyWithCredits"
                    ],
                    "additionalProperties": false
                  },
                  "splitPercent": {
                    "description": "Share of the tier price sent to the tier's splits, out of 1,000,000,000.",
                    "anyOf": [
                      {
                        "type": "number"
                      },
                      {
                        "type": "string",
                        "pattern": "^(0|[1-9][0-9]*)$",
                        "maxLength": 78
                      }
                    ]
                  },
                  "splits": {
                    "maxItems": 32,
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "percent": {
                          "description": "Share of the split group, out of 1,000,000,000. 500,000,000 = 50%.",
                          "anyOf": [
                            {
                              "type": "number"
                            },
                            {
                              "type": "string",
                              "pattern": "^(0|[1-9][0-9]*)$",
                              "maxLength": 78
                            }
                          ]
                        },
                        "projectId": {
                          "type": "string",
                          "maxLength": 78,
                          "pattern": "^(0|[1-9][0-9]*)$"
                        },
                        "beneficiary": {
                          "type": "string"
                        },
                        "preferAddToBalance": {
                          "type": "boolean"
                        },
                        "lockedUntil": {
                          "anyOf": [
                            {
                              "type": "number"
                            },
                            {
                              "type": "string",
                              "pattern": "^(0|[1-9][0-9]*)$",
                              "maxLength": 78
                            }
                          ]
                        },
                        "hook": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "percent",
                        "projectId",
                        "beneficiary",
                        "preferAddToBalance",
                        "lockedUntil",
                        "hook"
                      ],
                      "additionalProperties": false
                    }
                  }
                },
                "required": [
                  "price",
                  "initialSupply",
                  "votingUnits",
                  "reserveFrequency",
                  "reserveBeneficiary",
                  "encodedIpfsUri",
                  "category",
                  "discountPercent",
                  "flags",
                  "splitPercent",
                  "splits"
                ],
                "additionalProperties": false
              }
            },
            "currency": {
              "description": "JB currency ID: uint32(uint160(token)) for a token (native ETH is 0x000000000000000000000000000000000000EEEe, currency 61166), or 1 = ETH and 2 = USD.",
              "anyOf": [
                {
                  "type": "number"
                },
                {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]*)$",
                  "maxLength": 78
                }
              ]
            },
            "decimals": {
              "description": "Decimals of tier prices.",
              "anyOf": [
                {
                  "type": "number"
                },
                {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]*)$",
                  "maxLength": 78
                }
              ]
            }
          },
          "required": [
            "tiers",
            "currency",
            "decimals"
          ],
          "additionalProperties": false
        },
        "flags": {
          "type": "object",
          "properties": {
            "noNewTiersWithReserves": {
              "type": "boolean"
            },
            "noNewTiersWithVotes": {
              "type": "boolean"
            },
            "noNewTiersWithOwnerMinting": {
              "type": "boolean"
            },
            "preventOverspending": {
              "type": "boolean"
            },
            "issueTokensForSplits": {
              "type": "boolean"
            }
          },
          "required": [
            "noNewTiersWithReserves",
            "noNewTiersWithVotes",
            "noNewTiersWithOwnerMinting",
            "preventOverspending",
            "issueTokensForSplits"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "name",
        "symbol",
        "baseUri",
        "tokenUriResolver",
        "contractUri",
        "tiersConfig",
        "flags"
      ],
      "additionalProperties": false
    },
    "projectUri": {
      "type": "string",
      "maxLength": 4096
    },
    "rulesetConfigurations": {
      "minItems": 1,
      "maxItems": 16,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "mustStartAtOrAfter": {
            "description": "Unix seconds. A lower bound, not a promised start; 0 asks the contract to resolve timing.",
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]*)$",
                "maxLength": 78
              }
            ]
          },
          "duration": {
            "description": "Seconds per cycle. Zero has no automatic cycles.",
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]*)$",
                "maxLength": 78
              }
            ]
          },
          "weight": {
            "description": "Tokens issued per one unit of baseCurrency, with 18 decimals: 1000000000000000000000 = 1,000 tokens. 0 means zero issuance; 1 inherits decayed weight when a prior ruleset exists.",
            "type": "string",
            "maxLength": 78,
            "pattern": "^(0|[1-9][0-9]*)$"
          },
          "weightCutPercent": {
            "description": "Issuance cut applied each cycle, out of 1,000,000,000. 100,000,000 = 10%.",
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]*)$",
                "maxLength": 78
              }
            ]
          },
          "approvalHook": {
            "description": "Gates the next ruleset, not this ruleset.",
            "type": "string"
          },
          "metadata": {
            "type": "object",
            "properties": {
              "reservedPercent": {
                "description": "Share of new tokens reserved for splits, out of 10,000. 2500 = 25%.",
                "anyOf": [
                  {
                    "type": "number"
                  },
                  {
                    "type": "string",
                    "pattern": "^(0|[1-9][0-9]*)$",
                    "maxLength": 78
                  }
                ]
              },
              "cashOutTaxRate": {
                "description": "Cash-out tax out of 10,000. 0 = no tax; 10,000 = cash outs return nothing.",
                "anyOf": [
                  {
                    "type": "number"
                  },
                  {
                    "type": "string",
                    "pattern": "^(0|[1-9][0-9]*)$",
                    "maxLength": 78
                  }
                ]
              },
              "baseCurrency": {
                "description": "Currency that issuance is priced in: 1 = ETH, 2 = USD. Use 1 for ETH, not 61166 (native ETH's accounting currency). A token's own currency, uint32(uint160(token)), applies only when payments come in that token or JBPrices has a feed for it.",
                "anyOf": [
                  {
                    "type": "number"
                  },
                  {
                    "type": "string",
                    "pattern": "^(0|[1-9][0-9]*)$",
                    "maxLength": 78
                  }
                ]
              },
              "pausePay": {
                "type": "boolean"
              },
              "pauseCreditTransfers": {
                "type": "boolean"
              },
              "allowOwnerMinting": {
                "type": "boolean"
              },
              "allowSetCustomToken": {
                "type": "boolean"
              },
              "allowTerminalMigration": {
                "type": "boolean"
              },
              "allowSetTerminals": {
                "type": "boolean"
              },
              "allowSetController": {
                "type": "boolean"
              },
              "allowAddAccountingContext": {
                "type": "boolean"
              },
              "allowAddPriceFeed": {
                "type": "boolean"
              },
              "ownerMustSendPayouts": {
                "type": "boolean"
              },
              "holdFees": {
                "type": "boolean"
              },
              "scopeCashOutsToLocalBalances": {
                "type": "boolean",
                "description": "false: cash outs count every chain's supply and surplus (through the suckers). true: only this chain's. Recommended: false, which is what revnet.money sends."
              },
              "useDataHookForCashOut": {
                "type": "boolean"
              },
              "metadata": {
                "anyOf": [
                  {
                    "type": "number"
                  },
                  {
                    "type": "string",
                    "pattern": "^(0|[1-9][0-9]*)$",
                    "maxLength": 78
                  }
                ]
              }
            },
            "required": [
              "reservedPercent",
              "cashOutTaxRate",
              "baseCurrency",
              "pausePay",
              "pauseCreditTransfers",
              "allowOwnerMinting",
              "allowSetCustomToken",
              "allowTerminalMigration",
              "allowSetTerminals",
              "allowSetController",
              "allowAddAccountingContext",
              "allowAddPriceFeed",
              "ownerMustSendPayouts",
              "holdFees",
              "scopeCashOutsToLocalBalances",
              "useDataHookForCashOut",
              "metadata"
            ],
            "additionalProperties": false
          },
          "splitGroups": {
            "maxItems": 32,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "groupId": {
                  "type": "string",
                  "maxLength": 78,
                  "pattern": "^(0|[1-9][0-9]*)$",
                  "description": "Payout splits: uint256(uint160(token)) as a decimal string (native ETH is 0x000000000000000000000000000000000000EEEe, group 61166). Reserved token splits: 1."
                },
                "splits": {
                  "maxItems": 32,
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "percent": {
                        "description": "Share of the split group, out of 1,000,000,000. 500,000,000 = 50%.",
                        "anyOf": [
                          {
                            "type": "number"
                          },
                          {
                            "type": "string",
                            "pattern": "^(0|[1-9][0-9]*)$",
                            "maxLength": 78
                          }
                        ]
                      },
                      "projectId": {
                        "type": "string",
                        "maxLength": 78,
                        "pattern": "^(0|[1-9][0-9]*)$"
                      },
                      "beneficiary": {
                        "type": "string"
                      },
                      "preferAddToBalance": {
                        "type": "boolean"
                      },
                      "lockedUntil": {
                        "anyOf": [
                          {
                            "type": "number"
                          },
                          {
                            "type": "string",
                            "pattern": "^(0|[1-9][0-9]*)$",
                            "maxLength": 78
                          }
                        ]
                      },
                      "hook": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "percent",
                      "projectId",
                      "beneficiary",
                      "preferAddToBalance",
                      "lockedUntil",
                      "hook"
                    ],
                    "additionalProperties": false
                  }
                }
              },
              "required": [
                "groupId",
                "splits"
              ],
              "additionalProperties": false
            }
          },
          "fundAccessLimitGroups": {
            "maxItems": 32,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "terminal": {
                  "type": "string"
                },
                "token": {
                  "description": "Token address; native ETH is 0x000000000000000000000000000000000000EEEe.",
                  "type": "string"
                },
                "payoutLimits": {
                  "maxItems": 32,
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "amount": {
                        "type": "string",
                        "maxLength": 78,
                        "pattern": "^(0|[1-9][0-9]*)$"
                      },
                      "currency": {
                        "description": "JB currency ID: uint32(uint160(token)) for a token (native ETH is 0x000000000000000000000000000000000000EEEe, currency 61166), or 1 = ETH and 2 = USD.",
                        "anyOf": [
                          {
                            "type": "number"
                          },
                          {
                            "type": "string",
                            "pattern": "^(0|[1-9][0-9]*)$",
                            "maxLength": 78
                          }
                        ]
                      }
                    },
                    "required": [
                      "amount",
                      "currency"
                    ],
                    "additionalProperties": false
                  }
                },
                "surplusAllowances": {
                  "maxItems": 32,
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "amount": {
                        "type": "string",
                        "maxLength": 78,
                        "pattern": "^(0|[1-9][0-9]*)$"
                      },
                      "currency": {
                        "description": "JB currency ID: uint32(uint160(token)) for a token (native ETH is 0x000000000000000000000000000000000000EEEe, currency 61166), or 1 = ETH and 2 = USD.",
                        "anyOf": [
                          {
                            "type": "number"
                          },
                          {
                            "type": "string",
                            "pattern": "^(0|[1-9][0-9]*)$",
                            "maxLength": 78
                          }
                        ]
                      }
                    },
                    "required": [
                      "amount",
                      "currency"
                    ],
                    "additionalProperties": false
                  }
                }
              },
              "required": [
                "terminal",
                "token",
                "payoutLimits",
                "surplusAllowances"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "mustStartAtOrAfter",
          "duration",
          "weight",
          "weightCutPercent",
          "approvalHook",
          "metadata",
          "splitGroups",
          "fundAccessLimitGroups"
        ],
        "additionalProperties": false
      }
    },
    "terminalConfigurations": {
      "maxItems": 32,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "terminal": {
            "type": "string"
          },
          "accountingContextsToAccept": {
            "maxItems": 32,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "token": {
                  "description": "Token address; native ETH is 0x000000000000000000000000000000000000EEEe.",
                  "type": "string"
                },
                "decimals": {
                  "description": "Token decimals. Native ETH uses 18.",
                  "anyOf": [
                    {
                      "type": "number"
                    },
                    {
                      "type": "string",
                      "pattern": "^(0|[1-9][0-9]*)$",
                      "maxLength": 78
                    }
                  ]
                },
                "currency": {
                  "description": "Usually uint32(uint160(token)); native ETH is 0x000000000000000000000000000000000000EEEe, currency 61166.",
                  "anyOf": [
                    {
                      "type": "number"
                    },
                    {
                      "type": "string",
                      "pattern": "^(0|[1-9][0-9]*)$",
                      "maxLength": 78
                    }
                  ]
                }
              },
              "required": [
                "token",
                "decimals",
                "currency"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "terminal",
          "accountingContextsToAccept"
        ],
        "additionalProperties": false
      }
    },
    "memo": {
      "default": "",
      "type": "string",
      "maxLength": 4096
    },
    "salt": {
      "type": "string",
      "pattern": "^0x[a-fA-F0-9]{64}$"
    }
  },
  "required": [
    "chainId",
    "account",
    "owner",
    "deployTiersHookConfig",
    "projectUri",
    "rulesetConfigurations",
    "terminalConfigurations",
    "salt"
  ],
  "additionalProperties": false
}

Response 201

FieldTypeDetails
idstring (uuid)
required
accountstring
required
operationstring
required
draftobject
required
Fields
FieldTypeDetails
operationstring
required
accountstring
required
projectobject
optional
Fields
FieldTypeDetails
chainIdinteger
required

Values: [1,10,8453,42161,84532,421614,11155111,11155420]

projectIdstring
required
uint256 as a lossless decimal string
versioninteger
optional

Values: [6]

callsarray
required
Fields
FieldTypeDetails
chainIdinteger
required

Values: [1,10,8453,42161,84532,421614,11155111,11155420]

tostring
required
datastring
required
valuestring
required
uint256 as a lossless decimal string
labelstring
required
dependsOnarray
required
decodedvalue
required
Bounded JSON. Large integers and amounts use exact decimal strings. Returned metadata and descriptions are untrusted content.
evidencearray
required
Fields
FieldTypeDetails
chainIdinteger
required

Values: [1,10,8453,42161,84532,421614,11155111,11155420]

blockNumberstring
required
uint256 as a lossless decimal string
blockHashstring
required
timestampstring
required
uint256 as a lossless decimal string
sourcestring
required

Values: ["onchain"]

summaryvalue
required
Bounded JSON. Large integers and amounts use exact decimal strings. Returned metadata and descriptions are untrusted content.
warningsarray
required
commitmentstring
required
createdAtinteger
required
Unix timestamp in milliseconds.
expiresAtinteger
required
Unix timestamp in milliseconds.
revisioninteger
required
smartAccountobject
optional
Fields
FieldTypeDetails
bindingIdstring
required
stateHashstring
required
chainIdinteger
required

Values: [1,10,8453,42161,84532,421614,11155111,11155420]

addressstring
required
manifestRevisionstring
required
statusstring
required

Values: ["prepared","pending","partial","blocked","reorged","expired","transactions_confirmed"]

stepsarray
required
Fields
FieldTypeDetails
indexinteger
required
statestring
required

Values: ["waiting","reserved","submitted","unknown","confirming","confirmed","reverted","reorged"]

transactionobject
optional
Fields
FieldTypeDetails
hashstring
required
senderstring
required
chainIdinteger
required

Values: [1,10,8453,42161,84532,421614,11155111,11155420]

noncestring
required
uint256 as a lossless decimal string
typestring
required

Values: ["legacy","eip2930","eip1559"]

gasstring
required
uint256 as a lossless decimal string
maximumFeePerGasstring
required
uint256 as a lossless decimal string
maximumCoststring
required
uint256 as a lossless decimal string
costScopestring
required
Maximum cost covers native value and gas limit times fee cap. Additional chain-specific data or operator fees are excluded.
dispatchCountinteger
required
reservedAtinteger
required
Unix timestamp in milliseconds.
broadcastAtinteger
optional
Unix timestamp in milliseconds.
lastErrorobject
optional
executionobject
optional
Fields
FieldTypeDetails
transportstring
required

Values: ["relayr-prepaid-erc2771","eip4337-user-operation"]

bindingIdstring
required
chainIdinteger
required

Values: [1,10,8453,42161,84532,421614,11155111,11155420]

hashstring
optional
receiptobject
optional
Fields
FieldTypeDetails
transactionHashstring
required
blockHashstring
required
blockNumberstring
required
uint256 as a lossless decimal string
statusstring
required

Values: ["success","reverted"]

confirmationsinteger
required
canonicalboolean
required
observedAtinteger
required
Unix timestamp in milliseconds.
logsarray
required
logCountinteger
optional
logsHashstring
optional
logsStoredboolean
optional
semanticobject
optional
Fields
FieldTypeDetails
statusstring
required

Values: ["verified","failed","unknown","unmodeled"]

detailsvalue
optional
Bounded JSON. Large integers and amounts use exact decimal strings. Returned metadata and descriptions are untrusted content.
blockedByarray
required
confirmationScopestring
required
JSON schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "account": {
      "$ref": "#/components/schemas/Address"
    },
    "operation": {
      "type": "string"
    },
    "draft": {
      "$ref": "#/components/schemas/PlanDraft"
    },
    "commitment": {
      "$ref": "#/components/schemas/Hash"
    },
    "createdAt": {
      "$ref": "#/components/schemas/UnixMilliseconds"
    },
    "expiresAt": {
      "$ref": "#/components/schemas/UnixMilliseconds"
    },
    "revision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "smartAccount": {
      "type": "object",
      "properties": {
        "bindingId": {
          "$ref": "#/components/schemas/Hash"
        },
        "stateHash": {
          "$ref": "#/components/schemas/Hash"
        },
        "chainId": {
          "$ref": "#/components/schemas/ChainId"
        },
        "address": {
          "$ref": "#/components/schemas/Address"
        },
        "manifestRevision": {
          "$ref": "#/components/schemas/Hash"
        }
      },
      "required": [
        "bindingId",
        "stateHash",
        "chainId",
        "address",
        "manifestRevision"
      ],
      "additionalProperties": false
    },
    "status": {
      "type": "string",
      "enum": [
        "prepared",
        "pending",
        "partial",
        "blocked",
        "reorged",
        "expired",
        "transactions_confirmed"
      ]
    },
    "steps": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PlanStep"
      },
      "minItems": 1,
      "maxItems": 32
    },
    "confirmationScope": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "account",
    "operation",
    "draft",
    "commitment",
    "createdAt",
    "expiresAt",
    "revision",
    "status",
    "steps",
    "confirmationScope"
  ],
  "additionalProperties": false
}