49fdd23d58
* Move secureApi to shell * Extract isTestnet test * Use mobx + subscriptions for status * Re-add status indicator * Add lerna * Move intial packages to js/packages * Move 3rdparty/{email,sms}-verification to correct location * Move package.json & README to library src * Move tests for library packages * Move views & dapps to packages * Move i18n to root * Move shell to actual src (main app) * Remove ~ references * Change ~ to root (explicit imports) * Finalise convert of ~ * Move views into dapps as well * Move dapps to packages/ * Fix references * Update css * Update test spec locations * Update tests * Case fix * Skip flakey tests * Update enzyme * Skip previously ignored tests * Allow empty api for hw * Re-add theme for embed
180 lines
5.3 KiB
JavaScript
180 lines
5.3 KiB
JavaScript
// Copyright 2015-2017 Parity Technologies (UK) Ltd.
|
|
// This file is part of Parity.
|
|
|
|
// Parity is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
|
|
// Parity is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Parity. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
import { Data, Quantity } from '../types';
|
|
|
|
export default {
|
|
version: {
|
|
nodoc: 'Not present in Rust code',
|
|
desc: 'Returns the current whisper protocol version.',
|
|
params: [],
|
|
returns: {
|
|
type: String,
|
|
desc: 'The current whisper protocol version'
|
|
}
|
|
},
|
|
|
|
post: {
|
|
nodoc: 'Not present in Rust code',
|
|
desc: 'Sends a whisper message.',
|
|
params: [
|
|
{
|
|
type: Object, desc: 'The whisper post object:', format: 'inputPostFormatter',
|
|
details: {
|
|
from: {
|
|
type: Data, desc: '60 Bytes - The identity of the sender',
|
|
optional: true
|
|
},
|
|
to: {
|
|
type: Data, desc: '60 Bytes - The identity of the receiver. When present whisper will encrypt the message so that only the receiver can decrypt it',
|
|
optional: true
|
|
},
|
|
topics: {
|
|
type: Array, desc: 'Array of `Data` topics, for the receiver to identify messages'
|
|
},
|
|
payload: {
|
|
type: Data, desc: 'The payload of the message'
|
|
},
|
|
priority: {
|
|
type: Quantity, desc: 'The integer of the priority in a rang from ... (?)'
|
|
},
|
|
ttl: {
|
|
type: Quantity, desc: 'Integer of the time to live in seconds.'
|
|
}
|
|
}
|
|
}
|
|
],
|
|
returns: {
|
|
type: Boolean,
|
|
desc: '`true` if the message was send, otherwise `false`'
|
|
}
|
|
},
|
|
|
|
newIdentity: {
|
|
nodoc: 'Not present in Rust code',
|
|
desc: 'Creates new whisper identity in the client.',
|
|
params: [],
|
|
returns: {
|
|
type: Data,
|
|
desc: '60 Bytes - the address of the new identiy'
|
|
}
|
|
},
|
|
|
|
hasIdentity: {
|
|
nodoc: 'Not present in Rust code',
|
|
desc: 'Checks if the client hold the private keys for a given identity.',
|
|
params: [
|
|
{
|
|
type: Data,
|
|
desc: '60 Bytes - The identity address to check'
|
|
}
|
|
],
|
|
returns: {
|
|
type: Boolean,
|
|
desc: '`true` if the client holds the privatekey for that identity, otherwise `false`'
|
|
}
|
|
},
|
|
|
|
newGroup: {
|
|
nodoc: 'Not present in Rust code',
|
|
desc: '(?)',
|
|
params: [],
|
|
returns: {
|
|
type: Data, desc: '60 Bytes - the address of the new group. (?)'
|
|
}
|
|
},
|
|
|
|
addToGroup: {
|
|
nodoc: 'Not present in Rust code',
|
|
desc: '(?)',
|
|
params: [
|
|
{
|
|
type: Data,
|
|
desc: '60 Bytes - The identity address to add to a group (?)'
|
|
}
|
|
],
|
|
returns: {
|
|
type: Boolean,
|
|
desc: '`true` if the identity was successfully added to the group, otherwise `false` (?)'
|
|
}
|
|
},
|
|
|
|
newFilter: {
|
|
nodoc: 'Not present in Rust code',
|
|
desc: 'Creates filter to notify, when client receives whisper message matching the filter options.',
|
|
params: [
|
|
{
|
|
type: Object, desc: 'The filter options:',
|
|
details: {
|
|
to: {
|
|
type: Data, desc: '60 Bytes - Identity of the receiver. *When present it will try to decrypt any incoming message if the client holds the private key to this identity.*',
|
|
optional: true
|
|
},
|
|
topics: {
|
|
type: Array, desc: 'Array of `Data` topics which the incoming message\'s topics should match. You can use the following combinations'
|
|
}
|
|
}
|
|
}
|
|
],
|
|
returns: {
|
|
type: Quantity,
|
|
desc: 'The newly created filter'
|
|
}
|
|
},
|
|
|
|
uninstallFilter: {
|
|
nodoc: 'Not present in Rust code',
|
|
desc: 'Uninstalls a filter with given id. Should always be called when watch is no longer needed.\nAdditonally Filters timeout when they aren\'t requested with [shh_getFilterChanges](#shh_getfilterchanges) for a period of time.',
|
|
params: [
|
|
{
|
|
type: Quantity,
|
|
desc: 'The filter id'
|
|
}
|
|
],
|
|
returns: {
|
|
type: Boolean,
|
|
desc: '`true` if the filter was successfully uninstalled, otherwise `false`'
|
|
}
|
|
},
|
|
|
|
getFilterChanges: {
|
|
nodoc: 'Not present in Rust code',
|
|
desc: 'Polling method for whisper filters. Returns new messages since the last call of this method.\n**Note** calling the [shh_getMessages](#shh_getmessages) method, will reset the buffer for this method, so that you won\'t receive duplicate messages.',
|
|
params: [
|
|
{
|
|
type: Quantity,
|
|
desc: 'The filter id'
|
|
}
|
|
],
|
|
returns: {
|
|
type: Array,
|
|
desc: 'Array of messages received since last poll'
|
|
}
|
|
},
|
|
|
|
getMessages: {
|
|
nodoc: 'Not present in Rust code',
|
|
desc: 'Get all messages matching a filter. Unlike `shh_getFilterChanges` this returns all messages.',
|
|
params: [
|
|
{
|
|
type: Quantity,
|
|
desc: 'The filter id'
|
|
}
|
|
],
|
|
returns: 'See [shh_getFilterChanges](#shh_getfilterchanges)'
|
|
}
|
|
};
|