@aeternity/aepp-sdk 10.0.0 → 12.0.0

package/src/contract/compiler.js

@@ -1,195 +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.
- */
-
-/**
- * ContractCompilerAPI module
- *
- * This is the complement to {@link module:@aeternity/aepp-sdk/es/contract}.
- * @module @aeternity/aepp-sdk/es/contract/compiler
- * @export ContractCompilerAPI
- * @example import { ContractCompilerAPI } from '@aeternity/aepp-sdk'
- */
-
-import ContractBase from './index'
-import semverSatisfies from '../utils/semver-satisfies'
-import AsyncInit from '../utils/async-init'
-import genSwaggerClient from '../utils/swagger'
-
-/**
- * Contract Compiler Stamp
- *
- * This stamp include api call's related to contract compiler functionality.
- * @function
- * @alias module:@aeternity/aepp-sdk/es/contract/compiler
- * @rtype Stamp
- * @param {Object} [options={}] - Initializer object
- * @param {String} [options.compilerUrl] compilerUrl - Url for compiler API
- * @return {Object} Contract compiler instance
- * @example ContractCompilerAPI({ compilerUrl: 'COMPILER_URL' })
- */
-export default AsyncInit.compose(ContractBase, {
-  async init ({ compilerUrl, ignoreVersion }) {
-    if (!compilerUrl) return
-    await this.setCompilerUrl(compilerUrl, { ignoreVersion })
-  },
-  methods: {
-    async setCompilerUrl (compilerUrl, { ignoreVersion = false } = {}) {
-      if (!compilerUrl) throw new Error('"compilerUrl" required')
-      compilerUrl = compilerUrl.replace(/\/$/, '')
-      const client = await genSwaggerClient(`${compilerUrl}/api`, {
-        disableBigNumbers: true,
-        disableCaseConversion: true,
-        responseInterceptor: response => {
-          if (response.ok) return
-          let message = `${new URL(response.url).pathname.slice(1)} error`
-          if (response.body.reason) {
-            message += ': ' + response.body.reason +
-              (response.body.parameter ? ` in ${response.body.parameter}` : '') +
-              // TODO: revising after improving documentation https://github.com/aeternity/aesophia_http/issues/78
-              (response.body.info ? ` (${JSON.stringify(response.body.info)})` : '')
-          }
-          if (Array.isArray(response.body)) {
-            message += ':\n' + response.body
-              .map(e => `${e.type}:${e.pos.line}:${e.pos.col}: ${e.message}${e.context ? `(${e.context})` : ''}`)
-              .map(e => e.trim()) // TODO: remove after fixing https://github.com/aeternity/aesophia_http/issues/80
-              .join('\n')
-          }
-          response.statusText = message
-          return response
-        }
-      })
-      this.compilerVersion = client.spec.info.version
-      this._compilerApi = client.api
-
-      if (ignoreVersion) return
-      if (!semverSatisfies(this.compilerVersion, COMPILER_GE_VERSION, COMPILER_LT_VERSION)) {
-        throw new Error(`Unsupported compiler version ${this.compilerVersion}. ` +
-          `Supported: >= ${COMPILER_GE_VERSION} < ${COMPILER_LT_VERSION}`)
-      }
-    },
-    _ensureCompilerReady () {
-      if (!this._compilerApi) throw new Error('Compiler is not ready')
-    },
-    _prepareCompilerOptions ({ filesystem = {} } = {}) {
-      return { file_system: filesystem }
-    },
-    getCompilerVersion () {
-      this._ensureCompilerReady()
-      return Promise.resolve(this.compilerVersion)
-    },
-    /**
-     * Encode call data for contract call
-     * @function
-     * @category async
-     * @param {String} source Contract source code
-     * @param {String} name Name of function to call
-     * @param {Array} args Argument's for call
-     * @param {Object} [options={}]  Options
-     * @param {Object} [options.filesystem={}] Contract external namespaces map
-     * @return {Promise<String>}
-     */
-    async contractEncodeCallDataAPI (source, name, args = [], options) {
-      this._ensureCompilerReady()
-      const { calldata } = await this._compilerApi.encodeCalldata({
-        source,
-        function: name,
-        arguments: args,
-        options: this._prepareCompilerOptions(options)
-      })
-      return calldata
-    },
-    async compileContractAPI (code, options) {
-      this._ensureCompilerReady()
-      const { bytecode } = await this._compilerApi.compileContract({
-        code,
-        options: this._prepareCompilerOptions(options)
-      })
-      return bytecode
-    },
-    contractGetACI (code, options) {
-      this._ensureCompilerReady()
-      return this._compilerApi.generateACI({ code, options: this._prepareCompilerOptions(options) })
-    },
-    contractDecodeCallDataByCodeAPI (bytecode, calldata) {
-      this._ensureCompilerReady()
-      return this._compilerApi.decodeCalldataBytecode({ bytecode, calldata })
-    },
-    contractDecodeCallDataBySourceAPI (source, fn, callData, options) {
-      this._ensureCompilerReady()
-      return this._compilerApi.decodeCalldataSource({
-        function: fn,
-        source,
-        calldata: callData,
-        options: this._prepareCompilerOptions(options)
-      })
-    },
-    /**
-     * Decode contract call result data
-     * @function
-     * @category async
-     * @param {String} source - source code
-     * @param {String } fn - function name
-     * @param {String} callValue - result call data
-     * @param {String} callResult - result status
-     * @param {Object} [options={}]  Options
-     * @param {Object} [options.filesystem={}] Contract external namespaces map
-     * @return {Promise<String>} Result object
-     * @example
-     * const decodedData = await sdk.contractDecodeCallResultAPI(
-     *   SourceCode ,'functionName', 'cb_asdasdasd...', 'ok|revert'
-     * )
-     */
-    contractDecodeCallResultAPI (source, fn, callValue, callResult, options) {
-      this._ensureCompilerReady()
-      return this._compilerApi.decodeCallResult({
-        function: fn,
-        source,
-        'call-result': callResult,
-        'call-value': callValue,
-        options: this._prepareCompilerOptions(options)
-      })
-    },
-    async validateByteCodeAPI (bytecode, source, options) {
-      this._ensureCompilerReady()
-      const res = await this._compilerApi.validateByteCode({
-        bytecode,
-        source,
-        options: this._prepareCompilerOptions(options)
-      })
-      return typeof res === 'object' ? true : res
-    },
-    getFateAssembler (bytecode, options) {
-      this._ensureCompilerReady()
-      return this._compilerApi.getFateAssemblerCode(
-        { bytecode, options: this._prepareCompilerOptions(options) }
-      )
-    },
-    getBytecodeCompilerVersion (bytecode, options) {
-      this._ensureCompilerReady()
-      return this._compilerApi.getCompilerVersion({
-        bytecode,
-        options: this._prepareCompilerOptions(options)
-      })
-    }
-  },
-  props: {
-    compilerVersion: null
-  }
-})
-
-const COMPILER_GE_VERSION = '6.0.0'
-const COMPILER_LT_VERSION = '7.0.0'

package/src/contract/ga/helpers.js

@@ -1,17 +0,0 @@
-import BigNumber from 'bignumber.js'
-import { MAX_AUTH_FUN_GAS } from '../../tx/builder/schema'
-
-export const prepareGaParams = (ins) => async (authData, authFnName) => {
-  if (typeof authData !== 'object') throw new Error('AuthData must be an object')
-  if (authData.gas && BigNumber(authData.gas).gt(MAX_AUTH_FUN_GAS)) throw new Error(`the maximum gas value for ga authFun is ${MAX_AUTH_FUN_GAS}, got ${authData.gas}`)
-  const gas = authData.gas || MAX_AUTH_FUN_GAS
-  if (authData.callData) {
-    if (authData.callData.split('_')[0] !== 'cb') throw new Error('Auth data must be a string with "cb" prefix.')
-    return { authCallData: authData.callData, gas }
-  }
-  if (!authData.source || !authData.args) throw new Error('Auth data must contain source code and arguments.')
-  return {
-    authCallData: await ins.contractEncodeCallDataAPI(authData.source, authFnName, authData.args),
-    gas
-  }
-}

package/src/contract/ga/index.js

@@ -1,147 +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.
- */
-
-/**
- * Generalize Account module - routines to use generalize account
- *
- * @module @aeternity/aepp-sdk/es/contract/ga
- * @export GeneralizeAccount
- * @example import { GeneralizeAccount } from '@aeternity/aepp-sdk'
- */
-import { ContractAPI } from '../../ae/contract'
-import { TX_TYPE } from '../../tx/builder/schema'
-import { buildTx, unpackTx } from '../../tx/builder'
-import { prepareGaParams } from './helpers'
-import { hash } from '../../utils/crypto'
-
-/**
- * GeneralizeAccount Stamp
- *
- * Provide Generalize Account implementation
- * {@link module:@aeternity/aepp-sdk/es/contract/ga} clients.
- * @function
- * @alias module:@aeternity/aepp-sdk/es/contract/ga
- * @rtype Stamp
- * @param {Object} [options={}] - Initializer object
- * @return {Object} GeneralizeAccount instance
- * @example
- * const authContract = ``
- * await client.createGeneralizeAccount(authFnName, authContract, [...authFnArguments]
- * // Make spend using GA
- * const callData = 'cb_...' // encoded call data for auth contract
- * await client.spend(10000, receiverPub, { authData: { callData } })
- * // or
- * await client.spend(10000, receiverPub, {
- *   authData: { source: authContract, args: [...authContractArgs] }
- * }) // sdk will prepare callData itself
- */
-export const GeneralizeAccount = ContractAPI.compose({
-  methods: {
-    createGeneralizeAccount,
-    createMetaTx,
-    isGA
-  }
-})
-export default GeneralizeAccount
-
-/**
- * @alias module:@aeternity/aepp-sdk/es/contract/ga
- * @function
- * Check if account is GA account
- * @param {String} address - Account address
- * @return {Boolean}
- */
-async function isGA (address) {
-  const { contractId } = await this.getAccount(address)
-  return !!contractId
-}
-
-/**
- * Convert current account to GA account
- * @alias module:@aeternity/aepp-sdk/es/contract/ga
- * @function
- * @param {String} authFnName - Authorization function name
- * @param {String} source - Auth contract source code
- * @param {Array} [args] - init arguments
- * @param {Object} [options] - Options
- * @return {Promise<Readonly<{
- *   result: *, owner: *, createdAt: Date, address, rawTx: *, transaction: *
- * }>>}
- */
-async function createGeneralizeAccount (authFnName, source, args = [], options = {}) {
-  const opt = { ...this.Ae.defaults, ...options }
-  const ownerId = await this.address(opt)
-
-  if (await this.isGA(ownerId)) throw new Error(`Account ${ownerId} is already GA`)
-
-  const { tx, contractId } = await this.gaAttachTx({
-    ...opt,
-    ownerId,
-    code: (await this.contractCompile(source)).bytecode,
-    callData: await this.contractEncodeCallDataAPI(source, 'init', args),
-    authFun: hash(authFnName)
-  })
-
-  const { hash: transaction, rawTx } = await this.send(tx, opt)
-
-  return Object.freeze({
-    owner: ownerId,
-    transaction,
-    rawTx,
-    gaContractId: contractId
-  })
-}
-
-const wrapInEmptySignedTx = (tx) => buildTx({ encodedTx: tx, signatures: [] }, TX_TYPE.signed)
-
-/**
- * Create a metaTx transaction
- * @alias module:@aeternity/aepp-sdk/es/contract/ga
- * @function
- * @param {String} rawTransaction Inner transaction
- * @param {Object} authData Object with gaMeta params
- * @param {String} authFnName - Authorization function name
- * @param {Object} options - Options
- * @return {String}
- */
-async function createMetaTx (rawTransaction, authData, authFnName, options = {}) {
-  if (!authData) throw new Error('authData is required')
-  // Check if authData is callData or if it's an object prepare a callData from source and args
-  const { authCallData, gas } = await prepareGaParams(this)(authData, authFnName)
-  const opt = { ...this.Ae.defaults, ...options }
-  const { abiVersion } = await this.getVmVersion(TX_TYPE.contractCall)
-  const wrappedTx = wrapInEmptySignedTx(unpackTx(rawTransaction))
-  const params = {
-    ...opt,
-    tx: {
-      ...wrappedTx,
-      tx: wrappedTx.txObject
-    },
-    gaId: await this.address(opt),
-    abiVersion: abiVersion,
-    authData: authCallData,
-    gas,
-    vsn: 2
-  }
-  const { fee } = await this.prepareTxParams(TX_TYPE.gaMeta, params)
-  const { rlpEncoded: metaTxRlp } = buildTx(
-    { ...params, fee: `${fee}` },
-    TX_TYPE.gaMeta,
-    { vsn: 2 }
-  )
-  return wrapInEmptySignedTx(metaTxRlp).tx
-}

package/src/contract/index.js

@@ -1,163 +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.
- */
-
-/**
- * Contract Base module
- * @module @aeternity/aepp-sdk/es/contract
- * @export Contract
- * @example import ContractBase from '@aeternity/aepp-sdk/es/contract'
- */
-
-import stampit from '@stamp/it'
-import { required } from '@stamp/required'
-
-/**
- * Basic Contract Stamp
- *
- * This stamp include api call's related to contract functionality.
- * Attempting to create instances from the Stamp without overwriting all
- * abstract methods using composition will result in an exception.
- * @function
- * @alias module:@aeternity/aepp-sdk/es/contract
- * @rtype Stamp
- * @param {Object} [options={}] - Initializer object
- * @return {Object} Contract instance
- */
-const ContractBase = stampit(required({
-  methods: {
-    contractEncodeCallDataAPI: required,
-    compileContractAPI: required,
-    contractGetACI: required,
-    setCompilerUrl: required,
-    getCompilerVersion: required,
-    contractDecodeCallResultAPI: required,
-    validateByteCodeAPI: required,
-    getFateAssembler: required,
-    getBytecodeCompilerVersion: required
-  }
-}))
-
-/**
- * Get contract ACI
- * @function contractGetACI
- * @instance
- * @abstract
- * @category async
- * @rtype (source: String, options: Array) => aciObject: Promise[Object]
- * @param {String} source - Contract source code
- * @param {Object} [options={}]  Options
- * @param {Object} [options.filesystem]  Contract external namespaces map
- * @return {Object} - Contract aci object
- */
-
-/**
- * Encode contract data
- * @function contractEncodeCallDataAPI
- * @instance
- * @abstract
- * @category async
- * @rtype (source: String, name: String, args: Array, options: Array) => callData: Promise[String]
- * @param {String} source - Contract source code
- * @param {String} name - Function name
- * @param {Array} args - Function argument's
- * @param {Object} [options={}]  Options
- * @param {Object} [options.filesystem]  Contract external namespaces map
- * @return {String} - Contract encoded data
- */
-
-/**
- * Decode contract call result data
- * @function contractDecodeCallResultAPI
- * @instance
- * @abstract
- * @category async
- * @rtype (
- *   source: String, fn: String, callValue: String, callResult: String, options: Array
- * ) => decodedResult: Promise[String]
- * @param {String} source - Contract source
- * @param {String} fn - Fn name
- * @param {String} callValue - result data (cb_das...)
- * @param {String} callResult - contract call result status('ok', 'revert', ...)
- * @param {Object} [options={}]  Options
- * @param {Object} [options.filesystem]  Contract external namespaces map
- * @return {String} - Decoded contract call result
- */
-
-/**
- * Decode call data by source
- * @function contractDecodeCallDataBySourceAPI
- * @instance
- * @abstract
- * @category async
- * @rtype (
- *   source: String, function: String, callData: String, options: Array
- * ) => decodedResult: Promise[String]
- * @param {String} source - contract source
- * @param {String} function - function name
- * @param {String} callData - Encoded contract call data
- * @param {Object} [options={}]  Options
- * @param {Object} [options.filesystem]  Contract external namespaces map
- * @return {String} - Decoded contract call data
- */
-
-/**
- * Decode call data by bytecode
- * @function contractDecodeCallDataByCodeAPI
- * @instance
- * @abstract
- * @category async
- * @rtype (code: String, callData: String) => decodedResult: Promise[String]
- * @param {String} code - contract byte code
- * @param {String} callData - Encoded contract call data
- * @return {String} - Decoded contract call data
- */
-
-/**
- * Compile contract
- * @function compileContractAPI
- * @instance
- * @abstract
- * @category async
- * @rtype (code: String, options?: Object) => compiledContract: Object
- * @param {String} code - Contract source code
- * @param {Object} [options={}]  Options
- * @param {Object} [options.filesystem]  Contract external namespaces map
- * @return {Object} Object which contain bytecode of contract
- */
-
-/**
- * Set compiler url
- * @function setCompilerUrl
- * @instance
- * @abstract
- * @category async
- * @rtype (url: String) => void
- * @param {String} url - Compiler url
- * @return {void}
- */
-
-/**
- * Get Compiler Version
- * @function getCompilerVersion
- * @instance
- * @abstract
- * @category async
- * @rtype () => String
- * @return {String} Compiler version
- */
-
-export default ContractBase

package/src/index.js

@@ -1,90 +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.
- */
-
-import * as Crypto from './utils/crypto'
-import * as Keystore from './utils/keystore'
-import * as Bytes from './utils/bytes'
-import * as TxBuilder from './tx/builder'
-import * as TxBuilderHelper from './tx/builder/helpers'
-import * as SCHEMA from './tx/builder/schema'
-import * as ACITransformation from './contract/aci/transformation'
-import * as AmountFormatter from './utils/amount-formatter'
-import HdWallet from './utils/hd-wallet'
-
-import Ae from './ae'
-import Chain from './chain'
-import ChainNode from './chain/node'
-import Node from './node'
-import NodePool from './node-pool'
-import Tx from './tx'
-import Transaction from './tx/tx'
-import verifyTransaction from './tx/validator'
-import AccountBase from './account/base'
-import AccountMultiple from './account/multiple'
-import MemoryAccount from './account/memory'
-import Aens from './ae/aens'
-import Contract from './ae/contract'
-import GeneralizeAccount from './contract/ga'
-import ContractCompilerAPI from './contract/compiler'
-import RpcAepp from './ae/aepp'
-import RpcWallet from './ae/wallet'
-import Oracle from './ae/oracle'
-import genSwaggerClient from './utils/swagger'
-import Channel from './channel'
-import Universal from './ae/universal'
-
-export { default as ContentScriptBridge } from './utils/aepp-wallet-communication/content-script-bridge'
-export * as AeppWalletHelpers from './utils/aepp-wallet-communication/helpers'
-export * as AeppWalletSchema from './utils/aepp-wallet-communication/schema'
-export { default as WalletDetector } from './utils/aepp-wallet-communication/wallet-detector'
-export { default as BrowserRuntimeConnection } from './utils/aepp-wallet-communication/connection/browser-runtime'
-export { default as BrowserWindowMessageConnection } from './utils/aepp-wallet-communication/connection/browser-window-message'
-
-export const getDefaultPointerKey = TxBuilderHelper.getDefaultPointerKey
-
-export {
-  AmountFormatter,
-  AccountBase,
-  AccountMultiple,
-  Ae,
-  Aens,
-  Bytes,
-  Contract,
-  ContractCompilerAPI,
-  ACITransformation,
-  ChainNode,
-  RpcAepp,
-  RpcWallet,
-  Channel,
-  Crypto,
-  Keystore,
-  Chain,
-  GeneralizeAccount,
-  HdWallet,
-  MemoryAccount,
-  Node,
-  NodePool,
-  Oracle,
-  genSwaggerClient,
-  Transaction,
-  verifyTransaction,
-  Tx,
-  TxBuilder,
-  TxBuilderHelper,
-  Universal,
-  SCHEMA
-}