> ## Documentation Index
> Fetch the complete documentation index at: https://docs.artstarex.com/llms.txt
> Use this file to discover all available pages before exploring further.
# RWAToken
> `RWAToken` is the core real-world asset (RWA) token contract in the ArtStar protocol, with comprehensive compliance controls and primary market sale management. It supports primary sales settled in USDT, signature-based compliance checks, purchase limits, and time-bounded sale windows.
View the RWAToken.sol source code
**Upgradability**
This contract uses the `UUPSUpgradeable` pattern and inherits from `ERC20Upgradeable`, `OwnableUpgradeable`, and `PausableUpgradeable`.
## Methods
Initialization function for the upgradeable contract. It sets token parameters, the custody wallet, the USDT reference contract, and the compliance manager.
```solidity initialize theme={null}
function initialize(
string memory _name,
string memory _symbol,
address _initialOwner,
address _custodyWallet,
address _usdt,
address _complianceManage
) public;
```
Token name
Token symbol
Initial owner
Custody wallet
USDT contract address
Compliance manager address
Configures sale parameters, including token price and purchase limits.
```solidity configureSale theme={null}
function configureSale(
uint256 _priceUSDT,
uint256 _minPurchaseUSDT,
uint256 _maxPurchaseUSDT
) external;
```
Token price in USDT
Minimum purchase amount in USDT
Maximum purchase amount in USDT
Configures the sale start and end time constraints without changing the sale's active status.
```solidity configureSaleTime theme={null}
function configureSaleTime(uint256 _startTime, uint256 _endTime) external;
```
Start timestamp
End timestamp
Activates token sales. Sale time constraints are enforced during minting.
```solidity startSale theme={null}
function startSale() external;
```
Pauses an ongoing token sale.
```solidity pauseSale theme={null}
function pauseSale() external;
```
Sets the earliest timestamp at which tokens become transferable (`0` means unlocked).
```solidity setUnlockTime theme={null}
function setUnlockTime(uint256 _unlockTime) external;
```
Unlock timestamp
Emergency unlock mechanism that immediately allows token transfers.
```solidity emergencyUnlock theme={null}
function emergencyUnlock() external;
```
Emergency function that pauses all token transfers.
```solidity pause theme={null}
function pause() external;
```
Resumes all token transfers.
```solidity unpause theme={null}
function unpause() external;
```
Updates the custody wallet address that receives raised funds.
```solidity setCustodyWallet theme={null}
function setCustodyWallet(address _custodyWallet) external;
```
New custody wallet address
Recovers unsold tokens from the sale and mints them to the custody wallet.
```solidity recoverUnsoldTokens theme={null}
function recoverUnsoldTokens() external;
```
Recovers any ERC20 tokens that were accidentally sent to this contract.
```solidity recoverTokens theme={null}
function recoverTokens(address token) external;
```
Token contract address to recover
Executes a forced token transfer for compliance or recovery purposes.
```solidity forcedTransfer theme={null}
function forcedTransfer(
address from,
address to,
uint256 amount,
string calldata reason
) external;
```
Sender address
Recipient address
Transfer amount
Reason for the transfer
Updates legal and valuation information for the underlying real-world asset.
```solidity updateAssetInfo theme={null}
function updateAssetInfo(string memory _metadataURI, uint256 _valuation) external;
```
Metadata URI
Valuation
Purchases tokens with USDT during an active sale and verifies the user's compliance signature.
```solidity mint theme={null}
function mint(
uint256 amountUSDT,
bytes memory signature,
uint256 expireTime
) external;
```
Amount of USDT paid
Compliance signature payload
Signature expiration time
Owner-only function that burns tokens from a specific address for compliance or recovery purposes.
```solidity burn theme={null}
function burn(address from, uint256 amount) external;
```
Address whose tokens will be burned
Amount to burn
Returns the remaining number of tokens available for sale.
```solidity remainingForSale theme={null}
function remainingForSale() external view returns (uint256);
```
Remaining number of tokens available for sale
Calculates how many tokens can be minted for a given USDT amount.
```solidity usdtToTokenAmount theme={null}
function usdtToTokenAmount(uint256 amountUSDT) public view returns (uint256);
```
USDT amount
Equivalent token amount
Calculates the USDT amount required for a given token amount.
```solidity tokenToUSDTAmount theme={null}
function tokenToUSDTAmount(uint256 tokenAmount) public view returns (uint256);
```
Token amount
Required USDT amount