@mantleio/viem 0.0.1-alpha.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present Mantle
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,54 @@
+<br/>
+
+<p align="center">
+  <a href="https://viem.mantle.xyz/">
+  <h1>Mantle Viem</h1>
+  </a>
+</p>
+
+<p align="center">
+  Viem Extension for Mantle Chain
+<p>
+
+<br>
+
+## Features
+
+- Simplifies cross L1 & L2 interactions
+- Seamless extension to [Viem](https://github.com/wagmi-dev/viem)
+- TypeScript ready
+- Test suite running against [forked](https://ethereum.org/en/glossary/#fork) Ethereum network
+
+## Overview
+
+```ts
+// import modules
+import { walletActionsL1 } from '@mantleio/viem'
+import { mantle } from '@mantleio/viem/chains'
+import { createWalletClient, custom } from 'viem'
+import { privateKeyToAccount } from 'viem/accounts'
+import { mainnet } from 'viem/chains'
+
+// create wallet clients
+export const walletClientL1 = createWalletClient({
+  chain: mainnet,
+  transport: custom(window.ethereum),
+}).extend(walletActionsL1())
+
+// perform an action
+const hash = await walletClientL1.depositMNT({
+  account,
+  request: {
+    amount: parseEther('1'),
+  },
+  targetChain: mantle,
+})
+```
+
+## Contributing
+
+If you're interested in contributing, please read the [contributing docs](CONTRIBUTING.md) **before submitting a pull request**.
+
+## License
+
+[MIT](LICENSE.md) License