Merge pull request #14 from tonlabs/contracts_update

Flex initialization sample
everx-labs · Aug 30, 2022 · e45dcc3 · e45dcc3
2 parents 7c38eb0 + 97f1cd8
commit e45dcc3
Show file tree

Hide file tree

Showing 30 changed files with 158 additions and 74 deletions.
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ The library is targeted to be used with Node.js applications.
 
 Read the full Flex documentation here https://docs.everos.dev/flex
 
-# Setup Library
+# Initialize Flex object
 
 Library setup is simple, it includes setup for the Everscale client and configuration of the FLEX SDK.
 
@@ -20,31 +20,32 @@ query{
   }
 }
 ```
-Now specify the address of the endpoint and the Super Root in the config:
+Now specify the endpoint URL and Super Root address in the config
+and initialize `flex` object with it. You will need `flex` object later:
 
 ```ts
 import { TonClient } from "@eversdk/core";
 import { libNode } from "@eversdk/lib-node";
-import { Flex } from "../flex";
+import { Flex, FlexConfig } from "../flex";
 
 TonClient.useBinaryLibrary(libNode);
-Flex.config = {
+const FLEX_CONFIG: Partial<FlexConfig> = {
     evr: {
         sdk: {
             network: {
-                endpoints: "Insert FLEX endpoint here",
+                endpoints: ["FLEX ENDPOINT"],
             },
         },
     },
-    superRoot: "Insert Super Root address here",
+    superRoot: "Super Root address",
 };
-
- const flex = new Flex();
+const flex = new Flex(FLEX_CONFIG);
 
 ```
+# About Signer parameter
 
 Many functions of FLEX SDK accept parameters named `signer`.
-It is an object that has a secret, required to sign messages that will be sent to the blockchain accounts.
+It is an object that has a secret, required to sign messages that will be sent to the blockchain.
 
 `signer` parameter can accept these values:
 
@@ -192,7 +193,7 @@ npm run build
 ```
 
 To run an example do
- 
+
 ```bash 
 cd dist/examples
 node <example name>

diff --git a/dist/examples/delegate-tip3.js b/dist/examples/delegate-tip3.js
diff --git a/dist/examples/initialize-flex.d.ts b/dist/examples/initialize-flex.d.ts
@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=initialize-flex.d.ts.map
diff --git a/dist/examples/initialize-flex.js b/dist/examples/initialize-flex.js
diff --git a/dist/tsconfig.tsbuildinfo b/dist/tsconfig.tsbuildinfo
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -13,10 +13,12 @@
     --dark-hl-5: #569CD6;
     --light-hl-6: #0070C1;
     --dark-hl-6: #4FC1FF;
-    --light-hl-7: #008000;
-    --dark-hl-7: #6A9955;
-    --light-hl-8: #098658;
-    --dark-hl-8: #B5CEA8;
+    --light-hl-7: #267F99;
+    --dark-hl-7: #4EC9B0;
+    --light-hl-8: #008000;
+    --dark-hl-8: #6A9955;
+    --light-hl-9: #098658;
+    --dark-hl-9: #B5CEA8;
     --light-code-background: #F5F5F5;
     --dark-code-background: #1E1E1E;
 }
@@ -31,6 +33,7 @@
     --hl-6: var(--light-hl-6);
     --hl-7: var(--light-hl-7);
     --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
     --code-background: var(--light-code-background);
 } }
 
@@ -44,6 +47,7 @@
     --hl-6: var(--dark-hl-6);
     --hl-7: var(--dark-hl-7);
     --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
     --code-background: var(--dark-code-background);
 } }
 
@@ -57,6 +61,7 @@ body.light {
     --hl-6: var(--light-hl-6);
     --hl-7: var(--light-hl-7);
     --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
     --code-background: var(--light-code-background);
 }
 
@@ -70,6 +75,7 @@ body.dark {
     --hl-6: var(--dark-hl-6);
     --hl-7: var(--dark-hl-7);
     --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
     --code-background: var(--dark-code-background);
 }
 
@@ -82,4 +88,5 @@ body.dark {
 .hl-6 { color: var(--hl-6); }
 .hl-7 { color: var(--hl-7); }
 .hl-8 { color: var(--hl-8); }
+.hl-9 { color: var(--hl-9); }
 pre, code { background: var(--code-background); }
diff --git a/docs/classes/client.Client.html b/docs/classes/client.Client.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Client | flex-sdk-js</title><meta name="description" content="Documentation for flex-sdk-js"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">flex-sdk-js</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">flex-sdk-js</a></li><li><a href="../modules/client.html">client</a></li><li><a href="client.Client.html">Client</a></li></ul><h1>Class Client </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Client</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="client.Client.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="client.Client.html#deploy" class="tsd-kind-icon">deploy</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Client<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client.Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="client.Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="deploy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> deploy<a href="#deploy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">deploy<span class="tsd-signature-symbol">(</span>flex<span class="tsd-signature-symbol">: </span><a href="flex.Flex.html" class="tsd-signature-type" data-tsd-kind="Class">Flex</a>, options<span class="tsd-signature-symbol">: </span><a href="../modules/client.html#DeployClientOptions" class="tsd-signature-type" data-tsd-kind="Type alias">DeployClientOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/tonlabs/flex-sdk-js/blob/bce9071/flex/client/index.ts#L89">flex/client/index.ts:89</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Client | flex-sdk-js</title><meta name="description" content="Documentation for flex-sdk-js"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">flex-sdk-js</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">flex-sdk-js</a></li><li><a href="../modules/client.html">client</a></li><li><a href="client.Client.html">Client</a></li></ul><h1>Class Client </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Client</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="client.Client.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="client.Client.html#deploy" class="tsd-kind-icon">deploy</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Client<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="client.Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="client.Client.html" class="tsd-signature-type" data-tsd-kind="Class">Client</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="deploy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> deploy<a href="#deploy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">deploy<span class="tsd-signature-symbol">(</span>flex<span class="tsd-signature-symbol">: </span><a href="flex.Flex.html" class="tsd-signature-type" data-tsd-kind="Class">Flex</a>, options<span class="tsd-signature-symbol">: </span><a href="../modules/client.html#DeployClientOptions" class="tsd-signature-type" data-tsd-kind="Type alias">DeployClientOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/tonlabs/flex-sdk-js/blob/7440979/flex/client/index.ts#L89">flex/client/index.ts:89</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>Deploys Flex Client contract that is used to manage funds on DEX.</p>
 </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>flex: <a href="flex.Flex.html" class="tsd-signature-type" data-tsd-kind="Class">Flex</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
 <p>DEX instance</p>