@mavrykdynamics/taquito/dist/types/contract/interface.d.ts

High level functionality that builds upon the other packages in the Mavryk Typescript Library Suite.

import { BigMapKeyType, MichelsonMap, MichelsonMapKey, Schema } from '@mavrykdynamics/taquito-michelson-encoder';
import { SaplingDiffResponse } from '@mavrykdynamics/taquito-rpc';
import { OperationBatch } from '../batch/rpc-batch-provider';
import { Context } from '../context';
import { DelegateOperation } from '../operations/delegate-operation';
import { OriginationOperation } from '../operations/origination-operation';
import { RegisterGlobalConstantOperation } from '../operations/register-global-constant-operation';
import { RevealOperation } from '../operations/reveal-operation';
import { TransactionOperation } from '../operations/transaction-operation';
import { DelegateParams, OriginateParams, TransferParams, RegisterDelegateParams, ParamsWithKind, RevealParams, RegisterGlobalConstantParams, IncreasePaidStorageParams, TransferTicketParams, DrainDelegateParams, BallotParams, ProposalsParams, UpdateConsensusKeyParams, SmartRollupAddMessagesParams, SmartRollupOriginateParams, SmartRollupExecuteOutboxMessageParams, FailingNoopParams, StakeParams, UnstakeParams, FinalizeUnstakeParams } from '../operations/types';
import { ContractAbstraction, ContractStorageType, DefaultContractType } from './contract';
import { IncreasePaidStorageOperation } from '../operations/increase-paid-storage-operation';
import { TransferTicketOperation } from '../operations/transfer-ticket-operation';
import { DrainDelegateOperation } from '../operations';
import { BallotOperation } from '../operations';
import { ProposalsOperation } from '../operations/proposals-operation';
import { UpdateConsensusKeyOperation } from '../operations/update-consensus-key-operation';
import { SmartRollupAddMessagesOperation } from '../operations/smart-rollup-add-messages-operation';
import { SmartRollupOriginateOperation } from '../operations/smart-rollup-originate-operation';
import { SmartRollupExecuteOutboxMessageOperation } from '../operations/smart-rollup-execute-outbox-message-operation';
import { FailingNoopOperation } from '../operations/failing-noop-operation';
export type ContractSchema = Schema | unknown;
export interface StorageProvider {
    /**
     *
     * @description Return a well formatted json object of the contract storage
     *
     * @param contract contract address you want to get the storage from
     * @param schema optional schema can either be the contract script rpc response or a michelson-encoder schema
     *
     * @see https://protocol.mavryk.org/api/rpc.html#get-block-id-context-contracts-contract-id-script
     */
    getStorage<T>(contract: string, schema?: ContractSchema): Promise<T>;
    /**
     *
     * @description Return a well formatted json object of the contract big map storage
     *
     * @param contract contract address you want to get the storage from
     * @param key contract big map key to fetch value from
     * @param schema optional schema can either be the contract script rpc response or a michelson-encoder schema
     *
     * @deprecated Deprecated in favor of getBigMapKeyByID
     *
     * @see https://protocol.mavryk.org/api/rpc.html#post-block-id-context-contracts-contract-id-big-map-get
     */
    getBigMapKey<T>(contract: string, key: string, schema?: ContractSchema): Promise<T>;
    /**
     *
     * @description Return a well formatted json object of a big map value
     *
     * @param id Big Map ID
     * @param keyToEncode key to query (will be encoded properly according to the schema)
     * @param schema Big Map schema (can be determined using your contract type)
     * @param block optional block level to fetch the value from
     *
     * @see https://protocol.mavryk.org/api/rpc.html#get-block-id-context-big-maps-big-map-id-script-expr
     */
    getBigMapKeyByID<T>(id: string, keyToEncode: BigMapKeyType, schema: Schema, block?: number): Promise<T>;
    /**
     *
     * @description Fetch multiple values in a big map
     *
     * @param id Big Map ID
     * @param keysToEncode Array of keys to query (will be encoded properly according to the schema)
     * @param schema Big Map schema (can be determined using your contract type)
     * @param block optional block level to fetch the values from
     * @param batchSize optional batch size representing the number of requests to execute in parallel
     * @returns An object containing the keys queried in the big map and their value in a well-formatted JSON object format
     *
     */
    getBigMapKeysByID<T>(id: string, keysToEncode: Array<BigMapKeyType>, schema: Schema, block?: number, batchSize?: number): Promise<MichelsonMap<MichelsonMapKey, T | undefined>>;
    /**
     *
     * @description Return a well formatted json object of a sapling state
     *
     * @param id Sapling state ID
     * @param block optional block level to fetch the value from
     *
     */
    getSaplingDiffByID(id: string, block?: number): Promise<SaplingDiffResponse>;
}
export interface ContractProvider extends StorageProvider {
    /**
     *
     * @description Originate a new contract according to the script in parameters. Will sign and inject an operation using the current context
     *
     * @returns An operation handle with the result from the rpc node
     *
     * @param OriginationOperation Originate operation parameter
     */
    originate<TContract extends DefaultContractType = DefaultContractType>(contract: OriginateParams<ContractStorageType<TContract>>): Promise<OriginationOperation<TContract>>;
    /**
     *
     * @description Set the delegate for a contract. Will sign and inject an operation using the current context
     *
     * @returns An operation handle with the result from the rpc node
     *
     * @param SetDelegate operation parameter
     */
    setDelegate(params: DelegateParams): Promise<DelegateOperation>;
    /**
     *
     * @description Register the current address as delegate. Will sign and inject an operation using the current context
     *
     * @returns An operation handle with the result from the rpc node
     *
     * @param RegisterDelegate operation parameter
     */
    registerDelegate(params: RegisterDelegateParams): Promise<DelegateOperation>;
    /**
     *
     * @description Transfer mv from current address to a specific address. Will sign and inject an operation using the current context
     *
     * @returns An operation handle with the result from the rpc node
     *
     * @param Transfer operation parameter
     */
    transfer(params: TransferParams): Promise<TransactionOperation>;
    /**
     *
     * @description Stake mv from current address to a specific address. Built on top of the existing transaction operation
     *
     * @returns An operation handle with the result from the rpc node
     *
     * @param Stake pseudo-operation parameter
     */
    stake(params: StakeParams): Promise<TransactionOperation>;
    /**
     *
     * @description Unstake mv from current address to a specific address. Built on top of the existing transaction operation
     *
     * @returns An operation handle with the result from the rpc node
     *
     * @param Unstake pseudo-operation parameter
     */
    unstake(params: UnstakeParams): Promise<TransactionOperation>;
    /**
     *
     * @description Finalize unstake mv from current address to a specific address. Built on top of the existing transaction operation
     *
     * @returns An operation handle with the result from the rpc node
     *
     * @param finalize_unstake pseudo-operation parameter
     */
    finalizeUnstake(params: FinalizeUnstakeParams): Promise<TransactionOperation>;
    /**
     *
     * @description Transfer tickets from an implicit account to a contract or another implicit account.
     *
     * @returns An operation handle with the result from the rpc node
     *
     * @param TransferTicket operation parameter
     */
    transferTicket(params: TransferTicketParams): Promise<TransferTicketOperation>;
    /**
     *
     * @description Reveal the current address. Will throw an error if the address is already revealed.
     *
     * @returns An operation handle with the result from the rpc node
     *
     * @param Reveal operation parameter
     */
    reveal(params: RevealParams): Promise<RevealOperation>;
    at<T extends ContractAbstraction<ContractProvider>>(address: string, contractAbstractionComposer?: (abs: ContractAbstraction<ContractProvider>, context: Context) => T): Promise<T>;
    /**
     *
     * @description Batch a group of operation together. Operations will be applied in the order in which they are added to the batch
     *
     * @param params List of operation to batch together
     */
    batch(params?: ParamsWithKind[]): OperationBatch;
    /**
     *
     * @description Register a Micheline expression in a global table of constants. Will sign and inject an operation using the current context
     *
     * @returns An operation handle with the result from the rpc node
     *
     * @param params registerGlobalConstant operation parameter
     */
    registerGlobalConstant(params: RegisterGlobalConstantParams): Promise<RegisterGlobalConstantOperation>;
    /**
     *
     * @description Increase the amount of bytes in a smart contract storage by paying a fee
     *
     * @returns An operation handle with the result from the rpc node
     *
     * @param params IncreasePaidStorage operation parameter
     */
    increasePaidStorage(params: IncreasePaidStorageParams): Promise<IncreasePaidStorageOperation>;
    /**
     *
     * @description Submit a drain delegate operation
     *
     * @returns An operation handle with the result from the RPC node
     *
     * @param DrainDelegateParams DrainDelegate operation parameter
     */
    drainDelegate(params: DrainDelegateParams): Promise<DrainDelegateOperation>;
    /**
     *
     * @description Submit ballot for an ongoing proposal
     *
     * @returns An operation handle with the result from the RPC node
     *
     * @param BallotParams Ballot operation parameter
     */
    ballot(params: BallotParams): Promise<BallotOperation>;
    /**
     *
     * @description Submit proposal
     *
     * @returns An operation handle with the result from the RPC node
     *
     * @param ProposalsParams Proposals operation parameter
     */
    proposals(params: ProposalsParams): Promise<ProposalsOperation>;
    /**
     *
     * @description Update consensus key
     *
     * @returns An operation handle with the result from the RPC node
     *
     * @param UpdateConsensusKeyParams UpdateConsensusKey operation parameter
     */
    updateConsensusKey(params: UpdateConsensusKeyParams): Promise<UpdateConsensusKeyOperation>;
    /**
     *
     * @description Smart Rollup Add Messages
     *
     * @returns An operation handle with the result from the RPC node
     *
     * @param SmartRollupAddMessagesParams smartRollupAddMessages operation parameter
     */
    smartRollupAddMessages(params: SmartRollupAddMessagesParams): Promise<SmartRollupAddMessagesOperation>;
    /**
     * @description Smart rollup originate
     *
     * @returns An operation handle with the result from the RPC node
     *
     * @param SmartRollupOriginateParams smartRollupOriginate operation parameter
     */
    smartRollupOriginate(params: SmartRollupOriginateParams): Promise<SmartRollupOriginateOperation>;
    /**
     * @description Execute a message from a smart rollup's outbox of a cemented commitment
     *
     * @returns An operation handle with the result from the RPC node
     *
     * @param SmartRollupExecuteOutboxMessageParams smartRollupExecuteOutboxMessage operation parameter
     */
    smartRollupExecuteOutboxMessage(params: SmartRollupExecuteOutboxMessageParams): Promise<SmartRollupExecuteOutboxMessageOperation>;
    /**
     *
     * @description Send arbitrary data inside a failing_noop operation that's guaranteed to fail.
     *
     * @returns An operation handle with the result from the rpc node
     *
     * @param params FailingNoop operation parameter
     */
    failingNoop(params: FailingNoopParams): Promise<FailingNoopOperation>;
}