@aeternity/aepp-sdk
Version:
SDK for the æternity blockchain
83 lines (78 loc) • 2.34 kB
JavaScript
/*
* 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 Connection base module
* @module @aeternity/aepp-sdk/es/utils/aepp-wallet-communication/connection
* @export WalletConnection
* @example import WalletConnection from '@aeternity/aepp-sdk/es/utils/aepp-wallet-communication/connection'
*/
import { required } from '@stamp/required';
/**
* Basic Wallet Connection
*
* This stamp include interface for wallet connection 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/utils/aepp-wallet-communication/connection
* @rtype Stamp
* @param {Object} [options={}] - Initializer object
* @return {Object} WalletConnection instance
*/
export default required({
methods: {
connect: required,
disconnect: required,
sendMessage: required,
isConnected: required
}
});
/**
* Connect
* @function connect
* @instance
* @abstract
* @rtype (onMessage: Function) => void
* @param {Function} onMessage - Message handler
* @return {void}
*/
/**
* Disconnect
* @function disconnect
* @instance
* @abstract
* @rtype () => void
* @return {void}
*/
/**
* Send message
* @function sendMessage
* @instance
* @abstract
* @rtype (msg: Object) => void
* @param {Object} msg - Message
* @return {void}
*/
/**
* Check if connected
* @function isConnected
* @instance
* @abstract
* @rtype () => Boolean
* @return {Boolean} Is connected
*/
//# sourceMappingURL=index.js.map