gage

Chain, contracts, allowed loan terms, fees, the rules and any lend assets besides USDG. Start here.

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Tokens gage takes as collateral now: each one's minimum pledge, its most per loan where one is set (maxPerLoan, null where there is none), whether leverage buys it and its Borrow link on gage.cash; a row names the lend asset it is borrowed in, once there is more than USDG.

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

The largest loan the partner vaults fund now for at most maxCollateral of a token, or one exact loan (collateral and principal) priced as gage.cash prices it, in USDG or the lend asset named, with a prepare object for gage_prepare_borrow.

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    },
    "term": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Loan term in seconds, one of the terms gage_capabilities lists"
    },
    "wallet": {
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    },
    "lendAsset": {
      "description": "The asset the loan is paid in and repaid in: USDG when omitted, or a lend asset gage_capabilities lists (its token address)",
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    },
    "maxCollateral": {
      "description": "Most of the token to pledge, raw units: quotes the largest loan the vaults fund for it",
      "type": "string",
      "pattern": "^[1-9]\\d{0,77}$"
    },
    "collateral": {
      "description": "With principal: the exact pledge of one chosen loan, raw units",
      "type": "string",
      "pattern": "^[1-9]\\d{0,77}$"
    },
    "principal": {
      "description": "With collateral: the exact amount to borrow, raw units of the loan's asset; priced as the borrow card prices it",
      "type": "string",
      "pattern": "^[1-9]\\d{0,77}$"
    }
  },
  "required": [
    "token",
    "term"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Preview a leveraged loop for a pledge and a multiple: amounts, cost and the most the purchase costs. Signs nothing.

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    },
    "own": {
      "type": "string",
      "pattern": "^[1-9]\\d{0,77}$",
      "description": "The tokens you put in, raw units"
    },
    "multiple": {
      "type": "number",
      "minimum": 1.1,
      "maximum": 3,
      "description": "Leverage, 1.1 to 3 with at most two decimals (2 = twice the pledge held for the loan)"
    },
    "term": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Loan term in seconds, one of the terms gage_capabilities lists"
    },
    "wallet": {
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    },
    "lendAsset": {
      "description": "USDG only: leverage lends USDG (a loop in a lend asset is refused)",
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    }
  },
  "required": [
    "token",
    "own",
    "multiple",
    "term"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

One loan: state, amounts, deadlines, what can be done with it now (here, or on gage.cash for an action this server does not serve), its standing instruction to roll by itself, and what closed it (a roll or a cash-out).

{
  "type": "object",
  "properties": {
    "loanId": {
      "type": "string",
      "pattern": "^\\d{1,78}$"
    },
    "engine": {
      "description": "The engine; the current core when omitted",
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    }
  },
  "required": [
    "loanId"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

A wallet's loans (each one's sGAGE to claim, raw, and whether it rolls by itself), Earn holdings and credits (USDG, and each lend asset's apart).

{
  "type": "object",
  "properties": {
    "wallet": {
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$",
      "description": "The wallet that will sign"
    }
  },
  "required": [
    "wallet"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

The partner vaults that lend: tokens, fees, size, free cash, share value and each one's link on gage.cash.

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Prepare a loan: pledge a token, receive USDG (or the lend asset named by lendAsset), repay a fixed amount of it within the term. Use the prepare object of gage_borrow_quote, without its action. Returns the next unsigned transaction and a review link; never signs.

{
  "type": "object",
  "properties": {
    "wallet": {
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    },
    "token": {
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    },
    "collateral": {
      "type": "string",
      "pattern": "^[1-9]\\d{0,77}$",
      "description": "Tokens to pledge, raw units"
    },
    "principal": {
      "type": "string",
      "pattern": "^[1-9]\\d{0,77}$",
      "description": "To borrow, raw units of the loan's asset (USDG: 6 decimals)"
    },
    "cap": {
      "type": "string",
      "pattern": "^[1-9]\\d{0,77}$",
      "description": "To repay, raw units of the loan's asset, above principal"
    },
    "term": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Loan term in seconds, one of the terms gage_capabilities lists"
    },
    "lendAsset": {
      "description": "The asset the loan is paid in and repaid in: USDG when omitted, or a lend asset gage_capabilities lists (its token address)",
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    }
  },
  "required": [
    "wallet",
    "token",
    "collateral",
    "principal",
    "cap",
    "term"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Prepare a leveraged loop: the loan buys more of the pledged token in one transaction. USDG only. Refused above maxCostBps. Returns the next unsigned transaction and a review link; never signs.

{
  "type": "object",
  "properties": {
    "wallet": {
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    },
    "token": {
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    },
    "own": {
      "type": "string",
      "pattern": "^[1-9]\\d{0,77}$",
      "description": "The tokens you put in, raw units"
    },
    "multiple": {
      "type": "number",
      "minimum": 1.1,
      "maximum": 3,
      "description": "Leverage, 1.1 to 3 with at most two decimals (2 = twice the pledge held for the loan)"
    },
    "term": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Loan term in seconds, one of the terms gage_capabilities lists"
    },
    "maxCostBps": {
      "type": "integer",
      "minimum": 1,
      "maximum": 5000,
      "description": "Highest loan cost you accept, bps of the amount borrowed; the loop is refused above it"
    },
    "lendAsset": {
      "description": "USDG only: leverage lends USDG (a loop in a lend asset is refused)",
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    }
  },
  "required": [
    "wallet",
    "token",
    "own",
    "multiple",
    "term",
    "maxCostBps"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Prepare cancelling a loan still waiting for funding and taking its collateral back. Returns the next unsigned transaction and a review link; never signs.

{
  "type": "object",
  "properties": {
    "wallet": {
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    },
    "loanId": {
      "type": "string",
      "pattern": "^\\d{1,78}$"
    },
    "engine": {
      "description": "The engine; the current core when omitted, the loan's own core for a loan in a lend asset",
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    }
  },
  "required": [
    "wallet",
    "loanId"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Prepare repaying a running loan in full, in the asset it is paid in, and taking the collateral back, before its term ends. Returns the next unsigned transaction and a review link; never signs.

{
  "type": "object",
  "properties": {
    "wallet": {
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    },
    "loanId": {
      "type": "string",
      "pattern": "^\\d{1,78}$"
    },
    "engine": {
      "description": "The engine; the current core when omitted, the loan's own core for a loan in a lend asset",
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    }
  },
  "required": [
    "wallet",
    "loanId"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Prepare a deposit into a partner vault (lending), in the asset the vault takes: USDG, or its lend asset. Returns the next unsigned transaction and a review link; never signs.

{
  "type": "object",
  "properties": {
    "wallet": {
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    },
    "vault": {
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    },
    "amount": {
      "type": "string",
      "pattern": "^[1-9]\\d{0,77}$",
      "description": "To deposit, raw units of the vault's asset (USDG: 6 decimals)"
    },
    "maxSlippageBps": {
      "description": "Most the conversion may move against you, in bps; 50 when omitted",
      "type": "integer",
      "minimum": 0,
      "maximum": 500
    }
  },
  "required": [
    "wallet",
    "vault",
    "amount"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Prepare withdrawing from a partner vault, everything it can pay when shares is omitted. Returns the next unsigned transaction and a review link; never signs.

{
  "type": "object",
  "properties": {
    "wallet": {
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    },
    "vault": {
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    },
    "shares": {
      "description": "Shares to redeem, raw (18 decimals); all when omitted, less what a vault of an asset with more than 6 decimals cannot pay after a loss (a millionth of the asset at most)",
      "type": "string",
      "pattern": "^[1-9]\\d{0,77}$"
    },
    "maxSlippageBps": {
      "description": "Most the conversion may move against you, in bps; 50 when omitted",
      "type": "integer",
      "minimum": 0,
      "maximum": 500
    }
  },
  "required": [
    "wallet",
    "vault"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Prepare collecting what is ready here: USDG and lend assets from loans, collateral back, vault earnings and the sGAGE of loans and partner vaults; a claim that would revert now is left out, and said. The first vault's credits and claims, earlier engines' lender recoveries, retired Earn strategies and the GAGE/sGAGE pool's rewards and Drip are collected on gage.cash. Returns the next unsigned transaction and a review link; never signs.

{
  "type": "object",
  "properties": {
    "wallet": {
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$",
      "description": "The wallet that will sign"
    }
  },
  "required": [
    "wallet"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Prepare rating gage (agent #8845 in ERC-8004) in its Reputation Registry: your own score from 0 to 100, once a wallet, public on chain. Optional: gage offers nothing for a rating. Returns the next unsigned transaction and a review link; never signs.

{
  "type": "object",
  "properties": {
    "wallet": {
      "type": "string",
      "pattern": "^0x[0-9a-fA-F]{40}$"
    },
    "score": {
      "type": "integer",
      "minimum": 0,
      "maximum": 100,
      "description": "Your own rating of gage, a whole number from 0 (worst) to 100 (best)"
    }
  },
  "required": [
    "wallet",
    "score"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}