Skip to content

Commit 7aea90b

Browse files
sambachasambacha
committed
refactor(docs): release
1 parent bea75ad commit 7aea90b

File tree

94 files changed

+8808
-24035
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+8808
-24035
lines changed

‎.editorconfig

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# top-most EditorConfig file
2+
3+
root = true
4+
[*]
5+
indent_style = space
6+
end_of_line = lf
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
max_line_length = 100
11+
indent_size = 2
12+
13+
# Markdown
14+
[*.{md,adoc,asciidoc}]
15+
charset = utf-8
16+
end_of_line = lf
17+
insert_final_newline = true
18+
trim_trailing_whitespace = false
19+
20+
# Match nix files, set indent to spaces with width of two
21+
[*.nix]
22+
indent_style = space
23+
indent_size = 2
24+
25+
# JavaScript, JSON, JSX, JavaScript Modules, TypeScript
26+
# https://github.com/feross/standard
27+
# https://prettier.io
28+
[*.{cjs,js,json,jsx,mjs,ts,tsx}]
29+
indent_size = 2
30+
indent_style = space
31+
32+
# HTML
33+
# https://google.github.io/styleguide/htmlcssguide.xml#General_Formatting_Rules
34+
[*.{htm,html}]
35+
indent_size = 2
36+
indent_style = space
37+
trim_trailing_whitespace = true
38+
# TOML
39+
# https://github.com/toml-lang/toml/tree/master/examples
40+
[*.toml]
41+
indent_size = 2
42+
indent_style = space
43+
44+
# YAML
45+
# http://yaml.org/spec/1.2/2009-07-21/spec.html#id2576668
46+
[*.{yaml,yml}]
47+
indent_size = 2
48+
indent_style = space
49+
50+
# Shell
51+
# https://google.github.io/styleguide/shell.xml#Indentation
52+
[*.{bash,sh,zsh}]
53+
indent_size = 2
54+
indent_style = space
55+
56+
# confg + cfg
57+
[*.{conf,cfg}]
58+
charset = UTF-8
59+
end_of_line = LF
60+
indent_size = 4
61+
indent_style = tab
62+
insert_final_newline = true
63+
tab_width = 4
64+
trim_trailing_whitespace = true
65+
66+
# Match diffs, avoid to trim trailing whitespace
67+
[*.{diff,patch}]
68+
trim_trailing_whitespace = false

‎.vscode/extensions.json

-10
This file was deleted.

‎.vscode/settings.json

-4
This file was deleted.

‎.vscode/spellright.dict

-4
This file was deleted.

‎babel.config.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

‎data/rebate.schema.json

-80
This file was deleted.

‎docs/api.md

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
sidebar_position: 5
3+
---
4+
5+
# OpenMEV RPC
6+
7+
> Supported RPC and API Endpoints for OpenMEV
8+
9+
OpenMEV provides HTTP endpoints to interact with the reputation service and
10+
HTTP/WS endpoints to access onchain data with a subgraph.
11+
12+
:::tip If you want to use the OpenMEV APIs with a JavaScript library you can
13+
also use the npm package
14+
[`libmev`](https://github.com/manifoldfinance/libmev).
15+
:::
16+
17+
18+
## `Websocket`
19+
20+
> NOTE: You must have `wscat` installed - `npm i -g wscat`
21+
22+
```bash title="Shell"
23+
wscat -c wss://api.sushirelay.com/v1
24+
```
25+
26+
```json title="Response"
27+
< {"method":"manifold_motd","jsonrpc":"2.0","params":{"result":{"notice":"THIS IS A NOTICE OF MONITORING OF MANIFOLD FINANCE, INC NETWORK INFORMATION SYSTEMS By logging into Manifold Finance, Inc computer systems, you acknowledge and consent to monitoring of this system. Network Policy <https://docs.manifoldfinance.com/network/policy> By using this network, you certify that you have read, understand, and agree to abide by the Rules of Behavior for Manifold Finance Network Platform."}}}
28+
>
29+
```
30+
31+
32+
## Response RPC Methods
33+
34+
These are methods we support for which we return static responses to ensure compliance
35+
36+
```
37+
eth_chainId
38+
eth_protocolVersion
39+
eth_mining
40+
eth_hashrate
41+
eth_accounts
42+
eth_syncing
43+
eth_coinbase
44+
net_listening
45+
net_peerCount
46+
net_version
47+
web3_clientVersion
48+
```
49+
50+
## Supported RPC
51+
52+
These are all methods we expose and proxy to our internal eth clients
53+
```
54+
eth_blockNumber
55+
eth_call
56+
eth_estimateGas
57+
eth_gasPrice
58+
eth_getBalance
59+
eth_getBlockByHash
60+
eth_getBlockByNumber
61+
eth_getBlockTransactionCountByHash
62+
eth_getBlockTransactionCountByNumber
63+
eth_getCode
64+
eth_getStorageAt
65+
eth_getTransactionByBlockHashAndIndex
66+
eth_getTransactionByBlockNumberAndIndex
67+
eth_getTransactionByHash
68+
eth_getTransactionCount
69+
eth_getTransactionReceipt
70+
eth_getUncleByBlockHashAndIndex
71+
eth_getUncleByBlockNumberAndIndex
72+
eth_getUncleCountByBlockHash
73+
eth_getUncleCountByBlockNumber
74+
eth_sign
75+
eth_signTypedData
76+
eth_sendRawTransaction
77+
```
78+
79+
80+
### OpenMEV Transaction
81+
82+
Same signature as `eth_sendRawTransaction` but the tx is eligible for arb and goes into our OpenMEV workflow (e.g. gas rebate).
83+
Anything received via `eth_sendRawTransaction` just gets relayed
84+
85+
```
86+
manifold_sendTransaction
87+
```
88+

‎docs/contributing.md

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
---
2+
sidebar_position: 8
3+
---
4+
5+
# Contributing
6+
7+
:tada: Thank you for being interested in contributing to the OpenMEV project!:tada:
8+
9+
Feel welcome and read the following sections in order to know how to ask
10+
questions and how to work on something.
11+
12+
We're really glad you're reading this, because we need volunteer developers to
13+
help this project come to fruition. 👏
14+
15+
## Pull Requests
16+
17+
The best way to contribute to our projects is with pull requests. Here's a quick
18+
guide:
19+
20+
1. Fork the repo.
21+
22+
2. Run the tests. We only take pull requests with passing tests.
23+
24+
3. Add a test for your change. Only refactoring and documentation changes
25+
require no new tests.
26+
27+
4. Make sure to check out the [Style Guide](/contributing#style-guide) and
28+
ensure that your code complies with the rules.
29+
30+
5. Make the test pass.
31+
32+
6. Commit your changes.
33+
34+
7. Push to your fork and submit a pull request on our `dev` branch. Please
35+
provide us with some explanation of why you made the changes you made. For
36+
new features make sure to explain a standard use case to us.
37+
38+
## CI (Github Actions) Tests
39+
40+
We use GitHub Actions to test each PR before it is merged.
41+
42+
When you submit your PR (or later change that code), a CI build will
43+
automatically be kicked off. A note will be added to the PR, and will indicate
44+
the current status of the build.
45+
46+
## Style Guide
47+
48+
### Code rules
49+
50+
We always use ESLint and Prettier. To check that your code follows the rules,
51+
simply run the npm script `yarn lint`.
52+
53+
### Commits rules
54+
55+
For commits it is recommended to use
56+
[Conventional Commits](https://www.conventionalcommits.org).
57+
58+
Don't worry if it looks complicated, in our repositories, after `git add`, you
59+
can usually run the npm script `yarn commit` to make many of these steps
60+
interactive.
61+
62+
Each commit message consists of a **header**, a **body** and a **footer**. The
63+
**header** has a special format that includes a **type**, a **scope** and a
64+
**subject**:
65+
66+
<type>(<scope>): <subject>
67+
<BLANK LINE>
68+
<body>
69+
<BLANK LINE>
70+
<footer>
71+
72+
The **header** is mandatory and the **scope** of the header is optional.
73+
74+
#### Type
75+
76+
The type must be one of the following:
77+
78+
- feat: A new feature
79+
- fix: A bug fix
80+
- docs: Documentation only changes
81+
- style: Changes that do not affect the meaning of the code (white-space,
82+
formatting, missing semi-colons, etc)
83+
- refactor: A code change that neither fixes a bug nor adds a feature
84+
(improvements of the code structure)
85+
- perf: A code change that improves the performance
86+
- test: Adding missing or correcting existing tests
87+
- build: Changes that affect the build system or external dependencies (example
88+
scopes: gulp, npm)
89+
- ci: Changes to CI configuration files and scripts (example scopes: travis,
90+
circle)
91+
- chore: Other changes that don't modify src or test files
92+
- revert: Reverts a previous commit
93+
94+
#### Scope
95+
96+
The scope should be the name of the npm package affected (as perceived by the
97+
person reading the changelog generated from commit messages).
98+
99+
#### Subject
100+
101+
The subject contains a succinct description of the change:
102+
103+
- Use the imperative, present tense: "change" not "changed" nor "changes"
104+
- Don't capitalize the first letter
105+
- No dot (.) at the end
106+
107+
#### Body
108+
109+
Just as in the subject, use the imperative, present tense: "change" not
110+
"changed" nor "changes". The body should include the motivation for the change
111+
and contrast this with previous behavior.
112+
113+
### Branch rules
114+
115+
- There must be a `main` branch, used only for the releases.
116+
- There must be a `dev` branch, used to merge all the branches under it.
117+
- Avoid long descriptive names for long-lived branches.
118+
- Use kebab-case (no CamelCase).
119+
- Use grouping tokens (words) at the beginning of your branch names (in a
120+
similar way to the `type` of commit).
121+
- Define and use short lead tokens to differentiate branches in a way that is
122+
meaningful to your workflow.
123+
- Use slashes to separate parts of your branch names.
124+
- Remove branch after merge if it is not important.
125+
126+
Examples:
127+
128+
```bash
129+
git branch -b docs/readme
130+
git branch -b test/a-feature
131+
git branch -b feat/sidebar
132+
git branch -b fix/b-feature
133+
```

0 commit comments

Comments
 (0)