Taquito TypeDocs
    Preparing search index...

    Interface ContractProvider

    interface ContractProvider {
        at<
            T extends
                ContractAbstraction<
                    ContractProvider,
                    DefaultMethodsObject<ContractProvider>,
                    DefaultViews,
                    DefaultContractViews,
                    unknown,
                >,
        >(
            address: string,
            contractAbstractionComposer?: (
                abs: ContractAbstraction<ContractProvider>,
                context: Context,
            ) => T,
        ): Promise<T>;
        ballot(params: BallotParams): Promise<BallotOperation>;
        batch(params?: ParamsWithKind[]): OperationBatch;
        drainDelegate(params: DrainDelegateParams): Promise<DrainDelegateOperation>;
        failingNoop(params: FailingNoopParams): Promise<FailingNoopOperation>;
        finalizeUnstake(
            params: FinalizeUnstakeParams,
        ): Promise<TransactionOperation>;
        getBigMapKeyByID<T>(
            id: string,
            keyToEncode: BigMapKeyType,
            schema: Schema,
            block?: BlockIdentifier,
        ): Promise<T>;
        getBigMapKeysByID<T>(
            id: string,
            keysToEncode: BigMapKeyType[],
            schema: Schema,
            block?: BlockIdentifier,
            batchSize?: number,
        ): Promise<MichelsonMap<MichelsonMapKey, T | undefined>>;
        getSaplingDiffByID(
            id: string,
            block?: BlockIdentifier,
        ): Promise<SaplingDiffResponse>;
        getStorage<T>(
            contract: string,
            schema?: unknown,
            block?: BlockIdentifier,
        ): Promise<T>;
        increasePaidStorage(
            params: IncreasePaidStorageParams,
        ): Promise<IncreasePaidStorageOperation>;
        originate<TContract extends DefaultContractType = DefaultContractType>(
            contract: OriginateParams<ContractStorageType<TContract>>,
        ): Promise<OriginationOperation<TContract>>;
        proposals(params: ProposalsParams): Promise<ProposalsOperation>;
        registerDelegate(
            params: RegisterDelegateParams,
        ): Promise<DelegateOperation>;
        registerGlobalConstant(
            params: RegisterGlobalConstantParams,
        ): Promise<RegisterGlobalConstantOperation>;
        reveal(params: RevealParams): Promise<RevealOperation>;
        setDelegate(params: DelegateParams): Promise<DelegateOperation>;
        smartRollupAddMessages(
            params: SmartRollupAddMessagesParams,
        ): Promise<SmartRollupAddMessagesOperation>;
        smartRollupExecuteOutboxMessage(
            params: SmartRollupExecuteOutboxMessageParams,
        ): Promise<SmartRollupExecuteOutboxMessageOperation>;
        smartRollupOriginate(
            params: SmartRollupOriginateParams,
        ): Promise<SmartRollupOriginateOperation>;
        stake(params: StakeParams): Promise<TransactionOperation>;
        transfer(params: TransferParams): Promise<TransactionOperation>;
        transferTicket(
            params: TransferTicketParams,
        ): Promise<TransferTicketOperation>;
        unstake(params: UnstakeParams): Promise<TransactionOperation>;
        updateCompanionKey(
            params: UpdateCompanionKeyParams,
        ): Promise<UpdateCompanionKeyOperation>;
        updateConsensusKey(
            params: UpdateConsensusKeyParams,
        ): Promise<UpdateConsensusKeyOperation>;
    }

    Hierarchy (View Summary)

    Index

    Methods

    • Fetch multiple values in a big map

      Type Parameters

      • T

      Parameters

      • id: string

        Big Map ID

      • keysToEncode: BigMapKeyType[]

        Array of keys to query (will be encoded properly according to the schema)

      • schema: Schema

        Big Map schema (can be determined using your contract type)

      • Optionalblock: BlockIdentifier

        optional block level to fetch the values from

      • OptionalbatchSize: number

        optional batch size representing the number of requests to execute in parallel

      Returns Promise<MichelsonMap<MichelsonMapKey, T | undefined>>

      An object containing the keys queried in the big map and their value in a well-formatted JSON object format