Smart Balance | Enclave API Documentation

Enclave API Documentation

Get smart balance for a wallet address

GET/v3/smartbalance/getbalance

Query parameters

Response

Balance retrieved successfully

Body

netBalancestring

The net balance of the wallet

balancesobject

Detailed balance information across networks

Request

const response = await fetch('/v3/smartbalance/getbalance?walletAddress=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "netBalance": "text",
  "balances": {}
}

Get a quote for converting smart balance between networks

POST/v3/smartbalance/getquote

Body

walletAddress*string

outputNetwork*number

amount*string

type*enum

The type of conversion (debit or credit)

debitcredit

limitnumber

Optional limit for the conversion amount

Response

Quote generated successfully

Body

quoteobject

Request

const response = await fetch('/v3/smartbalance/getquote', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "walletAddress": "text",
      "outputNetwork": 1,
      "amount": "text",
      "type": "debit"
    }),
});
const data = await response.json();

Response

{
  "quote": {
    "amount": "text",
    "fee": "text",
    "total": "text"
  }
}

Compute solution for smart balance withdrawal

POST/v3/smartbalance/computesolution

Body

walletAddress*string

Address of the wallet

amount*string

Amount to withdraw

type*enum

Type of transaction

debitcredit

limitnumber

Optional limit for the transaction

outputNetwork*number

Target network for the withdrawal

Response

Solution computed successfully

Body

withdrawalPlanobject

Computed withdrawal plan details

tokenToClaimobject

Token details to be claimed

transactionsobject

signaturesobject

Request

const response = await fetch('/v3/smartbalance/computesolution', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "walletAddress": "text",
      "amount": "text",
      "type": "debit",
      "outputNetwork": 1
    }),
});
const data = await response.json();

Response

{
  "withdrawalPlan": {},
  "tokenToClaim": {},
  "transactions": {
    "claim": {},
    "withdrawal": {}
  },
  "signatures": {
    "paymaster": "text",
    "withdrawal": "text"
  }
}