Skip to main content

Vault

Struct Vault 

Source
pub struct Vault {
    pub address: VaultAddress,
    pub catalog_vault_id: CatalogVaultId,
    pub created_at: DateTime<Utc>,
    pub fee_recipient_address: VaultFeeRecipientAddress,
    pub metrics: Option<VaultMetrics>,
    pub network: LendNetwork,
    pub performance_fee_bps: i64,
    pub status: VaultStatus,
    pub underlying_asset: Asset,
    pub vault_id: VaultId,
}
Expand description

A vault created on top of a catalog vault.

JSON schema
{
 "description": "A vault created on top of a catalog vault.",
 "type": "object",
 "required": [
   "address",
   "catalogVaultId",
   "createdAt",
   "feeRecipientAddress",
   "network",
   "performanceFeeBps",
   "status",
   "underlyingAsset",
   "vaultId"
 ],
 "properties": {
   "address": {
     "description": "The 0x-prefixed onchain address of the vault. The address is deterministic and known at creation; the vault deploys at this address once the deployment user operation is included onchain.",
     "examples": [
       "0x15966F1582CAEFB56CDB4Fba1dC622E41F2Ad33D"
     ],
     "type": "string",
     "pattern": "^0x[a-fA-F0-9]{40}$"
   },
   "catalogVaultId": {
     "$ref": "#/components/schemas/CatalogVaultId"
   },
   "createdAt": {
     "description": "The time the vault was created, in RFC 3339 format.",
     "examples": [
       "2026-09-15T15:39:37Z"
     ],
     "type": "string",
     "format": "date-time"
   },
   "feeRecipientAddress": {
     "description": "The 0x-prefixed address that receives the vault's performance fees.",
     "examples": [
       "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
     ],
     "type": "string",
     "pattern": "^0x[a-fA-F0-9]{40}$"
   },
   "metrics": {
     "description": "The vault's current metrics. Only present once at least one metrics snapshot has been observed for the vault.",
     "examples": [
       {
         "apyBps": 500,
         "apyUpdatedAt": "2026-09-22T00:00:00Z",
         "tvl": "1000",
         "tvlUpdatedAt": "2026-09-22T00:00:00Z"
       }
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/VaultMetrics"
       }
     ]
   },
   "network": {
     "$ref": "#/components/schemas/LendNetwork"
   },
   "performanceFeeBps": {
     "description": "Your performance fee, in basis points. CDP charges an additional fee equal to currently 10% (1000 bps) of your fee.",
     "examples": [
       2000
     ],
     "type": "integer",
     "maximum": 5000.0,
     "minimum": 0.0
   },
   "status": {
     "$ref": "#/components/schemas/VaultStatus"
   },
   "underlyingAsset": {
     "description": "The symbol of the vault's underlying asset.",
     "examples": [
       "usdc"
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/Asset"
       }
     ]
   },
   "vaultId": {
     "$ref": "#/components/schemas/VaultId"
   }
 }
}

Fields§

§address: VaultAddress

The 0x-prefixed onchain address of the vault. The address is deterministic and known at creation; the vault deploys at this address once the deployment user operation is included onchain.

§catalog_vault_id: CatalogVaultId§created_at: DateTime<Utc>

The time the vault was created, in RFC 3339 format.

§fee_recipient_address: VaultFeeRecipientAddress

The 0x-prefixed address that receives the vault’s performance fees.

§metrics: Option<VaultMetrics>

The vault’s current metrics. Only present once at least one metrics snapshot has been observed for the vault.

§network: LendNetwork§performance_fee_bps: i64

Your performance fee, in basis points. CDP charges an additional fee equal to currently 10% (1000 bps) of your fee.

§status: VaultStatus§underlying_asset: Asset

The symbol of the vault’s underlying asset.

§vault_id: VaultId

Implementations§

Trait Implementations§

Source§

impl Clone for Vault

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Vault

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Vault

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&Vault> for Vault

Source§

fn from(value: &Vault) -> Self

Converts to this type from the input type.
Source§

impl From<Vault> for Vault

Source§

fn from(value: Vault) -> Self

Converts to this type from the input type.
Source§

impl Serialize for Vault

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<Vault> for Vault

Source§

type Error = ConversionError

The type returned in the event of a conversion error.
Source§

fn try_from(value: Vault) -> Result<Self, ConversionError>

Performs the conversion.

Auto Trait Implementations§

§

impl Freeze for Vault

§

impl RefUnwindSafe for Vault

§

impl Send for Vault

§

impl Sync for Vault

§

impl Unpin for Vault

§

impl UnsafeUnpin for Vault

§

impl UnwindSafe for Vault

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more