@aeternity/aepp-sdk 10.0.0 → 12.0.0

package/src/ae/index.js

@@ -1,167 +0,0 @@
-/*
- * ISC License (ISC)
- * Copyright (c) 2018 aeternity developers
- *
- *  Permission to use, copy, modify, and/or distribute this software for any
- *  purpose with or without fee is hereby granted, provided that the above
- *  copyright notice and this permission notice appear in all copies.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
- *  REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
- *  AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
- *  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- *  LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
- *  OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- *  PERFORMANCE OF THIS SOFTWARE.
- */
-
-/**
- * Ae module
- * @module @aeternity/aepp-sdk/es/ae
- * @export Ae
- * @example import { Ae } from '@aeternity/aepp-sdk'
- */
-
-import stampit from '@stamp/it'
-import Tx from '../tx'
-import Chain from '../chain'
-import AccountBase from '../account/base'
-import TxBuilder from '../tx/builder'
-import BigNumber from 'bignumber.js'
-import { AE_AMOUNT_FORMATS } from '../utils/amount-formatter'
-
-/**
- * Sign and post a transaction to the chain
- * @instance
- * @category async
- * @rtype (tx: String, options: Object) => Promise[String]
- * @param {String} tx - Transaction
- * @param {Object} [options={}] options - Options
- * @param {Object} [options.verify=true] - Verify transaction before broadcast, throw error if not
- * valid
- * @return {Object} Transaction
- */
-async function send (tx, options = {}) {
-  const opt = { ...this.Ae.defaults, ...options }
-  const { contractId, authFun } = options.innerTx
-    ? { contractId: false }
-    : await this.getAccount(await this.address(opt))
-  const signed = contractId
-    ? await this.signUsingGA(tx, { ...opt, authFun })
-    : await this.signTransaction(tx, opt)
-  return opt.innerTx
-    ? { hash: TxBuilder.buildTxHash(signed), rawTx: signed }
-    : this.sendTransaction(signed, opt)
-}
-
-async function signUsingGA (tx, { authData, authFun, ...options } = {}) {
-  return this.createMetaTx(tx, authData, authFun, options)
-}
-
-/**
- * Send tokens to another account
- * @instance
- * @category async
- * @rtype (amount: Number|String, recipientIdOrName: String, options?: Object) => Promise[String]
- * @param {Number|String} amount - Amount to spend
- * @param {String} recipientIdOrName - Address or name of recipient account
- * @param {Object} [options] - Options
- * @return {Object} Transaction
- */
-async function spend (amount, recipientIdOrName, options) {
-  const opt = { ...this.Ae.defaults, ...options }
-  return this.send(
-    await this.spendTx({
-      ...opt,
-      senderId: await this.address(opt),
-      recipientId: await this.resolveName(recipientIdOrName, 'account_pubkey', opt),
-      amount
-    }),
-    opt
-  )
-}
-
-// TODO: Rename to spendFraction
-/**
- * Send a fraction of token balance to another account
- * @instance
- * @category async
- * @rtype (fraction: Number|String, recipientIdOrName: String, options?: Object) => Promise[String]
- * @param {Number|String} fraction - Fraction of balance to spend (between 0 and 1)
- * @param {String} recipientIdOrName - Address or name of recipient account
- * @param {Object} [options] - Options
- * @return {Object} Transaction
- */
-async function transferFunds (fraction, recipientIdOrName, options) {
-  if (fraction < 0 || fraction > 1) {
-    throw new Error(`Fraction should be a number between 0 and 1, got ${fraction}`)
-  }
-  const opt = { ...this.Ae.defaults, ...options }
-  const recipientId = await this.resolveName(recipientIdOrName, 'account_pubkey', opt)
-  const senderId = await this.address(opt)
-  const balance = new BigNumber(await this.balance(senderId))
-  const desiredAmount = balance.times(fraction).integerValue(BigNumber.ROUND_HALF_UP)
-  const { tx: { fee } } = TxBuilder.unpackTx(
-    await this.spendTx({ ...opt, senderId, recipientId, amount: desiredAmount })
-  )
-  // Reducing of the amount may reduce transaction fee, so this is not completely accurate
-  const amount = desiredAmount.plus(fee).gt(balance) ? balance.minus(fee) : desiredAmount
-  return this.send(await this.spendTx({ ...opt, senderId, recipientId, amount }), opt)
-}
-
-/**
- * Submit transaction of another account paying for it (fee and gas)
- * @instance
- * @category async
- * @rtype (transaction: String, options?: Object) => Promise[String]
- * @param {String} transaction - tx_<base64>-encoded transaction
- * @param {Object} [options]
- * @return {Object} Transaction
- */
-async function payForTransaction (transaction, options) {
-  const opt = { ...this.Ae.defaults, ...options }
-  return this.send(
-    await this.payingForTx({
-      ...opt,
-      payerId: await this.address(opt),
-      tx: transaction
-    }),
-    opt
-  )
-}
-
-/**
- * Remove all listeners for RPC
- * @instance
- * @return {void}
- */
-function destroyInstance () {
-  const destroyMethods = ['destroyClient', 'destroyServer'] // Array with destroy function's
-  destroyMethods.forEach(m => this[m] && typeof this[m] === 'function' && this[m]())
-}
-
-/**
- * Basic Ae Stamp
- *
- * Attempting to create instances from the Stamp without overwriting all
- * abstract methods using composition will result in an exception.
- *
- * Ae objects are the composition of three basic building blocks:
- * * {@link module:@aeternity/aepp-sdk/es/tx--Tx}
- * * {@link module:@aeternity/aepp-sdk/es/account--Account}
- * * {@link module:@aeternity/aepp-sdk/es/chain--Chain}
- * Only by providing the joint functionality of those three, most more advanced
- * operations, i.e. the ones with actual use value on the chain, become
- * available.
- * @function
- * @alias module:@aeternity/aepp-sdk/es/ae
- * @rtype Stamp
- * @param {Object} [options={}] - Initializer object
- * @return {Object} Ae instance
- */
-const Ae = stampit(Tx, AccountBase, Chain, {
-  methods: { send, spend, transferFunds, payForTransaction, destroyInstance, signUsingGA },
-  deepProps: { Ae: { defaults: { denomination: AE_AMOUNT_FORMATS.AETTOS } } }
-})
-
-export default Ae

package/src/ae/oracle.js

@@ -1,296 +0,0 @@
-/*
- * ISC License (ISC)
- * Copyright (c) 2018 aeternity developers
- *
- *  Permission to use, copy, modify, and/or distribute this software for any
- *  purpose with or without fee is hereby granted, provided that the above
- *  copyright notice and this permission notice appear in all copies.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
- *  REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
- *  AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
- *  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- *  LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
- *  OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- *  PERFORMANCE OF THIS SOFTWARE.
- */
-
-/**
- * Oracle module - routines to interact with the æternity oracle system
- *
- * The high-level description of the oracle system is
- * https://github.com/aeternity/protocol/blob/master/ORACLE.md in the protocol
- * repository.
- * @module @aeternity/aepp-sdk/es/ae/oracle
- * @export Oracle
- * @example import { Oracle } from '@aeternity/aepp-sdk'
- */
-
-import Ae from './'
-import { decodeBase64Check } from '../utils/crypto'
-import { pause } from '../utils/other'
-import { oracleQueryId, decode } from '../tx/builder/helpers'
-import { unpackTx } from '../tx/builder'
-import { ORACLE_TTL, QUERY_FEE, QUERY_TTL, RESPONSE_TTL } from '../tx/builder/schema'
-
-/**
- * Constructor for Oracle Object (helper object for using Oracle)
- * @alias module:@aeternity/aepp-sdk/es/ae/oracle
- * @instance
- * @function
- * @category async
- * @param {String} oracleId Oracle public key
- * @return {Promise<Object>} Oracle object
- */
-async function getOracleObject (oracleId) {
-  const oracle = await this.api.getOracleByPubkey(oracleId)
-  const { oracleQueries: queries } = await this.api.getOracleQueriesByPubkey(oracleId)
-  return {
-    ...oracle,
-    queries,
-    pollQueries: this.pollForQueries.bind(this, oracleId),
-    postQuery: this.postQueryToOracle.bind(this, oracleId),
-    respondToQuery: this.respondToQuery.bind(this, oracleId),
-    extendOracle: this.extendOracleTtl.bind(this, oracleId),
-    getQuery: this.getQueryObject.bind(this, oracleId)
-  }
-}
-
-/**
- * Poll for oracle queries
- * @alias module:@aeternity/aepp-sdk/es/ae/oracle
- * @instance
- * @function
- * @param {String} oracleId Oracle public key
- * @param {Function} onQuery OnQuery callback
- * @param {Object} [options] Options object
- * @param {Number} [options.interval] Poll interval(default: 5000)
- * @return {Function} stopPolling - Stop polling function
- */
-function pollForQueries (oracleId, onQuery, { interval = 5000 } = {}) {
-  const knownQueryIds = new Set()
-  const checkNewQueries = async () => {
-    const queries = ((await this.api.getOracleQueriesByPubkey(oracleId)).oracleQueries || [])
-      .filter(({ id }) => !knownQueryIds.has(id))
-    queries.forEach(({ id }) => knownQueryIds.add(id))
-    if (queries.length) onQuery(queries)
-  }
-
-  checkNewQueries()
-  const intervalId = setInterval(checkNewQueries, interval)
-  return () => clearInterval(intervalId)
-}
-
-/**
- * Constructor for OracleQuery Object (helper object for using OracleQuery)
- * @alias module:@aeternity/aepp-sdk/es/ae/oracle
- * @instance
- * @function
- * @category async
- * @param {String} oracleId Oracle public key
- * @param {String} queryId Oracle Query id
- * @return {Promise<Object>} OracleQuery object
- */
-async function getQueryObject (oracleId, queryId) {
-  const q = await this.api.getOracleQueryByPubkeyAndQueryId(oracleId, queryId)
-  return {
-    ...q,
-    decodedQuery: decodeBase64Check(q.query.slice(3)).toString(),
-    decodedResponse: decodeBase64Check(q.response.slice(3)).toString(),
-    respond: this.respondToQuery.bind(this, oracleId, queryId),
-    pollForResponse: this.pollForQueryResponse.bind(this, oracleId, queryId),
-    decode: (data) => decodeBase64Check(data.slice(3))
-  }
-}
-
-/**
- * Poll for oracle query response
- * @alias module:@aeternity/aepp-sdk/es/ae/oracle
- * @instance
- * @function
- * @category async
- * @param {String} oracleId Oracle public key
- * @param {String} queryId Oracle Query id
- * @param {Object} [options] Options object
- * @param {Object} [options.attempts] Poll attempt's(default: 20)
- * @param {Object} [options.interval] Poll interval(default: 5000)
- * @return {Promise<Object>} OracleQuery object
- */
-export async function pollForQueryResponse (
-  oracleId,
-  queryId,
-  { attempts = 20, interval = 5000 } = {}
-) {
-  for (let i = 0; i < attempts; i++) {
-    if (i) await pause(interval)
-    const { response } = await this.api.getOracleQueryByPubkeyAndQueryId(oracleId, queryId)
-    const responseBuffer = decode(response, 'or')
-    if (responseBuffer.length) {
-      return String(responseBuffer)
-    }
-  }
-  throw new Error(`Giving up after ${(attempts - 1) * interval}ms`)
-}
-
-/**
- * Register oracle
- * @alias module:@aeternity/aepp-sdk/es/ae/oracle
- * @instance
- * @function
- * @category async
- * @param {String} queryFormat Format of query
- * @param {String} responseFormat Format of query response
- * @param {Object} [options={}] Options
- * @param {String|Number} [options.queryFee] Oracle query Fee
- * @param {Object} [options.oracleTtl] OracleTtl object {type: 'delta|block', value: 'number'}
- * @param {Number} [options.abiVersion] Always 0 (do not use virtual machine)
- * @param {Number|String} [options.fee] Transaction fee
- * @param {Number|String} [options.ttl] Transaction time to leave
- * @return {Promise<Object>} Oracle object
- */
-async function registerOracle (queryFormat, responseFormat, options = {}) {
-  const opt = { ...this.Ae.defaults, ...options } // Preset VmVersion for oracle
-  const accountId = await this.address(opt)
-
-  const oracleRegisterTx = await this.oracleRegisterTx({
-    ...opt,
-    accountId,
-    queryFormat,
-    responseFormat
-  })
-  return {
-    ...await this.send(oracleRegisterTx, opt),
-    ...await this.getOracleObject(`ok_${accountId.slice(3)}`)
-  }
-}
-
-/**
- * Post query to oracle
- * @alias module:@aeternity/aepp-sdk/es/ae/oracle
- * @instance
- * @function
- * @category async
- * @param {String} oracleId Oracle public key
- * @param {String} query Oracle query object
- * @param {Object} [options={}]
- * @param {String|Number} [options.queryTtl] queryTtl Oracle query time to leave
- * @param {String|Number} [options.responseTtl] queryFee Oracle query response time to leave
- * @param {String|Number} [options.queryFee] queryFee Oracle query fee
- * @param {Number} [options.fee] fee Transaction fee
- * @param {Number} [options.ttl] Transaction time to leave
- * @return {Promise<Object>} Query object
- */
-async function postQueryToOracle (oracleId, query, options = {}) {
-  const queryFee = options.queryFee || (await this.api.getOracleByPubkey(oracleId)).queryFee
-  const opt = { ...this.Ae.defaults, queryFee, ...options }
-  const senderId = await this.address(opt)
-
-  const oracleRegisterTx = await this.oraclePostQueryTx({
-    ...opt,
-    oracleId,
-    senderId,
-    query
-  })
-  const queryId = oracleQueryId(senderId, unpackTx(oracleRegisterTx).tx.nonce, oracleId)
-  return {
-    ...await this.send(oracleRegisterTx, opt),
-    ...await this.getQueryObject(oracleId, queryId)
-  }
-}
-
-/**
- * Extend oracle ttl
- * @alias module:@aeternity/aepp-sdk/es/ae/oracle
- * @instance
- * @function
- * @category async
- * @param {String} oracleId Oracle public key
- * @param {String} oracleTtl Oracle time to leave for extend
- * @param {Object} [options={}]
- * @param {Number} [options.fee] fee Transaction fee
- * @param {Number} [options.ttl] Transaction time to leave
- * @return {Promise<Object>} Oracle object
- */
-async function extendOracleTtl (oracleId, oracleTtl, options = {}) {
-  const opt = { ...this.Ae.defaults, ...options }
-  const callerId = await this.address(opt)
-
-  const oracleExtendTx = await this.oracleExtendTx({
-    ...opt,
-    oracleId,
-    callerId,
-    oracleTtl
-  })
-  return {
-    ...await this.send(oracleExtendTx, opt),
-    ...await this.getOracleObject(oracleId)
-  }
-}
-
-/**
- * Extend oracle ttl
- * @alias module:@aeternity/aepp-sdk/es/ae/oracle
- * @instance
- * @function
- * @category async
- * @param {String} oracleId Oracle public key
- * @param {String} queryId Oracle query id
- * @param {String} response Oracle query response
- * @param {Object} [options={}]
- * @param {Number} [options.responseTtl] responseTtl Query response time to leave
- * @param {Number} [options.fee] Transaction fee
- * @param {Number} [options.ttl] Transaction time to leave
- * @return {Promise<Object>} Oracle object
- */
-async function respondToQuery (oracleId, queryId, response, options = {}) {
-  const opt = { ...this.Ae.defaults, ...options }
-  const callerId = await this.address(opt)
-
-  const oracleRespondTx = await this.oracleRespondTx({
-    ...opt,
-    oracleId,
-    queryId,
-    callerId,
-    response
-  })
-  return {
-    ...await this.send(oracleRespondTx, opt),
-    ...await this.getOracleObject(oracleId)
-  }
-}
-
-/**
- * Oracle Stamp
- *
- * Oracle provides oracle-system related methods atop
- * {@link module:@aeternity/aepp-sdk/es/ae--Ae} clients.
- * @function
- * @alias module:@aeternity/aepp-sdk/es/ae/oracle
- * @rtype Stamp
- * @param {Object} [options={}] - Initializer object
- * @return {Object} Oracle instance
- */
-const Oracle = Ae.compose({
-  methods: {
-    registerOracle,
-    respondToQuery,
-    extendOracleTtl,
-    postQueryToOracle,
-    pollForQueryResponse,
-    pollForQueries,
-    getOracleObject,
-    getQueryObject
-  },
-  deepProps: {
-    Ae: {
-      defaults: {
-        queryFee: QUERY_FEE,
-        oracleTtl: ORACLE_TTL,
-        queryTtl: QUERY_TTL,
-        responseTtl: RESPONSE_TTL
-      }
-    }
-  }
-})
-
-export default Oracle

package/src/ae/universal.js

@@ -1,47 +0,0 @@
-/*
- * ISC License (ISC)
- * Copyright (c) 2018 aeternity developers
- *
- *  Permission to use, copy, modify, and/or distribute this software for any
- *  purpose with or without fee is hereby granted, provided that the above
- *  copyright notice and this permission notice appear in all copies.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
- *  REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
- *  AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
- *  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- *  LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
- *  OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- *  PERFORMANCE OF THIS SOFTWARE.
- */
-
-/**
- * Universal module
- * @module @aeternity/aepp-sdk/es/ae/universal
- * @export Universal
- * @example import { Universal } from '@aeternity/aepp-sdk'
- */
-
-import Ae from './'
-import Chain from '../chain/node'
-import Aens from './aens'
-import Transaction from '../tx/tx'
-import Oracle from './oracle'
-import GeneralizeAccount from '../contract/ga'
-import AccountMultiple from '../account/multiple'
-import Contract from './contract'
-
-/**
- * Universal Stamp
- *
- * Universal provides Ae base functionality with Contract and Aens
- * {@link module:@aeternity/aepp-sdk/es/ae--Ae} clients.
- * @function
- * @alias module:@aeternity/aepp-sdk/es/ae/universal
- * @rtype Stamp
- * @param {Object} [options={}] - Initializer object
- * @return {Object} Universal instance
- */
-export default Ae.compose(
-  AccountMultiple, Chain, Transaction, Aens, Contract, Oracle, GeneralizeAccount
-)

package/src/ae/wallet.js

@@ -1,50 +0,0 @@
-/*
- * ISC License (ISC)
- * Copyright (c) 2018 aeternity developers
- *
- *  Permission to use, copy, modify, and/or distribute this software for any
- *  purpose with or without fee is hereby granted, provided that the above
- *  copyright notice and this permission notice appear in all copies.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
- *  REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
- *  AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
- *  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- *  LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
- *  OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- *  PERFORMANCE OF THIS SOFTWARE.
- */
-
-/**
- * Wallet module
- * @module @aeternity/aepp-sdk/es/ae/wallet
- * @export Wallet
- * @example import { RpcWallet } from '@aeternity/aepp-sdk'
- */
-
-import Ae from './'
-import Chain from '../chain/node'
-import Tx from '../tx/tx'
-import Contract from './contract'
-import GeneralizeAccount from '../contract/ga'
-import WalletRpc from '../utils/aepp-wallet-communication/rpc/wallet-rpc'
-import Oracle from './oracle'
-import Aens from './aens'
-
-/**
- * Wallet Stamp
- * @function
- * @alias module:@aeternity/aepp-sdk/es/ae/wallet
- * @rtype Stamp
- * @param {Object} [options={}] - Initializer object
- * @param {String} options.url - Node instance to connect to
- * @param {Account[]} [options.accounts] - Accounts to initialize with
- * @param {String} [options.account] - Public key of account to preselect
- * @return {Object} Wallet instance
- * @example Wallet({
-  url: 'https://testnet.aeternity.io/',
-  accounts: [MemoryAccount({keypair})],
-  address: keypair.publicKey,
-})
- */
-export default Ae.compose(WalletRpc, Tx, Contract, Oracle, Aens, GeneralizeAccount, Chain)