@aeternity/aepp-sdk 10.0.0 → 12.0.0

package/src/account/base.js

@@ -1,153 +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.
- */
-
-/**
- * AccountBase module
- * @module @aeternity/aepp-sdk/es/account/base
- * @export AccountBase
- * @export isAccountBase
- */
-
-import stampit from '@stamp/it'
-import { required } from '@stamp/required'
-import { messageToHash, verifyMessage as verifyMessageCrypto, hash } from '../utils/crypto'
-import { buildTx } from '../tx/builder'
-import { decode } from '../tx/builder/helpers'
-import { TX_TYPE } from '../tx/builder/schema'
-import { getNetworkId } from '../node'
-
-/**
- * Check is provided object looks like an instance of AccountBase
- * @rtype (Object) => Boolean
- * @param {Object} acc - Object to check
- * @return {Boolean}
- */
-export const isAccountBase = (acc) => !['sign', 'address'].find(f => typeof acc[f] !== 'function')
-
-/**
- * Sign encoded transaction
- * @instance
- * @category async
- * @rtype (tx: String) => tx: Promise[String], throws: Error
- * @param {String} tx - Transaction to sign
- * @param {Object} opt - Options
- * @param {Object} [opt.innerTx] - Sign as inner transaction for PayingFor
- * @return {String} Signed transaction
- */
-async function signTransaction (tx, opt = {}) {
-  const prefixes = [this.getNetworkId(opt)]
-  if (opt.innerTx) prefixes.push('inner_tx')
-  const rlpBinaryTx = decode(tx, 'tx')
-  const txWithNetworkId = Buffer.concat([Buffer.from(prefixes.join('-')), hash(rlpBinaryTx)])
-
-  const signatures = [await this.sign(txWithNetworkId, opt)]
-  return buildTx({ encodedTx: rlpBinaryTx, signatures }, TX_TYPE.signed).tx
-}
-
-/**
- * Get network Id
- * @instance
- * @function getNetworkId
- * @category async
- * @rtype () => networkId: String
- * @return {String} Network Id
- */
-
-/**
- * Sign message
- * @instance
- * @category async
- * @rtype (msg: String) => signature: Promise[String], throws: Error
- * @param {String} message - Message to sign
- * @param {Object} opt - Options
- * @return {String} Signature
- */
-async function signMessage (message, opt = { returnHex: false }) {
-  const sig = await this.sign(messageToHash(message), opt)
-  return opt.returnHex ? Buffer.from(sig).toString('hex') : sig
-}
-
-/**
- * Verify message
- * @instance
- * @category async
- * @rtype (
- *   msg: String, signature: String, publicKey: String
- * ) => signature: Promise[String], throws: Error
- * @param {String} message - Message to verify
- * @param {String} signature - Signature
- * @param {Object} opt - Options
- * @return {Boolean}
- */
-async function verifyMessage (message, signature, opt = {}) {
-  return verifyMessageCrypto(
-    message,
-    typeof signature === 'string' ? Buffer.from(signature, 'hex') : signature,
-    decode(await this.address(opt))
-  )
-}
-
-/**
- * AccountBase Stamp
- *
- * Attempting to create instances from the Stamp without overwriting all
- * abstract methods using composition will result in an exception.
- *
- * Account is one of the three basic building blocks of an
- * {@link module:@aeternity/aepp-sdk/es/ae--Ae} client and provides access to a
- * signing key pair.
- * @function
- * @alias module:@aeternity/aepp-sdk/es/account
- * @rtype Stamp
- * @param {Object} [options={}] - Initializer object
- * @param {String} options.networkId - NETWORK_ID using for signing transaction's
- * @return {Object} Account instance
- */
-export default stampit({
-  init ({ networkId }) { // NETWORK_ID using for signing transaction's
-    if (!this.networkId && networkId) {
-      this.networkId = networkId
-    }
-  },
-  methods: { signTransaction, getNetworkId, signMessage, verifyMessage }
-}, required({
-  methods: {
-    sign: required,
-    address: required
-  }
-}))
-
-/**
- * Sign data blob
- * @function sign
- * @instance
- * @abstract
- * @category async
- * @rtype (data: String) => data: Promise[String]
- * @param {String} data - Data blob to sign
- * @return {String} Signed data blob
- */
-
-/**
- * Obtain account address
- * @function address
- * @instance
- * @abstract
- * @category async
- * @rtype () => address: Promise[String]
- * @return {String} Public account address
- */

package/src/account/memory.js

@@ -1,78 +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.
- */
-
-/**
- * Memory Account module
- * @module @aeternity/aepp-sdk/es/account/memory
- * @export MemoryAccount
- * @example import { MemoryAccount } from '@aeternity/aepp-sdk'
- */
-
-import AccountBase from './base'
-import { sign, isAddressValid, isValidKeypair } from '../utils/crypto'
-import { isHex } from '../utils/string'
-import { decode } from '../tx/builder/helpers'
-
-const secrets = new WeakMap()
-
-/**
- * In-memory account stamp
- * @function
- * @alias module:@aeternity/aepp-sdk/es/account/memory
- * @rtype Stamp
- * @param {Object} [options={}] - Initializer object
- * @param {Object} options.keypair - Key pair to use
- * @param {String} options.keypair.publicKey - Public key
- * @param {String} options.keypair.secretKey - Private key
- * @return {Account}
- */
-export default AccountBase.compose({
-  init ({ keypair, gaId }) {
-    this.isGa = !!gaId
-    if (gaId) {
-      if (!isAddressValid(gaId)) throw new Error('Invalid GA address')
-      secrets.set(this, { publicKey: gaId })
-      return
-    }
-
-    if (!keypair || typeof keypair !== 'object') throw new Error('KeyPair must be an object')
-    if (!keypair.secretKey || !keypair.publicKey) throw new Error('KeyPair must must have "secretKey", "publicKey" properties')
-    if (typeof keypair.publicKey !== 'string' || keypair.publicKey.indexOf('ak_') === -1) throw new Error('Public Key must be a base58c string with "ak_" prefix')
-    if (
-      !Buffer.isBuffer(keypair.secretKey) &&
-      (typeof keypair.secretKey === 'string' && !isHex(keypair.secretKey))
-    ) throw new Error('Secret key must be hex string or Buffer')
-
-    const pubBuffer = Buffer.from(decode(keypair.publicKey, 'ak'))
-    if (!isValidKeypair(Buffer.from(keypair.secretKey, 'hex'), pubBuffer)) throw new Error('Invalid Key Pair')
-
-    secrets.set(this, {
-      secretKey: Buffer.isBuffer(keypair.secretKey) ? keypair.secretKey : Buffer.from(keypair.secretKey, 'hex'),
-      publicKey: keypair.publicKey
-    })
-  },
-  props: { isGa: false },
-  methods: {
-    sign (data) {
-      if (this.isGa) throw new Error('You are trying to sign data using GA account without keypair')
-      return Promise.resolve(sign(data, secrets.get(this).secretKey))
-    },
-    address () {
-      return Promise.resolve(secrets.get(this).publicKey)
-    }
-  }
-})

package/src/account/multiple.js

@@ -1,154 +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.
- */
-
-/**
- * AccountMultiple module
- * @module @aeternity/aepp-sdk/es/accounts/multiple
- * @export AccountMultiple
- */
-
-import AsyncInit from '../utils/async-init'
-import MemoryAccount from './memory'
-import { decode } from '../tx/builder/helpers'
-import AccountBase, { isAccountBase } from './base'
-
-/**
- * AccountMultiple stamp
- *
- * The purpose of this stamp is to wrap up implementations of
- * {@link module:@aeternity/aepp-sdk/es/account/base--AccountBase} objects and provide a
- * common interface to all of them. List are a substantial part of
- * {@link module:@aeternity/aepp-sdk/es/ae/wallet--Wallet}s.
- * @function
- * @alias module:@aeternity/aepp-sdk/es/accounts/multiple
- * @rtype Stamp
- * @param {Object} [options={}] - Initializer object
- * @param {Array} [options.accounts] - Accounts array
- * @param {String} [options.address] - Address of account to select
- * @return {Object} AccountMultiple instance
- * @example
- * const accounts = await AccountMultiple({
- *   accounts: [MemoryAccount({ 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
- */
-export default AccountBase.compose(AsyncInit, {
-  async init ({ accounts = [], address }) {
-    this.accounts = Object.fromEntries(await Promise.all(
-      accounts.map(async a => [await a.address(), a])
-    ))
-    address = address || Object.keys(this.accounts)[0]
-    if (address) this.selectAccount(address)
-  },
-  props: {
-    accounts: {}
-  },
-  deepProps: {
-    selectedAddress: null
-  },
-  methods: {
-    async address ({ onAccount = this.selectedAddress } = {}) {
-      return this._resolveAccount(onAccount).address()
-    },
-    async sign (data, { onAccount = this.selectedAddress } = {}) {
-      return this._resolveAccount(onAccount).sign(data)
-    },
-    /**
-     * Get accounts addresses
-     * @alias module:@aeternity/aepp-sdk/es/accounts/multiple
-     * @function
-     * @rtype () => String[]
-     * @return {String[]}
-     * @example addresses()
-     */
-    addresses () {
-      return Object.keys(this.accounts)
-    },
-    /**
-     * Add specific account
-     * @alias module:@aeternity/aepp-sdk/es/accounts/multiple
-     * @function
-     * @category async
-     * @rtype (account: Account, { select: Boolean }) => void
-     * @param {Object} account - Account instance
-     * @param {Object} [options={}] - Options
-     * @param {Boolean} [options.select] - Select account
-     * @return {void}
-     * @example addAccount(account)
-     */
-    async addAccount (account, { select } = {}) {
-      const address = await account.address()
-      this.accounts[address] = account
-      if (select) this.selectAccount(address)
-    },
-    /**
-     * Remove specific account
-     * @alias module:@aeternity/aepp-sdk/es/accounts/multiple
-     * @function
-     * @rtype (address: String) => void
-     * @param {String} address - Address of account to remove
-     * @return {void}
-     * @example removeAccount(address)
-     */
-    removeAccount (address) {
-      if (!this.accounts[address]) {
-        console.warn(`removeAccount: Account for ${address} not available`)
-        return
-      }
-      delete this.accounts[address]
-      if (this.selectedAddress === address) this.selectedAddress = null
-    },
-    /**
-     * Select specific account
-     * @alias module:@aeternity/aepp-sdk/es/account/selector
-     * @instance
-     * @rtype (address: String) => void
-     * @param {String} address - Address of account to select
-     * @example selectAccount('ak_xxxxxxxx')
-     */
-    selectAccount (address) {
-      decode(address, 'ak')
-      if (!this.accounts[address]) throw new Error(`Account for ${address} not available`)
-      this.selectedAddress = address
-    },
-    /**
-     * Resolves an account
-     * @param account account address (should exist in sdk instance), MemoryAccount or keypair
-     * @returns {AccountBase}
-     * @private
-     */
-    _resolveAccount (account) {
-      if (account === null) {
-        throw new Error('No account or wallet configured')
-      } else {
-        switch (typeof account) {
-          case 'string':
-            decode(account, 'ak')
-            if (!this.accounts[account]) throw new Error(`Account for ${account} not available`)
-            return this.accounts[account]
-          case 'object':
-            return isAccountBase(account) ? account : MemoryAccount({ keypair: account })
-          default:
-            throw new Error(`Unknown account type: ${typeof account} (account: ${account})`)
-        }
-      }
-    }
-  }
-})