io.hotmoka.node.Accounts Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of io-hotmoka-node Show documentation
This module implements the shared code of all Hotmoka nodes.
There is a newer version: 1.6.0
/*
Copyright 2023 Fausto Spoto

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package io.hotmoka.node;

import java.io.IOException;

import io.hotmoka.beans.api.values.StorageReference;
import io.hotmoka.crypto.api.Entropy;
import io.hotmoka.node.api.Account;
import io.hotmoka.node.internal.AccountImpl;

/**
 * Providers of accounts.
 */
public final class Accounts {

	private Accounts() {}

	/**
	 * Yields an account in a Hotmoka node.
	 * 
	 * @param entropy the entropy, from which the key pair can be derived
	 * @param reference the reference to the account. This is limited to have 0 as progressive,
	 *                  in order to reduce the information needed to represent an account as BIP39 words
	 * @return the account
	 */
	public static Account of(Entropy entropy, StorageReference reference) {
		return new AccountImpl(entropy, reference);
	}

	/**
	 * Yields an account in a Hotmoka node.
	 * The entropy of the account is recovered from its PEM file.
	 * 
	 * @param reference the reference to the account. This is limited to have 0 as progressive,
	 *                  in order to reduce the information needed to represent an account as BIP39 words
	 * @return the account
	 * @throws IOException if the PEM file cannot be read
	 */
	public static Account of(StorageReference reference) throws IOException {
		return new AccountImpl(reference);
	}

	/**
	 * Yields an account in a Hotmoka node.
	 * The entropy of the account is recovered from its PEM file.
	 * 
	 * @param reference the reference to the account. This is limited to have 0 as progressive,
	 *                  in order to reduce the information needed to represent an account as BIP39 words
	 * @param dir the directory where the PEM file must be looked for
	 * @return the account
	 * @throws IOException if the PEM file cannot be read
	 */
	public static Account of(StorageReference reference, String dir) throws IOException {
		return new AccountImpl(reference, dir);
	}

	/**
	 * Yields an account in a Hotmoka node.
	 * The entropy of the account is recovered from its PEM file.
	 * 
	 * @param reference the reference to the account, as a string. This is limited to have 0 as progressive,
	 *                  in order to reduce the information needed to represent an account as BIP39 words
	 * @return the account
	 * @throws IOException if the PEM file cannot be read
	 */
	public static Account of(String reference) throws IOException {
		return new AccountImpl(reference);
	}

	/**
	 * Yields an account in a Hotmoka node.
	 * The entropy of the account is recovered from its PEM file.
	 * 
	 * @param reference the reference to the account, as a string. This is limited to have 0 as progressive,
	 *                  in order to reduce the information needed to represent an account as BIP39 words
	 * @param dir the directory where the PEM file must be looked for
	 * @return the account
	 * @throws IOException if the PEM file cannot be read
	 */
	public static Account of(String reference, String dir) throws IOException {
		return new AccountImpl(reference, dir);
	}

	/**
	 * Yields an account in a Hotmoka node,
	 * from its entropy and from the byte representation of its storage reference.
	 * 
	 * @param entropy the entropy
	 * @param reference the byte representation of the reference
	 * @return the account
	 */
	public static Account of(Entropy entropy, byte[] reference) {
		return new AccountImpl(entropy, reference);
	}
}