Skip to content

Commit bcb20c9

Browse files
committed
feat(docs): expand ICoreVaultManager documentation with new functions
1 parent a4152f3 commit bcb20c9

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

docs/fassets/reference/ICoreVaultManager.mdx

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,67 @@ function getSettings()
3232
- `_escrowAmount`: The amount of assets to be held in escrow.
3333
- `_minimalAmount`: The minimum amount that must remain in the vault after operations.
3434
- `_fee`: The fee charged for operations.
35+
36+
### `getAllowedDestinationAddresses`
37+
38+
Returns the list of allowed destination addresses.
39+
40+
```solidity
41+
function getAllowedDestinationAddresses() external view returns (string[] memory);
42+
```
43+
44+
### `isDestinationAddressAllowed`
45+
46+
Checks if the destination address is allowed.
47+
48+
```solidity
49+
function isDestinationAddressAllowed(string memory _address) external view returns (bool);
50+
```
51+
52+
### `coreVaultAddress`
53+
54+
Returns the core vault address.
55+
56+
```solidity
57+
function coreVaultAddress() external view returns (string memory);
58+
```
59+
60+
### `coreVaultAddressHash`
61+
62+
Returns the core vault address hash.
63+
64+
```solidity
65+
function coreVaultAddressHash() external view returns (bytes32);
66+
```
67+
68+
### `assetManager`
69+
70+
Returns the corresponding asset manager.
71+
72+
```solidity
73+
function assetManager() external view returns (address);
74+
```
75+
76+
### `custodianAddress`
77+
78+
Returns the custodian address.
79+
80+
```solidity
81+
function custodianAddress() external view returns (string memory);
82+
```
83+
84+
### `availableFunds`
85+
86+
Returns the available funds.
87+
88+
```solidity
89+
function availableFunds() external view returns (uint128);
90+
```
91+
92+
### `escrowedFunds`
93+
94+
Returns the escrowed funds.
95+
96+
```solidity
97+
function escrowedFunds() external view returns (uint128);
98+
```

0 commit comments

Comments
 (0)