Interface ContractProvider

interface ContractProvider {
    at<T>(address, contractAbstractionComposer?): Promise<T>;
    ballot(params): Promise<BallotOperation>;
    batch(params?): OperationBatch;
    drainDelegate(params): Promise<DrainDelegateOperation>;
    failingNoop(params): Promise<FailingNoopOperation>;
    getBigMapKey<T>(contract, key, schema?): Promise<T>;
    getBigMapKeyByID<T>(id, keyToEncode, schema, block?): Promise<T>;
    getBigMapKeysByID<T>(id, keysToEncode, schema, block?, batchSize?): Promise<MichelsonMap<MichelsonMapKey, undefined | T>>;
    getSaplingDiffByID(id, block?): Promise<SaplingDiffResponse>;
    getStorage<T>(contract, schema?): Promise<T>;
    increasePaidStorage(params): Promise<IncreasePaidStorageOperation>;
    originate<TContract>(contract): Promise<OriginationOperation<TContract>>;
    proposals(params): Promise<ProposalsOperation>;
    registerDelegate(params): Promise<DelegateOperation>;
    registerGlobalConstant(params): Promise<RegisterGlobalConstantOperation>;
    reveal(params): Promise<RevealOperation>;
    setDelegate(params): Promise<DelegateOperation>;
    smartRollupAddMessages(params): Promise<SmartRollupAddMessagesOperation>;
    smartRollupExecuteOutboxMessage(params): Promise<SmartRollupExecuteOutboxMessageOperation>;
    smartRollupOriginate(params): Promise<SmartRollupOriginateOperation>;
    transfer(params): Promise<TransactionOperation>;
    transferTicket(params): Promise<TransferTicketOperation>;
    updateConsensusKey(params): Promise<UpdateConsensusKeyOperation>;
}

Hierarchy (view full)

StorageProvider
- ContractProvider

Methods

at

at<T>(address, contractAbstractionComposer?): Promise<T>
Type Parameters
- T extends ContractAbstraction<ContractProvider, DefaultMethods<ContractProvider>, DefaultMethodsObject<ContractProvider>, DefaultViews, DefaultContractViews, unknown>
Parameters
- address: string
- Optional contractAbstractionComposer: ((abs, context) => T)
  - - (abs, context): T
    - Parameters
      abs: ContractAbstraction<ContractProvider, DefaultMethods<ContractProvider>, DefaultMethodsObject<ContractProvider>, DefaultViews, DefaultContractViews, unknown>
      context: Context
      Returns T
Returns Promise<T>
- Defined in packages/taquito/src/contract/interface.ts:181

ballot

ballot(params): Promise<BallotOperation>
Parameters
- params: BallotParams
Returns Promise<BallotOperation>
An operation handle with the result from the RPC node

Description
Submit ballot for an ongoing proposal
- Defined in packages/taquito/src/contract/interface.ts:237

batch

batch(params?): OperationBatch
Parameters
- Optional params: ParamsWithKind[]
  List of operation to batch together
Returns OperationBatch
Description
Batch a group of operation together. Operations will be applied in the order in which they are added to the batch
- Defined in packages/taquito/src/contract/interface.ts:195

drainDelegate

drainDelegate(params): Promise<DrainDelegateOperation>
Parameters
- params: DrainDelegateParams
Returns Promise<DrainDelegateOperation>
An operation handle with the result from the RPC node

Description
Submit a drain delegate operation
- Defined in packages/taquito/src/contract/interface.ts:227

failingNoop

failingNoop(params): Promise<FailingNoopOperation>
Parameters
- params: FailingNoopParams
  FailingNoop operation parameter
Returns Promise<FailingNoopOperation>
An operation handle with the result from the rpc node

Description
Send arbitrary data inside a failing_noop operation that's guaranteed to fail.
- Defined in packages/taquito/src/contract/interface.ts:297

getBigMapKey

getBigMapKey<T>(contract, key, schema?): Promise<T>
Type Parameters
- T
Parameters
- contract: string
  contract address you want to get the storage from
- key: string
  contract big map key to fetch value from
- Optional schema: unknown
  optional schema can either be the contract script rpc response or a michelson-encoder schema
Returns Promise<T>
Description
Return a well formatted json object of the contract big map storage

Deprecated
Deprecated in favor of getBigMapKeyByID

See
https://tezos.gitlab.io/api/rpc.html#post-block-id-context-contracts-contract-id-big-map-get
Inherited from StorageProvider.getBigMapKey
- Defined in packages/taquito/src/contract/interface.ts:67

getBigMapKeyByID

getBigMapKeyByID<T>(id, keyToEncode, schema, block?): Promise<T>
Type Parameters
- T
Parameters
- id: string
  Big Map ID
- keyToEncode: BigMapKeyType
  key to query (will be encoded properly according to the schema)
- schema: Schema
  Big Map schema (can be determined using your contract type)
- Optional block: number
  optional block level to fetch the value from
Returns Promise<T>
Description
Return a well formatted json object of a big map value

See
https://tezos.gitlab.io/api/rpc.html#get-block-id-context-big-maps-big-map-id-script-expr
Inherited from StorageProvider.getBigMapKeyByID
- Defined in packages/taquito/src/contract/interface.ts:80

getBigMapKeysByID

getBigMapKeysByID<T>(id, keysToEncode, schema, block?, batchSize?): Promise<MichelsonMap<MichelsonMapKey, undefined | T>>
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)
- Optional block: number
  optional block level to fetch the values from
- Optional batchSize: number
  optional batch size representing the number of requests to execute in parallel
Returns Promise<MichelsonMap<MichelsonMapKey, undefined | T>>
An object containing the keys queried in the big map and their value in a well-formatted JSON object format

Description
Fetch multiple values in a big map
Inherited from StorageProvider.getBigMapKeysByID
- Defined in packages/taquito/src/contract/interface.ts:99

getSaplingDiffByID

getSaplingDiffByID(id, block?): Promise<SaplingDiffResponse>
Parameters
- id: string
  Sapling state ID
- Optional block: number
  optional block level to fetch the value from
Returns Promise<SaplingDiffResponse>
Description
Return a well formatted json object of a sapling state
Inherited from StorageProvider.getSaplingDiffByID
- Defined in packages/taquito/src/contract/interface.ts:115

getStorage

getStorage<T>(contract, schema?): Promise<T>
Type Parameters
- T
Parameters
- contract: string
  contract address you want to get the storage from
- Optional schema: unknown
  optional schema can either be the contract script rpc response or a michelson-encoder schema
Returns Promise<T>
Description
Return a well formatted json object of the contract storage

See
https://tezos.gitlab.io/api/rpc.html#get-block-id-context-contracts-contract-id-script
Inherited from StorageProvider.getStorage
- Defined in packages/taquito/src/contract/interface.ts:53

increasePaidStorage

increasePaidStorage(params): Promise<IncreasePaidStorageOperation>
Parameters
- params: IncreasePaidStorageParams
  IncreasePaidStorage operation parameter
Returns Promise<IncreasePaidStorageOperation>
An operation handle with the result from the rpc node

Description
Increase the amount of bytes in a smart contract storage by paying a fee
- Defined in packages/taquito/src/contract/interface.ts:217

originate

originate<TContract>(contract): Promise<OriginationOperation<TContract>>
Type Parameters
- TContract extends DefaultContractType = DefaultContractType
Parameters
- contract: OriginateParams<ContractStorageType<TContract>>
Returns Promise<OriginationOperation<TContract>>
An operation handle with the result from the rpc node

Description
Originate a new contract according to the script in parameters. Will sign and inject an operation using the current context
- Defined in packages/taquito/src/contract/interface.ts:127

proposals

proposals(params): Promise<ProposalsOperation>
Parameters
- params: ProposalsParams
Returns Promise<ProposalsOperation>
An operation handle with the result from the RPC node

Description
Submit proposal
- Defined in packages/taquito/src/contract/interface.ts:247

registerDelegate

registerDelegate(params): Promise<DelegateOperation>
Parameters
- params: RegisterDelegateParams
Returns Promise<DelegateOperation>
An operation handle with the result from the rpc node

Description
Register the current address as delegate. Will sign and inject an operation using the current context
- Defined in packages/taquito/src/contract/interface.ts:149

registerGlobalConstant

registerGlobalConstant(params): Promise<RegisterGlobalConstantOperation>
Parameters
- params: RegisterGlobalConstantParams
  registerGlobalConstant operation parameter
Returns Promise<RegisterGlobalConstantOperation>
An operation handle with the result from the rpc node

Description
Register a Micheline expression in a global table of constants. Will sign and inject an operation using the current context
- Defined in packages/taquito/src/contract/interface.ts:205

reveal

reveal(params): Promise<RevealOperation>
Parameters
- params: RevealParams
Returns Promise<RevealOperation>
An operation handle with the result from the rpc node

Description
Reveal the current address. Will throw an error if the address is already revealed.
- Defined in packages/taquito/src/contract/interface.ts:179

setDelegate

setDelegate(params): Promise<DelegateOperation>
Parameters
- params: DelegateParams
Returns Promise<DelegateOperation>
An operation handle with the result from the rpc node

Description
Set the delegate for a contract. Will sign and inject an operation using the current context
- Defined in packages/taquito/src/contract/interface.ts:139

smartRollupAddMessages

smartRollupAddMessages(params): Promise<SmartRollupAddMessagesOperation>
Parameters
- params: SmartRollupAddMessagesParams
Returns Promise<SmartRollupAddMessagesOperation>
An operation handle with the result from the RPC node

Description
Smart Rollup Add Messages
- Defined in packages/taquito/src/contract/interface.ts:267

smartRollupExecuteOutboxMessage

smartRollupExecuteOutboxMessage(params): Promise<SmartRollupExecuteOutboxMessageOperation>
Parameters
- params: SmartRollupExecuteOutboxMessageParams
Returns Promise<SmartRollupExecuteOutboxMessageOperation>
An operation handle with the result from the RPC node

Description
Execute a message from a smart rollup's outbox of a cemented commitment
- Defined in packages/taquito/src/contract/interface.ts:285

smartRollupOriginate

smartRollupOriginate(params): Promise<SmartRollupOriginateOperation>
Parameters
- params: SmartRollupOriginateParams
Returns Promise<SmartRollupOriginateOperation>
An operation handle with the result from the RPC node

Description
Smart rollup originate
- Defined in packages/taquito/src/contract/interface.ts:277

transfer

transfer(params): Promise<TransactionOperation>
Parameters
- params: TransferParams
Returns Promise<TransactionOperation>
An operation handle with the result from the rpc node

Description
Transfer tz from current address to a specific address. Will sign and inject an operation using the current context
- Defined in packages/taquito/src/contract/interface.ts:159

transferTicket

transferTicket(params): Promise<TransferTicketOperation>
Parameters
- params: TransferTicketParams
Returns Promise<TransferTicketOperation>
An operation handle with the result from the rpc node

Description
Transfer tickets from an implicit account to a contract or another implicit account.
- Defined in packages/taquito/src/contract/interface.ts:169

updateConsensusKey

updateConsensusKey(params): Promise<UpdateConsensusKeyOperation>
Parameters
- params: UpdateConsensusKeyParams
Returns Promise<UpdateConsensusKeyOperation>
An operation handle with the result from the RPC node

Description
Update consensus key
- Defined in packages/taquito/src/contract/interface.ts:257

Interface ContractProvider

Hierarchy (view full)

Index

Methods

Methods

at

Type Parameters

Parameters

Parameters

Returns T

Returns Promise<T>

ballot

Parameters

Returns Promise<BallotOperation>

Description

batch

Parameters

Returns OperationBatch

Description

drainDelegate

Parameters

Returns Promise<DrainDelegateOperation>

Description

failingNoop

Parameters

Returns Promise<FailingNoopOperation>

Description

getBigMapKey

Type Parameters

Parameters

Returns Promise<T>

Description

Deprecated

See

getBigMapKeyByID

Type Parameters

Parameters

Returns Promise<T>

Description

See

getBigMapKeysByID

Type Parameters

Parameters

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

Description

getSaplingDiffByID

Parameters

Returns Promise<SaplingDiffResponse>

Description

getStorage

Type Parameters

Parameters

Returns Promise<T>

Description

See

increasePaidStorage

Parameters

Returns Promise<IncreasePaidStorageOperation>

Description

originate

Type Parameters

Parameters

Returns Promise<OriginationOperation<TContract>>

Description

proposals

Parameters

Returns Promise<ProposalsOperation>

Description

registerDelegate

Parameters

Returns Promise<DelegateOperation>

Description

registerGlobalConstant

Parameters

Returns Promise<RegisterGlobalConstantOperation>

Description

reveal

Parameters

Returns Promise<RevealOperation>

Description