From 5fb715f5d2c96b524ad2def49cadcab880c63296 Mon Sep 17 00:00:00 2001 From: Ekaterina Pantaz Date: Fri, 11 Oct 2024 22:01:03 +0000 Subject: [PATCH] GITBOOK-17: No subject --- docs/SUMMARY.md | 1 + docs/add_to_backend-1.md | 1 + .../copy-of-how-to-deploy-a-sponsor-wallet.md | 95 +++++++++++++++++++ docs/how-to-deploy-a-sponsor-wallet.md | 91 +----------------- docs/js-quick-start.md | 3 +- 5 files changed, 101 insertions(+), 90 deletions(-) create mode 100644 docs/copy-of-how-to-deploy-a-sponsor-wallet.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 1b8f32fb..1209abf3 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -2,6 +2,7 @@ * [About Acki Nacki SDK](README.md) * [How to deploy a Sponsor Wallet](how-to-deploy-a-sponsor-wallet.md) +* [Copy of How to deploy a Sponsor Wallet](copy-of-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) diff --git a/docs/add_to_backend-1.md b/docs/add_to_backend-1.md index 08b27a37..f9a64ec3 100644 --- a/docs/add_to_backend-1.md +++ b/docs/add_to_backend-1.md @@ -2,6 +2,7 @@ description: >- This document describes the various ways to accomplish the most important tasks of running a backend project that supports Acki Nacki +hidden: true --- # Add Acki Nacki to your backend diff --git a/docs/copy-of-how-to-deploy-a-sponsor-wallet.md b/docs/copy-of-how-to-deploy-a-sponsor-wallet.md new file mode 100644 index 00000000..cbb185e2 --- /dev/null +++ b/docs/copy-of-how-to-deploy-a-sponsor-wallet.md @@ -0,0 +1,95 @@ +--- +description: Create a simple wallet to sponsor your operations with TVM CLI +hidden: true +--- + +# Copy of How to deploy a Sponsor Wallet + +## **Build and install CLI tool** + +``` +cd ~ +git clone https://github.com/tvmlabs/tvm-sdk +cd tvm-sdk +cargo build --release +cd target/release +cp tvm-cli ~/.cargo/bin + +``` + +Now path to tvm-cli is publicly accessible. You can also add it to your ENVs + +`export PATH=$PATH:~/tvm-sdk/target/release/tvm-cli` + +## **Prepare wallet binary and ABI** + +Create a folder : + +``` +cd ~ +mkdir wallet +cd wallet +``` + +Download source files for the wallet from [wallet repo](https://github.com/tvmlabs/sdk-examples/tree/main/contracts/simpleWallet) and place them into this folder. + +{% hint style="warning" %} +This is a test wallet, not a production wallet that underwent Formal Verification. We are working on multisig wallet that [will be published soon](https://github.com/gosh-sh/ackinacki-wallet). Deployment process, although will be the same. +{% endhint %} + +## Configure CLI tool + +We need to target it to the blockchain we will deploy to. + +Here we target at testnet. + +``` +tvm-cli config --url ackinacki-testnet.tvmlabs.dev/graphql +``` + +## Generate seed phrase, keys and address + +In Acki nacki blockchain the wallet address depends on its binary code and initial data that includes the owner's public key. + +You can do it all with one command + +``` +tvm-cli genaddr wallet.tvc --genkey wallet.keys.json +``` + +`Raw address is your wallet address. Keys are saved to wallet.keys.json.` + +`Copy your seed phrase if you need it.` + +![](https://dev.docs-gosh.pages.dev/images/n\_Acki\_Nacki\_c\_t\_n\_giver\_genn\_addr.jpg) + +## **Request test tokens** + +Request test tokens on your address. If you plan to test your contract systems then request enough tokens, as this wallet will be used as sponsor wallet for gas. + +Please contact us in [Channel on Telegram](https://t.me/+1tWNH2okaPthMWU0). + +## Deploy your wallet + +When you receive the tokens check the state of the pre-deployed contract. It should be **`Uninit`**: + +``` +tvm-cli account +``` + +![](https://dev.docs-gosh.pages.dev/images/n\_Acki\_Nacki\_c\_t\_n\_giver\_account.jpg) + +Now you are ready to deploy your wallet with the following command: + +``` +tvm-cli deploy --abi wallet.abi.json --sign wallet.keys.json wallet.tvc {} +``` + +The arguments of the constructor must be specified in curly brackets:\ +`{}, We dont have any arguments here, so its empty.` + +![](https://dev.docs-gosh.pages.dev/images/n\_Acki\_Nacki\_c\_t\_n\_giver\_deploy.jpg) + +Check the contract state again. This time, it is should be `Active`. + +![](https://dev.docs-gosh.pages.dev/images/n\_Acki\_Nacki\_c\_t\_n\_giver\_account2.jpg) diff --git a/docs/how-to-deploy-a-sponsor-wallet.md b/docs/how-to-deploy-a-sponsor-wallet.md index 5cb02af4..5e1c84eb 100644 --- a/docs/how-to-deploy-a-sponsor-wallet.md +++ b/docs/how-to-deploy-a-sponsor-wallet.md @@ -1,94 +1,7 @@ --- -description: Create a simple wallet to sponsor your operations with TVM CLI +description: WIP --- # How to deploy a Sponsor Wallet -## **Build and install CLI tool** - -``` -cd ~ -git clone https://github.com/tvmlabs/tvm-sdk -cd tvm-sdk -cargo build --release -cd target/release -cp tvm-cli ~/.cargo/bin - -``` - -Now path to tvm-cli is publicly accessible. You can also add it to your ENVs - -`export PATH=$PATH:~/tvm-sdk/target/release/tvm-cli` - -## **Prepare wallet binary and ABI** - -Create a folder : - -``` -cd ~ -mkdir wallet -cd wallet -``` - -Download source files for the wallet from [wallet repo](https://github.com/tvmlabs/sdk-examples/tree/main/contracts/simpleWallet) and place them into this folder. - -{% hint style="warning" %} -This is a test wallet, not a production wallet that underwent Formal Verification. We are working on multisig wallet that [will be published soon](https://github.com/gosh-sh/ackinacki-wallet). Deployment process, although will be the same. -{% endhint %} - -## Configure CLI tool - -We need to target it to the blockchain we will deploy to. - -Here we target at testnet. - -``` -tvm-cli config --url ackinacki-testnet.tvmlabs.dev/graphql -``` - -## Generate seed phrase, keys and address - -In Acki nacki blockchain the wallet address depends on its binary code and initial data that includes the owner's public key. - -You can do it all with one command - -``` -tvm-cli genaddr wallet.tvc --genkey wallet.keys.json -``` - -`Raw address is your wallet address. Keys are saved to wallet.keys.json.` - -`Copy your seed phrase if you need it.` - -![](https://dev.docs-gosh.pages.dev/images/n\_Acki\_Nacki\_c\_t\_n\_giver\_genn\_addr.jpg) - -## **Request test tokens** - -Request test tokens on your address. If you plan to test your contract systems then request enough tokens, as this wallet will be used as sponsor wallet for gas. - -Please contact us in [Channel on Telegram](https://t.me/+1tWNH2okaPthMWU0). - -## Deploy your wallet - -When you receive the tokens check the state of the pre-deployed contract. It should be **`Uninit`**: - -``` -tvm-cli account -``` - -![](https://dev.docs-gosh.pages.dev/images/n\_Acki\_Nacki\_c\_t\_n\_giver\_account.jpg) - -Now you are ready to deploy your wallet with the following command: - -``` -tvm-cli deploy --abi wallet.abi.json --sign wallet.keys.json wallet.tvc {} -``` - -The arguments of the constructor must be specified in curly brackets:\ -`{}, We dont have any arguments here, so its empty.` - -![](https://dev.docs-gosh.pages.dev/images/n\_Acki\_Nacki\_c\_t\_n\_giver\_deploy.jpg) - -Check the contract state again. This time, it is should be `Active`. - -![](https://dev.docs-gosh.pages.dev/images/n\_Acki\_Nacki\_c\_t\_n\_giver\_account2.jpg) +The wallet guide will de published soon. diff --git a/docs/js-quick-start.md b/docs/js-quick-start.md index c013e436..8f10e570 100644 --- a/docs/js-quick-start.md +++ b/docs/js-quick-start.md @@ -2,9 +2,10 @@ description: >- This is a reference quick start guide in JS, other languages have the same api and should implement the integration the same way +hidden: true --- -# Quick Start +# JS Quick Start ## **Prerequisites**