Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file added docs/.gitbook/assets/1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/3.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/GQL (1).jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/GQL.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/GQL_.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/PV logo (1).webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/PV logo.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/accDC.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/active (1).jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/active (2).jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/active.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/avtR1 (1).jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/avtR1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/ballance_HW.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/ballance_HW2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/callExtTouch_HU.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/callExtTouch_HW2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/dc1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/dc2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/dcb1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/dcb2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/deploing.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/deploy (1).jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/deploy.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/expl (1).jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/expl.jpg
Binary file modified docs/.gitbook/assets/image (1) (1).png
Binary file modified docs/.gitbook/assets/image (1).png
Binary file modified docs/.gitbook/assets/image (2).png
Binary file modified docs/.gitbook/assets/image (3).png
Binary file modified docs/.gitbook/assets/image (4).png
Binary file modified docs/.gitbook/assets/image.png
Binary file added docs/.gitbook/assets/msg_body_for_HU.jpg
Binary file added docs/.gitbook/assets/raw addr (1) (1).jpg
Binary file added docs/.gitbook/assets/raw addr (1).jpg
Binary file added docs/.gitbook/assets/raw addr (2).jpg
Binary file added docs/.gitbook/assets/raw addr.jpg
Binary file added docs/.gitbook/assets/raw address (1).jpg
Binary file added docs/.gitbook/assets/raw address.jpg
Binary file added docs/.gitbook/assets/raw_address (1).jpg
Binary file added docs/.gitbook/assets/raw_address.jpg
Binary file added docs/.gitbook/assets/raw_address_universe.jpg
Binary file added docs/.gitbook/assets/seed_phrase (1).jpg
Binary file added docs/.gitbook/assets/seed_phrase (2).jpg
Binary file added docs/.gitbook/assets/seed_phrase.jpg
Binary file added docs/.gitbook/assets/seed_phrase_universe.jpg
Binary file added docs/.gitbook/assets/timestamp.jpg
Binary file added docs/.gitbook/assets/timestamp_HU_after.jpg
Binary file added docs/.gitbook/assets/timestamp_HU_before.jpg
Binary file added docs/.gitbook/assets/timestamp_HW2_after.jpg
Binary file added docs/.gitbook/assets/timestamp_HW2_before.jpg
Binary file added docs/.gitbook/assets/timestamp_after.jpg
Binary file added docs/.gitbook/assets/touch (1) (1).jpg
Binary file added docs/.gitbook/assets/touch (1).jpg
Binary file added docs/.gitbook/assets/touch.jpg
Binary file added docs/.gitbook/assets/uinit.jpg
Binary file added docs/.gitbook/assets/uninit (1) (1).jpg
Binary file added docs/.gitbook/assets/uninit (1).jpg
Binary file added docs/.gitbook/assets/uninit (2).jpg
Binary file added docs/.gitbook/assets/uninit.jpg
Binary file added docs/.gitbook/assets/universe_activ (1).jpg
Binary file added docs/.gitbook/assets/universe_activ.jpg
Binary file added docs/.gitbook/assets/universe_gen_addr_too.jpg
47 changes: 13 additions & 34 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,10 @@ description: Overview of SDK components

# About Acki Nacki SDK

Acki Nacki SDK is a customised for Acki Nacki TVM SDK that consists of
Acki Nacki SDK consists of

* Client Libraries
* CLI 
* Local Blockchain
* CLI

Core TVM-SDK client library is written in Rust, with bindings for other programming languages.

Expand Down Expand Up @@ -72,15 +71,15 @@ You need to install core package and the package with binary for your platform.

### If you did not find the language you need

* use library module `json_interface` which provides access to library functions through JSON-RPC interface. This interface exports several extern "C" functions. So you can build a dynamic or static link library and link it to your application as any other external libraries. The JSON Interface is fully "C" compliant. You can find description in section [JSON Interface](for-binding-developers/json\_interface.md).
* use library module `json_interface` which provides access to library functions through JSON-RPC interface. This interface exports several extern "C" functions. So you can build a dynamic or static link library and link it to your application as any other external libraries. The JSON Interface is fully "C" compliant. You can find description in section [JSON Interface](for-binding-developers/json_interface.md).
* write your own binding to chosen language and share it with community.

If you choose using JSON Interface please read this document [JSON Interface](for-binding-developers/json\_interface.md).\
If you choose using JSON Interface please read this document [JSON Interface](for-binding-developers/json_interface.md).\
Here you can find directions how to use `json_interface` and write your own binding.

## Use-cases

With TVM SDK you can implement logic of any complexity on TVM compatible blockchains (Everscale, Gosh, TON, Venom, etc).
With TVM SDK you can implement logic of any complexity on TVM compatible blockchains (Acki Nacki, Everscale, TON, Venom, etc).

* Create and send messages to blockchain
* Process messages reliably (supports retries and message expiration mechanics)
Expand All @@ -92,19 +91,19 @@ With TVM SDK you can implement logic of any complexity on TVM compatible blockch
* Sign data/check signature, calculate hashes (sha256, sha512), encrypt/decrypt data
* Validate addresses
* Work with blockchain native types (bag of cells or BOCs): encode, decode, calculate hash, etc
* Works on top of GraphQL API and compatible with Evernode-SE/DS, Evercloud.
* Works on top of GraphQL API and compatible with Acki Nacki [Block Keeper node](https://docs.ackinacki.com/glossary#block-keeper-node-bk) or [Block Manager](https://docs.ackinacki.com/glossary#block-manager) node

## Quick Start

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

[Error descriptions](reference/error\_codes.md)
[Error descriptions](reference/error_codes.md)

[JavaScript SDK Types and Methods (API Reference)](https://tonlabs.github.io/ever-sdk-js/)
[JavaScript SDK Types and Methods (API Reference)](https://github.com/tvmlabs/tvm-sdk-js)

[Core Types and Methods (API Reference)](reference/types-and-methods/modules.md)

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

## Versioning

Expand Down Expand Up @@ -158,7 +157,7 @@ foo(ParamsOfFoo {
});
```

For all Ton Client API structures `Default` trait is implemented.
For all TVM Client API structures `Default` trait is implemented.

## Build client library

Expand All @@ -179,7 +178,7 @@ Note that the build script generates binaries compatible with the platform used
Rebuild `api.json`:

```shell
cd toncli
cd tvmcli
cargo run api -o ../tools
```

Expand Down Expand Up @@ -209,31 +208,11 @@ To run test suite use standard Rust test command
cargo test
```

SDK tests need GraphQL endpoint to run on. Such an API is exposed by a Block Keeper which runs in real networks, Local Network or public testnets..

Local Network 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 need to run tests on a real network use the following environment variables to override the default parameters
SDK tests need GraphQL endpoint to run on. Such an API is exposed by a Block Manager or Keeper node.

```
TON_USE_SE: true/false - flag defining if tests run against local network (true) or a real network (false)
TON_NETWORK_ADDRESS - Block Keeper addresses separated by comma.
TON_GIVER_SECRET - Sponsor Wallet secret key. If not defined, default Local Network giver keys are used
TON_GIVER_ADDRESS - Address of the Sponsor Wallet to use for prepaying accounts before deploying test contracts. If not defined, the address is calculated using `GiverV2.tvc` and configured public key
```

## Download precompiled binaries (temporarily not maintained)

Instead of building library yourself, you can download the **latest** precompiled binaries from TVM SDK Binaries Store.

| Platform | Major | Download links |
| -------- | ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Win32 | 0 | [`ton_client.lib`](https://binaries.tonlabs.io/tonclient\_0\_win32\_lib.gz), [`ton_client.dll`](https://binaries.tonlabs.io/tonclient\_0\_win32\_dll.gz) |
| | 1 | [`ton_client.lib`](https://binaries.tonlabs.io/tonclient\_1\_win32\_lib.gz), [`ton_client.dll`](https://binaries.tonlabs.io/tonclient\_1\_win32\_dll.gz) |
| macOS | 0 | [`libton_client.dylib`](https://binaries.tonlabs.io/tonclient\_0\_darwin.gz) |
| | 1 | (x86\_64)[`libton_client.dylib`](https://binaries.tonlabs.io/tonclient\_1\_darwin.gz) |
| | 1 | (aarch64)[`libton_client.dylib`](https://binaries.tonlabs.io/tonclient\_1\_darwin\_arm64.gz) |
| Linux | 0 | [`libton_client.so`](https://binaries.tonlabs.io/tonclient\_0\_linux.gz) |
| | 1 | [`libton_client.so`](https://binaries.tonlabs.io/tonclient\_1\_linux.gz) |

If you want an older version of library (e.g. `0.25.0` for macOS), you need to choose a link to your platform from the list above and replace `0` with a version: [https://binaries.tonlabs.io/tonclient\_**0\_25\_0**\_darwin.gz](https://binaries.tonlabs.io/tonclient\_0\_25\_0\_darwin.gz)

_Downloaded archive is gzipped file_
106 changes: 56 additions & 50 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,47 @@
# Table of contents

* [About Acki Nacki SDK](README.md)
* [How to deploy a Sponsor Wallet](how-to-deploy-a-sponsor-wallet.md)
* [Quick start (JavaScript)](quick\_start.md)
* [JS Quick Start](js-quick-start.md)
* [GraphQL Quick Start](graphql-quick-start.md)
* [(Old) Add Acki Nacki to your backend](add\_to\_backend.md)
* [Add Acki Nacki to your backend](add\_to\_backend-1.md)
* [How to deploy a Multisig Wallet](how-to-deploy-a-multisig-wallet.md)
* [Dapp ID Full Guide: creation, fees, centralized replenishment](dapp-id-full-guide-creation-fees-centralized-replenishment.md)
* [Quick Starts](quick-starts/README.md)
* [Quick Start TVM SDK JavaScript](quick-starts/quick-start-tvm-sdk-javascript.md)
* [GraphQL Quick Start](graphql-quick-start.md)
* [Add Acki Nacki to your backend](add_to_backend.md)

## Reference

* [Core Library Reference](reference/types-and-methods/README.md)
* [Modules](reference/types-and-methods/modules.md)
* [Module abi](reference/types-and-methods/mod\_abi.md)
* [Module boc](reference/types-and-methods/mod\_boc.md)
* [Module client](reference/types-and-methods/mod\_client.md)
* [Module crypto](reference/types-and-methods/mod\_crypto.md)
* [Module debot](reference/types-and-methods/mod\_debot.md)
* [Module net](reference/types-and-methods/mod\_net.md)
* [Module processing](reference/types-and-methods/mod\_processing.md)
* [Module proofs](reference/types-and-methods/mod\_proofs.md)
* [Module tvm](reference/types-and-methods/mod\_tvm.md)
* [Module utils](reference/types-and-methods/mod\_utils.md)
* [Core Library Error API](reference/error\_api.md)
* [Error Codes](reference/error\_codes.md)
* [TVM-CLI Reference](https://github.com/tvmlabs/tvm-sdk/blob/main/tvm\_cli/README.md)
* [Module abi](reference/types-and-methods/mod_abi.md)
* [Module boc](reference/types-and-methods/mod_boc.md)
* [Module client](reference/types-and-methods/mod_client.md)
* [Module crypto](reference/types-and-methods/mod_crypto.md)
* [Module debot](reference/types-and-methods/mod_debot.md)
* [Module net](reference/types-and-methods/mod_net.md)
* [Module processing](reference/types-and-methods/mod_processing.md)
* [Module proofs](reference/types-and-methods/mod_proofs.md)
* [Module tvm](reference/types-and-methods/mod_tvm.md)
* [Module utils](reference/types-and-methods/mod_utils.md)
* [Core Library Error API](reference/error_api.md)
* [Error Codes](reference/error_codes.md)
* [TVM-CLI Reference](https://github.com/tvmlabs/tvm-sdk/blob/main/tvm_cli/README.md)

## VM Instructions

* [Acki Nacki VM Instructions](vm-instructions/acki-nacki-vm-instructions.md)
* [Formal Verification](vm-instructions/formal-verification/README.md)
* [Acki Nacki VM Instructions Business-Level Specification](vm-instructions/formal-verification/acki-nacki-vm-instructions-business-level-specification.md)

## GraphQL

* [Field Descriptions](graphql/field-descriptions.md)
* [GraphQL API](graphql/graphql-api.md)
* [Schema](graphql/schema.md)
* [Blockchain API](graphql/blockchain-api.md)
* [Info API](graphql/info-api.md)
* [Query Collections: Query Language](graphql/query-collections-query-language.md)
* [GraphQL API](graphql/graphql-api.md)
* [Field Descriptions](graphql/field-descriptions.md)
* [Info API](graphql/info-api.md)
* [Web Playground](graphql/web-playground.md)
* [Schema](graphql/schema.md)
* [Samples](graphql/samples.md)
* [Examples](graphql/examples.md)

## ABI

Expand All @@ -60,38 +66,38 @@
## JS(TS) guides

* [Installation](guides/installation/README.md)
* [Add SDK to your App](guides/installation/add\_sdk\_to\_your\_app.md)
* [Add SDK to your App](guides/installation/add_sdk_to_your_app.md)
* [Configuration](guides/configuration/README.md)
* [Endpoint Configuration](guides/configuration/endpoint-configuration.md)
* [Message Expiration](guides/configuration/message\_expiration.md)
* [Message Retry](guides/configuration/retry\_message.md)
* [Config Reference](guides/configuration/configure\_sdk.md)
* [Work with contracts](guides/work\_with\_contracts/README.md)
* [Add Contract to your App](guides/work\_with\_contracts/add\_contract\_to\_your\_app.md)
* [Use your own Sponsor Wallet](guides/work\_with\_contracts/custom\_giver.md)
* [Deploy](guides/work\_with\_contracts/deploy.md)
* [Run on-chain](guides/work\_with\_contracts/run\_onchain.md)
* [Run ABI Get Method](guides/work\_with\_contracts/run\_abi\_get\_method.md)
* [Run Fift Get Method](guides/work\_with\_contracts/run\_fift\_get\_method.md)
* [Query messages(events)](guides/work\_with\_contracts/work\_with\_events.md)
* [Decode Messages(Event)](guides/work\_with\_contracts/decode\_message.md)
* [External Signing](guides/work\_with\_contracts/external\_signing.md)
* [Emulate Transaction](guides/work\_with\_contracts/emulate\_transaction.md)
* [Estimate Fees](guides/work\_with\_contracts/estimate\_fees.md)
* [Validate address, convert address](guides/work\_with\_contracts/validate\_address\_convert\_address.md)
* [Message Expiration](guides/configuration/message_expiration.md)
* [Message Retry](guides/configuration/retry_message.md)
* [Config Reference](guides/configuration/configure_sdk.md)
* [Work with contracts](guides/work_with_contracts/README.md)
* [Add Contract to your App](guides/work_with_contracts/add_contract_to_your_app.md)
* [Use your own Sponsor Wallet](guides/work_with_contracts/custom_giver.md)
* [Deploy](guides/work_with_contracts/deploy.md)
* [Run on-chain](guides/work_with_contracts/run_onchain.md)
* [Run ABI Get Method](guides/work_with_contracts/run_abi_get_method.md)
* [Run Fift Get Method](guides/work_with_contracts/run_fift_get_method.md)
* [Query messages(events)](guides/work_with_contracts/work_with_events.md)
* [Decode Messages(Event)](guides/work_with_contracts/decode_message.md)
* [External Signing](guides/work_with_contracts/external_signing.md)
* [Emulate Transaction](guides/work_with_contracts/emulate_transaction.md)
* [Estimate Fees](guides/work_with_contracts/estimate_fees.md)
* [Validate address](guides/work_with_contracts/validate_address_convert_address.md)
* [Crypto](guides/crypto/README.md)
* [Mnemonics and Keys](guides/crypto/mnemonics\_and\_keys.md)
* [Queries](guides/queries\_and\_subscriptions/README.md)
* [Use-cases](guides/queries\_and\_subscriptions/use-cases.md)
* [How to work with net module](guides/queries\_and\_subscriptions/how-to-work-with-net-module.md)
* [net.query syntax](guides/queries\_and\_subscriptions/raw\_query.md)
* [Data pagination](guides/queries\_and\_subscriptions/data-pagination.md)
* [Query Collection](guides/queries\_and\_subscriptions/query\_collection.md)
* [Mnemonics and Keys](guides/crypto/mnemonics_and_keys.md)
* [Queries](guides/queries_and_subscriptions/README.md)
* [Use-cases](guides/queries_and_subscriptions/use-cases.md)
* [How to work with net module](guides/queries_and_subscriptions/how-to-work-with-net-module.md)
* [net.query syntax](guides/queries_and_subscriptions/raw_query.md)
* [Data pagination](guides/queries_and_subscriptions/data-pagination.md)
* [Query Collection](guides/queries_and_subscriptions/query_collection.md)

## For Binding Developers

* [How to work with Application Objects in binding generators](for-binding-developers/app\_objects.md)
* [JSON Interface to TVM Client](for-binding-developers/json\_interface.md)
* [How to work with Application Objects in binding generators](for-binding-developers/app_objects.md)
* [JSON Interface to TVM Client](for-binding-developers/json_interface.md)

## Links

Expand Down
Loading
Loading