Markets
Get Setup Steps
Post-deployment checklist with calldata for each outstanding step
GET
/
lending-external-securities
/
api
/
markets
/
{marketId}
/
setup-steps
curl "https://api.trusset.org/lending-external-securities/api/markets/{marketId}/setup-steps" \
-H "X-API-Key: trusset_your_key_here"
const res = await fetch(
`https://api.trusset.org/lending-external-securities/api/markets/${marketId}/setup-steps`,
{ headers: { 'X-API-Key': 'trusset_your_key_here' } }
);
const { data } = await res.json();
for (const step of data.steps.filter(s => !s.done)) {
const tx = data.calldata[step.key] ?? data.calldata.verifyRouterAsHolder;
console.log(`${step.title} requires ${step.requiredRole}`, tx);
}
{
"success": true,
"data": {
"mode": "FREEZE",
"priceSource": "NAV",
"collateralAgent": "0x555...666",
"liquidationRouterAddress": "0x067a3feea46649adad8e31c33b3a4d8774b8d8cf",
"relayerAddress": "0x123...456",
"steps": [
{
"key": "grantAdapterAgentRole",
"title": "Grant the freeze adapter the agent role on the token",
"done": false,
"requiredRole": "TOKEN_AGENT_ADMIN",
"target": "0xabc...def",
"subject": "0x4d2b...77ae",
"blocked": false
},
{
"key": "verifyRouterOnRegistry",
"title": "Verify the market liquidation router on the identity registry",
"done": false,
"requiredRole": "IDENTITY_REGISTRY_AGENT",
"target": "0x9e3c...1145",
"subject": "0x067a3feea46649adad8e31c33b3a4d8774b8d8cf"
},
{
"key": "authorizeOracleSigner",
"title": "Authorize the issuer wallet as oracle price signer",
"done": true,
"requiredRole": "ORACLE_OWNER",
"target": "0x3b25752c1459c5cf1b0bfcfdf0d56883c8047423",
"subject": "0x123...456"
},
{
"key": "grantLiquidatorRole",
"title": "Grant LIQUIDATOR_ROLE to the issuer wallet",
"done": false,
"requiredRole": "DEFAULT_ADMIN_ROLE",
"target": "0x70a0e25c7b768b87e658348b3b577678a173e038",
"subject": "0x123...456"
}
],
"calldata": {
"grantAdapterAgentRole": {
"to": "0xabc...def",
"data": "0x...",
"description": "Grant agent role to freeze adapter 0x4d2b...77ae on the security token (requires token agent admin)"
},
"verifyRouterAsHolder": {
"to": "0x9e3c...1145",
"data": "0x...",
"description": "Verify the market liquidation router as a holder on the identity registry"
},
"grantLiquidatorRole": {
"to": "0x70a0e25c7b768b87e658348b3b577678a173e038",
"data": "0x...",
"description": "Grant LIQUIDATOR_ROLE to issuer wallet 0x123...456 (requires market DEFAULT_ADMIN_ROLE)"
}
},
"complete": false
}
}
Returns the authorization work a market still needs before it can lend, as an ordered checklist. Each incomplete step comes with ready-to-sign calldata and the role required to execute it.
The steps differ by collateral mode, because freeze markets and custody markets rely on different token-side permissions. Two steps are common to both.
Path Parameters
string
required
Market ID.
Response Fields
object
Show child attributes
Show child attributes
boolean
True when the market has a lender of record and every step is either done or delegated.
string
FREEZE or CUSTODY. Determines which steps appear.string
NAV, MARKET or ORACLE, read from the contract where possible and from the record otherwise.string
Named pledgee recorded at deployment.
string
The institution holding the lender-of-record role, or
null.boolean
true while the market has no lender of record.string
How that institution declared it will realize seized collateral:
EXCHANGE_SALE, ISSUER_REDEMPTION or AUCTION.string
Where seized collateral is sent for realization.
boolean
Whether the market has been adopted and can be operated at all.
complete can never be true while this is false.boolean
Whether the factory record for this market could be read. When
false, the lender-of-record fields above fall back to the stored record.object
marketAdminHeldByInstance, oracleOwnedByInstance and oracleOwner. Says which of the two administrative keys your instance actually holds, which decides which steps you can sign yourself.string
Router that must be made an eligible collateral recipient.
string
The instance’s registered wallet: the primary one, or the oldest verified wallet when no primary is set. Oracle signer and liquidator role checks are evaluated against this address. When null, the liquidator step can never report done.
array
Show child attributes
Show child attributes
string
Step identifier.
string
Human-readable description.
boolean
Whether the on-chain state already satisfies this step.
string
Role the executing wallet must hold.
string
Contract the transaction is sent to.
string
Address being authorized.
boolean
true when the step is not this instance’s to perform and another party already covers it. A delegated step counts toward complete without being done.boolean
true when the step cannot be achieved as things stand, rather than merely being outstanding.string
Why, in words. Present alongside
blocked.string
The machine-readable form of the same. Present alongside
blocked.object
Transactions for incomplete steps, keyed by step name, each
{ to, data, description }. Completed steps are omitted.Steps by Mode
FREEZE
key | requiredRole | Executed by |
|---|---|---|
grantAdapterAgentRole | TOKEN_AGENT_ADMIN | The collateral token’s agent administrator |
verifyRouterOnRegistry | IDENTITY_REGISTRY_AGENT | The token’s identity registry operator |
authorizeOracleSigner | ORACLE_OWNER | The oracle owner, which is the admin address from deployment |
grantLiquidatorRole | DEFAULT_ADMIN_ROLE | The market admin |
CUSTODY
key | requiredRole | Executed by |
|---|---|---|
verifyAdapterAsHolder | IDENTITY_REGISTRY_AGENT | The token’s identity registry operator |
verifyRouterAsHolder | IDENTITY_REGISTRY_AGENT | The token’s identity registry operator |
authorizeOracleSigner | ORACLE_OWNER | The oracle owner |
grantLiquidatorRole | DEFAULT_ADMIN_ROLE | The market admin |
In
FREEZE mode the router step has key verifyRouterOnRegistry but its calldata is emitted under verifyRouterAsHolder, matching the custody naming. Look up calldata by the calldata object’s own keys rather than by step key.The first two steps in either mode are executed by whoever administers the collateral token, which for an imported third-party security is the original issuer or their transfer agent, not Trusset and not necessarily you. Plan for that dependency before announcing a market.
grantLiquidatorRole can be executed directly through Set Liquidator Role when the registered wallet holds the market admin role.curl "https://api.trusset.org/lending-external-securities/api/markets/{marketId}/setup-steps" \
-H "X-API-Key: trusset_your_key_here"
const res = await fetch(
`https://api.trusset.org/lending-external-securities/api/markets/${marketId}/setup-steps`,
{ headers: { 'X-API-Key': 'trusset_your_key_here' } }
);
const { data } = await res.json();
for (const step of data.steps.filter(s => !s.done)) {
const tx = data.calldata[step.key] ?? data.calldata.verifyRouterAsHolder;
console.log(`${step.title} requires ${step.requiredRole}`, tx);
}
{
"success": true,
"data": {
"mode": "FREEZE",
"priceSource": "NAV",
"collateralAgent": "0x555...666",
"liquidationRouterAddress": "0x067a3feea46649adad8e31c33b3a4d8774b8d8cf",
"relayerAddress": "0x123...456",
"steps": [
{
"key": "grantAdapterAgentRole",
"title": "Grant the freeze adapter the agent role on the token",
"done": false,
"requiredRole": "TOKEN_AGENT_ADMIN",
"target": "0xabc...def",
"subject": "0x4d2b...77ae",
"blocked": false
},
{
"key": "verifyRouterOnRegistry",
"title": "Verify the market liquidation router on the identity registry",
"done": false,
"requiredRole": "IDENTITY_REGISTRY_AGENT",
"target": "0x9e3c...1145",
"subject": "0x067a3feea46649adad8e31c33b3a4d8774b8d8cf"
},
{
"key": "authorizeOracleSigner",
"title": "Authorize the issuer wallet as oracle price signer",
"done": true,
"requiredRole": "ORACLE_OWNER",
"target": "0x3b25752c1459c5cf1b0bfcfdf0d56883c8047423",
"subject": "0x123...456"
},
{
"key": "grantLiquidatorRole",
"title": "Grant LIQUIDATOR_ROLE to the issuer wallet",
"done": false,
"requiredRole": "DEFAULT_ADMIN_ROLE",
"target": "0x70a0e25c7b768b87e658348b3b577678a173e038",
"subject": "0x123...456"
}
],
"calldata": {
"grantAdapterAgentRole": {
"to": "0xabc...def",
"data": "0x...",
"description": "Grant agent role to freeze adapter 0x4d2b...77ae on the security token (requires token agent admin)"
},
"verifyRouterAsHolder": {
"to": "0x9e3c...1145",
"data": "0x...",
"description": "Verify the market liquidation router as a holder on the identity registry"
},
"grantLiquidatorRole": {
"to": "0x70a0e25c7b768b87e658348b3b577678a173e038",
"data": "0x...",
"description": "Grant LIQUIDATOR_ROLE to issuer wallet 0x123...456 (requires market DEFAULT_ADMIN_ROLE)"
}
},
"complete": false
}
}
⌘I
curl "https://api.trusset.org/lending-external-securities/api/markets/{marketId}/setup-steps" \
-H "X-API-Key: trusset_your_key_here"
const res = await fetch(
`https://api.trusset.org/lending-external-securities/api/markets/${marketId}/setup-steps`,
{ headers: { 'X-API-Key': 'trusset_your_key_here' } }
);
const { data } = await res.json();
for (const step of data.steps.filter(s => !s.done)) {
const tx = data.calldata[step.key] ?? data.calldata.verifyRouterAsHolder;
console.log(`${step.title} requires ${step.requiredRole}`, tx);
}
{
"success": true,
"data": {
"mode": "FREEZE",
"priceSource": "NAV",
"collateralAgent": "0x555...666",
"liquidationRouterAddress": "0x067a3feea46649adad8e31c33b3a4d8774b8d8cf",
"relayerAddress": "0x123...456",
"steps": [
{
"key": "grantAdapterAgentRole",
"title": "Grant the freeze adapter the agent role on the token",
"done": false,
"requiredRole": "TOKEN_AGENT_ADMIN",
"target": "0xabc...def",
"subject": "0x4d2b...77ae",
"blocked": false
},
{
"key": "verifyRouterOnRegistry",
"title": "Verify the market liquidation router on the identity registry",
"done": false,
"requiredRole": "IDENTITY_REGISTRY_AGENT",
"target": "0x9e3c...1145",
"subject": "0x067a3feea46649adad8e31c33b3a4d8774b8d8cf"
},
{
"key": "authorizeOracleSigner",
"title": "Authorize the issuer wallet as oracle price signer",
"done": true,
"requiredRole": "ORACLE_OWNER",
"target": "0x3b25752c1459c5cf1b0bfcfdf0d56883c8047423",
"subject": "0x123...456"
},
{
"key": "grantLiquidatorRole",
"title": "Grant LIQUIDATOR_ROLE to the issuer wallet",
"done": false,
"requiredRole": "DEFAULT_ADMIN_ROLE",
"target": "0x70a0e25c7b768b87e658348b3b577678a173e038",
"subject": "0x123...456"
}
],
"calldata": {
"grantAdapterAgentRole": {
"to": "0xabc...def",
"data": "0x...",
"description": "Grant agent role to freeze adapter 0x4d2b...77ae on the security token (requires token agent admin)"
},
"verifyRouterAsHolder": {
"to": "0x9e3c...1145",
"data": "0x...",
"description": "Verify the market liquidation router as a holder on the identity registry"
},
"grantLiquidatorRole": {
"to": "0x70a0e25c7b768b87e658348b3b577678a173e038",
"data": "0x...",
"description": "Grant LIQUIDATOR_ROLE to issuer wallet 0x123...456 (requires market DEFAULT_ADMIN_ROLE)"
}
},
"complete": false
}
}