io.neow3j.transaction.AccountSigner Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
neow3j: Java/Kotlin/Android Development Toolkit for the Neo Blockchain
There is a newer version: 3.23.0
package io.neow3j.transaction;

import io.neow3j.types.Hash160;
import io.neow3j.wallet.Account;

/**
 * A signer of a transaction. It defines a in which scope the witness/signature of an account is valid, i.e., which
 * contracts can use the witness in an invocation.
 * 
 * If an {@code AccountSigner} is created with an private key-holding {@code Account}, it can be used to
 * automatically sign a transaction via {@link TransactionBuilder#sign()}.
 */
public class AccountSigner extends Signer {

    private Account account;

    private AccountSigner(Hash160 signerHash, WitnessScope scope) {
        super(signerHash, scope);
        account = Account.fromAddress(signerHash.toAddress());
    }

    private AccountSigner(Account account, WitnessScope scope) {
        super(account.getScriptHash(), scope);
        this.account = account;
    }

    /**
     * @return the account of this signer.
     */
    public Account getAccount() {
        return account;
    }

    /**
     * Creates a signer for the given account with no witness scope ({@link WitnessScope#NONE}).
     * 

     * The signature of this signer is only used for transactions and is disabled in contracts.
     *
     * @param account the signer account.
     * @return the signer.
     */
    public static AccountSigner none(Account account) {
        return new AccountSigner(account, WitnessScope.NONE);
    }

    /**
     * Creates a signer for the given account with no witness scope ({@link WitnessScope#NONE}).
     * 
     * The signature of this signer is only used for transactions and is disabled in contracts.
     *
     * @param accountHash the script hash of the signer account.
     * @return the signer.
     */
    public static AccountSigner none(Hash160 accountHash) {
        return new AccountSigner(accountHash, WitnessScope.NONE);
    }

    /**
     * Creates a signer for the given account with a scope ({@link WitnessScope#CALLED_BY_ENTRY}) that only allows
     * the entry point contract to use this signer's witness.
     *
     * @param account the signer account.
     * @return the signer.
     */
    public static AccountSigner calledByEntry(Account account) {
        return new AccountSigner(account, WitnessScope.CALLED_BY_ENTRY);
    }

    /**
     * Creates a signer for the given account with a scope ({@link WitnessScope#CALLED_BY_ENTRY}) that only allows
     * the entry point contract to use this signer's witness.
     *
     * @param accountHash the script hash of the signer account.
     * @return the signer.
     */
    public static AccountSigner calledByEntry(Hash160 accountHash) {
        return new AccountSigner(accountHash, WitnessScope.CALLED_BY_ENTRY);
    }

    /**
     * Creates a signer for the given account with global witness scope ({@link WitnessScope#GLOBAL}).
     *
     * @param account the account.
     * @return the signer.
     */
    public static AccountSigner global(Account account) {
        return new AccountSigner(account, WitnessScope.GLOBAL);
    }

    /**
     * Creates a signer for the given account with global witness scope ({@link WitnessScope#GLOBAL}).
     *
     * @param accountHash the script hash of the signer account.
     * @return the signer.
     */
    public static AccountSigner global(Hash160 accountHash) {
        return new AccountSigner(accountHash, WitnessScope.GLOBAL);
    }

}