ContractProvider

Hierarchy

StorageProvider
- ContractProvider

Methods

at

at<T>(address: string, contractAbstractionComposer?: (abs: ContractAbstraction<ContractProvider, Record<string, (...args: any[]) => ContractMethod<ContractProvider>>, Record<string, (args?: any) => ContractMethodObject<ContractProvider>>, Record<string, (...args: any[]) => ContractView>, Record<string, (args?: any) => OnChainView>, unknown>, context: Context) => T): Promise<T>

- Defined in packages/taquito/src/contract/interface.ts:177
Type parameters
- T: ContractAbstraction<ContractProvider, Record<string, (...args: any[]) => ContractMethod<ContractProvider>>, Record<string, (args?: any) => ContractMethodObject<ContractProvider>>, Record<string, (...args: any[]) => ContractView>, Record<string, (args?: any) => OnChainView>, unknown, T>
Parameters
- address: string
- Optional contractAbstractionComposer: (abs: ContractAbstraction<ContractProvider, Record<string, (...args: any[]) => ContractMethod<ContractProvider>>, Record<string, (args?: any) => ContractMethodObject<ContractProvider>>, Record<string, (...args: any[]) => ContractView>, Record<string, (args?: any) => OnChainView>, unknown>, context: Context) => T
  - - (abs: ContractAbstraction<ContractProvider, Record<string, (...args: any[]) => ContractMethod<ContractProvider>>, Record<string, (args?: any) => ContractMethodObject<ContractProvider>>, Record<string, (...args: any[]) => ContractView>, Record<string, (args?: any) => OnChainView>, unknown>, context: Context): T
    - Parameters
      - abs: ContractAbstraction<ContractProvider, Record<string, (...args: any[]) => ContractMethod<ContractProvider>>, Record<string, (args?: any) => ContractMethodObject<ContractProvider>>, Record<string, (...args: any[]) => ContractView>, Record<string, (args?: any) => OnChainView>, unknown>
      - context: Context
      Returns T
Returns Promise<T>

ballot

ballot(params: BallotParams): Promise<BallotOperation>

- Defined in packages/taquito/src/contract/interface.ts:233
description

Submit ballot for an ongoing proposal

Parameters
- params: BallotParams
Returns Promise<BallotOperation>

An operation handle with the result from the RPC node

batch

batch(params?: ParamsWithKind[]): OperationBatch

- Defined in packages/taquito/src/contract/interface.ts:191
description

Batch a group of operation together. Operations will be applied in the order in which they are added to the batch

Parameters
- Optional params: ParamsWithKind[]
  
  List of operation to batch together
Returns OperationBatch

drainDelegate

drainDelegate(params: DrainDelegateParams): Promise<DrainDelegateOperation>

- Defined in packages/taquito/src/contract/interface.ts:223
description

Submit a drain delegate operation

Parameters
- params: DrainDelegateParams
Returns Promise<DrainDelegateOperation>

An operation handle with the result from the RPC node

getBigMapKey

getBigMapKey<T>(contract: string, key: string, schema?: unknown): Promise<T>

Inherited from StorageProvider.getBigMapKey
- Defined in packages/taquito/src/contract/interface.ts:63
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

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>

getBigMapKeyByID

getBigMapKeyByID<T>(id: string, keyToEncode: BigMapKeyType, schema: Schema, block?: number): Promise<T>

Inherited from StorageProvider.getBigMapKeyByID
- Defined in packages/taquito/src/contract/interface.ts:76
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

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>

getBigMapKeysByID

getBigMapKeysByID<T>(id: string, keysToEncode: BigMapKeyType[], schema: Schema, block?: number, batchSize?: number): Promise<MichelsonMap<MichelsonMapKey, undefined | T>>

Inherited from StorageProvider.getBigMapKeysByID
- Defined in packages/taquito/src/contract/interface.ts:95
description

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)
- 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

getSaplingDiffByID

getSaplingDiffByID(id: string, block?: number): Promise<SaplingDiffResponse>

Inherited from StorageProvider.getSaplingDiffByID
- Defined in packages/taquito/src/contract/interface.ts:111
description

Return a well formatted json object of a sapling state

Parameters
- id: string
  
  Sapling state ID
- Optional block: number
  
  optional block level to fetch the value from
Returns Promise<SaplingDiffResponse>

getStorage

getStorage<T>(contract: string, schema?: unknown): Promise<T>

Inherited from StorageProvider.getStorage
- Defined in packages/taquito/src/contract/interface.ts:49
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

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>

increasePaidStorage

increasePaidStorage(params: IncreasePaidStorageParams): Promise<IncreasePaidStorageOperation>

- Defined in packages/taquito/src/contract/interface.ts:213
description

Increase the amount of bytes in a smart contract storage by paying a fee

Parameters
- params: IncreasePaidStorageParams
  
  IncreasePaidStorage operation parameter
Returns Promise<IncreasePaidStorageOperation>

An operation handle with the result from the rpc node

originate

originate<TContract>(contract: OriginateParams<PromiseReturnType<TContract["storage"]>>): Promise<OriginationOperation<TContract>>

- Defined in packages/taquito/src/contract/interface.ts:123
description

Originate a new contract according to the script in parameters. Will sign and inject an operation using the current context

Type parameters
- TContract: ContractAbstraction<ContractProvider, Record<string, (...args: any[]) => ContractMethod<ContractProvider>>, Record<string, (args?: any) => ContractMethodObject<ContractProvider>>, Record<string, (...args: any[]) => ContractView>, Record<string, (args?: any) => OnChainView>, unknown, TContract> = DefaultContractType
Parameters
- contract: OriginateParams<PromiseReturnType<TContract["storage"]>>
Returns Promise<OriginationOperation<TContract>>

An operation handle with the result from the rpc node

proposals

proposals(params: ProposalsParams): Promise<ProposalsOperation>

- Defined in packages/taquito/src/contract/interface.ts:243
description

Submit proposal

Parameters
- params: ProposalsParams
Returns Promise<ProposalsOperation>

An operation handle with the result from the RPC node

registerDelegate

registerDelegate(params: RegisterDelegateParams): Promise<DelegateOperation>

- Defined in packages/taquito/src/contract/interface.ts:145
description

Register the current address as delegate. Will sign and inject an operation using the current context

Parameters
- params: RegisterDelegateParams
Returns Promise<DelegateOperation>

An operation handle with the result from the rpc node

registerGlobalConstant

registerGlobalConstant(params: RegisterGlobalConstantParams): Promise<RegisterGlobalConstantOperation>

- Defined in packages/taquito/src/contract/interface.ts:201
description

Register a Micheline expression in a global table of constants. Will sign and inject an operation using the current context

Parameters
- params: RegisterGlobalConstantParams
  
  registerGlobalConstant operation parameter
Returns Promise<RegisterGlobalConstantOperation>

An operation handle with the result from the rpc node

reveal

reveal(params: RevealParams): Promise<RevealOperation>

- Defined in packages/taquito/src/contract/interface.ts:175
description

Reveal the current address. Will throw an error if the address is already revealed.

Parameters
- params: RevealParams
Returns Promise<RevealOperation>

An operation handle with the result from the rpc node

setDelegate

setDelegate(params: DelegateParams): Promise<DelegateOperation>

- Defined in packages/taquito/src/contract/interface.ts:135
description

Set the delegate for a contract. Will sign and inject an operation using the current context

Parameters
- params: DelegateParams
Returns Promise<DelegateOperation>

An operation handle with the result from the rpc node

smartRollupAddMessages

smartRollupAddMessages(params: SmartRollupAddMessagesParams): Promise<SmartRollupAddMessagesOperation>

- Defined in packages/taquito/src/contract/interface.ts:263
description

Smart Rollup Add Messages

Parameters
- params: SmartRollupAddMessagesParams
Returns Promise<SmartRollupAddMessagesOperation>

An operation handle with the result from the RPC node

smartRollupOriginate

smartRollupOriginate(params: SmartRollupOriginateParams): Promise<SmartRollupOriginateOperation>

- Defined in packages/taquito/src/contract/interface.ts:273
description

Smart rollup originate

Parameters
- params: SmartRollupOriginateParams
Returns Promise<SmartRollupOriginateOperation>

An operation handle with the result from the RPC node

transfer

transfer(params: TransferParams): Promise<TransactionOperation>

- Defined in packages/taquito/src/contract/interface.ts:155
description

Transfer tz from current address to a specific address. Will sign and inject an operation using the current context

Parameters
- params: TransferParams
Returns Promise<TransactionOperation>

An operation handle with the result from the rpc node

transferTicket

transferTicket(params: TransferTicketParams): Promise<TransferTicketOperation>

- Defined in packages/taquito/src/contract/interface.ts:165
description

Transfer tickets from an implicit account to a contract or another implicit account.

Parameters
- params: TransferTicketParams
Returns Promise<TransferTicketOperation>

An operation handle with the result from the rpc node

updateConsensusKey

updateConsensusKey(params: UpdateConsensusKeyParams): Promise<UpdateConsensusKeyOperation>

- Defined in packages/taquito/src/contract/interface.ts:253
description

Update consensus key

Parameters
- params: UpdateConsensusKeyParams
Returns Promise<UpdateConsensusKeyOperation>

An operation handle with the result from the RPC node

Hierarchy

Index

Methods

Methods

at

Type parameters

T: ContractAbstraction<ContractProvider, Record<string, (...args: any[]) => ContractMethod<ContractProvider>>, Record<string, (args?: any) => ContractMethodObject<ContractProvider>>, Record<string, (...args: any[]) => ContractView>, Record<string, (args?: any) => OnChainView>, unknown, T>

Parameters

address: string

Parameters

abs: ContractAbstraction<ContractProvider, Record<string, (...args: any[]) => ContractMethod<ContractProvider>>, Record<string, (args?: any) => ContractMethodObject<ContractProvider>>, Record<string, (...args: any[]) => ContractView>, Record<string, (args?: any) => OnChainView>, unknown>

context: Context

Returns T

Returns Promise<T>

ballot

Parameters

params: BallotParams

Returns Promise<BallotOperation>

batch

Parameters

Optional params: ParamsWithKind[]

Returns OperationBatch

drainDelegate

Parameters

params: DrainDelegateParams

Returns Promise<DrainDelegateOperation>

getBigMapKey

Type parameters

T

Parameters

contract: string

key: string

Optional schema: unknown

Returns Promise<T>

getBigMapKeyByID

Type parameters

T

Parameters

id: string

keyToEncode: BigMapKeyType

schema: Schema

Optional block: number

Returns Promise<T>

getBigMapKeysByID

Type parameters

T

Parameters

id: string

keysToEncode: BigMapKeyType[]

schema: Schema

Optional block: number

Optional batchSize: number

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

getSaplingDiffByID

Parameters

id: string

Optional block: number

Returns Promise<SaplingDiffResponse>

getStorage

Type parameters

T

Parameters

contract: string

Optional schema: unknown

Returns Promise<T>

increasePaidStorage

Parameters

params: IncreasePaidStorageParams

Returns Promise<IncreasePaidStorageOperation>

originate

Type parameters

Parameters

contract: OriginateParams<PromiseReturnType<TContract["storage"]>>

Returns Promise<OriginationOperation<TContract>>

proposals

Parameters

params: ProposalsParams

Returns Promise<ProposalsOperation>

registerDelegate

Parameters