Skip to content

Commit

Permalink
Automatic update project version. #none
Browse files Browse the repository at this point in the history
Update docs from gitbook
  • Loading branch information
tonjen authored Oct 19, 2023
2 parents 0778ea5 + 92b6557 commit 702ad14
Show file tree
Hide file tree
Showing 11 changed files with 40 additions and 50 deletions.
50 changes: 20 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,35 @@
# Ever SDK

Client libraries for DApp development in TVM blockchains (Everscale, Gosh, TON, Venom Blockchain, etc).

Core Ever-SDK client library is written in Rust, with bindings in 11 programming languages.

<div>
<img src="docs/.gitbook/assets/vf-dev-program.png" alt="" width="300">
<img src="docs/.gitbook/assets/GoshLogo.png" alt="" width="300">
</br>
<img src="docs/.gitbook/assets/Everscale Logo.png" alt="" width="300">

</div>
![](docs/.gitbook/assets/vf-dev-program.png) ![](docs/.gitbook/assets/GoshLogo.png)\
![](<docs/.gitbook/assets/Everscale Logo.png>)

**Get quick help in our telegram channel:**

[![Channel on Telegram](https://img.shields.io/badge/chat-on%20telegram-9cf.svg)](https://t.me/ever\_sdk)


- [Ever SDK](#ever-sdk)
- [Supported languages](#supported-languages)
- [Rust (core library)](#rust-core-library)
- [Official Javascript(Typescript) binding](#official-javascripttypescript-binding)
- [Community bindings](#community-bindings)
- [If you did not find the language you need](#if-you-did-not-find-the-language-you-need)
- [Use-cases](#use-cases)
- [Quick Start](#quick-start)
- [How to avoid Soft Breaking Problems](#how-to-avoid-soft-breaking-problems)
- [Build client library](#build-client-library)
- [Build artifacts](#build-artifacts)
- [Run tests](#run-tests)
- [Download precompiled binaries](#download-precompiled-binaries)

* [Ever SDK](./#ever-sdk)
* [Supported languages](./#supported-languages)
* [Rust (core library)](./#rust-core-library)
* [Official Javascript(Typescript) binding](./#official-javascripttypescript-binding)
* [Community bindings](./#community-bindings)
* [If you did not find the language you need](./#if-you-did-not-find-the-language-you-need)
* [Use-cases](./#use-cases)
* [Quick Start](./#quick-start)
* [How to avoid Soft Breaking Problems](./#how-to-avoid-soft-breaking-problems)
* [Build client library](./#build-client-library)
* [Build artifacts](./#build-artifacts)
* [Run tests](./#run-tests)
* [Download precompiled binaries](./#download-precompiled-binaries)

## Supported languages

### Rust (core library)

Repository: https://github.com/tonlabs/ever-sdk
Repository: https://github.com/tonlabs/ever-sdk

**What is Core Client Library?**

Expand Down Expand Up @@ -106,9 +100,9 @@ With Ever-SDK you can implement logic of any complexity on TVM compatible blockc

## Quick Start

Get your endpoing at [dashboard.evercloud.dev](https://dashboard.evercloud.dev/) or run Evernode-SE (local node) or Dapp Server (self-hosted blockchain node).&#x20;
Get your endpoing at [dashboard.evercloud.dev](https://dashboard.evercloud.dev/) or run Evernode-SE (local node) or Dapp Server (self-hosted blockchain node).

See the list of available TVM networks: https://docs.evercloud.dev/products/evercloud/networks-endpoints
See the list of available TVM networks: [https://docs.everplatform.dev/products/evercloud/networks-endpoints](https://docs.everplatform.dev/products/evercloud/networks-endpoints)

[Quick Start (Javascript binding)](docs/quick\_start.md)

Expand All @@ -120,10 +114,6 @@ See the list of available TVM networks: https://docs.evercloud.dev/products/ever

[Guides](docs/guides/installation/add\_sdk\_to\_your\_app.md)





## How to avoid Soft Breaking Problems

Soft Breaking is API changes that include only new optional fields in the existing structures. This changes are fully backward compatible for JSON Interface.
Expand Down Expand Up @@ -223,7 +213,7 @@ To run test suite use standard Rust test command
cargo test
```

SDK tests need [EVER OS API](https://docs.everos.dev/ever-platform/reference/graphql-api/networks) endpoint to run on. Such an API is exposed by a [DApp Server](https://github.com/tonlabs/evernode-ds) which runs in real networks and by local blockchain [Evernode SE](https://github.com/tonlabs/evernode-se).
SDK tests need [EVER OS API](https://docs.everplatform.dev/reference/graphql-api/networks) endpoint to run on. Such an API is exposed by a [DApp Server](https://github.com/tonlabs/evernode-ds) which runs in real networks and by local blockchain [Evernode SE](https://github.com/tonlabs/evernode-se).

Evernode SE is used by default with address `http://localhost` and port 80. If you launch it on another port you need to specify it explicitly like this: `http://localhost:port`. If you have Evernode SE running on another address or you need to run tests on a real Everscale network use the following environment variables to override the default parameters

Expand Down
8 changes: 4 additions & 4 deletions docs/add_to_backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ This document describes the various ways to accomplish the most important tasks

There are a few different ways to accomplish the necessary tasks:

* Blockchain access may be set up either through the [Evercloud](https://docs.evercloud.dev/products/evercloud/get-started) or through your own supernode - the [DApp server](https://docs.evercloud.dev/products/dapp-server-ds).
* Blockchain access may be set up either through the [Evercloud](https://docs.everplatform.dev/products/evercloud/get-started) or through your own supernode - the [DApp server](https://docs.everplatform.dev/products/dapp-server-ds).
* User account management can be accomplished either through the [everdev](https://docs.everos.dev/everdev/) command line tool or integrate into your backend with EVER-SDK client libraries. Both of these approaches are compatible with either of the blockchain access setups.

## Setting up Blockchain Access

### Using Evercloud

Using [Evercloud](https://docs.evercloud.dev/products/evercloud/get-started) allows you to work with TVM blockchains without having to run your own node. Everdev and SDK can connect to it, as if it were a regular node. It has the same API as a node, and provides all neede capabilities.
Using [Evercloud](https://docs.everplatform.dev/products/evercloud/get-started) allows you to work with TVM blockchains without having to run your own node. Everdev and SDK can connect to it, as if it were a regular node. It has the same API as a node, and provides all neede capabilities.

This page lists the [cloud endpoints](https://docs.evercloud.dev/products/evercloud/networks-endpoints). To get access credentials go through this [guide](https://docs.evercloud.dev/products/evercloud/get-started).
This page lists the [cloud endpoints](https://docs.everplatform.dev/products/evercloud/networks-endpoints). To get access credentials go through this [guide](https://docs.everplatform.dev/products/evercloud/get-started).

Whenever you have to specify a network endpoint in the examples given below, use the endpoints and credentials you receive in the [Evercloud dashboard](https://dashboard.evercloud.dev/projects).

Expand All @@ -31,7 +31,7 @@ Note: We recommend testing out the full setup on the developer network first.

### Using DApp Server&#x20;

If you prefer to run your own node, you may set up your own [DApp server](https://docs.evercloud.dev/products/dapp-server-ds). It is a client supernode, that may be set up on your own servers and provide full access to TVM networks. To connect to it with Everdev or SDK, it needs to have a domain name and a DNS record. You can specify its URL whenever you have to set the network in the examples given below.
If you prefer to run your own node, you may set up your own [DApp server](https://docs.everplatform.dev/products/dapp-server-ds). It is a client supernode, that may be set up on your own servers and provide full access to TVM networks. To connect to it with Everdev or SDK, it needs to have a domain name and a DNS record. You can specify its URL whenever you have to set the network in the examples given below.

Get the setup scripts in this repository: [https://github.com/tonlabs/evernode-ds](https://github.com/tonlabs/evernode-ds)

Expand Down
8 changes: 4 additions & 4 deletions docs/guides/configuration/endpoint-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ network: {

### Evercloud

If you don't want to manage your own infrastructure - get your Evercloud endpoints **for free** to Mainnet and Devnet and configure security settings here [https://docs.everos.dev/evernode-platform/products/evercloud/get-started](https://docs.everos.dev/evernode-platform/products/evercloud/get-started).
If you don't want to manage your own infrastructure - get your Evercloud endpoints **for free** to Mainnet and Devnet and configure security settings here [https://docs.everplatform.dev/products/evercloud/get-started](https://docs.everplatform.dev/products/evercloud/get-started).

Check the full list of [supported networks](https://docs.everos.dev/ever-platform/reference/graphql-api/networks).&#x20;
Check the full list of [supported networks](https://docs.everplatform.dev/reference/graphql-api/networks).&#x20;

```javascript
const client = new TonClient({
Expand All @@ -53,11 +53,11 @@ network: {

### Self-hosted dedicated node

If you want to run your own dedicated node yourself - see the[ Evernode-DS documentation ](https://docs.everos.dev/evernode-platform/products/dapp-server-ds)how to run your dedicated node.
If you want to run your own dedicated node yourself - see the[ Evernode-DS documentation ](https://docs.everplatform.dev/products/dapp-server-ds)how to run your dedicated node.

### Dedicated Evercloud

If you want your dedicated set of nodes to be run by Evernode Platform team, check this page [https://docs.everos.dev/evernode-platform/products/dedicated-node](https://docs.everos.dev/evernode-platform/products/dedicated-node).&#x20;
If you want your dedicated set of nodes to be run by Evernode Platform team, check this page [https://docs.everplatform.dev/products/dedicated-cloud-node](https://docs.everplatform.dev/products/dedicated-cloud-node).&#x20;

## Multiple endpoints configuration

Expand Down
8 changes: 4 additions & 4 deletions docs/guides/queries_and_subscriptions/data-pagination.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ description: >-

Read about each entity type pagination API:

* [Blocks](https://docs.everos.dev/ever-platform/samples/graphql-samples/blocks#blocks-pagination)
* [Transactions](https://docs.everos.dev/ever-platform/samples/graphql-samples/transactions#paginate-blockchain-transactions)
* [Account transactions](https://docs.everos.dev/ever-platform/samples/graphql-samples/accounts#pagination-of-account-transactions)
* [Account messages](https://docs.everos.dev/ever-platform/samples/graphql-samples/accounts#pagination-of-accounts-messages)
* [Blocks](https://docs.everplatform.dev/samples/graphql-samples/blocks#blocks-pagination)
* [Transactions](https://docs.everplatform.dev/samples/graphql-samples/transactions#paginate-blockchain-transactions)
* [Account transactions](https://docs.everplatform.dev/samples/graphql-samples/accounts#get-transactions-within-block-seqno-range)
* [Account messages](https://docs.everplatform.dev/samples/graphql-samples/accounts#get-messages-within-block-range)

Look at the sample how to implement these entities pagination with JS SDK:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

To get API data with the help of SDK, just wrap the GraphQL query inside net.query function.

[GraphQL samples. ](https://docs.everos.dev/ever-platform/samples/graphql-samples/accounts)
[GraphQL samples. ](https://docs.everplatform.dev/samples/graphql-samples/accounts)

See the next page how to do it.&#x20;
2 changes: 1 addition & 1 deletion docs/guides/queries_and_subscriptions/use-cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ description: What data can you get from GraphQL API?
* Subscribe to data updates
* Easily paginate such data as blocks, transactions

[See the full API use-cases here.](https://docs.everos.dev/ever-platform/reference/graphql-api#use-cases)
[See the full API use-cases here.](https://docs.everplatform.dev/reference/graphql-api#use-cases)
2 changes: 1 addition & 1 deletion docs/guides/work_with_contracts/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ This is not a correct way.
You can get it several ways:

* You can use SDK function [get\_code\_from\_tvc](../../reference/types-and-methods/mod\_boc.md#get\_code\_from\_tvc) of `boc` module and retrieve the code's boc from tvc file.
* You can download another account with the same `code_hash`'s `boc` from graphql, using [blockchain API](https://docs.evercloud.dev/samples/graphql-samples/accounts#get-account-info) and retrieve the 'code' from the result `boc` field.
* You can download another account with the same `code_hash`'s `boc` from graphql, using [blockchain API](https://docs.everplatform.dev/samples/graphql-samples/accounts#get-account-info) and retrieve the 'code' from the result `boc` field.

## Sample Source Code

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/work_with_contracts/monitor-messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## When you may need message monitor?

The **Message Monitor object** is based on the [GraphQL API extension of the same name](https://docs.evercloud.dev/reference/graphql-api/message-monitor-api). It was developed to solve the problem of batch external message processing.
The **Message Monitor object** is based on the [GraphQL API extension of the same name](https://docs.everplatform.dev/reference/graphql-api/message-monitor-api). It was developed to solve the problem of batch external message processing.

## About Message Monitor

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,9 +169,9 @@ Full sample: [https://github.com/tonlabs/sdk-samples/tree/master/core-examples/n
Guides for working with REMP in GraphQL API:
{% embed url="https://docs.evercloud.dev/samples/graphql-samples/subscribe-for-remp-receipts" %}
{% embed url="https://docs.everplatform.dev/samples/graphql-samples/subscribe-for-remp-receipts" %}
{% embed url="https://docs.evercloud.dev/samples/graphql-samples/send-message" %}
{% embed url="https://docs.everplatform.dev/samples/graphql-samples/send-message" %}
REMP Architecture documentation:
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/work_with_contracts/work_with_events.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ messages(

See the full sample here [https://github.com/tonlabs/sdk-samples/tree/master/core-examples/node-js/pagination](https://github.com/tonlabs/sdk-samples/tree/master/core-examples/node-js/pagination)

Read about used API here -> [Account messages pagination](https://docs.everos.dev/ever-platform/samples/graphql-samples/accounts#pagination-of-accounts-messages). &#x20;
Read about used API here -> [Account messages pagination](https://docs.everplatform.dev/samples/graphql-samples/accounts#get-messages-within-block-range). &#x20;

```javascript
result = await client.net.query({
Expand Down
2 changes: 1 addition & 1 deletion docs/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ $ npm i
The script implements the following logic:

1. Links the project with Node.js [Ever-SDK](https://github.com/tonlabs/ever-sdk) binary. If you plan to use JS SDK in Web, link it with Wasm binary. Read more [here](https://github.com/tonlabs/ever-sdk-js).
2. `TONClient` instance is created and initialized with [Evernode SE](https://github.com/tonlabs/evernode-se) ("[http://localhost](http://localhost)", local blockchain) endpoint. See the list of other available [endpoints](https://docs.everos.dev/ever-platform/reference/graphql-api/networks).
2. `TONClient` instance is created and initialized with [Evernode SE](https://github.com/tonlabs/evernode-se) ("[http://localhost](http://localhost)", local blockchain) endpoint. See the list of other available [endpoints](https://docs.everplatform.dev/reference/graphql-api/networks).
3. Future address is calculated from the code and data of the contract (data includes signing keys)
4. &#x20;Flag `useGiver: true` allows to sponsor deploy with Evernode SE giver that is hard coded as the default Account giver. [You can re-assign it to your own giver](guides/work\_with\_contracts/deploy.md#transfer-funds-to-the-future-address).

Expand Down

0 comments on commit 702ad14

Please sign in to comment.