web3.shh¶

The web3-shh package allows you to interact with the whisper protocol for broadcasting. For more see Whisper Overview.

var Shh = require('web3-shh');

// "Shh.providers.givenProvider" will be set if in an Ethereum supported browser.
var shh = new Shh(Shh.givenProvider || 'ws://some.local-or-remote.node:8546');

// or using the web3 umbrella package

var Web3 = require('web3');
var web3 = new Web3(Web3.givenProvider || 'ws://some.local-or-remote.node:8546');

// -> web3.shh

setProvider¶

web3.setProvider(myProvider)
web3.eth.setProvider(myProvider)
web3.shh.setProvider(myProvider)
web3.bzz.setProvider(myProvider)
...

해당 모듈의 web3 Provider를 변경 또는 설정 합니다. .. note:: web3.eth, web3.shh 등등과 같은 모든 하위 모듈에 대해 동일한 Provider가 설정됩니다. web3.bzz 는 분리된 provider가 예외적으로 적용됩니다.

매개변수(Parameters)¶

Object - myProvider: :ref:Provider를 검증합니다. <web3-providers>.

반환값 (Return)¶

Boolean

예시 (예시 (Example))¶

var Web3 = require('web3');
var web3 = new Web3('http://localhost:8545');
// 또는
var web3 = new Web3(new Web3.providers.HttpProvider('http://localhost:8545'));

// provider를 변경합니다.
web3.setProvider('ws://localhost:8546');

// 또는

web3.setProvider(new Web3.providers.WebsocketProvider('ws://localhost:8546'));

// node.js 에서 IPC Provider를 사용합니다.
var net = require('net');
var web3 = new Web3('/Users/myuser/Library/Ethereum/geth.ipc', net); // mac os 의 경로

// 또는

var web3 = new Web3(new Web3.providers.IpcProvider('/Users/myuser/Library/Ethereum/geth.ipc', net)); // mac os 경로
// 윈도우의 경로 : "\\\\.\\pipe\\geth.ipc"
// 리눅스의 경로: "/users/myuser/.ethereum/geth.ipc"

providers(프로바이더)¶

web3.providers
web3.eth.providers
web3.shh.providers
web3.bzz.providers
...

Object with the following providers:

Object - HttpProvider:http 프로바이더는 더이상 사용되지 않게 되었습니다. 이것은 구독에 사용할 수 없을 것 입니다.

Object - WebsocketProvider: 웹 소켓 프로바이더는 레거시 브라우저에 대한 표준입니다.

Object - IpcProvider: IPC 프로바이더는 로컬노드를 사용하는 nodejs Dapp에 대한 표준입니다. 가장 안전한 연결을 제공합니다.

예시 (예시 (Example))¶

var Web3 = require('web3');
// use the given Provider, e.g in Mist, or instantiate a new websocket provider
//
var web3 = new Web3(Web3.givenProvider || 'ws://remotenode.com:8546');
// or
var web3 = new Web3(Web3.givenProvider || new Web3.providers.WebsocketProvider('ws://remotenode.com:8546'));

// Using the IPC provider in node.js
var net = require('net');

var web3 = new Web3('/Users/myuser/Library/Ethereum/geth.ipc', net); // mac os path
// or
var web3 = new Web3(new Web3.providers.IpcProvider('/Users/myuser/Library/Ethereum/geth.ipc', net)); // mac os path
// on windows the path is: "\\\\.\\pipe\\geth.ipc"
// on linux the path is: "/users/myuser/.ethereum/geth.ipc"

설정하기¶

// ====
// Http
// ====

var Web3HttpProvider = require('web3-providers-http');

var options = {
    keepAlive: true,
    withCredentials: false,
    timeout: 20000, // ms
    headers: [
        {
            name: 'Access-Control-Allow-Origin',
            value: '*'
        },
        {
            ...
        }
    ],
    agent: {
        http: http.Agent(...),
        baseUrl: ''
    }
};

var provider = new Web3HttpProvider('http://localhost:8545', options);

// ==========
// 웹소켓
// ==========

var Web3WsProvider = require('web3-providers-ws');

var options = {
    timeout: 30000, // ms

    // 크레덴셜을 url에 포함해서 사용할 수 있습니다 ex: ws://username:password@localhost:8546
    headers: {
      authorization: 'Basic username:password'
    },

    // 만약 결과값이 크다면 사용할 수 있습니다.
    clientConfig: {
      maxReceivedFrameSize: 100000000,   // bytes - default: 1MiB
      maxReceivedMessageSize: 100000000, // bytes - default: 8MiB
    },

    // 자동 재연결 활성화
    reconnect: {
        auto: true,
        delay: 5000, // ms
        maxAttempts: 5,
        onTimeout: false
    }
};

var ws = new Web3WsProvider('ws://localhost:8546', options);

HTTP 와 Websocket 프로바이더에 대한 정보를 더 얻으려면 밑에 링크를 참고할 수 있습니다.

givenProvider¶

web3.givenProvider
web3.eth.
web3.shh.givenProvider
web3.bzz.givenProvider
...

이더리움 호환 브라우저에서 web3.js 를 사용하면, 이 함수는 해당 브라우저의 네이티브 프로바이더를 반환합니다. 호환 브라우저가 아닐 경우, null 을 반환합니다.

반환값 (Returns)¶

Object: 설정된 givenProvider 또는 null.;

예시 (Example)¶

currentProvider¶

web3.currentProvider
web3.eth.currentProvider
web3.shh.currentProvider
web3.bzz.currentProvider
...

현재 provider 또는 null 을 반환합니다

반환값 (Returns)¶

Object: 현재 설정된 프로바이더 또는 null;

예시 (Example)¶

BatchRequest¶

new web3.BatchRequest()
new web3.eth.BatchRequest()
new web3.shh.BatchRequest()
new web3.bzz.BatchRequest()

없음

반환값 (Returns)¶

Object: 밑에 두 메소드로 이루어져 있습니다:

add(request): batch call에 요청 오브젝트를 추가합니다.

execute(): batch 요청을 실행합니다.

예시 (Example)¶

var contract = new web3.eth.Contract(abi, address);

var batch = new web3.BatchRequest();
batch.add(web3.eth.getBalance.request('0x0000000000000000000000000000000000000000', 'latest', callback));
batch.add(contract.methods.balance(address).call.request({from: '0x0000000000000000000000000000000000000000'}, callback2));
batch.execute();

extend¶

web3.extend(methods)
web3.eth.extend(methods)
web3.shh.extend(methods)
web3.bzz.extend(methods)
...

web3 모듈을 확장할 수 있게 합니다.

인자¶

methods - Object: 메서드 배열이 있는 확장 개체에서는 개체를 아래와 같이 설명한다:
- property - String: (optional) 모듈에 추가할 속성의 이름. 설정된 속성이 없는 경우 모듈에 직접 추가됨.
- methods - Array: 메서드 설명 배열
  
  name - String: 추가할 메서드의 이름.
  
  call - String: RPC 메서드의 이름.
  
  params - Number: (optional) 함수에 대한 파라미터의 갯수, 기본값은 0.
  
  inputFormatter - Array: (optional) 입력 포맷터 함수 배열. 각 어레이 항목은 함수 매개 변수에 응답하므로 일부 매개 변수를 포맷하지 않으려면 대신 null 을 추가하세요.
  
  outputFormatter - ``Function: (optional) 메서드의 출력을 포맷하는 데 사용할 수 있다.

반환값 (Returns)¶

Object: 확장 모듈을 반환합니다.

예시 (Example)¶

web3.extend({
    property: 'myModule',
    methods: [{
        name: 'getBalance',
        call: 'eth_getBalance',
        params: 2,
        inputFormatter: [web3.extend.formatters.inputAddressFormatter, web3.extend.formatters.inputDefaultBlockNumberFormatter],
        outputFormatter: web3.utils.hexToNumberString
    },{
        name: 'getGasPriceSuperFunction',
        call: 'eth_gasPriceSuper',
        params: 2,
        inputFormatter: [null, web3.utils.numberToHex]
    }]
});

web3.extend({
    methods: [{
        name: 'directCall',
        call: 'eth_callForFun',
    }]
});

console.log(web3);
> Web3 {
    myModule: {
        getBalance: function(){},
        getGasPriceSuperFunction: function(){}
    },
    directCall: function(){},
    eth: Eth {...},
    bzz: Bzz {...},
    ...
}

getId¶

web3.eth.net.getId([callback])
web3.bzz.net.getId([callback])
web3.shh.net.getId([callback])

Gets the current network ID.

Parameters¶

none

Returns¶

Promise returns Number: The network ID.

Example¶

web3.eth.net.getId()
.then(console.log);
> 1

isListening¶

web3.eth.net.isListening([callback])
web3.bzz.net.isListening([callback])
web3.shh.net.isListening([callback])

Checks if the node is listening for peers.

Parameters¶

none

Returns¶

Promise returns Boolean

Example¶

web3.eth.net.isListening()
.then(console.log);
> true

getPeerCount¶

web3.eth.net.getPeerCount([callback])
web3.bzz.net.getPeerCount([callback])
web3.shh.net.getPeerCount([callback])

Get the number of peers connected to.

Parameters¶

none

Returns¶

Promise returns Number

Example¶

web3.eth.net.getPeerCount()
.then(console.log);
> 25

getVersion¶

web3.shh.getVersion([callback])

Returns the version of the running whisper.

Parameters¶

Function - (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns¶

String - The version of the current whisper running.

Example¶

web3.shh.getVersion()
.then(console.log);
> "5.0"

getInfo¶

web3.shh.getInfo([callback])

Gets information about the current whisper node.

Parameters¶

Function - (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns¶

Object - The information of the node with the following properties:

messages - Number: Number of currently floating messages.

maxMessageSize - Number: The current message size limit in bytes.

memory - Number: The memory size of the floating messages in bytes.

minPow - Number: The current minimum PoW requirement.

Example¶

web3.shh.getInfo()
.then(console.log);
> {
    "minPow": 0.8,
    "maxMessageSize": 12345,
    "memory": 1234335,
    "messages": 20
}

setMaxMessageSize¶

web3.shh.setMaxMessageSize(size, [callback])

Sets the maximal message size allowed by this node. Incoming and outgoing messages with a larger size will be rejected. Whisper message size can never exceed the limit imposed by the underlying P2P protocol (10 Mb).

Parameters¶

Number - Message size in bytes.
Function - (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns¶

Boolean - true on success, error on failure.

Example¶

web3.shh.setMaxMessageSize(1234565)
.then(console.log);
> true

setMinPoW¶

web3.shh.setMinPoW(pow, [callback])

Sets the minimal PoW required by this node.

This experimental function was introduced for the future dynamic adjustment of PoW requirement. If the node is overwhelmed with messages, it should raise the PoW requirement and notify the peers. The new value should be set relative to the old value (e.g. double). The old value can be obtained via web3.shh.getInfo().

Parameters¶

Number - The new PoW requirement.
Function - (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns¶

Boolean - true on success, error on failure.

Example¶

web3.shh.setMinPoW(0.9)
.then(console.log);
> true

markTrustedPeer¶

web3.shh.markTrustedPeer(enode, [callback])

Marks specific peer trusted, which will allow it to send historic (expired) messages.

주석

This function is not adding new nodes, the node needs to be an existing peer.

Parameters¶

String - Enode of the trusted peer.
Function - (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns¶

Boolean - true on success, error on failure.

Example¶

web3.shh.markTrustedPeer()
.then(console.log);
> true

newKeyPair¶

web3.shh.newKeyPair([callback])

Generates a new public and private key pair for message decryption and encryption.

Parameters¶

Function - (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns¶

String - Key ID on success and an error on failure.

Example¶

web3.shh.newKeyPair()
.then(console.log);
> "5e57b9ffc2387e18636e0a3d0c56b023264c16e78a2adcba1303cefc685e610f"

addPrivateKey¶

web3.shh.addPrivateKey(privateKey, [callback])

Stores a key pair derived from a private key, and returns its ID.

Parameters¶

String - The private key as HEX bytes to import.
Function - (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns¶

String - Key ID on success and an error on failure.

Example¶

web3.shh.addPrivateKey('0x8bda3abeb454847b515fa9b404cede50b1cc63cfdeddd4999d074284b4c21e15')
.then(console.log);
> "3e22b9ffc2387e18636e0a3d0c56b023264c16e78a2adcba1303cefc685e610f"

deleteKeyPair¶

web3.shh.deleteKeyPair(id, [callback])

Deletes the specifies key if it exists.

Parameters¶

String - The key pair ID, returned by the creation functions (shh.newKeyPair and shh.addPrivateKey).
Function - (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns¶

Boolean - true on success, error on failure.

Example¶

web3.shh.deleteKeyPair('3e22b9ffc2387e18636e0a3d0c56b023264c16e78a2adcba1303cefc685e610f')
.then(console.log);
> true

hasKeyPair¶

web3.shh.hasKeyPair(id, [callback])

Checks if the whisper node has a private key of a key pair matching the given ID.

Parameters¶

String - The key pair ID, returned by the creation functions (shh.newKeyPair and shh.addPrivateKey).
Function - (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns¶

Boolean - true on if the key pair exist in the node, false if not. Error on failure.

Example¶

web3.shh.hasKeyPair('fe22b9ffc2387e18636e0a3d0c56b023264c16e78a2adcba1303cefc685e610f')
.then(console.log);
> true

getPublicKey¶

web3.shh.getPublicKey(id, [callback])

Returns the public key for a key pair ID.

Parameters¶

String - The key pair ID, returned by the creation functions (shh.newKeyPair and shh.addPrivateKey).
Function - (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns¶

String - Public key on success and an error on failure.

Example¶

web3.shh.getPublicKey('3e22b9ffc2387e18636e0a3d0c56b023264c16e78a2adcba1303cefc685e610f')
.then(console.log);
> "0x04d1574d4eab8f3dde4d2dc7ed2c4d699d77cbbdd09167b8fffa099652ce4df00c4c6e0263eafe05007a46fdf0c8d32b11aeabcd3abbc7b2bc2bb967368a68e9c6"

getPrivateKey¶

web3.shh.getPrivateKey(id, [callback])

Returns the private key for a key pair ID.

Parameters¶

String - The key pair ID, returned by the creation functions (shh.newKeyPair and shh.addPrivateKey).
Function - (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns¶

String - Private key on success and an error on failure.

Example¶

web3.shh.getPrivateKey('3e22b9ffc2387e18636e0a3d0c56b023264c16e78a2adcba1303cefc685e610f')
.then(console.log);
> "0x234234e22b9ffc2387e18636e0534534a3d0c56b0243567432453264c16e78a2adc"

newSymKey¶

web3.shh.newSymKey([callback])

Generates a random symmetric key and stores it under an ID, which is then returned. Will be used for encrypting and decrypting of messages where the sym key is known to both parties.

Parameters¶

Function - (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns¶

String - Key ID on success and an error on failure.

Example¶

web3.shh.newSymKey()
.then(console.log);
> "cec94d139ff51d7df1d228812b90c23ec1f909afa0840ed80f1e04030bb681e4"

addSymKey¶

web3.shh.addSymKey(symKey, [callback])

Stores the key, and returns its ID.

Parameters¶

String - The raw key for symmetric encryption as HEX bytes.
Function - (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns¶

String - Key ID on success and an error on failure.

Example¶

web3.shh.addSymKey('0x5e11b9ffc2387e18636e0a3d0c56b023264c16e78a2adcba1303cefc685e610f')
.then(console.log);
> "fea94d139ff51d7df1d228812b90c23ec1f909afa0840ed80f1e04030bb681e4"

generateSymKeyFromPassword¶

web3.shh.generateSymKeyFromPassword(password, [callback])

Generates the key from password, stores it, and returns its ID.

Parameters¶

String - A password to generate the sym key from.
Function - (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns¶

Promise<string>|undefined - Returns the Key ID as Promise or undefined if a callback is defined.

Example¶

web3.shh.generateSymKeyFromPassword('Never use this password - password!')
.then(console.log);
> "2e57b9ffc2387e18636e0a3d0c56b023264c16e78a2adcba1303cefc685e610f"

hasSymKey¶

web3.shh.hasSymKey(id, [callback])

Checks if there is a symmetric key stored with the given ID.

Parameters¶

String - The key pair ID, returned by the creation functions (shh.newSymKey, shh.addSymKey or shh.generateSymKeyFromPassword).
Function - (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns¶

Boolean - true on if the symmetric key exist in the node, false if not. Error on failure.

Example¶

web3.shh.hasSymKey('f6dcf21ed6a17bd78d8c4c63195ab997b3b65ea683705501eae82d32667adc92')
.then(console.log);
> true

getSymKey¶

web3.shh.getSymKey(id, [callback])

Returns the symmetric key associated with the given ID.

Parameters¶

String - The key pair ID, returned by the creation functions (shh.newKeyPair and shh.addPrivateKey).
Function - (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns¶

String - The raw symmetric key on success and an error on failure.

Example¶

web3.shh.getSymKey('af33b9ffc2387e18636e0a3d0c56b023264c16e78a2adcba1303cefc685e610f')
.then(console.log);
> "0xa82a520aff70f7a989098376e48ec128f25f767085e84d7fb995a9815eebff0a"

deleteSymKey¶

web3.shh.deleteSymKey(id, [callback])

Deletes the symmetric key associated with the given ID.

Parameters¶

String - The key pair ID, returned by the creation functions (shh.newKeyPair and shh.addPrivateKey).
Function - (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns¶

Boolean - true on if the symmetric key was deleted, error on failure.

Example¶

web3.shh.deleteSymKey('bf31b9ffc2387e18636e0a3d0c56b023264c16e78a2adcba1303cefc685e610f')
.then(console.log);
> true

post¶

web3.shh.post(object [, callback])

This method should be called, when we want to post whisper a message to the network.

Parameters¶

Object - The post object:
- symKeyID - String (optional): ID of symmetric key for message encryption (Either symKeyID or pubKey must be present. Can not be both.).
- pubKey - String (optional): The public key for message encryption (Either symKeyID or pubKey must be present. Can not be both.).
- sig - String (optional): The ID of the signing key.
- ttl - Number: Time-to-live in seconds.
- topic - String: 4 Bytes (mandatory when key is symmetric): Message topic.
- payload - String: The payload of the message to be encrypted.
- padding - Number (optional): Padding (byte array of arbitrary length).
- powTime - Number (optional)?: Maximal time in seconds to be spent on proof of work.
- powTarget - Number (optional)?: Minimal PoW target required for this message.
- targetPeer - Number (optional): Peer ID (for peer-to-peer message only).
callback - Function: (optional) Optional callback, returns an error object as first parameter and the result as second.

Returns¶

Promise - returns a promise. Upon success, the then function will be passed a string representing the hash of the sent message. On error, the catch function will be passed a string containing the reason for the error.

Example¶

var identities = [];
var subscription = null;

Promise.all([
    web3.shh.newSymKey().then((id) => {identities.push(id);}),
    web3.shh.newKeyPair().then((id) => {identities.push(id);})

]).then(() => {

    // will receive also its own message send, below
    subscription = shh.subscribe("messages", {
        symKeyID: identities[0],
        topics: ['0xffaadd11']
    }).on('data', console.log);

}).then(() => {
   web3.shh.post({
        symKeyID: identities[0], // encrypts using the sym key ID
        sig: identities[1], // signs the message using the keyPair ID
        ttl: 10,
        topic: '0xffaadd11',
        payload: '0xffffffdddddd1122',
        powTime: 3,
        powTarget: 0.5
    }).then(h => console.log(`Message with hash ${h} was successfuly sent`))
    .catch(err => console.log("Error: ", err));
});

subscribe¶

web3.shh.subscribe('messages', options [, callback])

Subscribe for incoming whisper messages.

Parameters¶

"messages" - String: Type of the subscription.
Object - The subscription options:
- symKeyID - String: ID of symmetric key for message decryption.
- privateKeyID - String: ID of private (asymmetric) key for message decryption.
- sig - String (optional): Public key of the signature, to verify.
- topics- Array (optional when "privateKeyID" key is given): Filters messages by this topic(s). Each topic must be a 4 bytes HEX string.
- minPow - Number (optional): Minimal PoW requirement for incoming messages.
- allowP2P - Boolean (optional): Indicates if this filter allows processing of direct peer-to-peer messages (which are not to be forwarded any further, because they might be expired). This might be the case in some very rare cases, e.g. if you intend to communicate to MailServers, etc.
callback - Function: (optional) Optional callback, returns an error object as first parameter and the result as second. Will be called for each incoming subscription, and the subscription itself as 3 parameter.

Notification Returns¶

Object - The incoming message:

hash - String: Hash of the enveloped message.

sig - String: Public key which signed this message.

recipientPublicKey - String: The recipients public key.

timestamp - String: Unix timestamp of the message genertion.

ttl - Number: Time-to-live in seconds.

topic - String: 4 Bytes HEX string message topic.

payload - String: Decrypted payload.

padding - Number: Optional padding (byte array of arbitrary length).

pow - Number: Proof of work value.

Example¶

web3.shh.subscribe('messages', {
    symKeyID: 'bf31b9ffc2387e18636e0a3d0c56b023264c16e78a2adcba1303cefc685e610f',
    sig: '0x04d1574d4eab8f3dde4d2dc7ed2c4d699d77cbbdd09167b8fffa099652ce4df00c4c6e0263eafe05007a46fdf0c8d32b11aeabcd3abbc7b2bc2bb967368a68e9c6',
    ttl: 20,
    topics: ['0xffddaa11'],
    minPow: 0.8,
}, function(error, message, subscription){

    console.log(message);
    > {
        "hash": "0x4158eb81ad8e30cfcee67f20b1372983d388f1243a96e39f94fd2797b1e9c78e",
        "padding": "0xc15f786f34e5cef0fef6ce7c1185d799ecdb5ebca72b3310648c5588db2e99a0d73301c7a8d90115a91213f0bc9c72295fbaf584bf14dc97800550ea53577c9fb57c0249caeb081733b4e605cdb1a6011cee8b6d8fddb972c2b90157e23ba3baae6c68d4f0b5822242bb2c4cd821b9568d3033f10ec1114f641668fc1083bf79ebb9f5c15457b538249a97b22a4bcc4f02f06dec7318c16758f7c008001c2e14eba67d26218ec7502ad6ba81b2402159d7c29b068b8937892e3d4f0d4ad1fb9be5e66fb61d3d21a1c3163bce74c0a9d16891e2573146aa92ecd7b91ea96a6987ece052edc5ffb620a8987a83ac5b8b6140d8df6e92e64251bf3a2cec0cca",
        "payload": "0xdeadbeaf",
        "pow": 0.5371803278688525,
        "recipientPublicKey": null,
        "sig": null,
        "timestamp": 1496991876,
        "topic": "0x01020304",
        "ttl": 50
    }
})
// or
.on('data', function(message){ ... });

clearSubscriptions¶

web3.shh.clearSubscriptions()

Resets subscriptions.

주석

This will not reset subscriptions from other packages like web3-eth, as they use their own requestManager.

Parameters¶

Boolean: If true it keeps the "syncing" subscription.

Returns¶

Boolean

Example¶

web3.shh.subscribe('messages', {...} ,function(){ ... });

...

web3.shh.clearSubscriptions();

newMessageFilter¶

web3.shh.newMessageFilter(options)

Create a new filter within the node. This filter can be used to poll for new messages that match the set of criteria.

Parameters¶

Object: See web3.shh.subscribe() options for details.

Returns¶

String: The filter ID.

Example¶

web3.shh.newMessageFilter()
.then(console.log);
> "2b47fbafb3cce24570812a82e6e93cd9e2551bbc4823f6548ff0d82d2206b326"

deleteMessageFilter¶

web3.shh.deleteMessageFilter(id)

Deletes a message filter in the node.

Parameters¶

String: The filter ID created with shh.newMessageFilter().

Returns¶

Boolean: true on success, error on failure.

Example¶

web3.shh.deleteMessageFilter('2b47fbafb3cce24570812a82e6e93cd9e2551bbc4823f6548ff0d82d2206b326')
.then(console.log);
> true

getFilterMessages¶

web3.shh.getFilterMessages(id)

Retrieve messages that match the filter criteria and are received between the last time this function was called and now.

Parameters¶

String: The filter ID created with shh.newMessageFilter().

Returns¶

Array: Returns an array of message objects like web3.shh.subscribe() notification returns

Example¶

web3.shh.getFilterMessages('2b47fbafb3cce24570812a82e6e93cd9e2551bbc4823f6548ff0d82d2206b326')
.then(console.log);
> [{
    "hash": "0x4158eb81ad8e30cfcee67f20b1372983d388f1243a96e39f94fd2797b1e9c78e",
    "padding": "0xc15f786f34e5cef0fef6ce7c1185d799ecdb5ebca72b3310648c5588db2e99a0d73301c7a8d90115a91213f0bc9c72295fbaf584bf14dc97800550ea53577c9fb57c0249caeb081733b4e605cdb1a6011cee8b6d8fddb972c2b90157e23ba3baae6c68d4f0b5822242bb2c4cd821b9568d3033f10ec1114f641668fc1083bf79ebb9f5c15457b538249a97b22a4bcc4f02f06dec7318c16758f7c008001c2e14eba67d26218ec7502ad6ba81b2402159d7c29b068b8937892e3d4f0d4ad1fb9be5e66fb61d3d21a1c3163bce74c0a9d16891e2573146aa92ecd7b91ea96a6987ece052edc5ffb620a8987a83ac5b8b6140d8df6e92e64251bf3a2cec0cca",
    "payload": "0xdeadbeaf",
    "pow": 0.5371803278688525,
    "recipientPublicKey": null,
    "sig": null,
    "timestamp": 1496991876,
    "topic": "0x01020304",
    "ttl": 50
},{...}]