Skip to content

Commit 68ed64d

Browse files
nduchaknduchak
authored
Merge pull request #919 from aeternity/release/7.1.0
Release 7.1.0
2 parents b70c79f + 992a3e8 commit 68ed64d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+46363
-2965
lines changed

‎CHANGELOG.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
# [7.1.0](https://github.com/aeternity/aepp-sdk-js/compare/6.0.1...7.1.0) (2020-02-25)
2+
3+
### Refactor
4+
5+
* **AEX:** Simplify message id processing ([#916](https://github.com/aeternity/aepp-sdk-js/pull/916)). Pass AEEP `origin` to Wallet callback ([#918](https://github.com/aeternity/aepp-sdk-js/pull/918))
6+
* **Node:** Move `getNetworkId` to helpers ([#910](https://github.com/aeternity/aepp-sdk-js/pull/910))
7+
* **ACI:** Minor ACI validation improvement.
8+
Move decoding of events to builder. Add ability to decode events without ACI
9+
10+
### Features
11+
12+
* **ACI:** Implement Contract Events for ACI([Contract Event Guide](https://github.com/aeternity/aepp-sdk-js/blob/develop/docs/guides/contract-events.md))
13+
* **Contract:** Helpers for Oracle and AENS signature delegation([Signature delegation guide](https://github.com/aeternity/aepp-sdk-js/blob/develop/docs/guides/delegate-signature-to-contract.md))
14+
* **AmountFormatter:** Rework amount formatter. Change formatter units naming. Add more units ([#909](https://github.com/aeternity/aepp-sdk-js/issues/909)) ([6970efe](https://github.com/aeternity/aepp-sdk-js/commit/6970efe))
15+
* **TxBuilder:** Integrate amount formatter to transaction builder ([#897](https://github.com/aeternity/aepp-sdk-js/pull/897))
16+
* **Account:** Implement Message Signing (`singMessage`, `verifyMessage`) ([#903](https://github.com/aeternity/aepp-sdk-js/pull/903))
17+
* **AEX-2:** Add `removeRpcClient` method to RpcClient/RpcWallet stamp's([#912](https://github.com/aeternity/aepp-sdk-js/pull/912))
18+
19+
120
# [7.0.0](https://github.com/aeternity/aepp-sdk-js/compare/6.0.1...7.0.0) (2020-01-31)
221

322

‎docs/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,9 @@ You can use this URL with any releasee on [npmjs](https://www.npmjs.com/package/
4747

4848
### Contract Usage
4949
- [Contract ACI](guides/contract-aci-usage.md)
50+
- [Contract Events](guides/contract-events.md)
51+
- [AENS delegation signature](guides/delegate-signature-to-contract.md)
5052
- [AENS usage](guides/aens-usage.md)
51-
- [AENS usage](guides/racle-usage.md)
5253

5354

5455
## Examples

‎docs/api.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,12 @@
2222
* [@aeternity/aepp-sdk/es/oracle](api/oracle.md)
2323
* [@aeternity/aepp-sdk/es/oracle/node](api/oracle/node.md)
2424
* [@aeternity/aepp-sdk/es/rpc/client](api/rpc/client.md)
25+
* [@aeternity/aepp-sdk/es/tx/builder/helpers](api/tx/builder/helpers.md)
2526
* [@aeternity/aepp-sdk/es/tx/builder](api/tx/builder.md)
2627
* [@aeternity/aepp-sdk/es/tx/builder/schema](api/tx/builder/schema.md)
2728
* [@aeternity/aepp-sdk/es/tx](api/tx.md)
2829
* [@aeternity/aepp-sdk/es/tx/tx](api/tx/tx.md)
30+
* [@aeternity/aepp-sdk/es/tx/validator](api/tx/validator.md)
2931
* [@aeternity/aepp-sdk/es/utils/aepp-wallet-communication/connection/browser-runtime](api/utils/aepp-wallet-communication/connection/browser-runtime.md)
3032
* [@aeternity/aepp-sdk/es/utils/aepp-wallet-communication/connection/browser-window-message](api/utils/aepp-wallet-communication/connection/browser-window-message.md)
3133
* [@aeternity/aepp-sdk/es/utils/aepp-wallet-communication/connection](api/utils/aepp-wallet-communication/connection.md)
@@ -34,6 +36,9 @@
3436
* [@aeternity/aepp-sdk/es/utils/aepp-wallet-communication/rpc/rpc-client](api/utils/aepp-wallet-communication/rpc/rpc-client.md)
3537
* [@aeternity/aepp-sdk/es/utils/aepp-wallet-communication/rpc/wallet-rpc](api/utils/aepp-wallet-communication/rpc/wallet-rpc.md)
3638
* [@aeternity/aepp-sdk/es/utils/aepp-wallet-communication/wallet-detector](api/utils/aepp-wallet-communication/wallet-detector.md)
39+
* [@aeternity/aepp-sdk/es/utils/amount-formatter](api/utils/amount-formatter.md)
40+
* [@aeternity/aepp-sdk/es/utils/bignumber](api/utils/bignumber.md)
41+
* [@aeternity/aepp-sdk/es/utils/bytes](api/utils/bytes.md)
3742
* [@aeternity/aepp-sdk/es/utils/crypto](api/utils/crypto.md)
3843
* [@aeternity/aepp-sdk/es/utils/keystore](api/utils/keystore.md)
3944
* [@aeternity/aepp-sdk/es/utils/swagger](api/utils/swagger.md)

‎docs/api/account.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ import Account from '@aeternity/aepp-sdk/es/account'
1010

1111
* [@aeternity/aepp-sdk/es/account](#module_@aeternity/aepp-sdk/es/account)
1212
* [Account([options])](#exp_module_@aeternity/aepp-sdk/es/account--Account) ⇒ `Object` ⏏
13+
* [.signTransaction(tx, opt)](#module_@aeternity/aepp-sdk/es/account--Account+signTransaction) ⇒ `String`
14+
* [.signMessage(message, opt)](#module_@aeternity/aepp-sdk/es/account--Account+signMessage) ⇒ `String`
15+
* [.verifyMessage(message, signature, opt)](#module_@aeternity/aepp-sdk/es/account--Account+verifyMessage) ⇒ `Boolean`
1316
* [.getNetworkId()](#module_@aeternity/aepp-sdk/es/account--Account+getNetworkId) ⇒ `String`
1417
* *[.sign(data)](#module_@aeternity/aepp-sdk/es/account--Account+sign) ⇒ `String`*
1518
* *[.address()](#module_@aeternity/aepp-sdk/es/account--Account+address) ⇒ `String`*
@@ -35,6 +38,21 @@ signing key pair.
3538
| [options] | `Object` | <code>{}</code> | Initializer object |
3639
| options.networkId | `String` | | NETWORK_ID using for signing transaction's |
3740

41+
<a id="module_@aeternity/aepp-sdk/es/account--Account+signTransaction"></a>
42+
43+
#### account.signTransaction(tx, opt) ⇒ `String`
44+
Sign encoded transaction
45+
46+
**Kind**: instance method of [`Account`](#exp_module_@aeternity/aepp-sdk/es/account--Account)
47+
**Returns**: `String` - Signed transaction
48+
**Category**: async
49+
**rtype**: `(tx: String) => tx: Promise[String], throws: Error`
50+
51+
| Param | Type | Description |
52+
| --- | --- | --- |
53+
| tx | `String` | Transaction to sign |
54+
| opt | `Object` | Options |
55+
3856
<a id="module_@aeternity/aepp-sdk/es/account--Account+getNetworkId"></a>
3957

4058
#### account.getNetworkId() ⇒ `String`

‎docs/api/accounts.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import Accounts from '@aeternity/aepp-sdk/es/accounts'
1313
* [addresses()](#exp_module_@aeternity/aepp-sdk/es/accounts--addresses) ⇒ `Array.&lt;String&gt;` ⏏
1414
* [Accounts([options])](#exp_module_@aeternity/aepp-sdk/es/accounts--Accounts) ⇒ `Object` ⏏
1515
* _async_
16+
* [signWith(address, data)](#exp_module_@aeternity/aepp-sdk/es/accounts--signWith) ⇒ `String` ⏏
1617
* [addAccount(account, [options])](#exp_module_@aeternity/aepp-sdk/es/accounts--addAccount) ⇒ `Void` ⏏
1718

1819
<a id="exp_module_@aeternity/aepp-sdk/es/accounts--removeAccount"></a>
@@ -69,6 +70,21 @@ accounts.removeAccount(address) // Remove account
6970
accounts.selectAccount(address) // Select account
7071
accounts.addresses() // Get available accounts
7172
```
73+
<a id="exp_module_@aeternity/aepp-sdk/es/accounts--signWith"></a>
74+
75+
### signWith(address, data) ⇒ `String` ⏏
76+
Sign data blob with specific key
77+
78+
**Kind**: Exported function
79+
**Returns**: `String` - Signed data blob
80+
**Category**: async
81+
**rtype**: `(address: String, data: String) => data: Promise[String], throws: Error`
82+
83+
| Param | Type | Description |
84+
| --- | --- | --- |
85+
| address | `String` | Public key of account to sign with |
86+
| data | `String` | Data blob to sign |
87+
7288
<a id="exp_module_@aeternity/aepp-sdk/es/accounts--addAccount"></a>
7389

7490
### addAccount(account, [options]) ⇒ `Void` ⏏

‎docs/api/ae.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import Ae from '@aeternity/aepp-sdk/es/ae'
1313
* _instance_
1414
* [.destroyInstance()](#module_@aeternity/aepp-sdk/es/ae--Ae+destroyInstance) ⇒ `void`
1515
* _async_
16+
* [.send(tx, [options])](#module_@aeternity/aepp-sdk/es/ae--Ae+send) ⇒ `String` \| `String`
1617
* [.spend(amount, recipientId, options)](#module_@aeternity/aepp-sdk/es/ae--Ae+spend) ⇒ `String` \| `String`
1718
* [.transferFunds(percentage, recipientId, options)](#module_@aeternity/aepp-sdk/es/ae--Ae+transferFunds) ⇒ `String` \| `String`
1819
* _inner_
@@ -27,9 +28,9 @@ Attempting to create instances from the Stamp without overwriting all
2728
abstract methods using composition will result in an exception.
2829

2930
Ae objects are the composition of three basic building blocks:
30-
* [module:@aeternity/aepp-sdk/es/tx--Tx](module:@aeternity/aepp-sdk/es/tx--Tx)
31+
* [Tx](#exp_module_@aeternity/aepp-sdk/es/tx--Tx)
3132
* [Account](#exp_module_@aeternity/aepp-sdk/es/account--Account)
32-
* [module:@aeternity/aepp-sdk/es/chain--Chain](module:@aeternity/aepp-sdk/es/chain--Chain)
33+
* [Chain](#exp_module_@aeternity/aepp-sdk/es/chain--Chain)
3334
Only by providing the joint functionality of those three, most more advanced
3435
operations, i.e. the ones with actual use value on the chain, become
3536
available.
@@ -48,6 +49,22 @@ available.
4849
Remove all listeners for RPC
4950

5051
**Kind**: instance method of [`Ae`](#exp_module_@aeternity/aepp-sdk/es/ae--Ae)
52+
<a id="module_@aeternity/aepp-sdk/es/ae--Ae+send"></a>
53+
54+
#### ae.send(tx, [options]) ⇒ `String` \| `String`
55+
Sign and post a transaction to the chain
56+
57+
**Kind**: instance method of [`Ae`](#exp_module_@aeternity/aepp-sdk/es/ae--Ae)
58+
**Returns**: `String` \| `String` - Transaction or transaction hash
59+
**Category**: async
60+
**rtype**: `(tx: String, options: Object) => Promise[String]`
61+
62+
| Param | Type | Default | Description |
63+
| --- | --- | --- | --- |
64+
| tx | `String` | | Transaction |
65+
| [options] | `Object` | <code>{}</code> | options - Options |
66+
| [options.verify] | `Object` | | verify - Verify transaction before broadcast, throw error if not valid |
67+
5168
<a id="module_@aeternity/aepp-sdk/es/ae--Ae+spend"></a>
5269

5370
#### ae.spend(amount, recipientId, options) ⇒ `String` \| `String`

‎docs/api/ae/aens.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import Aens from '@aeternity/aepp-sdk/es/ae/aens'
1616
* [Aens([options])](#exp_module_@aeternity/aepp-sdk/es/ae/aens--Aens) ⇒ `Object` ⏏
1717
* _instance_
1818
* _async_
19+
* [.revoke(name, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/aens--revoke) ⇒ `Promise.&lt;Object&gt;` ⏏
1920
* [.update(name, pointers, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/aens--update) ⇒ `Promise.&lt;Object&gt;` ⏏
2021
* [.transfer(name, account, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/aens--transfer) ⇒ `Promise.&lt;Object&gt;` ⏏
2122
* [.query(name, opt)](#exp_module_@aeternity/aepp-sdk/es/ae/aens--query) ⇒ `Promise.&lt;Object&gt;` ⏏
@@ -39,6 +40,33 @@ Aens provides name-system related methods atop
3940
| --- | --- | --- | --- |
4041
| [options] | `Object` | <code>{}</code> | Initializer object |
4142

43+
<a id="exp_module_@aeternity/aepp-sdk/es/ae/aens--revoke"></a>
44+
45+
### .revoke(name, [options]) ⇒ `Promise.&lt;Object&gt;` ⏏
46+
Revoke a name
47+
48+
**Kind**: instance method of [`@aeternity/aepp-sdk/es/ae/aens`](#module_@aeternity/aepp-sdk/es/ae/aens)
49+
**Returns**: `Promise.&lt;Object&gt;` - Transaction result
50+
**Category**: async
51+
52+
| Param | Type | Default | Description |
53+
| --- | --- | --- | --- |
54+
| name | `String` | | Name hash |
55+
| [options] | `Object` | <code>{}</code> | options |
56+
| [options.onAccount] | `String` \| `Object` | | onAccount Make operation on specific account from sdk(you pass publickKey) or using provided KeyPair(Can be keypair object or MemoryAccount) |
57+
| [options.fee] | `Number` \| `String` \| `BigNumber` | | fee |
58+
| [options.ttl] | `Number` \| `String` \| `BigNumber` | | ttl |
59+
| [options.nonce] | `Number` \| `String` \| `BigNumber` | | nonce |
60+
61+
**Example**
62+
```js
63+
const name = 'test.chain'
64+
const nameObject = await sdkInstance.aensQuery(name)
65+
66+
await sdkInstance.aensRevoke(name, { fee, ttl , nonce })
67+
// or
68+
await nameObject.revoke({ fee, ttl, nonce })
69+
```
4270
<a id="exp_module_@aeternity/aepp-sdk/es/ae/aens--update"></a>
4371

4472
### .update(name, pointers, [options]) ⇒ `Promise.&lt;Object&gt;` ⏏

‎docs/api/ae/contract.md

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,14 @@ import { Contract } from '@aeternity/aepp-sdk' (Using bundle)
2525
* [contractCall(source, address, name, argsOrCallData, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/contract--contractCall) ⏏
2626
* [contractDeploy(code, source, initState, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/contract--contractDeploy) ⇒ `Promise.&lt;Object&gt;` ⏏
2727
* [contractCompile(source, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/contract--contractCompile) ⇒ `Promise.&lt;Object&gt;` ⏏
28+
* [delegateSignatureCommon(ids, [opt], [opt])](#exp_module_@aeternity/aepp-sdk/es/ae/contract--delegateSignatureCommon) ⇒ `Promise.&lt;String&gt;` ⏏
29+
* [delegateNamePreclaimSignature(contractId, [opt])](#exp_module_@aeternity/aepp-sdk/es/ae/contract--delegateNamePreclaimSignature) ⇒ `Promise.&lt;String&gt;` ⏏
30+
* [delegateNameClaimSignature(name, contractId, [opt])](#exp_module_@aeternity/aepp-sdk/es/ae/contract--delegateNameClaimSignature) ⇒ `Promise.&lt;String&gt;` ⏏
31+
* [delegateNameTransferSignature(contractId, name, [opt])](#exp_module_@aeternity/aepp-sdk/es/ae/contract--delegateNameTransferSignature) ⇒ `Promise.&lt;String&gt;` ⏏
32+
* [delegateNameRevokeSignature(contractId, name, [opt])](#exp_module_@aeternity/aepp-sdk/es/ae/contract--delegateNameRevokeSignature) ⇒ `Promise.&lt;String&gt;` ⏏
33+
* [delegateOracleRegisterSignature(contractId, [opt])](#exp_module_@aeternity/aepp-sdk/es/ae/contract--delegateOracleRegisterSignature) ⇒ `Promise.&lt;String&gt;` ⏏
34+
* [delegateOracleExtendSignature(contractId, [opt])](#exp_module_@aeternity/aepp-sdk/es/ae/contract--delegateOracleExtendSignature) ⇒ `Promise.&lt;String&gt;` ⏏
35+
* [delegateOracleRespondSignature(queryId, contractId, [opt])](#exp_module_@aeternity/aepp-sdk/es/ae/contract--delegateOracleRespondSignature) ⇒ `Promise.&lt;String&gt;` ⏏
2836

2937
<a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--exports.ContractAPI"></a>
3038

@@ -226,3 +234,120 @@ const compiled = await client.contractCompile(SOURCE_CODE)
226234
encodeCall: (fnName, args = []) => Prepare callData
227235
}
228236
```
237+
<a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--delegateSignatureCommon"></a>
238+
239+
### delegateSignatureCommon(ids, [opt], [opt]) ⇒ `Promise.&lt;String&gt;` ⏏
240+
Utility method to create a delegate signature for a contract
241+
242+
**Kind**: Exported function
243+
**Returns**: `Promise.&lt;String&gt;` - Signature in hex representation
244+
**Category**: async
245+
246+
| Param | Type | Default | Description |
247+
| --- | --- | --- | --- |
248+
| ids | `Array.&lt;String&gt;` | | The list of id's to prepend |
249+
| [opt] | `Object` | <code>{}</code> | options |
250+
| [opt] | `Object` | <code>{}</code> | opt Options |
251+
252+
<a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--delegateNamePreclaimSignature"></a>
253+
254+
### delegateNamePreclaimSignature(contractId, [opt]) ⇒ `Promise.&lt;String&gt;` ⏏
255+
Helper to generate a signature to delegate a name pre-claim to a contract.
256+
257+
**Kind**: Exported function
258+
**Returns**: `Promise.&lt;String&gt;` - Signature for delegation
259+
**Category**: async
260+
261+
| Param | Type | Default | Description |
262+
| --- | --- | --- | --- |
263+
| contractId | `String` | | Contract Id |
264+
| [opt] | `Object` | <code>{}</code> | opt Options |
265+
266+
<a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--delegateNameClaimSignature"></a>
267+
268+
### delegateNameClaimSignature(name, contractId, [opt]) ⇒ `Promise.&lt;String&gt;` ⏏
269+
Helper to generate a signature to delegate a name claim to a contract.
270+
271+
**Kind**: Exported function
272+
**Returns**: `Promise.&lt;String&gt;` - Signature for delegation
273+
**Category**: async
274+
275+
| Param | Type | Default | Description |
276+
| --- | --- | --- | --- |
277+
| name | `String` | | The name being claimed |
278+
| contractId | `String` | | Contract Id |
279+
| [opt] | `Object` | <code>{}</code> | opt Options |
280+
281+
<a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--delegateNameTransferSignature"></a>
282+
283+
### delegateNameTransferSignature(contractId, name, [opt]) ⇒ `Promise.&lt;String&gt;` ⏏
284+
Helper to generate a signature to delegate a name transfer to a contract.
285+
286+
**Kind**: Exported function
287+
**Returns**: `Promise.&lt;String&gt;` - Signature for delegation
288+
**Category**: async
289+
290+
| Param | Type | Default | Description |
291+
| --- | --- | --- | --- |
292+
| contractId | `String` | | Contract Id |
293+
| name | `String` | | The name being transferred |
294+
| [opt] | `Object` | <code>{}</code> | opt Options |
295+
296+
<a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--delegateNameRevokeSignature"></a>
297+
298+
### delegateNameRevokeSignature(contractId, name, [opt]) ⇒ `Promise.&lt;String&gt;` ⏏
299+
Helper to generate a signature to delegate a name revoke to a contract.
300+
301+
**Kind**: Exported function
302+
**Returns**: `Promise.&lt;String&gt;` - Signature for delegation
303+
**Category**: async
304+
305+
| Param | Type | Default | Description |
306+
| --- | --- | --- | --- |
307+
| contractId | `String` | | Contract Id |
308+
| name | `String` | | The name being revoked |
309+
| [opt] | `Object` | <code>{}</code> | opt Options |
310+
311+
<a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--delegateOracleRegisterSignature"></a>
312+
313+
### delegateOracleRegisterSignature(contractId, [opt]) ⇒ `Promise.&lt;String&gt;` ⏏
314+
Helper to generate a signature to delegate a Oracle register to a contract.
315+
316+
**Kind**: Exported function
317+
**Returns**: `Promise.&lt;String&gt;` - Signature for delegation
318+
**Category**: async
319+
320+
| Param | Type | Default | Description |
321+
| --- | --- | --- | --- |
322+
| contractId | `String` | | Contract Id |
323+
| [opt] | `Object` | <code>{}</code> | opt Options |
324+
325+
<a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--delegateOracleExtendSignature"></a>
326+
327+
### delegateOracleExtendSignature(contractId, [opt]) ⇒ `Promise.&lt;String&gt;` ⏏
328+
Helper to generate a signature to delegate a Oracle extend to a contract.
329+
330+
**Kind**: Exported function
331+
**Returns**: `Promise.&lt;String&gt;` - Signature for delegation
332+
**Category**: async
333+
334+
| Param | Type | Default | Description |
335+
| --- | --- | --- | --- |
336+
| contractId | `String` | | Contract Id |
337+
| [opt] | `Object` | <code>{}</code> | opt Options |
338+
339+
<a id="exp_module_@aeternity/aepp-sdk/es/ae/contract--delegateOracleRespondSignature"></a>
340+
341+
### delegateOracleRespondSignature(queryId, contractId, [opt]) ⇒ `Promise.&lt;String&gt;` ⏏
342+
Helper to generate a signature to delegate a Oracle respond to a contract.
343+
344+
**Kind**: Exported function
345+
**Returns**: `Promise.&lt;String&gt;` - Signature for delegation
346+
**Category**: async
347+
348+
| Param | Type | Default | Description |
349+
| --- | --- | --- | --- |
350+
| queryId | `String` | | Oracle Query Id |
351+
| contractId | `String` | | Contract Id |
352+
| [opt] | `Object` | <code>{}</code> | opt Options |
353+

‎docs/api/ae/oracle.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import Oracle from '@aeternity/aepp-sdk/es/ae/oracle'
1616
* [Oracle([options])](#exp_module_@aeternity/aepp-sdk/es/ae/oracle--Oracle) ⇒ `Object` ⏏
1717
* _instance_
1818
* _async_
19+
* [.getOracleObject(oracleId)](#exp_module_@aeternity/aepp-sdk/es/ae/oracle--getOracleObject) ⇒ `Promise.&lt;Object&gt;` ⏏
1920
* [.pollForQueries(oracleId, onQuery, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/oracle--pollForQueries) ⇒ `function` ⏏
2021
* [.getQueryObject(oracleId, queryId)](#exp_module_@aeternity/aepp-sdk/es/ae/oracle--getQueryObject) ⇒ `Promise.&lt;Object&gt;` ⏏
2122
* [.exports.pollForQueryResponse(oracleId, queryId, [options])](#exp_module_@aeternity/aepp-sdk/es/ae/oracle--exports.pollForQueryResponse) ⇒ `Promise.&lt;Object&gt;` ⏏
@@ -40,6 +41,19 @@ Oracle provides oracle-system related methods atop
4041
| --- | --- | --- | --- |
4142
| [options] | `Object` | <code>{}</code> | Initializer object |
4243

44+
<a id="exp_module_@aeternity/aepp-sdk/es/ae/oracle--getOracleObject"></a>
45+
46+
### .getOracleObject(oracleId) ⇒ `Promise.&lt;Object&gt;` ⏏
47+
Constructor for Oracle Object (helper object for using Oracle)
48+
49+
**Kind**: instance method of [`@aeternity/aepp-sdk/es/ae/oracle`](#module_@aeternity/aepp-sdk/es/ae/oracle)
50+
**Returns**: `Promise.&lt;Object&gt;` - Oracle object
51+
**Category**: async
52+
53+
| Param | Type | Description |
54+
| --- | --- | --- |
55+
| oracleId | `String` | Oracle public key |
56+
4357
<a id="exp_module_@aeternity/aepp-sdk/es/ae/oracle--pollForQueries"></a>
4458

4559
### .pollForQueries(oracleId, onQuery, [options]) ⇒ `function` ⏏

0 commit comments

Comments
 (0)