Skip to content

DEVELOPERS

nFALCON Integration

nFALCON is the Nest FalconX CLO Vault. This page is organized around the recommended Actions API path first, then the direct contract path for advanced EVM integrations.

FieldValue
VaultNest FalconX CLO Vault
SymbolnFALCON
Slugnest-falconx-clo
EVM share token0x066d10e240999aea6798b2e2ca0bdac2923cbdff
Share decimals6
EVM Actions API base URLhttps://api.nest.credit/v1/actions
ChainDeposit or redemption assetnFALCON NestVaultDecimals
Plume98866USDC0x2223…a7af0x4738…c5e76
Plume98866pUSD0xdddd…6f3f0x74c9…4c056
Ethereum1USDC0xa0b8…eb480x4738…c5e76

Use the EVM Actions API when your app wants Nest to handle quote construction, vault selection, Predicate compliance checks, calldata encoding, and transaction simulation for nFALCON. The API returns transactions that your app signs and sends with the user’s EVM wallet.

This section covers:

The base URL is:

https://api.nest.credit/v1/actions

All amounts are raw base-unit integer strings. Do not send decimal UI amounts.

Use the quote route before building transactions. This returns the expected raw share amount, decimals, fee fields, rate fields, and a preview of the transaction steps.

Terminal window
curl -X POST https://api.nest.credit/v1/actions/vaults/nest-falconx-clo/mint/quote \
-H 'content-type: application/json' \
-d '{
"depositAsset": "0x222365ef19f7947e5484218551b56bb3965aa7af",
"depositAmount": "1000000",
"chainId": 98866
}'

Example response shape:

{
"data": {
"slug": "nest-falconx-clo",
"shareTokenAddress": "0x066d10e240999aea6798b2e2ca0bdac2923cbdff",
"depositAsset": "0x222365ef19f7947e5484218551b56bb3965aa7af",
"depositAmount": "1000000",
"depositDecimals": 6,
"shareAmount": "...",
"shareDecimals": 6,
"rate": "...",
"rateDecimals": 6,
"feeAmount": "0",
"fees": {
"ratePpm": 0,
"flatAmount": "0",
"maxRatePpm": 0,
"maxFlatAmount": "0"
},
"steps": [
{ "label": "approve", "description": "Approve PredicateProxy to spend the deposit asset" },
{ "label": "deposit", "description": "Deposit through NestVaultPredicateProxy" }
]
}
}

steps is a preview. The actual build-tx response may omit approve if the wallet already has sufficient allowance.

Use build-tx when the user is ready to deposit. The recipient is the EVM address that signs as depositor and receives the minted nFALCON shares.

Terminal window
curl -X POST https://api.nest.credit/v1/actions/vaults/nest-falconx-clo/mint/build-tx \
-H 'content-type: application/json' \
-d '{
"depositAsset": "0x222365ef19f7947e5484218551b56bb3965aa7af",
"depositAmount": "1000000",
"chainId": 98866,
"recipient": "0x00000000000000000000000000000000000000ab"
}'

Submit the returned transactions in order. Every returned transaction uses the chain ID from the request. By default, the API simulates the transaction bundle before returning it. User-facing apps should generally keep simulation enabled.

Use the redeem quote route before submitting a redemption. This quotes the redemption asset amount and validates the selected asset for this vault.

Terminal window
curl -X POST https://api.nest.credit/v1/actions/vaults/nest-falconx-clo/redeem/quote \
-H 'content-type: application/json' \
-d '{
"redemptionAsset": "0x222365ef19f7947e5484218551b56bb3965aa7af",
"shareAmount": "1000000",
"chainId": 98866
}'

For this guide, treat the NestVault redemption flow as the supported redemption path. If an integration receives an unsupported route value, surface it as an integration error instead of trying to fall back to a different contract flow.

Use this route to submit a redemption request on the same EVM chain.

Terminal window
curl -X POST https://api.nest.credit/v1/actions/vaults/nest-falconx-clo/redeem/build-tx \
-H 'content-type: application/json' \
-d '{
"redemptionAsset": "0x222365ef19f7947e5484218551b56bb3965aa7af",
"shareAmount": "1000000",
"chainId": 98866,
"user": "0x00000000000000000000000000000000000000ab"
}'

NestVault redemptions return:

  • approve, if the selected NestVault does not already have sufficient share-token allowance.
  • requestRedeem, to submit the asynchronous redemption request.

After the request becomes claimable, use the claim routes below.

For NestVault-backed redemptions:

Terminal window
curl -X POST https://api.nest.credit/v1/actions/vaults/nest-falconx-clo/claim/pending \
-H 'content-type: application/json' \
-d '{
"redemptionAsset": "0x222365ef19f7947e5484218551b56bb3965aa7af",
"chainId": 98866,
"user": "0x00000000000000000000000000000000000000ab"
}'
Terminal window
curl -X POST https://api.nest.credit/v1/actions/vaults/nest-falconx-clo/claim/build-tx \
-H 'content-type: application/json' \
-d '{
"redemptionAsset": "0x222365ef19f7947e5484218551b56bb3965aa7af",
"chainId": 98866,
"user": "0x00000000000000000000000000000000000000ab"
}'

claim/build-tx builds a transaction to claim all currently claimable shares for the selected NestVault and user.

The update routes are for reducing an existing pending redemption:

POST /vaults/nest-falconx-clo/update-redeem/pending
POST /vaults/nest-falconx-clo/update-redeem/build-tx

newShareAmount is the final pending share amount, not the delta to remove.

When instant liquidity is available for the selected asset, use:

POST /vaults/nest-falconx-clo/instant-redeem/quote
POST /vaults/nest-falconx-clo/instant-redeem/liquidity
POST /vaults/nest-falconx-clo/instant-redeem/build-tx

The instant-redeem request body uses redemptionAsset, shareAmount, chainId, and user. receiver is optional and defaults to user.

Use direct contracts only when your integration needs lower-level control than the Actions API provides. This path requires you to handle the full flow yourself:

This section covers:

For a direct integration, you handle:

  • Validate the selected chain, vault slug, and asset.
  • Check Predicate compliance and obtain a valid Predicate message.
  • Read the correct NestVault for the asset.
  • Quote shares or redemption assets.
  • Apply any app-level slippage or UX checks.
  • Submit ERC-20 approvals.
  • Submit deposit, redeem, update, instant-redeem, or claim calls.
  • Track asynchronous redemption state.
ContractAddress
nFALCON share token0x066d…bdff
NestVaultPredicateProxy0xfc0c…9035
USDC NestVault (Plume, Ethereum)0x4738…c5e7
pUSD NestVault (Plume)0x74c9…4c05

For accountants, roles, and other shared protocol contracts, use the Smart Contracts page as the source of truth.

For nFALCON minting, the direct flow is:

  1. Read the NestVault for the selected deposit asset and chain.
  2. Call previewDeposit(depositAmount) on that NestVault to estimate shares after fees.
  3. Get a Predicate message for the user and chain.
  4. Approve NestVaultPredicateProxy to spend the deposit asset.
  5. Call NestVaultPredicateProxy.deposit(depositAsset, depositAmount, recipient, nestVault, predicateMessage).

Minimal TypeScript outline:

import { encodeFunctionData, parseUnits } from "viem";
const chainId = 98866;
const recipient = "0x00000000000000000000000000000000000000ab";
const depositAsset = "0x222365ef19f7947e5484218551b56bb3965aa7af";
const depositAmount = parseUnits("1", 6);
const nestVault = "0x4738386d69cf5a7ac088da2887fc0df02795c5e7";
const predicateProxy = "0xfc0c4222b3a0c9b060c0b959dec62442036b9035";
// 1. previewDeposit on nestVault
// 2. get Predicate message for recipient
// 3. approve depositAsset -> predicateProxy
// 4. encode PredicateProxy deposit call
const data = encodeFunctionData({
abi: NestVaultPredicateProxyAbi,
functionName: "deposit",
args: [depositAsset, depositAmount, recipient, nestVault, predicateMessage],
});

The Actions API’s mint/build-tx route performs these steps for app integrations and is the preferred reference for expected calldata shape.

For nFALCON redemptions, use the selected NestVault for the redemption asset:

  1. Approve the NestVault to spend nFALCON shares, if allowance is insufficient.
  2. Call NestVault.requestRedeem(shareAmount, user, user).
  3. Wait until shares become claimable.
  4. Call NestVault.redeem(claimableShares, user, user) to claim the redemption asset.

If you need to reduce a pending redemption before it is claimable, call NestVault.updateRedeem(newShareAmount, user, user).

ConditionExpected behavior
Unsupported vault slugAPI returns 400.
Unsupported chain IDEVM Actions API returns 400.
Unsupported asset for the selected chainAPI returns 400.
Non-compliant walletEVM mint build returns 400; Solana mint build returns 403.
Deposit too small to mint sharesEVM quote/build returns 400.
Failed transaction simulationEVM build-tx returns 400 unless skipSimulation is true.
RPC, indexer, or Predicate service issueAPI returns 500.
Existing allowance is sufficientapprove may be omitted from returned transactions.
  • Treat every API amount as a raw integer amount.
  • Use the API’s returned depositDecimals, shareDecimals, and redemptionDecimals when rendering UI values.
  • Execute returned EVM transactions in order.
  • Never assume approve is present. Render and execute the returned transactions[].
  • Do not reuse quotes indefinitely. Re-quote close to the time the user signs.
  • For direct contract integrations, prefer the registry and Smart Contracts page over copying addresses from old integration examples.