Mutations

Updating off-chain vault metadata with an EIP-712 signature from the vault owner.

The API exposes a single mutation today, used by vault owners to update off-chain metadata — the descriptive fields shown on the Lagoon frontend. None of these fields affect on-chain behaviour; for on-chain configuration, use the vault contract directly (see Smart Contract Reference).

updateVaultMetadata

mutation UpdateVaultMetadata(
  $vault: Address!
  $chainId: Int!
  $input: UpdateVaultMetadataInput!
  $signature: String!
  $deadline: Int!
) {
  updateVaultMetadata(
    vaultAddress: $vault
    chainId: $chainId
    input: $input
    signature: $signature
    deadline: $deadline
  ) {
    address
    name
    description
    shortDescription
    maxCapacity
    transparencyUrl
  }
}

Try in Apollo Sandbox →

Input fields

UpdateVaultMetadataInput — every field is optional; omitted fields are left unchanged.

Field	Type	Description
description	String	Detailed description of the vault and its strategy.
shortDescription	String	One-line summary.
maxCapacity	String	Off-chain soft cap on total deposits, surfaced to the frontend so vault operators can limit incoming deposits via the UI. Purely informative, no on-chain enforcement.
averageSettlement	Float	Average settlement time in hours.
transparencyUrl	String	URL to a transparency report or dashboard.

Authentication

The mutation is gated by an EIP-712 signature from the vault owner. The server recovers the signer from signature over the typed data, then checks that the recovered address matches the on-chain owner of vaultAddress on chainId. deadline is a Unix-seconds timestamp after which the signature is rejected (replay protection); the Lagoon dApp uses a 5-minute TTL.

Domain

{
  name: 'Lagoon Vault Admin',
  version: '1',
  chainId,            // uint256 — same chainId as the mutation argument
  verifyingContract,  // address — same vaultAddress as the mutation argument
}

Typed data

primaryType: 'UpdateVaultMetadata'

UpdateVaultMetadata: [
  { name: 'chainId',           type: 'uint256' },
  { name: 'vaultAddress',      type: 'address' },
  { name: 'description',       type: 'string'  },
  { name: 'shortDescription',  type: 'string'  },
  { name: 'transparencyUrl',   type: 'string'  },
  { name: 'maxCapacity',       type: 'string'  },
  { name: 'averageSettlement', type: 'string'  },
  { name: 'deadline',          type: 'uint256' },
]

Defaults must match exactly or the signature will silently fail to verify.

• Omitted string fields → '' (empty string)

• Omitted uint256 fields → 0n

• averageSettlement is hashed as a string, not a number — format with value.toFixed(6) so the canonical decimal representation matches the backend.

Signing with viem / wagmi

import { useSignTypedData } from 'wagmi';

const signature = await signTypedDataAsync({
  domain: {
    name: 'Lagoon Vault Admin',
    version: '1',
    chainId: BigInt(chainId),
    verifyingContract: vaultAddress,
  },
  types: {
    UpdateVaultMetadata: [
      { name: 'chainId',           type: 'uint256' },
      { name: 'vaultAddress',      type: 'address' },
      { name: 'description',       type: 'string'  },
      { name: 'shortDescription',  type: 'string'  },
      { name: 'transparencyUrl',   type: 'string'  },
      { name: 'maxCapacity',       type: 'string'  },
      { name: 'averageSettlement', type: 'string'  },
      { name: 'deadline',          type: 'uint256' },
    ],
  },
  primaryType: 'UpdateVaultMetadata',
  message: {
    chainId: BigInt(chainId),
    vaultAddress,
    description:       input.description       ?? '',
    shortDescription:  input.shortDescription  ?? '',
    transparencyUrl:   input.transparencyUrl   ?? '',
    maxCapacity:       input.maxCapacity       ?? '',
    averageSettlement: input.averageSettlement != null
      ? input.averageSettlement.toFixed(6)
      : '',
    deadline: BigInt(deadline),
  },
});

Example call

Shape of the call (the signature below is a placeholder — produce yours by signing the EIP-712 payload with the vault owner's key):

curl -sS -X POST https://api.lagoon.finance/query \
  -H "Content-Type: application/json" \
  -d '{
    "query": "mutation UpdateVaultMetadata($vault: Address!, $chainId: Int!, $input: UpdateVaultMetadataInput!, $signature: String!, $deadline: Int!) { updateVaultMetadata(vaultAddress: $vault, chainId: $chainId, input: $input, signature: $signature, deadline: $deadline) { address name description shortDescription maxCapacity transparencyUrl } }",
    "variables": {
      "vault": "0x936facdf10c8c36294e7b9d28345255539d81bc7",
      "chainId": 1,
      "input": { "shortDescription": "rETH yield strategy.", "averageSettlement": 24 },
      "signature": "0x...",
      "deadline": 1800000000
    }
  }'

The mutation returns the updated Vault so the client can read back the new metadata without a follow-up query.