Skip to content

Commit e76a6c5

Browse files
a-zorinagitbook-bot
authored andcommitted
GitBook: [#7] No subject
1 parent 2343ed0 commit e76a6c5

File tree

7 files changed

+169
-180
lines changed

7 files changed

+169
-180
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ everdev <tool> <command> ...args
6969

7070
Some tools (network, signer, contract, js) and commands have short aliases. For example instead of using `everdev network list` you can use `everdev n l` and even shorter `everdev nl`.
7171

72-
Explore the detailed description of command line interface in the corresponding [section](docs/command-line-interface/).
72+
Explore the detailed description of command line interface in the corresponding [section](broken-reference).
7373

7474
## Working with DevNet
7575

@@ -88,4 +88,4 @@ Learn more about creating your own controller: [Creating Controller](docs/guides
8888

8989
## Troubleshooting
9090

91-
If you encountered any problem try to seek the solution in [Troubleshooting Notes](docs/troubleshooting.md). If it didn't help - please, ask in our [telegram channel](https://t.me/ton\_sdk).
91+
If you encountered any problem try to seek the solution in [Troubleshooting Notes](docs/troubleshooting.md). If it didn't help - please, ask in our [telegram channel](https://t.me/ever\_sdk).

docs/command-line-interface/c.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ everdev clang create Contract
1010

1111
## Compile
1212

13-
This command compiles and links a selected C++ contract.
14-
After successful compilation you get .abi.json and .tvc files that you can later [use in your DApps to deploy and run contract methods](https://tonlabs.gitbook.io/ton-sdk/guides/work_with_contracts/add_contract_to_your_app).
13+
This command compiles and links a selected C++ contract. After successful compilation you get .abi.json and .tvc files that you can later [use in your DApps to deploy and run contract methods](https://docs.everos.dev/ever-sdk/guides/work\_with\_contracts/add\_contract\_to\_your\_app).
1514

1615
```shell
1716
everdev clang compile Contract.cpp

docs/command-line-interface/network-tool.md

+5-8
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22

33
Network tool is a convenient way to organize all of your network configurations in one place.
44

5-
You can register several blockchains (networks) under short names
6-
and then use these names as a target blockchain when working with contracts.
5+
You can register several blockchains (networks) under short names and then use these names as a target blockchain when working with contracts.
76

8-
You can mark one of the networks as a default.
9-
It can be used in network commands without providing net name.
7+
You can mark one of the networks as a default. It can be used in network commands without providing net name.
108

119
## Add a network
1210

@@ -30,7 +28,7 @@ Options:
3028
--force, -f Overwrite key if already exists
3129
```
3230
33-
Example with [mainnet endpoints](https://tonlabs.gitbook.io/ton-sdk/reference/ton-os-api/networks):
31+
Example with [mainnet endpoints](https://docs.everos.dev/ever-sdk/reference/ever-os-api/networks):
3432
3533
```bash
3634
everdev network add main eri01.main.everos.dev,gra01.main.everos.dev,gra02.main.everos.dev,lim01.main.everos.dev,rbx01.main.everos.dev
@@ -58,10 +56,10 @@ Options:
5856
--signer, -s Signer to be used with giver
5957
--value, -v Deploying account initial balance in nanotokens
6058
```
59+
6160
**Note:** The default signer and the initial balance value of 10 tokens will be used, unless otherwise specified through options. Also note, that some contracts may require a higher initial balance for successful deployment. DePool contract, for instance, requires a minimun of 21 tokens.
6261
63-
Only one giver can be set for a network. Setting another one will overwrite the current giver.
64-
To view the current giver settings for all networks, use the `everdev network list` command (for details see the section [below](#list-registered-networks)).
62+
Only one giver can be set for a network. Setting another one will overwrite the current giver. To view the current giver settings for all networks, use the `everdev network list` command (for details see the section [below](network-tool.md#list-registered-networks)).
6563
6664
## List registered networks
6765
@@ -96,4 +94,3 @@ This command deletes a network from everdev registry.
9694
```bash
9795
everdev network delete network_name
9896
```
99-

docs/command-line-interface/solidity.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ everdev sol create Contract
1010

1111
## Compile
1212

13-
This command compiles and links a selected Solidity contract.
14-
After successful compilation you get .abi.json and .tvc files that you can later [use in your DApps to deploy and run contract methods](https://tonlabs.gitbook.io/ton-sdk/guides/work_with_contracts/add_contract_to_your_app).
13+
This command compiles and links a selected Solidity contract. After successful compilation you get .abi.json and .tvc files that you can later [use in your DApps to deploy and run contract methods](https://docs.everos.dev/ever-sdk/guides/work\_with\_contracts/add\_contract\_to\_your\_app).
1514

1615
```shell
1716
everdev sol compile Contract.sol
@@ -22,8 +21,8 @@ To save generated assembler code use `-c` option (default is false)
2221
```shell
2322
everdev sol compile Contract.sol -c path/to/output/file
2423
```
25-
Assembler code will be saved in path/to/output/file with the extension `code`
2624

25+
Assembler code will be saved in path/to/output/file with the extension `code`
2726

2827
You can specify the output files location with the `-o` option:
2928

@@ -66,8 +65,8 @@ This command updates the compiler and linker to the latest version.
6665
```shell
6766
everdev sol update
6867
```
69-
**Attention!**
70-
Use --force option to force update of components that do not update their version.
68+
69+
**Attention!** Use --force option to force update of components that do not update their version.
7170

7271
## Set
7372

@@ -76,5 +75,5 @@ This command sets the compiler and linker versions and downloads them if needed.
7675
```shell
7776
everdev sol set --compiler 0.38.0 --linker 0.23.54
7877
```
79-
**Attention!**
80-
Use --force option to force update of components that do not update their version.
78+
79+
**Attention!** Use --force option to force update of components that do not update their version.

docs/guides/quick-start.md

+81-71
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,77 @@
1-
# Get started with Development Tools
1+
# Quick Start
2+
23
## Guide overview
4+
35
This guide will help you get started with such essensial Everscale tools as:
4-
- [Everdev CLI](https://github.com/tonlabs/everdev)
5-
- [Solidity Compiler](https://github.com/tonlabs/TON-Solidity-Compiler)
6-
- [Local Blockchain](https://github.com/tonlabs/evernode-se)
7-
- [Everscale Blockchain Explorer](https://ever.live)
8-
- [GraphQL API](https://tonlabs.gitbook.io/ton-sdk/reference/ton-os-api)
9-
6+
7+
* [Everdev CLI](https://github.com/tonlabs/everdev)
8+
* [Solidity Compiler](https://github.com/tonlabs/TON-Solidity-Compiler)
9+
* [Local Blockchain](https://github.com/tonlabs/evernode-se)
10+
* [Everscale Blockchain Explorer](https://ever.live)
11+
* [GraphQL API](https://docs.everos.dev/ever-sdk/reference/ever-os-api)
12+
1013
You will learn how to:
11-
- Create and compile your first Solidity contract
12-
- Run Local blockchain for testing
13-
- Deploy your first contract
14-
- Run it on-chain
15-
- Run a getter-function
16-
- Make a transfer
17-
- Explore contract data in Explorer and GraphQL playground
14+
15+
* Create and compile your first Solidity contract
16+
* Run Local blockchain for testing
17+
* Deploy your first contract
18+
* Run it on-chain
19+
* Run a getter-function
20+
* Make a transfer
21+
* Explore contract data in Explorer and GraphQL playground
1822

1923
## Table of Contents
20-
- [Get started with Development Tools](#get-started-with-development-tools)
21-
- [Guide overview](#guide-overview)
22-
- [Table of Contents](#table-of-contents)
23-
- [Install everdev - single interface to access all the developer tools](#install-everdev---single-interface-to-access-all-the-developer-tools)
24-
- [Create helloWorld contract](#create-helloworld-contract)
25-
- [Compile it](#compile-it)
26-
- [Run Local Blockchain](#run-local-blockchain)
27-
- [Configure default network](#configure-default-network)
28-
- [Configure Giver wallet that will sponsor deploy operation](#configure-giver-wallet-that-will-sponsor-deploy-operation)
29-
- [Generate the keys for contract ownership](#generate-the-keys-for-contract-ownership)
30-
- [Calculate the contract address](#calculate-the-contract-address)
31-
- [Deploy](#deploy)
32-
- [View contract information with Explorer](#view-contract-information-with-explorer)
33-
- [Explore contract information with GraphQL](#explore-contract-information-with-graphql)
34-
- [Run on-chain](#run-on-chain)
35-
- [Run a getter function](#run-a-getter-function)
36-
- [Transfer some tokens](#transfer-some-tokens)
37-
- [What's next?](#whats-next)
24+
25+
* [Get started with Development Tools](quick-start.md#get-started-with-development-tools)
26+
* [Guide overview](quick-start.md#guide-overview)
27+
* [Table of Contents](quick-start.md#table-of-contents)
28+
* [Install everdev - single interface to access all the developer tools](quick-start.md#install-everdev---single-interface-to-access-all-the-developer-tools)
29+
* [Create helloWorld contract](quick-start.md#create-helloworld-contract)
30+
* [Compile it](quick-start.md#compile-it)
31+
* [Run Local Blockchain](quick-start.md#run-local-blockchain)
32+
* [Configure default network](quick-start.md#configure-default-network)
33+
* [Configure Giver wallet that will sponsor deploy operation](quick-start.md#configure-giver-wallet-that-will-sponsor-deploy-operation)
34+
* [Generate the keys for contract ownership](quick-start.md#generate-the-keys-for-contract-ownership)
35+
* [Calculate the contract address](quick-start.md#calculate-the-contract-address)
36+
* [Deploy](quick-start.md#deploy)
37+
* [View contract information with Explorer](quick-start.md#view-contract-information-with-explorer)
38+
* [Explore contract information with GraphQL](quick-start.md#explore-contract-information-with-graphql)
39+
* [Run on-chain](quick-start.md#run-on-chain)
40+
* [Run a getter function](quick-start.md#run-a-getter-function)
41+
* [Transfer some tokens](quick-start.md#transfer-some-tokens)
42+
* [What's next?](quick-start.md#whats-next)
3843

3944
### Install everdev - single interface to access all the developer tools
40-
```$ npm install -g everdev```
4145

42-
If you experience any problems with installation, check out our [troubleshooting section](../troubleshooting.md).
46+
`$ npm install -g everdev`
4347

48+
If you experience any problems with installation, check out our [troubleshooting section](../troubleshooting.md).
4449

4550
### Create helloWorld contract
46-
```$ everdev sol create helloWorld```
51+
52+
`$ everdev sol create helloWorld`
4753

4854
### Compile it
49-
```$ everdev sol compile helloWorld.sol```
5055

51-
### Run Local Blockchain
56+
`$ everdev sol compile helloWorld.sol`
57+
58+
### Run Local Blockchain
59+
5260
**Attention** Docker should be running.
5361

54-
```$ everdev se start```
62+
`$ everdev se start`
63+
64+
### Configure default network
5565

56-
### Configure default network
5766
Set Local Blockchain [SE (Simple Emulator)](https://github.com/tonlabs/evernode-se) as the default network:
5867

59-
```$ everdev network default se```
68+
`$ everdev network default se`
6069

6170
### Configure Giver wallet that will sponsor deploy operation
62-
Here we use address and private key of [SE High Load Giver](https://github.com/tonlabs/evernode-se/tree/master/contracts/giver_v2).
6371

64-
**Attention! This giver is available only in SE. If you work in DevNet or MainNet, you need to deploy your own giver.
65-
[Check how to do it in this guide](work-with-devnet.md).**
72+
Here we use address and private key of [SE High Load Giver](https://github.com/tonlabs/evernode-se/tree/master/contracts/giver\_v2).
6673

74+
**Attention! This giver is available only in SE. If you work in DevNet or MainNet, you need to deploy your own giver.** [**Check how to do it in this guide**](work-with-devnet.md)**.**
6775

6876
```
6977
$ everdev signer add giver_keys 172af540e43a524763dd53b26a066d472a97c4de37d5498170564510608250c3
@@ -82,9 +90,10 @@ Signer Public Key
8290
giver_keys 2ada2e65ab8eeab09490e3521415f45b6e42df9c760a639bcf53957550b25a16 se network giver signer
8391
owner_keys (Default) 3826202b129ea8c041b8d49a655512648fc94377d1958a7a4fc9f4b3051ecf7b
8492
```
85-
*Note that there are shortcuts for all the commands: s l = signer list :)
8693

87-
**Don't forget to make the owner key default otherwize giver keys will be used as default.
94+
\*Note that there are shortcuts for all the commands: s l = signer list :)
95+
96+
\*\*Don't forget to make the owner key default otherwize giver keys will be used as default.
8897

8998
### Calculate the contract address
9099

@@ -100,11 +109,12 @@ Address: 0:e74c4258496e79e62e014ca96911acbf5cb0e286fd55dd6f4e3da54e4197ddf5 (c
100109
Code Hash: c517820144a4daf5a3414c9233556b2b0ad34cdd228f200ea68a4c0327e0bd29 (from TVC file)
101110
Account: Doesn't exist
102111
```
112+
103113
You can see that the contract does not exist yet (is not deployed) but you can already see its future address.
104114

105115
### Deploy
106116

107-
Here we deploy the contract, sponsoring it with 10 Tokens (Everscale native currency has 9 decimals). The money for deploy are taken from the giver we configured in the previous steps.
117+
Here we deploy the contract, sponsoring it with 10 Tokens (Everscale native currency has 9 decimals). The money for deploy are taken from the giver we configured in the previous steps.
108118

109119
```
110120
$ everdev contract deploy -v 10000000000 helloWorld
@@ -121,13 +131,13 @@ Contract has deployed at address: 0:e74c4258496e79e62e014ca96911acbf5cb0e286fd55
121131
```
122132

123133
### View contract information with Explorer
124-
Go to [localhost](http://localhost/) and search for your contract address in search bar.
125-
Open your account page. You will need it later to see its transactions and messages, that we will produce in the next steps.
126134

135+
Go to [localhost](http://localhost) and search for your contract address in search bar. Open your account page. You will need it later to see its transactions and messages, that we will produce in the next steps.
127136

128137
### Explore contract information with GraphQL
129-
Go to [localhost/graphql](http://localhost/graphql).
130-
Enter in the left pane and click Run button (replace the contract's address with the one you got in the previous steps).
138+
139+
Go to [localhost/graphql](http://localhost/graphql). Enter in the left pane and click Run button (replace the contract's address with the one you got in the previous steps).
140+
131141
```
132142
query {
133143
accounts(
@@ -145,7 +155,9 @@ query {
145155
}
146156
}
147157
```
158+
148159
You will see:
160+
149161
```
150162
{
151163
"data": {
@@ -161,16 +173,16 @@ You will see:
161173
}
162174
}
163175
```
176+
164177
You can specify any other fields in the result section that are available in GraphQL Schema. (Click `Docs` on the right side of your screen to explore it).
165178

166-
**What is GraphQL?**
167-
This is the API of blockchain, to retrieve data from it and to send data into it.
168-
You can use this playground later, if you will need need to test some queries.
179+
**What is GraphQL?** This is the API of blockchain, to retrieve data from it and to send data into it. You can use this playground later, if you will need need to test some queries.
169180

170181
### Run on-chain
182+
171183
Let's move on and run an on-chain method.
172184

173-
```
185+
```
174186
$ everdev c run helloWorld
175187
176188
Configuration
@@ -191,21 +203,20 @@ Available functions:
191203
Select function (number):
192204
```
193205

194-
Let's enter 3. You will see the transaction ID of the operation.
206+
Let's enter 3. You will see the transaction ID of the operation.
195207

196-
```Execution has finished with result: {
208+
```
197209
"transaction": {
198210
"json_version": 5,
199211
"id": "8087f774d4b8b4d4716cb31a74deea32550a04b40e853f55c64579fa3897108f",
200212
"boc": "te6ccgECBw......
201213
........................
202214
```
203215

204-
You can also execute it inline like this:
205-
```$ everdev c run helloWorld touch```
216+
You can also execute it inline like this:\
217+
`$ everdev c run helloWorld touch`
206218

207-
In the result you can see the transaction_id.
208-
Search for it on your Contract's page in Explorer and in GraphQL playground (use `transactions` collection instead of `accounts`).
219+
In the result you can see the transaction\_id. Search for it on your Contract's page in Explorer and in GraphQL playground (use `transactions` collection instead of `accounts`).
209220

210221
### Run a getter function
211222

@@ -226,6 +237,7 @@ Execution has finished with result: {
226237
"out_messages": []
227238
}
228239
```
240+
229241
### Transfer some tokens
230242

231243
```
@@ -252,21 +264,19 @@ Execution has finished with result: {
252264
"id": "550731bb26e5054387a781257e077dbdd769367f16b19bfa529c20475e2a08f6",
253265
"boc": "te6ccgECCwEAAkwAA7V+dMQlhJbnnmLgFMqWkRrL9csOKG/VXdb049pU5Bl931AAAAAAAAADdx7fDdz4W9u1NnBVF9To555bwxWhiXk8pjgn1OO6cR6wAAAAAAAAAzYPiDAAADRxN2doBQQBAg8MSMYbFBYEQAMCAG/Jh6EgTBRYQAAAAAAAAgAAAAAAAmHZXn3oj36iIsmePH9xls7+ruVE+XB4H24a
254266
```
255-
**Attention!**
256-
- Contracts take value in nanotokens, so in this step we transfered 1 token.
257-
- Bounce = true means that if the recipient does not exist, money will be returned back.
258-
**If you plan to transfer money for deploy, specify Bounce = false!**
259-
260-
Again, now you can find this transaction in Explorer or GraphQL API.
261267

262-
## What's next?
268+
**Attention!**
263269

264-
1. If you want to migrate to Dev Network, read [Working with DevNet guide](work-with-devnet.md).
270+
* Contracts take value in nanotokens, so in this step we transfered 1 token.
271+
* Bounce = true means that if the recipient does not exist, money will be returned back. **If you plan to transfer money for deploy, specify Bounce = false!**
265272

266-
2. Also take a look at our [blockchain basics page](https://everos.dev/faq/blockchain-basic) that will help you understand the core concepts of Everscale:)
273+
Again, now you can find this transaction in Explorer or GraphQL API.
267274

268-
3. If you want to integrate your application with Everscale - dive into our [SDK Quick Start](https://tonlabs.gitbook.io/ton-sdk/quick_start)!
275+
## What's next?
269276

277+
1. If you want to migrate to Dev Network, read [Working with DevNet guide](work-with-devnet.md).
278+
2. Also take a look at our [blockchain basics page](https://everos.dev/faq/blockchain-basic) that will help you understand the core concepts of Everscale:)
279+
3. If you want to integrate your application with Everscale - dive into our [SDK Quick Start](https://docs.everos.dev/ever-sdk/quick\_start)!
270280
4. If you are an exchange - check out our [exchange guide](https://docs.ton.dev/86757ecb2/p/10aec9-add-ton-crystal-to-your-exchange)!
271281

272-
We hope this guide was helpful to you! If you have any difficulties/questions/suggestions/etc. please write to out telegram channel https://t.me/ever_sdk.
282+
We hope this guide was helpful to you! If you have any difficulties/questions/suggestions/etc. please write to out [telegram channel](https://t.me/ever\_sdk).

0 commit comments

Comments
 (0)