Release 4.3.0 (#582)

* Realign 4.2.0 (#548) * chore(package): Bump version to 2.4.1 * chore(Adjust CHANGELOG): * chore(CAHNGELOG): Fix typo * docs(USAGE): Fix networkId in Wallet example * fix(Http): Remove userAgent from axios * chore(CHANGELOG): Fix typo * docs(*): Regenrate docs * chore(bump version in package): * chore(CHANGELOG): Adjust changelog to conventional changelog style * chore(Docker): Update node version tot 2.3.0 * docs(CHANGELOG): Adjust release * feat(npm): Add script for auto-generating changelog * chore(Node): downgrade to 2.2.0 due to failed channel test * fix(Channel): Fix failing test on 2.3.0 node * chore(package-lock): adjust package-lock * chore(Channel): Revert to 2.2.0 * docs(Docs): Regenerate docs * refactor(node): Add txHash to sendTransaction error * chore(package): bump version to 3.1.0 * chore(Docs): Regeneratee docs and changelog * chore(package): Add packa-lock * chore(changelog): Adjust closes issue * chore(package): Bump version to 3.2.0 * docs(Docs and Changelog): Regenerate docs * docs(CHANGELOG): Adjust changelog * docs(CHANGELOG): Adjust changelog * chore(Jenkions): Force jenkins * fix(NPM): Make audit of npm packages. Remove esm from deps * chore(Release): Bump version in package, generate CHNAGELOG * force Jenkins * force Jenkins * force Jenkins * force Jenkins * fix(AEP exampe): Fix contract in AEPP example * Release/3.3.0 (#417) * Realign/3.2.1 (#412) * chore(package): Bump version to 2.4.1 * chore(Adjust CHANGELOG): * chore(CAHNGELOG): Fix typo * docs(USAGE): Fix networkId in Wallet example * fix(Http): Remove userAgent from axios * chore(CHANGELOG): Fix typo * docs(*): Regenrate docs * chore(bump version in package): * chore(CHANGELOG): Adjust changelog to conventional changelog style * chore(Docker): Update node version tot 2.3.0 * docs(CHANGELOG): Adjust release * feat(npm): Add script for auto-generating changelog * chore(Node): downgrade to 2.2.0 due to failed channel test * fix(Channel): Fix failing test on 2.3.0 node * chore(package-lock): adjust package-lock * chore(Channel): Revert to 2.2.0 * docs(Docs): Regenerate docs * refactor(node): Add txHash to sendTransaction error * chore(package): bump version to 3.1.0 * chore(Docs): Regeneratee docs and changelog * chore(package): Add packa-lock * chore(changelog): Adjust closes issue * chore(package): Bump version to 3.2.0 * docs(Docs and Changelog): Regenerate docs * docs(CHANGELOG): Adjust changelog * docs(CHANGELOG): Adjust changelog * chore(Jenkions): Force jenkins * fix(NPM): Make audit of npm packages. Remove esm from deps * chore(Release): Bump version in package, generate CHNAGELOG * force Jenkins * force Jenkins * force Jenkins * force Jenkins * feat(Consensus): Add function to get consensus version. (#413) * feat(Consensus): Add function to get conmsensus version. Get vm/abi based on node protocol * chore(node): Remove logs * add docs for node getProtocol * disable channel tests * try to fix channel test * try to fix channel test * Make sdk compatible with node from 2.3.0 to 4.0.0 * feat(TxBuilder): INT type must be greater or equal 0 int transaction * feat(State Channels): Make state channels compatible with aeternity v… (#415) * feat(State Channels): Make state channels compatible with aeternity v3.0.0 * Fix lint error * feat(Transaction Builder): Add serializations for transactions introd… (#416) * feat(Transaction Builder): Add serializations for transactions introduced in fortuna release * Fix lint errors * fix(AEP exampe): Fix contract in AEPP example * chore(package): Bump version to 3.3.0 * fix(Node): Use universalUrl istead of ES URL * Enable channel tests * chore(package): Bump version to 3.4.0 * chore(CHANGELOG): Adjust CHANGELOG for 3.4.0 * chore(CHANGELOG/.env): Adjust changlog. Point node version in `.env` to v3.0.0-rc.1 * chore(.env): Remove trailing newlines * docs(Docs): Regenrate docs * fix(Deps): Update axios lib to 0.19.0 * chore(Release): Bump version to 3.4.1. Regenerate CHANGELOG * Adjust changelog * build(deps): Make audit of example app packages. Regenerate lock files * chore(package): Bump version to 4.0.0 Regenerate CHANGELOG * chore(CHANGELOG): Adjust CHANGELOG * chore(build): Regenerate package-lock and pnpm-lock * docs(API): Regenrate * chore(Changelog): Adjust CHANGELOG * chore(docs): Resolve comments * chore(examples): Regenerate lock files * chore(CHANGELOG): Adjust * chore(Release): Bump version to 4.0.1. Generate CHANGELOG * docs(api): generate docs * chore(lock): Update lock files * force jenkins * Adjust changelog * chore(release): bump version in package to 4.1.0 * build(docker): Add Channel url to docker env for test * chore(release): Regenerate CHANGELOG * chore(docs): Regenerate docs and lock file * chore(CHANGELOG): Adjust changelog. Add example of usage * chore(example): Update sdk version in example vuejs app * fix typo * Bump version to 4.2.0 Adjust README * Adjust Changelog * Adjust Changelog * Update examples app deps * chore(examples): Update lock file fix webpack config * Update vue-loader in group default to the latest version 🚀 (#553) * chore(package): update vue-loader to version 15.7.1 * chore(package): update vue-loader to version 15.7.1 * Update babel7 in group default to the latest version 🚀 (#552) * chore(package): update @babel/cli to version 7.5.5 * chore(package): update @babel/cli to version 7.5.5 * chore(package): update @babel/cli to version 7.5.5 * chore(package): update @babel/core to version 7.5.5 * chore(package): update @babel/core to version 7.5.5 * chore(package): update @babel/core to version 7.5.5 * chore(package): update @babel/node to version 7.5.5 * chore(package): update @babel/node to version 7.5.5 * chore(package): update @babel/node to version 7.5.5 * chore(package): update @babel/plugin-proposal-export-default-from to version 7.5.2 * chore(package): update @babel/plugin-proposal-export-default-from to version 7.5.2 * chore(package): update @babel/plugin-proposal-export-default-from to version 7.5.2 * chore(package): update @babel/plugin-proposal-object-rest-spread to version 7.5.5 * chore(package): update @babel/plugin-proposal-object-rest-spread to version 7.5.5 * chore(package): update @babel/plugin-proposal-object-rest-spread to version 7.5.5 * chore(package): update @babel/plugin-transform-runtime to version 7.5.5 * chore(package): update @babel/plugin-transform-runtime to version 7.5.5 * chore(package): update @babel/plugin-transform-runtime to version 7.5.5 * chore(package): update @babel/preset-env to version 7.5.5 * chore(package): update @babel/preset-env to version 7.5.5 * chore(package): update @babel/preset-env to version 7.5.5 * chore(package): update @babel/register to version 7.5.5 * chore(package): update @babel/register to version 7.5.5 * chore(package): update @babel/register to version 7.5.5 * chore(package): update @babel/runtime to version 7.5.5 * chore(package): update @babel/runtime to version 7.5.5 * chore(package): update @babel/runtime to version 7.5.5 * test(transaction): Fix ttl for oracle transactions (#556) * update browserslist to version 4.6.4 (#551) * chore(package): update browserslist to version 4.6.4 * chore(package): update browserslist to version 4.6.4 * fix(State Channels): Fix websocket url (#558) Fixes a bug which caused unneccessary params (for example: sign, url) to be included to websocket url. * refactor(State Channels): Do not include white space for outgoing websocket messages (#559) * chore(package): update cz-conventional-changelog to version 3.0.0 (#560) * Update webpack to 4.36.1 🚀 (#557) * chore(package): update webpack to version 4.36.1 * chore(package): update webpack to version 4.36.1 * chore(package): update webpack to version 4.36.1 * Update index.js (#565) docs(ACI): add some additional clarification to getContractInstance() doc * feat(state channel): make state channel compatible with aeternity@4.0.0 (#568) * fix(state channels): fix onChainTx event params (#566) * feat(ACI): Implement sophia `variant` type (#567) * feat(ACI): Implement sophia `variant` type. Improve arguments validation * feat(ACI): Implement `vars` injection to `typeDef` ``` datatype myOption('a) = Node | Some('a) entrypoint optionFn(v: myOption(string)): myOption(string = v) ``` * fix(lint): Fix linter error * feat(ACI): Add validation for sophia `datatype` simple and generic variant * feat(ACI): Allow pass datatype as object(for generic variants) or string. Add tests * fix(swagger): Pass query params in case of get request (#570) * Make Swagger a sync stamp (#569) * Make Swagger a sync stamp * Add AsyncInit to Node stamp * chore(deps): Audit and regenerate lock files (#575) * feat(NodePool): Implement NodePool stamp (#574) * feat(NodePool): Implement NodePool stamp. Fix tests * fix(NodePool): Fix merge conflict * fix(NodePool): Fix example app * feat(NodePool): Remove proxy object on 'api' prop instead use propDescriptor with custom getter(this allow to clone the object) * fix(Linter): Fix linter errors * feat(NodePool): Add tests * feat(contract): add ability to use call-static/dry-run without keyPair (#577) * feat(NodePool): Implement NodePool stamp. Fix tests * fix(NodePool): Fix merge conflict * fix(NodePool): Fix example app * feat(NodePool): Remove proxy object on 'api' prop instead use propDescriptor with custom getter(this allow to clone the object) * fix(Linter): Fix linter errors * feat(selector): add `address` validation of selected anddress and selectAddress function * feat(contract): add ability to use call-static/dry-run without keyPair If keyPair is not provided Use 0 account with predefined amounts of token. Add ability to predefine this 0 zero account using option `dryRunAccount: { pub: '', amount '' }` * feat(Contract): add validation of amount option in dry-run * feat(Linter): fix linter * feat(TxBuilder): Add helper for producing tx hash (#579) * Refactor AE account composition (#581) * refactor(Accounts): Init refactoring of account stamp relation * fix(Accounts): Improve initialization. Refactor stamps composition * revert(examples): Remove debug * fix(Account): Prevent breaking changes. Add workaround for using `setKeypair` fn synchronously * chore(release): Bump version to 4.3.0 * docs(release): Update docs * docs(release): Fix example apps * docs(release): Add NodePool docs update tutorials * docs(release): Adjust README * docs(release): fix imports * chore(release): fix examples apps. Regenerate lock files * chore(release): include NodePool and Accounts in bundle
aeternity · Aug 5, 2019 · 772f3ab · 772f3ab
1 parent ca79d6e
commit 772f3ab
Show file tree

Hide file tree

Showing 61 changed files with 20,315 additions and 13,191 deletions.
diff --git a/.env b/.env
@@ -1,2 +1,2 @@
-TAG=v3.3.0
+TAG=v4.0.0
 COMPILER_TAG=v3.2.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,33 @@
+# [4.3.0](https://github.com/aeternity/aepp-sdk-js/compare/2.4.0...4.3.0) (2019-08-05)
+
+
+### Bug Fixes
+
+* **State Channels:** Fix onChainTx event params ([#566](https://github.com/aeternity/aepp-sdk-js/issues/566)) ([11c85eb](https://github.com/aeternity/aepp-sdk-js/commit/11c85eb))
+* **State Channels:** Fix websocket url ([#558](https://github.com/aeternity/aepp-sdk-js/issues/558)) ([33c1fd8](https://github.com/aeternity/aepp-sdk-js/commit/33c1fd8))
+* **Swagger:** Pass query params in case of get request ([#570](https://github.com/aeternity/aepp-sdk-js/pull/570))
+
+### Code Refactoring
+
+* **State Channel:** Do not include white space for outgoing websocket messages ([#559](https://github.com/aeternity/aepp-sdk-js/pull/559))
+
+
+### Features
+
+* **ACI:** Implement sophia `variant` type ([#567](https://github.com/aeternity/aepp-sdk-js/issues/567)) ([8505dcf](https://github.com/aeternity/aepp-sdk-js/commit/8505dcf))
+* **Contract:** add ability to use call-static/dry-run without keyPair ([#577](https://github.com/aeternity/aepp-sdk-js/issues/577)) ([c38edd9](https://github.com/aeternity/aepp-sdk-js/commit/c38edd9))
+* **NodePool:** Implement NodePool stamp ([#574](https://github.com/aeternity/aepp-sdk-js/issues/574)) ([674166c](https://github.com/aeternity/aepp-sdk-js/commit/674166c))
+* **State Channel:** make state channel compatible with aeternity@4.0.0 ([#568](https://github.com/aeternity/aepp-sdk-js/issues/568)) ([0d0e09b](https://github.com/aeternity/aepp-sdk-js/commit/0d0e09b))
+* **TxBuilder:** Add helper for producing tx hash ([#579](https://github.com/aeternity/aepp-sdk-js/issues/579)) ([e1b405e](https://github.com/aeternity/aepp-sdk-js/commit/e1b405e))
+* **AE** Make all AE stamps composed with Accounts ([#581](https://github.com/aeternity/aepp-sdk-js/pull/581))
+
+
+### Docs
+
+* **ACI** Add some additional clarification to `getContractInstance`
+
+
+
 # [4.2.0](https://github.com/aeternity/aepp-sdk-js/compare/2.4.0...4.2.0) (2019-07-15)
 
 

diff --git a/README.md b/README.md
@@ -107,22 +107,43 @@ import Ae from '@aeternity/aepp-sdk/es/ae/universal' // or other flavor
 
 ```js
 // Use Flavor
-Ae({
-  url: 'https://sdk-testnet.aepps.com',
-  // internalUrl: 'https://sdk-testnet.aepps.com',
-  compilerUrl: 'https://compiler.aepps.com',
-  keypair: { secretKey: 'A_PRIV_KEY', publicKey: 'A_PUB_ADDRESS' },
-  networkId: 'ae_uat' // or any other networkId your client should connect to
-}).then(ae => {
-  // Interacting with the blockchain client
-  // getting the latest block height
-  ae.height().then(height => {
-    // logs current height
-    console.log('Current Block Height:', height)
-  }).catch(e => {
-    // logs error
-    console.log(e)
-  })
+import Ae from '@aeternity/aepp-sdk/es/ae/universal' // or other flavor
+import MemoryAccount from '@aeternity/aepp-sdk/es/account/memory' // or other flavor
+import Node from '@aeternity/aepp-sdk/es/node' // or other flavor
+
+Promise.all([
+  Node({ url, internalUrl })
+]).then(nodes => {
+    Ae({
+        // This two params deprecated and will be remove in next major release
+        url: 'https://sdk-testnet.aepps.com',
+        internalUrl: 'https://sdk-testnet.aepps.com',
+        // instead use
+        nodes: [
+          { name: 'someNode', instance: nodes[0] },
+        // mode2
+        ],
+        compilerUrl: 'COMPILER_URL',
+        // `keypair` param deprecated and will be removed in next major release
+        keypair: { secretKey: 'A_PRIV_KEY', publicKey: 'A_PUB_ADDRESS' },
+        // instead use
+        accounts: [
+          MemoryAccount({ keypair: { secretKey: 'A_PRIV_KEY', publicKey: 'A_PUB_ADDRESS' } }),
+        // acc2
+        ],
+        address: 'SELECTED_ACCOUNT_PUB',
+        networkId: 'ae_uat' // or any other networkId your client should connect to
+    }).then(ae => {
+      // Interacting with the blockchain client
+      // getting the latest block height
+      ae.height().then(height => {
+        // logs current height
+        console.log('Current Block Height:', height)
+      }).catch(e => {
+        // logs error
+        console.log(e)
+      })
+    })
 })
 
 ```

diff --git a/docs/api.md b/docs/api.md
@@ -16,6 +16,7 @@
   * [@aeternity/aepp-sdk/es/contract/aci](api/contract/aci.md)
   * [@aeternity/aepp-sdk/es/contract/compiler](api/contract/compiler.md)
   * [@aeternity/aepp-sdk/es/contract](api/contract.md)
+  * [@aeternity/aepp-sdk/es/node-pool](api/node-pool.md)
   * [@aeternity/aepp-sdk/es/node](api/node.md)
   * [@aeternity/aepp-sdk/es/oracle](api/oracle.md)
   * [@aeternity/aepp-sdk/es/oracle/node](api/oracle/node.md)

diff --git a/docs/api/account/memory.md b/docs/api/account/memory.md
@@ -8,12 +8,6 @@ Memory Account module
 ```js
 import MemoryAccount from '@aeternity/aepp-sdk/es/account/memory'
 ```
-
-* [@aeternity/aepp-sdk/es/account/memory](#module_@aeternity/aepp-sdk/es/account/memory)
-    * [MemoryAccount([options])](#exp_module_@aeternity/aepp-sdk/es/account/memory--MemoryAccount) ⇒ `Account` ⏏
-    * _instance_
-        * [.setKeypair(keypair)](#exp_module_@aeternity/aepp-sdk/es/account/memory--setKeypair) ⇒ `Void` ⏏
-
 <a id="exp_module_@aeternity/aepp-sdk/es/account/memory--MemoryAccount"></a>
 
 ### MemoryAccount([options]) ⇒ `Account` ⏏
@@ -29,21 +23,3 @@ In-memory `Account` factory
 | options.keypair.publicKey | `String` |  | Public key |
 | options.keypair.secretKey | `String` |  | Private key |
 
-<a id="exp_module_@aeternity/aepp-sdk/es/account/memory--setKeypair"></a>
-
-### .setKeypair(keypair) ⇒ `Void` ⏏
-Select specific account
-
-**Kind**: instance method of [`@aeternity/aepp-sdk/es/account/memory`](#module_@aeternity/aepp-sdk/es/account/memory)  
-**rtype**: `(keypair: {publicKey: String, secretKey: String}) => Void`
-
-| Param | Type | Description |
-| --- | --- | --- |
-| keypair | `Object` | Key pair to use |
-| keypair.publicKey | `String` | Public key |
-| keypair.secretKey | `String` | Private key |
-
-**Example**  
-```js
-setKeypair(keypair)
-```
diff --git a/docs/api/accounts.md b/docs/api/accounts.md
@@ -8,6 +8,63 @@ Accounts module
 ```js
 import Accounts from '@aeternity/aepp-sdk/es/accounts'
 ```
+
+* [@aeternity/aepp-sdk/es/accounts](#module_@aeternity/aepp-sdk/es/accounts)
+    * ~~[setKeypair(keypair)](#exp_module_@aeternity/aepp-sdk/es/accounts--setKeypair) ⇒ `Void` ⏏~~
+    * [removeAccount(address)](#exp_module_@aeternity/aepp-sdk/es/accounts--removeAccount) ⇒ `Void` ⏏
+    * [addresses()](#exp_module_@aeternity/aepp-sdk/es/accounts--addresses) ⇒ `Array.&lt;String&gt;` ⏏
+    * [Accounts([options])](#exp_module_@aeternity/aepp-sdk/es/accounts--Accounts) ⇒ `Object` ⏏
+    * _async_
+        * [signWith(address, data)](#exp_module_@aeternity/aepp-sdk/es/accounts--signWith) ⇒ `String` ⏏
+        * [addAccount(account, [options])](#exp_module_@aeternity/aepp-sdk/es/accounts--addAccount) ⇒ `Void` ⏏
+
+<a id="exp_module_@aeternity/aepp-sdk/es/accounts--setKeypair"></a>
+
+### ~~setKeypair(keypair) ⇒ `Void` ⏏~~
+***Deprecated***
+
+Select specific account
+
+**Kind**: Exported function  
+**rtype**: `(keypair: {publicKey: String, secretKey: String}) => Void`
+
+| Param | Type | Description |
+| --- | --- | --- |
+| keypair | `Object` | Key pair to use |
+| keypair.publicKey | `String` | Public key |
+| keypair.secretKey | `String` | Private key |
+
+**Example**  
+```js
+setKeypair(keypair)
+```
+<a id="exp_module_@aeternity/aepp-sdk/es/accounts--removeAccount"></a>
+
+### removeAccount(address) ⇒ `Void` ⏏
+Remove specific account
+
+**Kind**: Exported function  
+**rtype**: `(address: String) => Void`
+
+| Param | Type | Description |
+| --- | --- | --- |
+| address | `String` | Address of account to remove |
+
+**Example**  
+```js
+removeAccount(address)
+```
+<a id="exp_module_@aeternity/aepp-sdk/es/accounts--addresses"></a>
+
+### addresses() ⇒ `Array.&lt;String&gt;` ⏏
+Get accounts addresses
+
+**Kind**: Exported function  
+**rtype**: `() => String[]`
+**Example**  
+```js
+addresses()
+```
 <a id="exp_module_@aeternity/aepp-sdk/es/accounts--Accounts"></a>
 
 ### Accounts([options]) ⇒ `Object` ⏏
@@ -25,8 +82,47 @@ common interface to all of them. Accounts are a substantial part of
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | [options] | `Object` | <code>{}</code> | Initializer object |
+| [options.accounts] | `Array` |  | Accounts array |
+
+**Example**  
+```js
+const accounts = await Accounts({ accounts: [ MemmoryAccount({ keypair: 'keypair_object' }) ] })
+await accounts.addAccount(account, { select: true }) // Add account and make it selected
+accounts.removeAccount(address) // Remove account
+accounts.selectAccount(address) // Select account
+accounts.addresses() // Get available accounts
+```
+<a id="exp_module_@aeternity/aepp-sdk/es/accounts--signWith"></a>
+
+### signWith(address, data) ⇒ `String` ⏏
+Sign data blob with specific key
+
+**Kind**: Exported function  
+**Returns**: `String` - Signed data blob  
+**Category**: async  
+**rtype**: `(address: String, data: String) => data: Promise[String], throws: Error`
+
+| Param | Type | Description |
+| --- | --- | --- |
+| address | `String` | Public key of account to sign with |
+| data | `String` | Data blob to sign |
+
+<a id="exp_module_@aeternity/aepp-sdk/es/accounts--addAccount"></a>
+
+### addAccount(account, [options]) ⇒ `Void` ⏏
+Add specific account
+
+**Kind**: Exported function  
+**Category**: async  
+**rtype**: `(account: Account, { select: Boolean }) => Void`
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| account | `Object` |  | Account instance |
+| [options] | `Object` | <code>{}</code> | Options |
+| [options.select] | `Boolean` |  | Select account |
 
 **Example**  
 ```js
-Accounts()
+addAccount(account)
 ```
diff --git a/docs/api/ae/aens.md b/docs/api/ae/aens.md
@@ -18,7 +18,7 @@ import Aens from '@aeternity/aepp-sdk/es/ae/aens'
     * _instance_
         * [.update(nameId, target, options)](#exp_module_@aeternity/aepp-sdk/es/ae/aens--update) ⇒ `Object` ⏏
         * [.query(name)](#exp_module_@aeternity/aepp-sdk/es/ae/aens--query) ⇒ `Promise.&lt;Object&gt;` ⏏
-        * [.claim(name, salt, waitForHeight, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/aens--claim) ⇒ `Promise.&lt;Object&gt;` ⏏
+        * [.claim(name, salt, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/aens--claim) ⇒ `Promise.&lt;Object&gt;` ⏏
         * [.preclaim(name, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/aens--preclaim) ⇒ `Promise.&lt;Object&gt;` ⏏
         * _async_
             * [.transfer(nameId, account, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/aens--transfer) ⇒ `Promise.&lt;Object&gt;` ⏏
@@ -66,7 +66,7 @@ Query the status of an AENS registration
 
 <a id="exp_module_@aeternity/aepp-sdk/es/ae/aens--claim"></a>
 
-### .claim(name, salt, waitForHeight, [options]) ⇒ `Promise.&lt;Object&gt;` ⏏
+### .claim(name, salt, [options]) ⇒ `Promise.&lt;Object&gt;` ⏏
 Claim a previously preclaimed registration. This can only be done after the
 preclaim step
 
@@ -77,7 +77,6 @@ preclaim step
 | --- | --- | --- |
 | name | `String` |  | 
 | salt | `String` |  | 
-| waitForHeight | `Number` |  | 
 | [options] | `Record` | <code>{}</code> | 
 
 <a id="exp_module_@aeternity/aepp-sdk/es/ae/aens--preclaim"></a>

diff --git a/docs/api/contract/aci.md b/docs/api/contract/aci.md
@@ -60,7 +60,7 @@ Call contract function
 <a id="exp_module_@aeternity/aepp-sdk/es/contract/aci--getContractInstance"></a>
 
 ### getContractInstance(source, [options]) ⇒ `ContractInstance` ⏏
-Generate contract ACI object with predefined js methods for contract usage
+Generate contract ACI object with predefined js methods for contract usage - can be used for creating a reference to already deployed contracts
 
 **Kind**: Exported function  
 **Returns**: `ContractInstance` - JS Contract API