AlgorandMultiSignatureTest.java

/*
 * Copyright (C) 2019-2022 Six Clovers, Inc. - All rights reserved.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package com.sixclovers.external;

import static org.testng.Assert.assertNotNull;

import java.util.Arrays;
import java.util.LinkedList;
import java.util.List;

import org.testng.annotations.BeforeClass;
import org.testng.annotations.Ignore;
import org.testng.annotations.Test;

import com.algorand.algosdk.account.Account;
import com.algorand.algosdk.crypto.Address;
import com.algorand.algosdk.crypto.Ed25519PublicKey;
import com.algorand.algosdk.crypto.MultisigAddress;
import com.algorand.algosdk.transaction.SignedTransaction;
import com.algorand.algosdk.transaction.Transaction;
import com.algorand.algosdk.util.Encoder;

@SuppressWarnings("PMD")
public class AlgorandMultiSignatureTest {

    /* Step 1: Provide the referenceToken and signaturePayloads from the Complete Transaction response. */

    // An opaque token to be maintained with the signature payload.
    private final String referenceToken = "PLACEHOLDER - replace with data from a TransactionPayload";

    // The list of multi-sig payloads that parties must sign.
    private final List<String> signaturePayloads = Arrays.asList("PLACEHOLDER", "replace with data from a TransactionPayload");

    /* Step 2: Provide the public and private key information to sign transactions. */

    // The public address of signer 1 (Six Clovers).
    private final String signerPublicAddress1 = "PLACEHOLDER";

    // The private key of signer 2 (the seed is held by you in a hot wallet to sign transactions).
    private final String signerPrivateKey2 = "PLACEHOLDER - replace with a base64 encoded seed byte[]";

    // The public address of signer 3 (the seed is held by your custodian or cold wallet storage provider).
    private final String signerPublicAddress3 = "PLACEHOLDER";

    private Account signerAccount;

    private MultisigAddress multisigAddress;

    private Address multisigSender;

    @BeforeClass
    public void beforeClass() {
        signerAccount = getAccountFromSeed(signerPrivateKey2);

        final int version = 1;
        final int threshold = 2;
        final List<Ed25519PublicKey> publicKeys = new LinkedList<>();
        publicKeys.add(convert(signerPublicAddress1));
        publicKeys.add(signerAccount.getEd25519PublicKey());
        publicKeys.add(convert(signerPublicAddress3));
        multisigAddress = new MultisigAddress(version, threshold, publicKeys);
        multisigSender = getMultisigSender(multisigAddress);
    }

    @Test
    public void testAlgorandMultiSignatureTransaction() {
        /* Step 3: Decode the signaturePayloads given by the transaction request. */
        final List<Transaction> decodedTransactions = decodeSignaturePayloads(signaturePayloads);

        /* Step 4: Verify and sign each transaction. */
        final List<Object> signedTransactions = signTransactions(decodedTransactions);

        /* Step 5: Encode the objects so that we may send them to the Commit Transaction endpoint. */
        final List<String> encodedTransactions = encodeTransactions(signedTransactions);

        assertNotNull(referenceToken);
        assertNotNull(encodedTransactions);

        /* Step 6: Submit the values to the Commit Transaction endpoint. */
        System.out.println("referenceToken: " + encodeToJson(referenceToken));
        System.out.println("signaturePayloads: " + encodeToJson(encodedTransactions));
    }

    private Ed25519PublicKey convert(final String address) {
        try {
            final byte[] encodedPublicKey = new Address(address).toVerifyKey().getEncoded();
            final byte[] publicKey = new byte[32];
            System.arraycopy(encodedPublicKey, 12, publicKey, 0, 32);
            return new Ed25519PublicKey(publicKey);
        } catch (final Exception e) {
            // We never expect this to happen in live code, but to make test failures obvious, we throw a RuntimeException.
            // Log.error(e);
            // return null;
            throw new RuntimeException(e);
        }
    }

    private byte[] decodeFromBase64(final String value) {
        return Encoder.decodeFromBase64(value);
    }

    private Transaction decodeFromMsgPack(final byte[] bytes) {
        try {
            return Encoder.decodeFromMsgPack(bytes, Transaction.class);
        } catch (final Exception e) {
            // We never expect this to happen in live code, but to make test failures obvious, we throw a RuntimeException.
            // Log.error(e);
            // return null;
            throw new RuntimeException(e);
        }
    }

    private List<Transaction> decodeSignaturePayloads(final List<String> signaturePayloads) {
        final List<Transaction> transactions = new LinkedList<>();
        for (final String signaturePayload : signaturePayloads) {
            transactions.add(decodeFromMsgPack(decodeFromBase64(signaturePayload)));
        }
        return transactions;
    }

    private String encodeToBase64(final byte[] bytes) {
        return Encoder.encodeToBase64(bytes);
    }

    private String encodeToJson(final Object object) {
        try {
            return Encoder.encodeToJson(object);
        } catch (final Exception e) {
            // We never expect this to happen in live code, but to make test failures obvious, we throw a RuntimeException.
            // Log.error(e);
            // return null;
            throw new RuntimeException(e);
        }
    }

    private byte[] encodeToMsgPack(final Object object) {
        try {
            return Encoder.encodeToMsgPack(object);
        } catch (final Exception e) {
            // We never expect this to happen in live code, but to make test failures obvious, we throw a RuntimeException.
            // Log.error(e);
            // return null;
            throw new RuntimeException(e);
        }
    }

    private List<String> encodeTransactions(final List<Object> objects) {
        final List<String> encodedPayloads = new LinkedList<>();
        for (final Object object : objects) {
            encodedPayloads.add(encodeToBase64(encodeToMsgPack(object)));
        }
        return encodedPayloads;
    }

    private Account getAccountFromSeed(final String seed) {
        try {
            return new Account(decodeFromBase64(seed));
        } catch (final Exception e) {
            // We never expect this to happen in live code, but to make test failures obvious, we throw a RuntimeException.
            // Log.error(e);
            // return null;
            throw new RuntimeException(e);
        }
    }

    private Address getMultisigSender(final MultisigAddress multisigAddress) {
        try {
            return multisigAddress.toAddress();
        } catch (final Exception e) {
            // We never expect this to happen in live code, but to make test failures obvious, we throw a RuntimeException.
            // Log.error(e);
            // return null;
            throw new RuntimeException(e);
        }
    }

    private SignedTransaction signTransaction(final Transaction transaction) {
        try {
            return signerAccount.signMultisigTransaction(multisigAddress, transaction);
        } catch (final Exception e) {
            // We never expect this to happen in live code, but to make test failures obvious, we throw a RuntimeException.
            // Log.error(e);
            // return null;
            throw new RuntimeException(e);
        }
    }

    private List<Object> signTransactions(final List<Transaction> transactions) {
        final List<Object> objects = new LinkedList<>();
        for (final Transaction transaction : transactions) {
            if (multisigSender.equals(transaction.sender)) {
                // Sign the transaction.
                final SignedTransaction signedTransaction = signTransaction(transaction);

                // Store the signed transaction.
                objects.add(signedTransaction);
            } else {
                // Store the same transaction unsigned. It belongs to the same transaction group and will be signed by someone else.
                objects.add(transaction);
            }
        }
        return objects;
    }

}