Merge pull request #336 from neonlabsorg/main

Introduce documentation about Neon Safe

docs/developing/integrate/wallets/safe.md

@@ -0,0 +1,90 @@
+---
+title: Safe
+proofedDate: 20240609
+iterationBy: na
+includedInSite: false
+approvedBy: na
+comment:
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+## Introduction
+
+What is Safe?
+
+The Safe Account functions as a proxy contract, which means it forwards requests to a singleton contract. This singleton contract holds all the essential logic required for the Safe to operate. Proxy contracts are advantageous because they are typically more cost-effective to deploy and manage on public blockchains and they allow for easier upgrades. The primary purpose of the Safe proxy contract is to oversee and maintain the Safe’s state.
+The term "contract state" refers to the variables (or values) associated with a specific contract. Functions and contract code are usually stored and executed as bytecode within the Neon EVM, while variables are managed separately. These variables are the values that functions change when they run. For the Safe, the singleton contract provides the functions that adjust the state variables in the proxy. This singleton contract is also called the master copy of the Safe.
+
+Purpose:
+The primary purpose of Safe Neon EVM is to facilitate the secure storage, management, and multi-signature capabilities for digital assets. By leveraging the features of the Neon EVM, it allows users to utilize Ethereum-compatible tools like Solidity and Vyper while benefiting from Solana’s low transaction fees, high speeds, and parallel processing capabilities.
+
+## How to create a Safe account on Neon EVM Mainnet
+
+### Step 1: Connect your wallet
+
+1.1 Go to the [login](https://safe.neonevm.org/welcome) page and connect your wallet.
+
+<div className='neon-img-width-600' style={{textAlign: 'center'}}>
+
+![](img/safe1.png)
+
+</div>
+
+1.2 1.2 Select your wallet from the available options to get started
+
+<div className='neon-img-width-600' style={{textAlign: 'center'}}>
+
+![](img/safe2.png)
+
+</div>
+
+1.3 Create new Safe account
+
+<div className='neon-img-width-600' style={{textAlign: 'center'}}>
+
+![](img/safe3.png)
+
+</div>
+
+1.4 Set the signer wallets
+
+<div className='neon-img-width-600' style={{textAlign: 'center'}}>
+
+![](img/safe4.png)
+
+</div>
+
+
+1.5 Review the filled information
+
+<div className='neon-img-width-600' style={{textAlign: 'center'}}>
+
+![](img/safe5.png)
+
+</div>
+
+1.6 Wait for the transaction confirmation
+Accept the transaction in your initial wallet
+
+<div className='neon-img-width-600' style={{textAlign: 'center'}}>
+
+![](img/safe6.png)
+
+</div>
+
+1.7 After the confirmation your account will be created
+
+<div className='neon-img-width-600' style={{textAlign: 'center'}}>
+
+![](img/safe7.png)
+
+</div>
+
+1.8 Welcome page
+<div className='neon-img-width-600' style={{textAlign: 'center'}}>
+
+![](img/safe8.png)
+
+</div>

docs/developing/integrate/wallets/safe_cli.md

@@ -0,0 +1,93 @@
+---
+title: Safe CLI
+proofedDate: 20241909
+iterationBy: na
+includedInSite: false
+approvedBy: na
+comment:
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+## Introduction
+
+Get the Safe CLI
+Prerequisite: Install Docker Desktop (https://www.docker.com/products/docker-desktop/)
+
+Once Docker is installed on your system, create Safe account using the Safe guide
+
+Purpose:
+
+The primary purpose of the Neon CLI (Command Line Interface) for Neon EVM is to allow developers to manage, deploy, and operate Ethereum-compatible dApps on the Solana blockchain directly from the command line. This interface simplifies development tasks by enabling users to handle various functions, such as deploying smart contracts, configuring projects, managing databases, and setting up multi-signature accounts.
+
+
+## Interact with a Safe wallet using CLI
+
+### Step 1: Create 2 or more wallets
+
+1.1 Go to the [login](https://safe.neonevm.org/welcome) page and connect your wallet and create two or more wallets
+
+<div className='neon-img-width-600' style={{textAlign: 'center'}}>
+
+![](img/cli1.png)
+
+</div>
+
+### Step 2: Installation
+
+Run
+```
+docker run -it safeglobal/safe-cli safe-cli 0x0000000000000000000000000000000000000000 https://neon-mainnet.everstake.one/
+```
+
+<div className='neon-img-width-600' style={{textAlign: 'center'}}>
+
+![](img/cli3.png)
+
+</div>
+
+### Step 3: How to remove an owner
+
+3.1 Run
+For 2 wallets:
+```
+load_cli_owners <private-key1> <private-key2>
+```
+
+If you have more wallets then add more private keys
+
+<div className='neon-img-width-600' style={{textAlign: 'center'}}>
+
+![](img/cli4.png)
+
+</div>
+
+3.2 Run
+```
+show_cli_owners
+```
+
+<div className='neon-img-width-600' style={{textAlign: 'center'}}>
+
+![](img/cli5.png)
+
+</div>
+
+3.3 Run
+```
+remove_owner <address> --threshold 3
+```
+
+Example for 2 wallets:
+```
+remove_owner 0x0x0000000000000000000000000000000000000000 --threshold 2
+```
+
+If you have more than two wallets then change the number of --threshold
+
+<div className='neon-img-width-600' style={{textAlign: 'center'}}>
+
+![](img/cli6.png)
+
+</div>

package.json

@@ -26,7 +26,7 @@
     "clsx": "^2.1.0",
     "docusaurus-json-schema-plugin": "^1.11.0",
     "docusaurus-plugin-image-zoom": "^2.0.0",
-    "markdown-link-check": "^3.11.2",
+    "markdown-link-check": "3.12.2",
     "neon-web-components": "^1.1.3",
     "prism-react-renderer": "^2.3.1",
     "raw-loader": "^4.0.2",

sc.sh

@@ -0,0 +1,5 @@
+set -e
+#find ./README.md ./docs/ -regex ".*.[md|mdx]" -print0 | xargs -0 -n1 ./node_modules/markdown-link-check/bin/markdown-link-check --config linkcheck.config.json -v
+find ..md ./docs/ -regex ".*.[md|mdx]" -print0 | xargs -0 -n1 sh -c './node_modules/markdown-link-check/bin/markdown-link-check --config linkcheck.config.json -v "$1"; echo "File: $1; Exit code: $?"' _ 
+./node_modules/markdown-link-check/bin/markdown-link-check --config linkcheck.config.json -v ./docs/operating/operator-introduction.md
+./node_modules/markdown-link-check/bin/markdown-link-check --config linkcheck.config.json -v ./docs/quick_start.mdx

sidebars.js

@@ -77,6 +77,8 @@ const sidebars = {
       items: [
         'developing/integrate/wallets/integrating_metamask_into_your_dapp',
         'developing/integrate/wallets/integrating_walletconnect',
+        'developing/integrate/wallets/safe',
+        'developing/integrate/wallets/safe_cli',
         'developing/integrate/wallets/integrating_web3auth',
         'developing/integrate/oracles/integrating_chainlink',
         'developing/integrate/oracles/integrating_pyth',