- Metamask browser extension properly configurated
- Phantom browser extension properly configurated
- git
- npm 8.6+
- node 18+
- typescript 5.0.2+
- react 18.2+
- vite 4.4.5+
- openssl 3.0+
- Algokit 4.1
- Python 3.10+
- pip 23+
- pipx 1.2.1+
- Docker 20+
- Docker compose 2.5+
- Algosdk 2.7+
- other dependencies defined in package.json
Before installing this project you might be sure respect the above requirements. For convenience we invite you to go here for instructions on how to install algokit
- Clone Janus project:
git clone https://github.com/VKappaKV/Janus- Start algokit localnet:
algokit localnet start
algokit explore # launch explorer- Try single wallet integrations
git checkout Metamask #To try the Metamask demo
git checkout Phantom #To try the Phantom demo- Install dependencies
npm install- Run Janus
npm run dev
# open http://localhost:5173/ in your browserMoving to the localhost URL http://localhost:5173/, a user inferface allows the user to :
- Connect a wallet (only Metamask and Phantom a.t.m.)
- Create a logic signature related to the connected wallet
- Provide funds to the logic signature
- Create and sign transactions to the Algorand network
- Check transaction with the dappflow explorer
The project is composed by:
- App.tsx: Represents the main file which manage the wallet and Algorand connection.
- Metamask.tsxand Phantom.tsx: Implement the wallets SDK, this allows the DAPP to extract important information like keys and signatures and communicate with wallets.
- Algorand.ts: Make use of the algorand SDK to communicate with the Algorand network.
Focusing on Algorand.ts, it is mainly composed by Logic Signature creation functions, one for each encryption algorithm, the ed25519 version is represented as follows.
const createLogicSignatureEd25519 = async (pk: string) => {
const hexAddress = `0x${pk}`;
console.log(hexAddress);
const smartSigSource = `#pragma version 9 \n txn TxID \narg 0 \n byte ${hexAddress} \n ed25519verify_bare`;
// this is the "ideal" version, in production we get message to sign by parameter (see the "problems" section in this file)
const result = await algod.compile(Buffer.from(smartSigSource)).do();
const b64program = result.result;
const smartSig = new algosdk.LogicSig(
new Uint8Array(Buffer.from(b64program, "base64"))
);
return smartSig;
};The function takes an hex encoded public key pk as input, at first, the 0x prefix is added to the public key string, then the code adds hexAddress to the Logic Signature Teal code stored in smartSigSource. Lastly, the Logic Signature is compiled and returned to the caller. The Logic Signature creation for ECDSA secp256k1 algorithm is represented as follows :
const createLogicSignatureSecp256k1 = async (pkX: string, pkY: string) => {
console.log(">> Creating logic signature secp256k1");
const hexAddressY = `0x${pkY}`;
const hexAddressX = `0x${pkX}`;
const smartSigSource = `#pragma version 9 \ntxn TxID \narg 0 \narg 1 \nbyte ${hexAddressX} \nbyte ${hexAddressY} \necdsa_verify Secp256k1`;
console.log(smartSigSource);
const result = await algod.compile(Buffer.from(smartSigSource)).do();
const b64program = result.result;
const smartSig = new algosdk.LogicSig(
new Uint8Array(Buffer.from(b64program, "base64"))
);
console.log(
">> Created Logic Signature, the LogicSig is : " + JSON.stringify(smartSig)
);
return smartSig;
};Similarly to the ed25519 version, this function takes as input the hex encoded decompressed public key (splitted in X and Y values) and hard codes the 0x prefixed values into the Logic Signature. Finally it returns the compiled Logic signature teal code.
After the Logic Signature creation, a transaction is created from the Logic Signature to a chosen receiver.
const smartSigTnx = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
from: lsig.address(),
to: alice.addr,
amount,
suggestedParams: await suggestedParams(),
});Analyzing the the logic signature, we can notice that it is valid just if the arguments that takes in input is a valid Transaction ID signature for the hard coded public key. The transaction creation allows us to extract the Transaction ID and ask to the wallet to sign it returning the signature. Lastly, the signature is added to the smartSig's args attribute as follows:
lsig.args = [Buffer.from(signature)];
const signedSmartSigTxn = algosdk.signLogicSigTransactionObject(
smartSigTxn,
lsig
);
await algod.sendRawTransaction(signedSmartSigTxn.blob).do();Where lsig is the Logic Signature object. Finally, the transaction is sent to the Algorand network.
During development we encountered some difficulties regarding the integration of wallets, metamask and phantom, with our project. In particular, we couldn't verify the signatures generated by the wallets with the opcodes of Algorand (ed25519verify_bare and ecdsa_verify Secp256k1). This is essentially due to the encodings needed to sign a message, which cannot be applied during verification given that the message to be signed (txn TxID) is generated within the logic signature and is immutable.
-
As regards the Phantom wallet, one of its great limitations is that the signMessage method does not allow you to sign Hex directly but rather requires a transformation in UTF8 and then in uint8Array (proof). A temporary solution that we have found is to pass as an argument, in addition to the signature, the message that was signed, in its last encoding before signing. This allows you to verify the logic signature correctly but contextually a vulnerability is exposed that allows a replay attack to be carried out because the txid is not generated directly within the logic signature but is passed as an argument.
-
As regards the Metamask wallet, we had difficulties with the personal_sign method of ethereum, as it adds a prefix to the message to be signed, which cannot also be affixed to the txid generated within the logic signature. The temporary solution we have identified is to derive from the signature produced by personal_sign a pair of keys, of which the private key is the hash of signature and the public key, derived from the private key, is then inserted into the logic signature.