/*
 * Copyright 2020 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.
 */

import { Observable } from 'rxjs';
import { MerkleStateInfo } from '../model/blockchain';
import { HashLockInfo } from '../model/lock';
import { SearcherRepository } from './paginationStreamer';
import { HashLockSearchCriteria } from './searchCriteria';

/**
 * Hashlock interface repository.
 */
export interface HashLockRepository extends SearcherRepository<HashLockInfo, HashLockSearchCriteria> {
    /**
     * Get hash lock info of the given id
     * @param hash Hashlock hash
     * @returns Observable<HashLockInfo>
     */
    getHashLock(hash: string): Observable<HashLockInfo>;

    /**
     * Get secret lock merkle info of the given id.
     * @param hash HashLockInfo hash id
     * @returns Observable<MerkleStateInfo>
     */
    getHashLockMerkle(hash: string): Observable<MerkleStateInfo>;
}