131 lines
5.6 KiB
Markdown
131 lines
5.6 KiB
Markdown
# Gas relayer protocol
|
|
|
|
Current implementation of gas relayers use whisper as a communication medium to broadcast availability, and transaction details. As such, the messages require specific settings and format to be interpreted correctly by the relayer network.
|
|
|
|
#### Sending a message to the gas relayer network (all accounts and private keys should be replaced by your own)
|
|
```
|
|
shh.post({
|
|
symKeyID: SYM_KEY, // If requesting availability
|
|
pubKey: PUBLIC_KEY_ID, // If sending a transaction
|
|
sig: WHISPER_KEY_ID,
|
|
ttl: 10,
|
|
powTarget: 0.002,
|
|
powTime: 1,
|
|
topic: TOPIC_NAME,
|
|
payload: PAYLOAD_BYTES
|
|
}).then(......)
|
|
```
|
|
|
|
- `symKeyID: SYM_KEY` must contain the whisper symmetric key used. It is shown on the console when running the service with `node`. With the provided configuration you can use the symmetric key `0xd0d905c1c62b810b787141430417caf2b3f54cffadb395b7bb39fdeb8f17266b`. Only used when asking for relayer availability.
|
|
- `pubKey: PUBLIC_KEY_ID`. After asking for availability, once the user decides on a relayer, it needs to set the `pubKey` attribute with the relayer public key (received in the availability reply in the `sig` attribute of the message).
|
|
- `WHISPER_KEY_ID` represents a keypair registered on your node, that will be used to sign the message. Can be generated with `web3W.shh.newKeyPair()`
|
|
- `TOPIC_NAME` must contain one of the topic names generated based on converting the contract name to hex, and taking the first 8 bytes. For the provided configuration the following topics are available:
|
|
- - IdentityGasRelay: `0x4964656e`
|
|
- - SNTController: `0x534e5443`
|
|
- `PAYLOAD_BYTES` a hex string that contains details on the operation to perform.
|
|
|
|
|
|
#### Polling for gas relayers
|
|
The first step is asking the relayers for their availability. The message payload needs to be the hex string representation of a JSON object with a specific structure:
|
|
|
|
```
|
|
const payload = web3.utils.toHex({
|
|
'contract': "0xContractToInvoke",
|
|
'address': web3.eth.defaultAccount,
|
|
'action': 'availability',
|
|
'token': "0xGasTokenAddress",
|
|
'gasPrice': 1234
|
|
});
|
|
```
|
|
|
|
- `contract` is the address of the contract that will perform the operation, in this case it can be an Identity, or the SNTController.
|
|
- `address` The address that will sign the transactions. Normally it's `web3.eth.defaultAccount`
|
|
- `gasToken`: token used for paying the gas cost
|
|
- `gasPrice`: The gas price used for the transaction
|
|
|
|
This is a example code of how to send an 'availability' message:
|
|
|
|
```
|
|
const whisperKeyPairID = await web3W.shh.newKeyPair();
|
|
|
|
const msgObj = {
|
|
symKeyId: "0xd0d905c1c62b810b787141430417caf2b3f54cffadb395b7bb39fdeb8f17266b",
|
|
sig: whisperKeyPairID,
|
|
ttl: 10,
|
|
powTarget: 0.002,
|
|
powTime: 1,
|
|
topic: "0x4964656e",
|
|
payload: web3.utils.toHex({
|
|
'contract': "0x692a70d2e424a56d2c6c27aa97d1a86395877b3a",
|
|
'address': web3.eth.defaultAccount
|
|
'action': 'availability',
|
|
'gasToken': "0x744d70fdbe2ba4cf95131626614a1763df805b9e",
|
|
'gasPrice': 40000000000 // 40 gwei equivalent in SNT
|
|
})
|
|
};
|
|
|
|
|
|
web3.shh.post(msgObj)
|
|
.then((err, result) => {
|
|
console.log(result);
|
|
console.log(err);
|
|
});
|
|
```
|
|
|
|
When it replies, you need to extract the `sig` attribute to obtain the relayer's public key
|
|
|
|
#### Sending transaction details
|
|
|
|
Sending a transaction is similar to the previous operation, except that we send the message to an specific node, we use the action `transaction`, and also we send a `encodedFunctionCall` with the details of the transaction to execute.
|
|
|
|
From the list of relayers received via whisper messages, you need to extract the `message.sig` to obtain the `pubKey`. This value is used to send the transaction to that specific relayer.
|
|
|
|
`encodedFunCall` is the hex data used obtained from `web3.eth.abi.encodeFunctionCall` for the specific function we want to invoke.
|
|
|
|
If we were to execute `callGasRelayed(address,uint256,bytes,uint256,uint256,uint256,address,bytes)` (part of the IdentityGasRelay) in contract `0x692a70d2e424a56d2c6c27aa97d1a86395877b3a`, with these values: `"0x11223344556677889900998877665544332211",100,"0x00",1,10,20,"0x1122334455112233445511223344551122334455"`, "0x1122334455", `PAYLOAD_BYTES` can be prepared as follows:
|
|
|
|
```
|
|
// The following values are created obtained when polling for relayers
|
|
const whisperKeyPairID = await web3W.shh.newKeyPair();
|
|
const relayerPubKey = "0xRELAYER_PUBLIC_KEY_HERE";
|
|
// ...
|
|
// ...
|
|
const jsonAbi = ABIOfIdentityGasRelay.find(x => x.name == "callGasRelayed");
|
|
|
|
const funCall = web3.eth.abi.encodeFunctionCall(jsonAbi,
|
|
[
|
|
"0x11223344556677889900998877665544332211",
|
|
100,
|
|
"0x00",
|
|
1,
|
|
10,
|
|
20,
|
|
"0x1122334455112233445511223344551122334455",
|
|
"0x1122334455"
|
|
]);
|
|
|
|
const msgObj = {
|
|
pubKey: relayerPubKey,
|
|
sig: whisperKeyPairID,
|
|
ttl: 10,
|
|
powTarget: 0.002,
|
|
powTime: 1,
|
|
topic: "0x4964656e",
|
|
payload: web3.utils.toHex({
|
|
'contract': "0x692a70d2e424a56d2c6c27aa97d1a86395877b3a",
|
|
'address': web3.eth.defaultAccount
|
|
'action': 'transaction',
|
|
'encodedFunctionCall': funCall,
|
|
})
|
|
};
|
|
|
|
|
|
web3.shh.post(msgObj)
|
|
.then((err, result) => {
|
|
console.log(result);
|
|
console.log(err);
|
|
});
|
|
|
|
```
|
|
|
|
Notice that sending messages use specific TTL, PoW Targets nad Time. These values specified here are those accepted by the Status.im cluster of nodes. The configuration for dev environment use greater values, since it is not expected to communicate with other nodes. |