Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DevOps updates and Fixes #294

Merged
merged 61 commits into from
Oct 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
61 commits
Select commit Hold shift + click to select a range
0139177
Merge branch 'main' into fixes
m4sterbunny Aug 14, 2023
b068862
Merge branch 'main' into fixes
m4sterbunny Aug 15, 2023
04ccc49
updates foundry tutorial link
m4sterbunny Aug 15, 2023
f395eb7
backup location for Grammarly style guide
m4sterbunny Aug 15, 2023
df29a3f
adds to backup style
m4sterbunny Aug 17, 2023
016d35a
Fixes (#73)
m4sterbunny Aug 22, 2023
1e1aa94
Merge branch 'main' into fixes
m4sterbunny Aug 24, 2023
a4fee95
updates style and applies style to Galan
m4sterbunny Aug 24, 2023
5a22cee
applies discussed updates to remove duplication
m4sterbunny Aug 28, 2023
ca3a895
finishes proof and updates style guide
m4sterbunny Aug 28, 2023
19f6e7a
style only
m4sterbunny Sep 1, 2023
19c8005
added mainnet contract
m4sterbunny Sep 1, 2023
ea2df10
adds keys for review
m4sterbunny Sep 4, 2023
88268cc
Feature/ndev 1996/neon transfer demo (#75)
m4sterbunny Sep 13, 2023
a1a1dc3
NDEV-1682. Added ability to change images for dark/light mode. Added …
oable Sep 15, 2023
92ec83b
feat: add shared cookie component
eubash Sep 15, 2023
8db005f
updates NeonPass guide and extends knowledge base around NeonPass and…
m4sterbunny Sep 15, 2023
775adf6
adds image
m4sterbunny Sep 15, 2023
943bf0f
refactor: update shared components package / update cookie styles
eubash Sep 19, 2023
c174e69
proofs proposed pages && add proposed emergent fees page
m4sterbunny Sep 19, 2023
1f6efc2
Proof (#47)
m4sterbunny Sep 19, 2023
39e6e1e
updates link
m4sterbunny Sep 19, 2023
5a1b3c6
Merge branch 'main' into prod126-proxy-local
m4sterbunny Sep 19, 2023
a526cb8
Merge pull request #74 from neonlabsorg/prod126-proxy-local
m4sterbunny Sep 19, 2023
b807a6e
Merge branch 'main' into fixes
m4sterbunny Sep 19, 2023
8c0aed2
Merge pull request #78 from neonlabsorg/fixes
m4sterbunny Sep 19, 2023
6610096
removes links to non-existant pages
m4sterbunny Sep 19, 2023
fe39dda
Merge pull request #79 from neonlabsorg/fixes
m4sterbunny Sep 19, 2023
7fff446
removes links to non-existant pages
m4sterbunny Sep 19, 2023
198996e
NDEV-1682. Updated pictures as in the design.
oable Sep 19, 2023
6223601
removes links to non-existant pages
m4sterbunny Sep 19, 2023
9ecb711
NDEV-1682. Updated ecosystem picture
oable Sep 20, 2023
0abaed5
Merge branch 'NDEV-2139'
eubash Sep 21, 2023
8606d02
NDEV-2181. Added ecosystem interactive.
oable Sep 25, 2023
3344e47
proofing round
m4sterbunny Sep 28, 2023
ad64bcd
proofing round
m4sterbunny Sep 28, 2023
6637991
Merge branch 'main' into prod-173-NeonPass-FAQ
m4sterbunny Sep 28, 2023
dd692f9
review of PR and todos
m4sterbunny Sep 29, 2023
93e0873
fixes that awkward wording
m4sterbunny Sep 29, 2023
e157b93
Fixes (#82)
m4sterbunny Sep 29, 2023
79a6aeb
updates style guide (#80)
m4sterbunny Sep 29, 2023
a1c5551
aligns Igor's updates with main
m4sterbunny Oct 2, 2023
99479af
first step of image cleanup & response to PR
m4sterbunny Oct 2, 2023
17d3c40
Merge branch 'main' into prod-173-NeonPass-FAQ
m4sterbunny Oct 3, 2023
e28212c
Merge pull request #77 from neonlabsorg/prod-173-NeonPass-FAQ
m4sterbunny Oct 3, 2023
073799e
Revert "Updates NeonPass guide and extends knowledge base around Neon…
m4sterbunny Oct 3, 2023
0bd842e
Merge pull request #83 from neonlabsorg/revert-77-prod-173-NeonPass-FAQ
m4sterbunny Oct 3, 2023
d37f88e
Merge pull request #76 from neonlabsorg/feature/NDEV-1682-light-dark-…
m4sterbunny Oct 3, 2023
bcd92c9
Merge branch 'main' into fixes
m4sterbunny Oct 3, 2023
bc333bb
fixes 2 404s
m4sterbunny Oct 3, 2023
86e900b
Merge pull request #84 from neonlabsorg/fixes
m4sterbunny Oct 3, 2023
f13313a
Merge branch 'main' into main
m4sterbunny Oct 3, 2023
2b252ff
Clears out last ref to mainnet neon RPC in favour of chainlist
m4sterbunny Oct 4, 2023
efb7b26
Merge pull request #85 from neonlabsorg/fixes
m4sterbunny Oct 4, 2023
bdd31e2
Update update_prod.yml
himaster Oct 4, 2023
e8acbb3
Merge pull request #86 from neonlabsorg/DOPS-388-himaster
himaster Oct 4, 2023
fd1316f
Add algolia reindex to CI process
himaster Oct 4, 2023
165af1d
Merge pull request #87 from neonlabsorg/DOPS-388-himaster-1
himaster Oct 4, 2023
081efa9
Add Algolia reindex to CI
himaster Oct 4, 2023
b93d2bb
Update update_prod.yml
himaster Oct 4, 2023
6ba4d39
Merge pull request #88 from neonlabsorg/DOPS-388-himaster-2
himaster Oct 4, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 8 additions & 11 deletions .github/styles/Grammarly.csv
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
"24:7",24/7,"Existing style, maintain consistency"
"Advisory,advisory","Information","Warning -- this is a legally sensitive term. However, context is everything: it may be that the original text is more appropriate."
"amongst",among,"Existing style, maintain consistency"
"Anonymous","Pseudonymous","Warning -- this is a legally sensitive term. However, context is everything: it may be that the original text is more appropriate."
"ALAN, alan",Alan,"Existing style, maintain consistency"
"ALANS, alans",Alan,"The plural of Alan is Alan"
"Anonymous","Pseudonymous","Warning -- this is a legally sensitive term. However, context is everything: it may be that the original text is more appropriate."
"api;Api",API,"Existing style, maintain consistency"
"back-end;backend","backend","back-end is used as an adjective only."
"api,Api",API,"Existing style, maintain consistency"
"Backdoor","Alternative","Warning -- this is a legally sensitive term. However, context is everything: it may be that the original text is more appropriate."
"back-end;backend","backend","back-end is used as an adjective only."
"best","a good option","Warning -- this is a legally sensitive term. However, context is everything: it may be that the original text is more appropriate."
"Berkley packet filter;berkeley packet filter",Berkeley Packet Filter,"Existing style, maintain consistency"
"Betting","Predicting","Warning -- this is a legally sensitive term. However, context is everything: it may be that the original text is more appropriate."
Expand Down Expand Up @@ -98,7 +98,7 @@ governor,Governor,"Caps for a noun of an active component in the system"
"Metamask;Meta mask;metamask;metaMask",MetaMask,"Brand name"
"Money-laundering","","Avoid entirely -- this is a legally sensitive term. However, context is everything: it may be that the original text is more appropriate."
"multi sig;multi-sig",multisig,"Existing style, maintain consistency"
"NoenEVM;Noen EVM;NeonEVM;Neon EVM", Neon evm,"Existing style, maintain consistency"
"NoenEVM;Noen EVM;NeonEVM;Neon evm;neon evm",Neon EVM,"Existing style, maintain consistency"
"Neon Labs","Neon EVM","It is highly unlikely that you need to use Neon Labs in the public domain. Rather just refer to the main Brand."
"Neon Protocol","Neon EVM","It is highly unlikely that you need to use Neon Protocol in the public domain. Rather just refer to the main Brand."
"Neon Foundation","Neon EVM","It is highly unlikely that you need to use Neon Foundation in the public domain. Rather just refer to the main Brand."
Expand All @@ -108,11 +108,10 @@ governor,Governor,"Caps for a noun of an active component in the system"
"Neon",NEON,"NEON caps is the token, Neon the noun should rarely be used > provide component instead"
"NEONS, Neons, neons",NEON,"The plural of NEON is NEON"
"No-brainer","Clear Choice","Warning -- this is a legally sensitive term. However, context is everything: it may be that the original text is more appropriate."
"non-deterministic,nondeterministic","Existing style, maintain consistency"
"NeonProxy, Noen proxy, Neon proxy",Neon Proxy,"Existing style, maintain consistency"
"Nft",NFT,"Acronymn as caps"
"node JS,Node JS",NodeJS,"Brand name"
"non-deterministic,nondeterministic","Existing style, maintain consistency"
"non-deterministic",nondeterministic","Existing style, maintain consistency"
"Loophole","Strategy","Warning -- this is a legally sensitive term. However, context is everything: it may be that the original text is more appropriate."
"L2 rollup","L2 Rollup","as per ""On the Road"" Medium post"
"on boarding;on-boarding",onboarding,"Existing style, maintain consistency"
Expand Down Expand Up @@ -187,6 +186,7 @@ StrakEx,StarkEx,"typo fix"
"the Neon,The Neon","Neon","In most instances, 'The Neon EVM' can be stated as Neon EVM"
"the Mainnet,The Mainnet","Mainnet","In most instances, The Mainnet can be stated as Mainnet"
"the Devnet,The Devnet","Devnet","'The Devnet' should most often simply be stated as Devnet"
"token account,Token account,token Account,token-account",Token Account,"Existing style, maintain consistency"
"unbeatable","competitive","Warning -- this is a legally sensitive term. However, context is everything: it may be that the original text is more appropriate."
"Undetectable","Discreet","Warning -- this is a legally sensitive term. However, context is everything: it may be that the original text is more appropriate."
"Under the table","","Avoid entirely -- this is a legally sensitive term. However, context is everything: it may be that the original text is more appropriate."
Expand All @@ -197,13 +197,10 @@ StrakEx,StarkEx,"typo fix"
"U.S,U.S.",US,"Existing style, maintain consistency"
"U.S.A,U.S.A.",US,"Existing style, maintain consistency"
"web3,web 3,Web 3",Web3,"Existing style, maintain consistency"
"white paper",whitepaper,"Existing style, maintain consistency"
"White paper",Whitepaper,"Existing style, maintain consistency"
"web3,web 3,Web 3",Web3,"Existing style, maintain consistency"
"white paper",whitepaper,"Existing style, maintain consistency""web3,web 3,Web 3",Web3,"Existing style, maintain consistency"
"Wrapped","wrapped","Be very careful using this term Neon EVM does NOT wrap tokens: NeonPass provides an ERC-20 interface to SPL tokens: no mint, no burn"
"Windfall","Earnings","Warning -- this is a legally sensitive term. However, context is everything: it may be that the original text is more appropriate."
"World-wide,world-wide","worldwide","Stay consistent!"
"ZK-rollup;ZKRollup;zk-rollup;zkRollup",ZK-Rollup,"Existing style, maintain consistency"
"zk SNARK",zk-SNARK,"Existing style, maintain consistency"
"zk STARK",zk-STARK,"Existing style, maintain consistency"

"zk STARK",zk-STARK,"Existing style, maintain consistency"
3 changes: 3 additions & 0 deletions .github/workflows/update_prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,6 @@ jobs:
AWS_SECRET_ACCESS_KEY: ${{secrets.DOCS_PROD_AWS_SECRET_ACCESS_KEY}}
AWS_REGION: ${{vars.DOCS_PROD_S3_REGION}}
SOURCE_DIR: "build"
- name: Algolia Reindex
run: |
curl -H "Content-Type: application/json" -X POST --user ${{secrets.CRAWLER_USER_ID}}:${{secrets.CRAWLER_API_KEY}} "https://crawler.algolia.com/api/1/crawlers/${{vars.CRAWLER_ID}}/reindex"
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,11 @@ import TabItem from '@theme/TabItem';

with authentication via [GitHub](https://github.com/anonNeon)


## Troubleshooting

You pull main and can no longer build. Don't fret, someone probably changed a dependency do:
`npm install`
and then build or serve and see if that fixes it


6 changes: 6 additions & 0 deletions declarations.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
declare namespace JSX {
interface IntrinsicElements {
"cookie-control": any;
"component": any;
}
}
746 changes: 746 additions & 0 deletions docs/about/DELETE-img/neon_ecosystem_white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 13 additions & 15 deletions docs/about/how_it_works.md → docs/about/how_it_works.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,42 +6,40 @@
approvedBy: YYY
comments: #1 TODO see inline comment 2.3
---
import {ImgTheme} from '@site/src/components/ImageTheme';

import architecture from '@site/static/img/doc-images/about/how-it-works.png';
<ImgTheme src='/img/doc-images/about/how-it-works.svg' srcDark='/img/doc-images/about/how-it-works_dark.svg' />

<div className='neon-img-box-300' style={{textAlign: 'center', width: 900, display: 'block', margin: 'auto'}}>
This page provides a high-level overview of how Neon EVM coordinates communication between Ethereum dApps and Solana.

<img src={architecture} />

</div>

This page provides a high-level overview of how Neon coordinates communication between Ethereum dApps and Solana.

## Neon's transaction lifecycle
## Neon EVM's transaction lifecycle

Effecting a user-initiated transaction (tx) from an Ethereum dApp on Solana requires three main steps:

1. The user initiates a tx. A tx is a signed Ethereum-like tx directed to a Neon RPC endpoint.
1. The user initiates a tx. A tx is a signed Ethereum-like tx directed to a Neon RPC endpoint.

> See [How to Connect to the Neon RPC](/docs/wallet/metamask_setup) via an Ethereum-compatible wallet.

The Ethereum API passes the tx to the Neon Proxy via the [Neon API service](docs/developing/connect_rpc).
The Ethereum API passes the tx to the Neon Proxy via the [Neon API service](docs/developing/connect_rpc.md).

<!-- todo why does the link above connect to the rpc // chainlist page -- requires fix? -->

Check warning on line 25 in docs/about/how_it_works.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [write-good-adapted.todo] 'todo' left in text Raw Output: {"message": "[write-good-adapted.todo] 'todo' left in text", "location": {"path": "docs/about/how_it_works.mdx", "range": {"start": {"line": 25, "column": 6}}}, "severity": "WARNING"}

Check warning on line 25 in docs/about/how_it_works.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google-adapted.Substitutions] Use 'preceding' instead of 'above'. Raw Output: {"message": "[Google-adapted.Substitutions] Use 'preceding' instead of 'above'.", "location": {"path": "docs/about/how_it_works.mdx", "range": {"start": {"line": 25, "column": 29}}}, "severity": "WARNING"}

2. This request is received by the Neon Proxy.

> 2.1 The Neon Proxy processes the request, providing:
> - Gas usage estimate for tx execution
> - Broadcast initiation: wrapping the Ethereum-like tx as a Solana tx

> 2.2. The Neon Proxy passes the wrapped tx to the Neon EVM program hosted on Solana. This results in the following:
> - A Solana receipt
> - A corresponding Neon EVM receipt
> 2.3 The Neon smart contract then:

> 2.3 The Neon smart contract then:
> - Unwraps the tx and checks the user's signature
> - Loads the EVM state, including account data and the smart contract's code, from Solana storage
> - Executes the tx inside [Solana BPF](https://docs.solana.com/developing/runtime-facilities/programs#bpf-loader)
> - Updates Solana's state to reflect the new Neon EVM state
> - Updates Solana's state to reflect the new Neon EVM state

<!-- missing logical link here as tx execution impact on Neon EVM not made clear -->

3. Solana and Neon EVM undertake a state change.
Expand Down
39 changes: 18 additions & 21 deletions docs/about/neon_ecosystem.md → docs/about/neon_ecosystem.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,15 @@
iterationBy: HB
includedInSite: true
approvedBy: YYY
comment: #2 TODO Tracer API needs internal linking to replace Medium article
links: The ecosystem image links to /docs/tokens/neon_token and /docs/tokens/gas_fees

Check warning on line 7 in docs/about/neon_ecosystem.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google-adapted.Substitutions] Use 'Ecosystem' or 'use caps for Neon/Solana/Ethereum Ecosystems' instead of 'ecosystem'. Raw Output: {"message": "[Google-adapted.Substitutions] Use 'Ecosystem' or 'use caps for Neon/Solana/Ethereum Ecosystems' instead of 'ecosystem'.", "location": {"path": "docs/about/neon_ecosystem.mdx", "range": {"start": {"line": 7, "column": 12}}}, "severity": "WARNING"}

Check failure on line 7 in docs/about/neon_ecosystem.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'NEON' instead of 'neon'. Raw Output: {"message": "[Vale.Terms] Use 'NEON' instead of 'neon'.", "location": {"path": "docs/about/neon_ecosystem.mdx", "range": {"start": {"line": 7, "column": 50}}}, "severity": "ERROR"}
comment: #2 TODO Tracer API needs internal linking to replace Medium article todo we have more wallets than just MetaMask -- perhaps add an FAQ and link there? TODO what was the outcome of Anton not wanting to use BPF?

Check failure on line 8 in docs/about/neon_ecosystem.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [proselint-adapted.Annotations] 'TODO' left in text. Raw Output: {"message": "[proselint-adapted.Annotations] 'TODO' left in text.", "location": {"path": "docs/about/neon_ecosystem.mdx", "range": {"start": {"line": 8, "column": 13}}}, "severity": "ERROR"}

Check warning on line 8 in docs/about/neon_ecosystem.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [write-good-adapted.todo] 'TODO' left in text Raw Output: {"message": "[write-good-adapted.todo] 'TODO' left in text", "location": {"path": "docs/about/neon_ecosystem.mdx", "range": {"start": {"line": 8, "column": 13}}}, "severity": "WARNING"}

Check warning on line 8 in docs/about/neon_ecosystem.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [write-good-adapted.todo] 'todo' left in text Raw Output: {"message": "[write-good-adapted.todo] 'todo' left in text", "location": {"path": "docs/about/neon_ecosystem.mdx", "range": {"start": {"line": 8, "column": 78}}}, "severity": "WARNING"}

Check warning on line 8 in docs/about/neon_ecosystem.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google-adapted.Contractions] Feel free to use 'we've' instead of 'we have'. Raw Output: {"message": "[Google-adapted.Contractions] Feel free to use 'we've' instead of 'we have'.", "location": {"path": "docs/about/neon_ecosystem.mdx", "range": {"start": {"line": 8, "column": 83}}}, "severity": "INFO"}

Check warning on line 8 in docs/about/neon_ecosystem.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [write-good-adapted.todo] 'TODO' left in text Raw Output: {"message": "[write-good-adapted.todo] 'TODO' left in text", "location": {"path": "docs/about/neon_ecosystem.mdx", "range": {"start": {"line": 8, "column": 161}}}, "severity": "WARNING"}

Check failure on line 8 in docs/about/neon_ecosystem.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [proselint-adapted.Annotations] 'TODO' left in text. Raw Output: {"message": "[proselint-adapted.Annotations] 'TODO' left in text.", "location": {"path": "docs/about/neon_ecosystem.mdx", "range": {"start": {"line": 8, "column": 161}}}, "severity": "ERROR"}

Check warning on line 8 in docs/about/neon_ecosystem.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [write-good-adapted.E-Prime] Try to avoid using 'was'. Raw Output: {"message": "[write-good-adapted.E-Prime] Try to avoid using 'was'.", "location": {"path": "docs/about/neon_ecosystem.mdx", "range": {"start": {"line": 8, "column": 171}}}, "severity": "INFO"}
---
<!-- import { QuickLookNeonImage } from '@site/src/components/QuickLookNeonImage' -->
<!-- <QuickLookNeonImage/> -->
import {ImgTheme} from '@site/src/components/ImageTheme';
import {QuickLookNeonImage} from '@site/src/components/QuickLookNeonImage';

import ecosystem from '@site/static/img/doc-images/about/neon-ecosystem.png';


<div className='neon-img-box-300' style={{textAlign: 'center', maxWidth: 800, display: 'block', margin: 'auto'}}>
<img src={ecosystem} />
</div>
<QuickLookNeonImage></QuickLookNeonImage>

[//]: # (<ImgTheme src='/img/doc-images/about/neon-ecosystem.svg' srcDark='/img/doc-images/about/neon-ecosystem_dark.svg' />)

Check failure on line 15 in docs/about/neon_ecosystem.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'NEON' instead of 'neon'. Raw Output: {"message": "[Vale.Terms] Use 'NEON' instead of 'neon'.", "location": {"path": "docs/about/neon_ecosystem.mdx", "range": {"start": {"line": 15, "column": 47}}}, "severity": "ERROR"}

Check failure on line 15 in docs/about/neon_ecosystem.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'NEON' instead of 'neon'. Raw Output: {"message": "[Vale.Terms] Use 'NEON' instead of 'neon'.", "location": {"path": "docs/about/neon_ecosystem.mdx", "range": {"start": {"line": 15, "column": 98}}}, "severity": "ERROR"}

**Neon EVM** is *the* solution that makes Solana's throughput, swift block speeds, and low gas prices available to Ethereum contracts. Neon EVM interacts directly with Solana nodes to carry out transactions on Solana. The service is made up of three main components:

Expand All @@ -28,18 +25,19 @@

## Neon EVM program

The **Neon EVM program** is a smart contract on the Solana blockchain. The Neon EVM program accepts Ethereum-like transactions and processes them on Solana according to Ethereum rules. Ethereum transactions directed to the Neon EVM are called Neon Transactions.
The **Neon EVM program** is a smart contract on the Solana blockchain. The Neon EVM program accepts Ethereum-like transactions and processes them on Solana according to Ethereum rules. Ethereum transactions directed to the Neon EVM are called Neon Transactions.

> **Neon Transactions**: a [subset of Ethereum's JSON-RPC Specification](/docs/evm_compatibility/json_rpc_api_methods) may be directed to the Neon EVM to be used as inputs for the targeted Neon clients.

## Neon Proxy

It's the Neon Proxy that allows Ethereum dApps to be ported to Neon with minimal reconfiguration. Neon Proxy packages a Neon transaction into a Solana transaction. The proxy is provided as a containerized solution that's intuitive for [Operators](/docs/operating/operator-introduction).

> **Neon Operators** run Neon Proxy servers to facilitate the seamless execution of Ethereum-like transactions on Solana. It is this proxy service that allows Ethereum dApps to be ported to Neon with minimal reconfiguration. Operators accept payment in NEON and make payments within the Solana Ecosystem in SOL.
It's the Neon Proxy that allows Ethereum dApps to be ported to Neon with minimal reconfiguration. Neon Proxy packages a EVM transaction into a Solana transaction. The Proxy is provided as a containerized solution that's intuitive for [Operators](/docs/operating/operator-introduction).

:::info
**Neon Operators** run Neon Proxy servers to facilitate the seamless execution of Ethereum-like transactions on Solana. It is this proxy service that allows Ethereum dApps to be ported to Neon with minimal reconfiguration. Operators accept payment in NEON (although the roadmap will expand the options) and make payments within the Solana Ecosystem in SOL.
:::

### The NEON Token
### The NEON token

The NEON token is a utility token with 2 functions:

Expand Down Expand Up @@ -79,16 +77,16 @@

### Oracles

Oracles enable the decentralized Web3 ecosystem to access price feeds and other external (off-chain) data sources. Neon EVM supports querying data from Solana deployed Oracles:
Oracles enable the decentralized Web3 ecosystem to access price feeds and other external (off-chain) data sources. Neon EVM supports querying data from Solana deployed Oracles:
* [Chainlink](/docs/developing/integrate/oracles/integrating_chainlink)
* [Pyth](/docs/developing/integrate/oracles/integrating_pyth)


### Wallets

Neon EVM is supported by the MetaMask non-custodial wallet.
Neon EVM is supported by EVM-compatible wallets such as MetaMask's non-custodial wallet.

> This allows dApp devs to sign deployment transactions and mint tokens.
> This allows dApp devs to sign deployment transactions and mint tokens.
<!-- > Learn more about minting and wrapping tokens with Neon EVM. suggest adding link here as Phantom wallet is invovled for Solana-based mints -->

### Protocols
Expand All @@ -97,16 +95,15 @@

### Tracer API

Neon's Tracer API is an extension for Neon Proxy. It assists developers to test, debug, and understand the behavior of their smart contracts on Neon EVM. The API provides a full externality trace on any Neon transactions executed on the Solana blockchain.
Neon's Tracer API is an extension for Neon Proxy. It assists developers to test, debug, and understand the behavior of their smart contracts on Neon EVM. The API provides a full externality trace on any Neon transactions executed on the Solana blockchain.

The Tracer API supports a rerun of historical transactions, runs transactions on historical states, and analyzes the state of the Solana blockchain after the execution of each instruction.
The Tracer API supports a rerun of historical transactions, runs transactions on historical states, and analyzes the state of the Solana blockchain after the execution of each instruction.

> More details are available in [our blog](https://medium.com/neon-labs/neon-proxy-tracing-api-fdb3842a80fa).

## Development tools

Various tools such as:
- [Hardhat](/docs/developing/deploy_facilities/using_hardhat)
- [Truffle](/docs/developing/deploy_facilities/using_truffle)
- [Remix](/docs/developing/deploy_facilities/using_remix).
- [Remix](/docs/developing/deploy_facilities/using_remix)

25 changes: 10 additions & 15 deletions docs/about/why_neon.md → docs/about/why_neon.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,30 @@
approvedBy: YYY
comments: na
---

import infographic from '@site/static/img/doc-images/about/infographic.png';
import {ImgTheme} from '@site/src/components/ImageTheme';

*Neon EVM is a low-friction solution to scale Ethereum dApps on Solana.*


<div className='neon-img-box-300' style={{textAlign: 'center', width: 600, display: 'block', margin: 'auto'}}>

<img src={infographic} />


</div>
<ImgTheme src='/img/doc-images/about/infographic.svg' srcDark='/img/doc-images/about/infographic_dark.svg' />

## Neon EVM

Neon EVM is a fully compatible Ethereum environment solution built on the Solana blockchain. The platform allows developers to deploy Ethereum dApps without undertaking any reconfiguration.
Neon EVM is a fully compatible Ethereum environment solution built on the Solana blockchain. The platform allows developers to deploy Ethereum dApps without undertaking any reconfiguration.

> Minimal reconfiguration required: Ethereum developers can build without Rust.
:::info

Check warning on line 19 in docs/about/why_neon.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google-adapted.Substitutions] Use 'information' instead of 'info'. Raw Output: {"message": "[Google-adapted.Substitutions] Use 'information' instead of 'info'.", "location": {"path": "docs/about/why_neon.mdx", "range": {"start": {"line": 19, "column": 4}}}, "severity": "WARNING"}
Minimal reconfiguration required: allowing Ethereum developers to build without Rust.
:::

Neon EVM enables Solidity- and Vyper-based dApps to tap into Solana’s network benefits: low fees, high transaction speeds, and parallel transaction execution capabilities.

From a developer’s perspective, this means creating Solana-compatible contracts using tools you’re familiar with from the Ethereum Ecosystem.
From a developer’s perspective, this means creating Solana-compatible contracts using tools you’re familiar with from the Ethereum Ecosystem.

Neon EVM makes the key Ethereum dApp tools compatible with Solana, including Vyper, Solidity, [MetaMask](/docs/wallet/metamask_setup), [Hardhat](/docs/developing/deploy_facilities/using_hardhat), [Truffle](/docs/developing/deploy_facilities/using_truffle), and [Remix](/docs/developing/deploy_facilities/using_remix). The solution allows any Ethereum application to run on Solana with minimal reconfiguration required, this includes Uniswap, SushiSwap, 0x, and MakerDAO.
Neon EVM makes the key Ethereum dApp tools compatible with Solana, including Vyper, Solidity, [MetaMask](/docs/wallet/metamask_setup), [Hardhat](/docs/developing/deploy_facilities/using_hardhat), [Remix](/docs/developing/deploy_facilities/using_remix), (and [Truffle](/docs/developing/deploy_facilities/using_truffle)). The solution allows any Ethereum application to run on Solana with minimal reconfiguration, this includes Uniswap, SushiSwap, 0x, and MakerDAO.


### Who uses Neon EVM?

Neon EVM serves any developers or product teams who wish that their dApp could reach customers on Solana. Teams interested in the significant savings thanks to the low gas fees, or scaling with the high throughput that Solana provides are likely to be the first movers. Neon EVM also opens up the liquidity on Solana to DeFi products.
Teams interested in the significant savings thanks to the low gas fees, or scaling with the high throughput that Solana provides are likely to be the first movers. Neon EVM serves any developers or product teams who wish that their dApp could reach customers on Solana. Neon EVM also opens up the liquidity on Solana to DeFi products.

Check warning on line 32 in docs/about/why_neon.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [write-good-adapted.Weasel] 'likely' is a weasel word! Raw Output: {"message": "[write-good-adapted.Weasel] 'likely' is a weasel word!", "location": {"path": "docs/about/why_neon.mdx", "range": {"start": {"line": 32, "column": 134}}}, "severity": "WARNING"}

## The best from Ethereum

Expand All @@ -45,7 +40,7 @@
With Neon EVM, developers retain:

* Familiar languages: Solidity, Vyper
* Well-known Ethereum tools: MetaMask, Hardhat, Truffle, Remix, etc.
* Well-known Ethereum tools: MetaMask, Hardhat, Remix, etc.
* Ethereum RPC API compatibility
* Ethereum Accounts, Signatures, Token standards (ERC-20 and ERC-721)

Expand Down
3 changes: 2 additions & 1 deletion docs/developing/integrate/neon_transfer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@

## Prerequisites

- You need to provide Solana and Neon EVM providers from supported official libraries such as `@solana/web3.js` or `web3.js`, `ether.js` and `WalletConnect`.
- You need to integrate Solana-compatible and EVM-compatible wallet providers from supported official libraries such as `@solana/web3.js` or `web3.js`, `ether.js` and `WalletConnect`.

Check failure on line 30 in docs/developing/integrate/neon_transfer.mdx

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'Solana' instead of 'solana'. Raw Output: {"message": "[Vale.Terms] Use 'Solana' instead of 'solana'.", "location": {"path": "docs/developing/integrate/neon_transfer.mdx", "range": {"start": {"line": 30, "column": 123}}}, "severity": "ERROR"}

- Supported browser plugins (e.g. Phantom or MetaMask wallets).

<!-- I don't understand provide providers above -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,8 @@ Check out Web3Modal code on [GitHub](https://github.com/WalletConnect/web3modal)

Web3Modal supports:

- [React](https://docs.walletconnect.com/2.0/web3modal/react/wagmi/installation)
- [HTML](https://docs.walletconnect.com/2.0/web/web3modal/html/wagmi/installation)

- [React](https://docs.walletconnect.com/web3modal/react/about)
- [HTML](https://docs.walletconnect.com/web3modal/html/about)
:::

## Get Started
Expand Down
Loading
Loading