io.nem.sdk.model.transaction.HashLockTransaction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sdk-core Show documentation

sdk-core lib for NEM2 sdk Java

The newest version!

/*
 * Copyright 2019 NEM
 *
 * 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.nem.sdk.model.transaction;

import io.nem.sdk.model.mosaic.Mosaic;
import java.math.BigInteger;

/**
 * Lock funds transaction is used before sending an Aggregate bonded transaction, as a deposit to
 * announce the transaction. When aggregate bonded transaction is confirmed funds are returned to
 * HashLockTransaction signer.
 *
 * @since 1.0
 */
public class HashLockTransaction extends Transaction {

    private final Mosaic mosaic;
    private final BigInteger duration;
    private final String hash;

    /**
     * It creates a {@link HashLockTransaction} based on the factory.
     *
     * @param factory the factory with the configured information.
     */
    HashLockTransaction(HashLockTransactionFactory factory) {
        super(factory);
        this.mosaic = factory.getMosaic();
        this.duration = factory.getDuration();
        this.hash = factory.getHash();
    }

    /**
     * Returns locked mosaic.
     *
     * @return locked mosaic.
     */
    public Mosaic getMosaic() {
        return mosaic;
    }

    /**
     * Returns funds lock duration in number of blocks.
     *
     * @return funds lock duration in number of blocks.
     */
    public BigInteger getDuration() {
        return duration;
    }

    /**
     * Returns signed transaction hash for which funds are locked.
     *
     * @return signed transaction hash for which funds are locked.
     */
    public String getHash() {
        return hash;
    }

}