StellarMultiSignatureTest.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.stellar.sdk.AbstractTransaction;
import org.stellar.sdk.ChangeTrustOperation;
import org.stellar.sdk.KeyPair;
import org.stellar.sdk.Network;
import org.stellar.sdk.Operation;
import org.stellar.sdk.PaymentOperation;
import org.stellar.sdk.Transaction;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Ignore;
import org.testng.annotations.Test;

import com.algorand.algosdk.util.Encoder;

@SuppressWarnings("PMD")
public class StellarMultiSignatureTest {

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

    // An opaque token to be maintained with the signature payload.
    private String referenceToken;

    // The list of multi-sig payloads that parties must sign.
    private List<String> signaturePayloads;

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

    // The Stellar network.
    private final Network network = Network.TESTNET;

    // The multisig address of the wallet.
    private String multisigAddress;

    // The private key of signer 2 (the seed is held by you in a hot wallet to sign transactions).
    private KeyPair signerPrivateKey2;

    @BeforeClass
    public void beforeClass() {
        referenceToken = "PLACEHOLDER - replace with data from a TransactionPayload";

        signaturePayloads = Arrays.asList("PLACEHOLDER - replace with data from a TransactionPayload");

        multisigAddress = "PLACEHOLDER";

        signerPrivateKey2 = KeyPair.fromSecretSeed("PLACEHOLDER - replace with a base64 encoded seed byte[]");
    }

    @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<Transaction> 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 List<Transaction> decodeSignaturePayloads(final List<String> signaturePayloads) {
        final List<Transaction> transactions = new LinkedList<>();
        for (final String signaturePayload : signaturePayloads) {
            transactions.add(decodeTransaction(signaturePayload));
        }
        return transactions;
    }

    private Transaction decodeTransaction(final String transaction) {
        try {
            return (Transaction)AbstractTransaction.fromEnvelopeXdr(transaction, network);
        } 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 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 String encodeTransaction(final Transaction transaction) {
        return transaction.toEnvelopeXdrBase64();
    }

    private List<String> encodeTransactions(final List<Transaction> transactions) {
        final List<String> encodedPayloads = new LinkedList<>();
        for (final Transaction transaction : transactions) {
            encodedPayloads.add(encodeTransaction(transaction));
        }
        return encodedPayloads;
    }

    private void signTransaction(final Transaction transaction) {
        try {
            transaction.sign(signerPrivateKey2);
        } 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> signTransactions(final List<Transaction> transactions) {
        for (final Transaction transaction : transactions) {
            boolean shouldSign = false; // So we ensure we add at most 1 signature per private key.
            for (final Operation operation : transaction.getOperations()) {
                if (operation instanceof PaymentOperation) {
                    if (multisigAddress.equals(operation.getSourceAccount())) {
                        shouldSign = true;
                    }
                } else if (operation instanceof ChangeTrustOperation) {
                    if (multisigAddress.equals(transaction.getSourceAccount()) && transaction.getOperations().length == 1) {
                        shouldSign = true;
                    }
                }
            }
            if (shouldSign) {
                signTransaction(transaction);
            }
        }
        return transactions;
    }

}