js-waku-examples/rln-js/index.html

413 lines
15 KiB
HTML
Raw Normal View History

2022-09-26 04:01:38 +00:00
<!DOCTYPE html>
<html lang='en'>
<head>
<meta charset='UTF-8'/>
<meta content='width=device-width, initial-scale=1.0' name='viewport'/>
<title>JS-Waku light node example</title>
</head>
<body>
2022-10-05 02:46:56 +00:00
<div><h1>Waku RLN</h1>
<div><span id='status'></span></div>
<div><h2>Blockchain</h2>
<div><h3>Wallet</h3>
<p>Address: <span id='address'></span></p>
<button id='connect-wallet' type='button'>Connect Wallet</button>
</div>
<div><h3>Contract Data</h3>
<p>Latest membership id on contract: <span id='latest-membership-id'></span></p>
<button disabled id='retrieve-rln-details' type='button'>Retrieve contract state from blockchain
</button>
</div>
2022-10-04 05:31:18 +00:00
</div>
2022-10-05 02:46:56 +00:00
<div><h2>Credentials</h2>
<p>You can either generate new credentials:</p>
<button disabled id='generate-credentials' type='button'>Generate RLN Credentials</button>
<p>Or import existing ones:</p>
2022-09-27 15:05:42 +00:00
<label for="membership-id">Membership ID (your index in the RLN smart contract):</label>
<input id="membership-id" name="membership-id" type="text"><br>
<label for="id-key">RLN Identity Key (hex string):</label>
<input id="id-key" name="id-key" type="text"><br>
<label for="commitment-key">RLN Commitment Key (hex string):</label>
<input id="commitment-key" name="commitment-key" type="text"><br>
<button disabled id='import-button' type='button'>Import RLN Credentials</button>
2022-10-05 02:46:56 +00:00
<p><strong>Membership id: </strong><span id="id">none</span></p>
<p><strong>Key: </strong><span id="key">none</span></p>
<p><strong>Commitment: </strong><span id="commitment">none</span></p>
2022-10-04 05:31:18 +00:00
<button disabled id='register-button' type='button'>Register Credentials in Contract</button>
2022-09-26 04:01:38 +00:00
</div>
2022-10-05 02:46:56 +00:00
<div><h1>Waku</h1>
<div id="waku-status"></div>
<label for='remote-multiaddr'>Remote peer's multiaddr</label>
<input id='remote-multiaddr'
type='text'
value="/dns4/node-01.ac-cn-hongkong-c.wakuv2.test.statusim.net/tcp/443/wss/p2p/16Uiu2HAkvWiyFsgRhuJEb9JfjYxEkoHLgnUQmr1N5mKWnYjxYRVm">
<button disabled id='dial' type='button'>Dial</button>
<br/>
<label for='nick-input'>Your nickname</label>
<input id='nick-input' placeholder='Choose a nickname' type='text'>
<button disabled id='set-nick' type='button'>Set nickname</button>
<br/>
<label for='textInput'>Message text</label>
<input disabled id='textInput' placeholder='Type your message here' type='text'>
<button disabled id='sendButton' type='button'>Send message using Light Push</button>
<span id='sending-status'></span>
<br/>
<div id="messages"></div>
</div>
2022-09-26 04:01:38 +00:00
</div>
<script type='module'>
2022-10-04 05:31:18 +00:00
import {utils} from 'https://unpkg.com/js-waku@0.29.0-29436ea/bundle/index.js';
import {createLightNode} from 'https://unpkg.com/js-waku@0.29.0-29436ea/bundle/lib/create_waku.js'
import {waitForRemotePeer} from 'https://unpkg.com/js-waku@0.29.0-29436ea/bundle/lib/wait_for_remote_peer.js'
2022-10-05 02:46:56 +00:00
import {
EncoderV0,
DecoderV0
} from 'https://unpkg.com/js-waku@0.29.0-29436ea/bundle/lib/waku_message/version_0.js'
2022-09-27 15:05:42 +00:00
import {protobuf} from "https://taisukef.github.io/protobuf-es.js/dist/protobuf-es.js";
2022-10-05 02:46:56 +00:00
import {
create,
MembershipKey,
RLNDecoder,
RLNEncoder
} from "https://unpkg.com/@waku/rln@0.0.10/bundle/index.js";
2022-10-04 05:31:18 +00:00
import {ethers} from "https://unpkg.com/ethers@5.0.7/dist/ethers-all.esm.min.js"
2022-09-26 04:01:38 +00:00
2022-10-05 02:46:56 +00:00
const statusSpan = document.getElementById('status')
// Blockchain Elements
const addressDiv = document.getElementById('address');
const connectWalletButton = document.getElementById('connect-wallet');
const latestMembershipSpan = document.getElementById('latest-membership-id')
const retrieveRLNDetailsButton = document.getElementById('retrieve-rln-details')
// Credentials Elements
2022-09-26 04:01:38 +00:00
const generateCredsButton = document.getElementById('generate-credentials')
2022-10-05 02:46:56 +00:00
2022-09-27 15:05:42 +00:00
const membershipIdInput = document.getElementById('membership-id')
const identityKeyInput = document.getElementById('id-key')
const commitmentKeyInput = document.getElementById('commitment-key')
const importButton = document.getElementById('import-button')
2022-10-05 02:46:56 +00:00
const idDiv = document.getElementById('id');
const keyDiv = document.getElementById('key');
const commitmentDiv = document.getElementById('commitment');
2022-10-04 05:31:18 +00:00
const registerButton = document.getElementById('register-button');
2022-09-26 04:01:38 +00:00
2022-09-27 15:05:42 +00:00
// Waku Elements
2022-10-05 02:46:56 +00:00
const statusDiv = document.getElementById('waku-status');
2022-09-27 15:05:42 +00:00
2022-10-04 05:31:18 +00:00
const remoteMultiAddrInput = document.getElementById('remote-multiaddr')
2022-10-05 02:46:56 +00:00
const dialButton = document.getElementById('dial')
2022-10-04 05:31:18 +00:00
2022-09-27 15:05:42 +00:00
const nicknameInput = document.getElementById('nick-input')
const setNickButton = document.getElementById('set-nick')
const textInput = document.getElementById('textInput');
const sendButton = document.getElementById('sendButton');
2022-10-05 02:46:56 +00:00
const sendingStatusSpan = document.getElementById('sending-status');
2022-09-27 15:05:42 +00:00
const messagesDiv = document.getElementById('messages')
2022-10-05 02:46:56 +00:00
let membershipId, membershipKey, encoder, node, nodeConnected, nick, rlnInstance;
2022-10-04 05:31:18 +00:00
let retrievedRLNEvents = false;
2022-10-05 02:46:56 +00:00
const rlnInstancePromise = create();
2022-10-04 05:31:18 +00:00
// Load zero-kit WASM blob.
2022-10-05 02:46:56 +00:00
statusSpan.innerText = 'WASM Blob download in progress...'
rlnInstancePromise.then((_rlnInstance) => {
rlnInstance = _rlnInstance
statusSpan.innerText = 'WASM Blob download in progress... done!'
updateFields()
setTimeout(() => {
statusSpan.innerText = ''
}, 5000)
})
const ContentTopic = "/toy-chat/2/luzhou/proto";
// Protobuf
const ProtoChatMessage = new protobuf.Type("ChatMessage")
.add(new protobuf.Field("timestamp", 1, "uint64"))
.add(new protobuf.Field("nick", 2, "string"))
.add(new protobuf.Field("text", 3, "bytes"));
// Function to update the fields to guide the user by disabling buttons.
2022-09-27 15:05:42 +00:00
const updateFields = () => {
2022-10-04 05:31:18 +00:00
if (membershipKey) {
2022-09-27 15:05:42 +00:00
keyDiv.innerHTML = utils.bytesToHex(membershipKey.IDKey)
commitmentDiv.innerHTML = utils.bytesToHex(membershipKey.IDCommitment)
2022-10-04 05:31:18 +00:00
idDiv.innerHTML = membershipId || "-"
2022-10-05 02:46:56 +00:00
if (membershipId && rlnInstance) {
2022-10-04 05:31:18 +00:00
encoder = new RLNEncoder(
new EncoderV0(ContentTopic),
rlnInstance,
membershipId,
membershipKey
);
}
2022-09-27 15:05:42 +00:00
}
2022-10-05 02:46:56 +00:00
generateCredsButton.disabled = !rlnInstance
registerButton.disabled = !(membershipKey && retrievedRLNEvents && !membershipId)
2022-09-27 15:05:42 +00:00
importButton.disabled = !(membershipIdInput.value
&& identityKeyInput.value
&& commitmentKeyInput.value);
const readyToSend = (membershipKey && membershipId && nodeConnected && nick)
textInput.disabled = !readyToSend;
sendButton.disabled = !readyToSend;
setNickButton.disabled = !nicknameInput.value;
2022-10-05 02:46:56 +00:00
dialButton.disabled = !(node && node.isStarted() && retrievedRLNEvents)
retrieveRLNDetailsButton.disabled = !rlnInstance && !retrievedRLNEvents;
2022-09-27 15:05:42 +00:00
}
2022-10-05 02:46:56 +00:00
// Blockchain
2022-09-26 04:01:38 +00:00
generateCredsButton.onclick = () => {
2022-09-27 15:05:42 +00:00
membershipKey = rlnInstance.generateMembershipKey()
2022-10-04 05:31:18 +00:00
updateFields();
2022-09-27 15:05:42 +00:00
}
membershipIdInput.onchange = updateFields;
identityKeyInput.onchange = updateFields;
commitmentKeyInput.onchange = updateFields;
importButton.onclick = () => {
const idKey = utils.hexToBytes(identityKeyInput.value)
const idCommitment = utils.hexToBytes(commitmentKeyInput.value)
membershipKey = new MembershipKey(idKey, idCommitment)
membershipId = membershipIdInput.value;
updateFields()
2022-09-26 04:01:38 +00:00
}
2022-10-04 05:31:18 +00:00
const checkChain = async (chainId) => {
retrieveRLNDetailsButton.disabled = retrievedRLNEvents || chainId !== 5;
registerButton.disabled = !(chainId === 5 && retrievedRLNEvents);
if (chainId !== 5) {
alert("Switch to Goerli")
}
}
const rlnDeployBlk = 7677135;
const rlnAddress = "0x367F3e869cF2E1DD28644E308b42652cb6fcDA72";
const rlnAbi = [
"function MEMBERSHIP_DEPOSIT() public view returns(uint256)",
"function register(uint256 pubkey) external payable",
"function withdraw(uint256 secret, uint256 _pubkeyIndex, address payable receiver) external",
"event MemberRegistered(uint256 pubkey, uint256 index)",
"event MemberWithdrawn(uint256 pubkey, uint256 index)"
];
const provider = new ethers.providers.Web3Provider(window.ethereum, "any");
let accounts;
let rlnContract;
const handleMembership = (pubkey, index) => {
try {
const idCommitment = ethers.utils.zeroPad(ethers.utils.arrayify(pubkey), 32);
rlnInstance.insertMember(idCommitment);
2022-10-05 02:46:56 +00:00
const indexInt = index.toNumber()
if (!latestMembershipSpan.innerText || indexInt > latestMembershipSpan.innerText) {
latestMembershipSpan.innerText = indexInt
}
console.debug("IDCommitment registered in tree", idCommitment, indexInt);
2022-10-04 05:31:18 +00:00
} catch (err) {
2022-10-05 02:46:56 +00:00
console.error(err); // TODO: the merkle tree can be in a wrong state. The app should be disabled
2022-10-04 05:31:18 +00:00
}
}
const setAccounts = acc => {
accounts = acc;
2022-10-05 02:46:56 +00:00
addressDiv.innerHTML = accounts.length ? accounts[0] : "";
2022-10-04 05:31:18 +00:00
}
connectWalletButton.onclick = async () => {
try {
accounts = await provider.send("eth_requestAccounts", []);
setAccounts(accounts);
2022-10-05 02:46:56 +00:00
const network = await provider.getNetwork();
checkChain(network.chainId);
2022-10-04 05:31:18 +00:00
} catch (e) {
console.log("No web3 provider available", e);
}
};
retrieveRLNDetailsButton.onclick = async () => {
rlnContract = new ethers.Contract(rlnAddress, rlnAbi, provider);
const filter = rlnContract.filters.MemberRegistered()
// populating merkle tree:
const alreadyRegisteredMembers = await rlnContract.queryFilter(filter, rlnDeployBlk)
alreadyRegisteredMembers.forEach(event => {
handleMembership(event.args.pubkey, event.args.index, event);
});
retrievedRLNEvents = true;
// reacting to new registrations
rlnContract.on(filter, (pubkey, index, event) => {
handleMembership(event.args.pubkey, event.args.index, event);
});
2022-10-05 02:46:56 +00:00
updateFields()
2022-10-04 05:31:18 +00:00
}
window.ethereum.on('accountsChanged', setAccounts);
window.ethereum.on('chainChanged', chainId => {
checkChain(parseInt(chainId, 16));
});
registerButton.onclick = async () => {
try {
registerButton.disabled = true;
const pubkey = ethers.BigNumber.from(membershipKey.IDCommitment);
const price = await rlnContract.MEMBERSHIP_DEPOSIT();
const signer = provider.getSigner()
const rlnContractWithSigner = rlnContract.connect(signer);
const txResponse = await rlnContractWithSigner.register(pubkey, {value: price});
console.log("Transaction broadcasted:", txResponse);
const txReceipt = await txResponse.wait();
console.log("Transaction receipt", txReceipt);
// Update membershipId
membershipId = txReceipt.events[0].args.index.toNumber();
console.log("Obtained index for current membership credentials", membershipId);
updateFields();
registerButton.disabled = false;
} catch (err) {
alert(err);
registerButton.disabled = false;
}
}
2022-09-26 04:01:38 +00:00
// Waku
2022-09-27 15:05:42 +00:00
nicknameInput.onchange = updateFields
setNickButton.onclick = () => {
nick = nicknameInput.value;
updateFields()
}
2022-09-26 04:01:38 +00:00
let messages = [];
2022-10-05 02:46:56 +00:00
const updateMessages = () => {
messagesDiv.innerHTML = "<ul>"
messages.forEach(msg => {
messagesDiv.innerHTML += `<li>${msg.msg} - [epoch: ${msg.epoch}, proof: ${msg.proofState} ]</li>`
if (msg.proofState === "verifying...") {
console.log("Verifying proof")
const res = msg.verify()
console.log("proof verified!", res)
if (res === undefined) {
msg.proofState = "no proof attached"
} else if (res) {
msg.proofState = "verified."
} else {
msg.proofState = "invalid!"
}
updateMessages()
}
})
messagesDiv.innerHTML += "</ul>"
2022-09-26 04:01:38 +00:00
}
2022-09-27 15:05:42 +00:00
const callback = (wakuMessage) => {
const {timestamp, nick, text} = ProtoChatMessage.decode(wakuMessage.payload)
const time = new Date();
time.setTime(Number(timestamp));
2022-09-26 04:01:38 +00:00
2022-10-05 02:46:56 +00:00
let proofState, verify;
if (typeof wakuMessage.verify === "undefined") {
proofState = "no proof attached";
} else {
verify = wakuMessage.verify.bind(wakuMessage);
proofState = "verifying...";
}
messages.push({
msg: `(${nick}) <strong>${utils.bytesToUtf8(text)}</strong> <i>[${time.toString()}]</i>`,
epoch: wakuMessage.epoch,
verify,
proofState
});
updateMessages()
2022-09-27 15:05:42 +00:00
}
2022-09-26 04:01:38 +00:00
2022-10-05 02:46:56 +00:00
2022-09-27 15:05:42 +00:00
(async () => {
statusDiv.innerHTML = '<p>Creating Waku node.</p>';
2022-10-04 05:31:18 +00:00
node = await createLightNode();
2022-09-27 15:05:42 +00:00
statusDiv.innerHTML = '<p>Starting Waku node.</p>';
await node.start();
statusDiv.innerHTML = '<p>Waku node started.</p>';
2022-10-04 05:31:18 +00:00
updateFields()
})()
dialButton.onclick = async () => {
const ma = remoteMultiAddrInput.value
if (!ma) {
statusDiv.innerHTML = '<p>Error: No multiaddr provided.</p>';
return;
}
statusDiv.innerHTML = '<p>Dialing peer.</p>';
await node.dial(ma, ["filter", "lightpush"])
2022-09-26 04:01:38 +00:00
await waitForRemotePeer(node, ["filter", "lightpush"]);
2022-09-27 15:05:42 +00:00
statusDiv.innerHTML = '<p>Waku node connected.</p>';
2022-10-05 02:46:56 +00:00
await rlnInstancePromise;
const decoder = new RLNDecoder(rlnInstance, new DecoderV0(ContentTopic));
2022-09-26 04:01:38 +00:00
await node.filter.subscribe([decoder], callback)
2022-10-04 05:31:18 +00:00
statusDiv.innerHTML = '<p>Waku node subscribed.</p>';
2022-09-27 15:05:42 +00:00
nodeConnected = true;
2022-10-04 05:31:18 +00:00
}
2022-09-26 04:01:38 +00:00
sendButton.onclick = async () => {
2022-09-27 15:05:42 +00:00
const text = utils.utf8ToBytes(textInput.value);
const timestamp = new Date();
const msg = ProtoChatMessage.create({text, nick, timestamp: timestamp.valueOf()});
const payload = ProtoChatMessage.encode(msg).finish();
console.log("Sending message with proof...")
2022-10-05 02:46:56 +00:00
sendingStatusSpan.innerText = 'sending...'
2022-09-27 15:05:42 +00:00
await node.lightPush.push(encoder, {payload, timestamp});
2022-10-05 02:46:56 +00:00
sendingStatusSpan.innerText = 'sent!'
2022-09-27 15:05:42 +00:00
console.log("Message sent!")
2022-09-26 04:01:38 +00:00
textInput.value = null;
2022-10-05 02:46:56 +00:00
setTimeout(() => {
sendingStatusSpan.innerText = ''
}, 5000)
2022-09-26 04:01:38 +00:00
};
</script>
</body>
</html>