Skip to main content

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.

Required permission: contract:deploy

Request​

GET /v2/admin/nodes/{node_id}/setups/{setup_id}/contracts

Parameters​

NameTypeInDescription
node_idstringpathRequired. The node's id
setup_idstringpathRequired. The setup's id

Headers​

NameDescription
AuthorizationRequired. Bearer <access_token>

Example​

curl --request GET \
--url '{{baseUrl}}/v2/admin/nodes/6a4bef2b1e781b11c22e9707/setups/6a552db09c6088e126a4be87/contracts' \
--header 'Authorization: Bearer <access_token>'

Response​

{
"diamond_cut_facet": {
"address": "0x07CE06EF88C5b104A3632371b6E07A360Bcdb168",
"version": "1.0.0",
"node_contract_id": "6a552db29c6088e126a4be88"
},
"diamond": {
"address": "0x39247A80f1c0ddcEfb4986fA7A59E919E1F2Fa38",
"version": "1.0.0",
"node_contract_id": "6a552db29c6088e126a4be88"
},
"diamond_loupe_facet": {
"address": "0x709a52Dec3C716FBb4d7d8382EDD8F6e645D8b54",
"version": "1.0.0",
"node_contract_id": "6a552db29c6088e126a4be88"
},
"ownership_facet": {
"address": "0x0Fdf63aB85Ca5eb1404FCA1992b616D45AB34589",
"version": "1.0.0",
"node_contract_id": "6a552db29c6088e126a4be88"
},
"listing_contract": {
"address": "0xb6627b1685d1199E3087D2247d5F432fb1721c34",
"version": "1.0.1",
"node_contract_id": "6a552db29c6088e126a4be88"
},
"rent_contract": {
"address": "0x57327F5C456B661Fc0D337473ec8F14a4ADccfb3",
"version": "1.0.0",
"node_contract_id": "6a552db29c6088e126a4be88"
},
"burn_contract": {
"address": "0x222CB82947be52A91a88B1A2E116abf4D9bA6eed",
"version": "1.0.0",
"node_contract_id": "6a552db29c6088e126a4be88"
},
"fee_contract": {
"address": "0x1bD038546274fbE5656711d4E5371EE1bABCd126",
"version": "2.3.0",
"node_contract_id": "6a552db29c6088e126a4be88"
},
"secondary_contract": {
"address": "0x8B3a9f9Ea0fA265f56D28AD9Ea0416E5b6a32011",
"version": "1.0.0",
"node_contract_id": "6a552db29c6088e126a4be88"
},
"otc_contract": {
"address": "0x80d60e8E2F2f0c19de948b8bc64c862119137924",
"version": "1.0.2",
"node_contract_id": "6a552db29c6088e126a4be88"
}
}

Response Fields​

FieldTypeDescription
diamond_cut_facetobjectDiamond-cut facet
diamondobjectThe diamond: the address every other contract is reached through
diamond_loupe_facetobjectDiamond-loupe facet
ownership_facetobjectOwnership facet
listing_contractobjectListing facet
rent_contractobjectRent facet
burn_contractobjectBurn facet
fee_contractobjectFee facet
secondary_contractobjectSecondary-market facet
otc_contractobjectOTC facet
kyc_token_contractobjectKYC token proxy, when one of the setup's deployment records holds it
kyc_token_impl_contractobjectKYC token implementation, when one of the setup's deployment records holds it
<type>.addressstringContract address
<type>.versionstringDeployed version
<type>.node_contract_idstringId of the deployment record that deployed it (see Get Setup Contract History)

Every field is omitted while that contract is not deployed. The response carries no wallet: the setup itself names the signing wallet (Get Node Setup).

Errors​

Every refusal from this endpoint is answered with HTTP 409, whatever its code.

StatusCodeDescription
40910016node_id or setup_id is not a valid id
40910001Node not found, or the setup does not exist or belongs to another node (node domain 2)
40910005The node is outside your part of the hierarchy (node domain 2)
40910000Unexpected server-side failure

See Errors for the error format and common codes.