@majora-finance/mopt v1.0.0

MajoraOperationsPaymentToken Smart Contract

MajoraOperationsPaymentToken is a Solidity smart contract that extends the functionality of ERC20 tokens with additional features to facilitate payments and allowances for specific Majora infrastructure operations. It allows users to establish operation allowances to Majora vaults or position manager.

Features

1. ERC20 Token Functionality: This smart contract inherits from the OpenZeppelin's ERC20Upgradeable contract, providing all the standard ERC20 token functionalities like transfer, transferFrom, and balanceOf.

2. Permit Functionality: The contract also utilizes the ERC20PermitUpgradeable extension to enable users to approve allowances for an operation using a permit function, allowing for a gasless approval process.

3. Burn Functionality: The contract includes the ERC20BurnableUpgradeable extension, allowing token holders to burn their tokens, removing them from the circulating supply.

4. Ownable: The contract inherits from OwnableUpgradeable, which ensures that only the contract's owner has the ability to set the operator proxy and payment fee.

Package

To install the npm package with all ethers@5.7 interfaces:

npm install @majora-finance/mopt

Usage

1. Initialize the Contract: After deploying the contract, call the initialize function with the desired name and symbol for the ERC20 token.

2. Set Operator Proxy: Only the owner of the contract can set the operator proxy by calling the setOperatorProxy function and providing the address of the proxy.

3. Set Payment Fee: The contract owner can set the payment fee (in basis points) by calling the setPaymentFee function.

4. Mint Tokens: Users can mint tokens to their address by sending Ether to the mint function. The amount of Ether sent will be converted to tokens.

5. Burn Tokens: Users can burn their tokens by calling the burn function with the desired token amount.

6. Approve Operation: Users can approve an operator to spend tokens on their behalf for a specific operation using the approveOperation function.

7. Execute Payment: The operator proxy can execute a payment on behalf of a user by calling the executePayment function, providing the payer's address, the recipient's address, the operator's address, and the payment amount. The payment amount will be deducted from the payer's balance, and a configurable payment fee will be deducted and sent to the contract owner.

License

This project is licensed under the BUSL-1.1 license. Please refer to the individual contract files for their specific license information.

Disclaimer

These contracts are provided as-is without any warranty or guarantee of any kind. Use them at your own risk. Always review and audit the code before deploying it in a production environment.