@water-cooler-studios/monad-contracts-core 1.0.0

package/LICENSE

@@ -0,0 +1,95 @@
+Business Source License 1.1
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
+"Business Source License" is a trademark of MariaDB Corporation Ab.
+
+-----------------------------------------------------------------------------
+
+Parameters
+
+Licensor:             Water Cooler Studios
+
+Licensed Work:        Kintsu Contracts Core
+
+Change Date:          2027-25-12
+
+Change License:       GNU General Public License v2.0 or later
+
+-----------------------------------------------------------------------------
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+MariaDB hereby grants you permission to use this License’s text to license
+your works, and to refer to it using the trademark "Business Source License",
+as long as you comply with the Covenants of Licensor below.
+
+-----------------------------------------------------------------------------
+
+Covenants of Licensor
+
+In consideration of the right to use this License’s text and the "Business
+Source License" name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where "compatible" means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text "None".
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.
+
+-----------------------------------------------------------------------------
+
+Notice
+
+The Business Source License (this document, or the "License") is not an Open
+Source license. However, the Licensed Work will eventually be made available
+under an Open Source License, as stated in this License.

package/README.md

@@ -0,0 +1,54 @@
+# Monad Contracts
+
+### Install Build Tools
+
+```shell
+curl -L https://foundry.paradigm.xyz | bash
+foundryup
+forge soldeer install
+```
+
+### Build
+
+```shell
+forge build
+```
+
+### Test
+
+```shell
+forge test
+```
+
+### Deploy contracts locally
+
+- Open new terminal and run
+  ```shell
+  anvil --code-size-limit 128000
+  ```
+- Create `.env` file (if not already present) from [.env.local](.env.local) template
+- Change `.env` file if desired, currently configured with default anvil wallet
+- Deploy in separate terminal window with:
+  ```shell
+  forge script DeployCore --rpc-url anvil --broadcast
+  ```
+
+### Common commands
+```bash
+cast call $SMON "balanceOf(address)(uint256)" $ME
+cast call $SMON "getAllUserUnlockRequests(address)((uint96,uint96,uint40,uint16)[])" $ME
+cast send $SMON --private-key $PK "deposit(uint96,address)(uint96)" 0 $ME --value "1 ether"
+cast send $SMON --private-key $PK "requestUnlock(uint96,uint96)(uint96)" "1 ether" 0
+cast send $SMON --private-key $PK "redeem(uint256,address)(uint96)" 0 $ME
+cast send $SMON --private-key $PK "submitBatch()"
+cast send $SMON --private-key $PK "sweep(uint64[],uint8)" "[3]" 32
+cast send $SMON --private-key $PK "compound(uint64[])" "[3]"
+```
+
+### Direct Staking Precompile Interactions
+```bash
+cast call 0x0000000000000000000000000000000000001000 "getDelegator(uint64,address)(uint256,uint256,uint256,uint256,uint256,uint256,uint256)" 3 $ME
+cast send --private-key $PK 0x0000000000000000000000000000000000001000 "delegate(uint64)(bool)" 3 --value "0.1 ether"
+cast send --private-key $PK 0x0000000000000000000000000000000000001000 "undelegate(uint64,uint256,uint8)(bool)" 3 "0.1 ether" 0
+cast send --private-key $PK 0x0000000000000000000000000000000000001000 "withdraw(uint64,uint8)(bool)" 3 0
+```