diff --git a/README.md b/README.md index f3ce4b4..b6a49cd 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,69 @@ -# ARKA - (Albanian for Cashier's case) is the first open source "Paymaster" as a service software. -This project was bootstrapped with Fastify-CLI. +
+

ARKA

+
-## Available Scripts +
+ +

+ + ARKA (Albanian for Cashier's case) is open source "Paymaster" as a service software. + +

+
-In the project directory, you can run: +-------------- -### `npm run dev` +>[!IMPORTANT] +>This repo/software is under active development. -To start the app in dev mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. +## 💸 Arka -### `npm start` +Arka paymaster is an open source piece of infrastructure which is a vital piece of +the [ERC-4337 stack](https://www.erc4337.io/). -For production mode +Paymasters are what is needed to sponsor users +transactions. -### `npm run test` +The flow is as follows: +- Use Etherspot's hosted version of Arka (https://arka.etherspot.io/) or deploy your own. +- [Whitelist](https://etherspot.fyi/arka/api-calls/whitelisting) an address you want to sponsor. +- [Deposit](https://etherspot.fyi/arka/api-calls/deposit) to the paymaster. +- Include the paymaster data in the [UserOp](https://etherspot.fyi/account-abstraction/userops) to have the transaction sponsored. -Run the test cases. +## 🔙 Arka Backend -## Learn More +This contains the full source code and implementation of Arka. -To learn Fastify, check out the [Fastify documentation](https://www.fastify.io/docs/latest/). +To run your own instance of this, please [follow these steps.](https://github.com/etherspot/arka/tree/master/backend#how-to-run) + +You can see a [list of available endpoints here](https://github.com/etherspot/arka/tree/master/backend#available-endpoints--). + +## 🖥 Arka Frontend + +This is a basic frontend which let's a user interact with the Arka smart contract on various chains. + +To run the dapp: +#### `cd frontend` +#### `npm i` +#### `npm start` + +For more details on what can be done here please look at [the frontend readme.](https://github.com/etherspot/arka/blob/master/frontend/README.md) + + +## 🔗 Important links + +- **[Arka developer documentation](https://etherspot.fyi/arka/intro)** +- **[Sponsor a Transaction](https://etherspot.fyi/arka/sponsor-a-transaction)** +- **[Chains which Arka is live on](https://etherspot.fyi/skandha/chains)** + + +## 💬 Contact + +If you have any questions or feedback about Arka, please feel free to reach out to us. + +- [Follow on Twitter](https://twitter.com/etherspot) +- [Join our discord](https://discord.etherspot.io/) + +## 📄 License + +Licensed under the [MIT License](https://github.com/etherspot/arka/blob/master/LICENSE). diff --git a/backend/README.md b/backend/README.md index acd33ba..8340009 100644 --- a/backend/README.md +++ b/backend/README.md @@ -1,4 +1,4 @@ -# Mock Paymaster API +# Arka Paymaster API This is a simple API that signs userOps so that their fees are covered by EtherspotPaymaster contract.