Releases: waku-org/js-waku
Releases · waku-org/js-waku
Release 0.14.0
Added
- If the
callback
function passed toWakuStore.queryHistory
returnstrue
, then no further pages are retrieved from the store. - Use webpack to build UMD bundle of the library, see README for usage.
Changed
- Breaking: Renamed
WakuStore.QueryOptions
'sdirection
topageDirection
(and its type) as it only affects the page ordering,
not the ordering of messages with the page.
Fixed
- Docs: Ensure that
WakuStore
'sQueryOptions
documentation is available online.
Release 0.13.1
Fixed
Error: Bootstrap requires a list of peer addresses
error when usingbootstrap: true
inWaku.create
.
Release 0.12.2
Fixed
- hot fix:
Error: Bootstrap requires a list of peer addresses
error when usingbootstrap: true
inWaku.create
.
Release 0.13.0
Changed
- Upgrade libp2p libraries: @chainsafe/[email protected], [email protected], [email protected].
- Connects to a limited number of bootstrap nodes, defaults to 1.
Release 0.12.1
Changed
- hot fix: Connects to a limited number of bootstrap nodes, defaults to 1.
Release 0.12.0
Added
- Examples (eth-pm): Encrypt Public Key Messages using symmetric encryption.
- Guides: Encrypt messages using Waku Message Version 1.
- Allow passing decryption keys in hex string format.
- Allow passing decryption keys to
WakuStore
instance to avoid having to pass them at everyqueryHistory
call. - Allow passing decryption keys to
Waku
instance to avoid having to pass them to bothWakuRelay
andWakuStore
. Waku.waitForConnectedPeer
helper to ensure that we are connected to Waku peers when using the bootstrap option.
Changed
- Breaking: Moved
startTime
andendTime
for history queries to atimeFilter
property as both or neither must be passed; passing only one parameter is not supported. - Renamed and promote the usage of
generateSymmetricKey()
to generate random symmetric keys. - Improved errors thrown by
WakuStore.queryHistory
.
Fixed
- Buffer concat error when using symmetric encryption in the browser.
Release 0.11.0
Added
- Examples: New Ethereum Private Message Using Wallet Encryption Web App
example that demonstrates the usage ofeth_encrypt
API (available on Metamask) and EIP-712 for typed structured data signing. - New
bootstrap
option forWaku.create
to easily connect to Waku nodes upon start up. - Support for
startTime
andendTime
in Store queries to filter by time window as per 21/WAKU2-FTSTORE.
Changed
- Renamed
discover.getStatusFleetNodes
todiscovery.getBootstrapNodes
;
Changed the API to allow retrieval of bootstrap nodes from other sources. - Examples: Renamed
eth-dm
toeth-pm
; "Direct Message" can lead to confusion with "Direct Connection" that
refers to low latency network connections. - Examples (eth-pm): Use sign typed data EIP-712 instead of personal sign.
- Upgraded dependencies to remove warning at installation.
- Breaking: Moved
DefaultPubSubTopic
towaku.ts
and fixed the casing. - Breaking: Rename all
pubsubTopic
occurrences topubSubTopic
, across all interfaces.
Removed
- Examples (cli-chat): The focus of this library is Web environment;
Several examples now cover usage of Waku Relay and Waku Store making cli-chat example obsolete;
web-chat POC should be preferred to use the TOY-CHAT protocol. ChatMessage
has been moved from js-waku to web-chat example;
it is a type used for the TOY-CHAT protocol;
js-waku users should not build on top if this toy protocol and instead design message data structures appropriate to their use case.- Unused dependencies & scripts.
Release 0.10.0
Added
- Relay and ReactJS guides and examples
(#56).
Changed
- Breaking: The
WakuMessage
APIs have been changed to movecontentTopic
out of the optional parameters.
Removed
- Examples (web-chat): Remove broken
/fleet
command. - Breaking: Removed
DefaultContentTopic
as developers must choose a content topic for their app;
recommendations for content topic can be found at https://rfc.vac.dev/spec/23/.
Fixed
WakuMessage.payloadAsUtf8
returning garbage on utf-8 non-ascii characters.ChatMessage.payloadAsUtf8
returning garbage on utf-8 non-ascii characters.
[0.9.0] - 2021-07-26
Changed
- Breaking: Store Response Protobuf changed to align with nim-waku v0.5
(nim-waku#676).
Release 0.9.0
Changed
- Breaking: Store Response Protobuf changed to align with nim-waku v0.5
(nim-waku#676).
Release 0.8.1
Added
- Examples (web-chat): New
/fleet
command to switch connection between Status prod and test fleets. - Export
generatePrivateKey
andgetPublicKey
directly from the root. - Usage of the encryption and signature APIs to the readme.
Changed
- Breaking: Renamed
WakuRelay.(add|delete)PrivateDecryptionKey
toWakuRelay.(add|delete)DecryptionKey
to make it clearer that it accepts both symmetric keys and asymmetric private keys.
Fix
- Align
WakuMessage
readme example with actual code behaviour.