Skip to content

Commit 76e0ed9

Browse files
committed
feat(docs): add IMintingTagManager reference and update IAssetManager with new functions
1 parent b389885 commit 76e0ed9

3 files changed

Lines changed: 126 additions & 1 deletion

File tree

docs/fassets/10-reference.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,12 @@ Smart contract interfaces for interacting with the FAssets system.
6262
href: "/fassets/reference/ICoreVaultManager",
6363
docId: "fassets/reference/ICoreVaultManager",
6464
},
65+
{
66+
type: "link",
67+
label: "IMintingTagManager",
68+
href: "/fassets/reference/IMintingTagManager",
69+
docId: "fassets/reference/IMintingTagManager",
70+
},
6571
{
6672
type: "link",
6773
label: "IAgentOwnerRegistry",

docs/fassets/reference/IAssetManager.mdx

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,27 @@ function fAsset()
9898
returns (IERC20);
9999
```
100100

101+
### `directMintingPaymentAddress`
102+
103+
Gets the payment address to which the underlying assets must be sent for direct minting.
104+
105+
```solidity
106+
function directMintingPaymentAddress()
107+
external view
108+
returns (string memory);
109+
```
110+
111+
### `getMintingTagManager`
112+
113+
Returns the minting tag manager contract address.
114+
To interact with it, use the [IMintingTagManager](/fassets/reference/IMintingTagManager) reference.
115+
116+
```solidity
117+
function getMintingTagManager()
118+
external view
119+
returns (address);
120+
```
121+
101122
## Agents
102123

103124
## `getAllAgents`
@@ -305,7 +326,8 @@ Sourced from `ICoreVaultSettings.sol` on [GitHub](https://github.com/flare-found
305326

306327
### `getCoreVaultManager`
307328

308-
Returns the core vault manager address. To interact with the Core Vault manager reference the [Core Vault Manager](/fassets/reference/ICoreVaultManager) contract.
329+
Returns the core vault manager address.
330+
To interact with the Core Vault manager reference the [Core Vault Manager](/fassets/reference/ICoreVaultManager) contract.
309331

310332
```solidity
311333
function getCoreVaultManager()
Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
title: IMintingTagManager
3+
description: FAssets IMintingTagManager interface reference.
4+
keywords: [fassets, minting-tags, xrp, bitcoin, dogecoin, flare-network]
5+
sidebar_position: 5
6+
---
7+
8+
Reference for managing and interacting with FAssets `IMintingTagManager`.
9+
10+
To get the minting tag manager address, use the [getMintingTagManager](/fassets/reference/IAssetManager#getmintingtagmanager) method on the [IAssetManager](/fassets/reference/IAssetManager) contract.
11+
12+
## Functions
13+
14+
### `reserve`
15+
16+
Reserve a new minting tag by paying the reservation fee.
17+
The caller becomes the owner of the tag and the initial minting recipient.
18+
19+
```solidity
20+
function reserve() external payable returns (uint256);
21+
```
22+
23+
#### Returns
24+
25+
- The newly reserved minting tag ID.
26+
27+
### `setMintingRecipient`
28+
29+
Set the minting recipient for a tag.
30+
Only callable by the tag owner.
31+
The minting recipient is the address that receives minted FAssets when this tag is used.
32+
33+
```solidity
34+
function setMintingRecipient(uint256 _mintingTag, address _recipient) external;
35+
```
36+
37+
#### Parameters
38+
39+
- `_mintingTag`: The minting tag ID.
40+
- `_recipient`: The new minting recipient address (must not be the zero address).
41+
42+
### `reservationFee`
43+
44+
Return the fee (in native currency) required to reserve a new minting tag.
45+
46+
```solidity
47+
function reservationFee() external view returns (uint256);
48+
```
49+
50+
### `reservedTagsForOwner`
51+
52+
Return all minting tag IDs owned by the given address.
53+
54+
```solidity
55+
function reservedTagsForOwner(address _owner) external view returns (uint256[] memory);
56+
```
57+
58+
#### Parameters
59+
60+
- `_owner`: The address to query.
61+
62+
#### Returns
63+
64+
- An array of minting tag IDs owned by `_owner`.
65+
66+
### `mintingRecipient`
67+
68+
Return the minting recipient for a given tag.
69+
70+
```solidity
71+
function mintingRecipient(uint256 _mintingTag) external view returns (address);
72+
```
73+
74+
#### Parameters
75+
76+
- `_mintingTag`: The minting tag ID.
77+
78+
#### Returns
79+
80+
- The address that receives minted FAssets when this tag is used.
81+
82+
### `allowedExecutor`
83+
84+
Return the currently active allowed executor for a given tag.
85+
If no executor is set or the pending change has not activated yet, this returns the previous executor.
86+
87+
```solidity
88+
function allowedExecutor(uint256 _mintingTag) external view returns (address);
89+
```
90+
91+
#### Parameters
92+
93+
- `_mintingTag`: The minting tag ID.
94+
95+
#### Returns
96+
97+
- The address of the allowed executor, or `address(0)` if none is set.

0 commit comments

Comments
 (0)