List Node Setups
Lists a node's setups. A setup is one contract deployment of the node: it is bound to the custody wallet that signs it and to the network it runs on, and every deploy creates a new setup — so a node can have several setups, including several on the same wallet and network. Tokens, fees and contract upgrades all refer to a setup by its setup_id.
Get Node Setup
Returns one of a node's setups. The setup must belong to the node in the path; a setup of another node is reported as not found.
Create Node Setup
Opens a new setup on the wallet and network you select and starts deploying its contracts — the node's diamond and facets. This is the only way to deploy a node's contracts. Every call creates a new setup, even for a wallet and network that already have one; to retry a setup whose deploy stalled, use Deploy Setup Contracts instead.
Deploy Setup Contracts
Continues the contract deployment of an existing setup. Create Node Setup already starts the deploy, so you need this call only to retry: a contract is sent again only while it is undeployed and its last attempt is missing or failed, so after a failure this picks up at the contract that failed and leaves the deployed ones alone. On a setup whose deployment is complete or still running it queues no transaction.
Get Setup Contract Status
Reports the progress of a setup's contract deployment: for each deploy step, the status and error of its most recent transaction. Poll it after Create Node Setup or Deploy Setup Contracts; the deployment is finished when every step, executediamondcut last, is 3 (Done). For the deployed addresses use Get Setup Contracts.
Get Setup Contracts
Returns the contracts a setup has on chain: for each contract type, its address, version and the deployment record it came from. Contracts deployed by later upgrades replace the earlier ones of the same type. A type that is not deployed yet is omitted, so a setup with nothing deployed answers {}. For the progress of a running deploy use Get Setup Contract Status; for every deployment record use Get Setup Contract History.
Get Setup Contract History
Lists every deployment record of a setup, newest first: the initial deployment (create) and each later upgrade (update), with its status and, per contract, the versions, addresses and transaction hash. Get Setup Contracts folds these records into the current view; this endpoint returns them unfolded.
Get Setup Upgrade Status
Compares each of a setup's contracts with the latest version the platform ships and reports whether an upgrade is available. It changes nothing; run the upgrade with Upgrade Setup Contracts.
Upgrade Setup Contracts
Upgrades a setup's contracts to the latest versions the platform ships. The server compares each contract with the latest version (as Get Setup Upgrade Status reports), records an update deployment for the ones that differ and deploys the first of them. If an earlier deployment record of this setup is still unfinished, the call continues that record instead of creating a new one. When every contract is already current, nothing happens.