Wallet | Taquito

Hierarchy

Wallet

Index

Constructors

constructor

Methods

Constructors

constructor

new Wallet(context: Context): Wallet

- Defined in packages/taquito/src/wallet/wallet.ts:158
Parameters
- context: Context
Returns Wallet

Methods

at

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

- Defined in packages/taquito/src/wallet/wallet.ts:296
description

Create an smart contract abstraction for the address specified. Calling entrypoints with the returned smart contract abstraction will leverage the wallet provider to make smart contract calls

Type parameters
- T: ContractAbstraction<Wallet, Record<string, (...args: any[]) => ContractMethod<Wallet>>, Record<string, (args?: any) => ContractMethodObject<Wallet>>, Record<string, (...args: any[]) => ContractView>, Record<string, (args?: any) => OnChainView>, unknown, T>
Parameters
- address: string
  
  Smart contract address
- contractAbstractionComposer: (abs: ContractAbstraction<Wallet, Record<string, (...args: any[]) => ContractMethod<Wallet>>, Record<string, (args?: any) => ContractMethodObject<Wallet>>, Record<string, (...args: any[]) => ContractView>, Record<string, (args?: any) => OnChainView>, unknown>, context: Context) => T = ...
  - - (abs: ContractAbstraction<Wallet, Record<string, (...args: any[]) => ContractMethod<Wallet>>, Record<string, (args?: any) => ContractMethodObject<Wallet>>, Record<string, (...args: any[]) => ContractView>, Record<string, (args?: any) => OnChainView>, unknown>, context: Context): T
    - Parameters
      - abs: ContractAbstraction<Wallet, Record<string, (...args: any[]) => ContractMethod<Wallet>>, Record<string, (args?: any) => ContractMethodObject<Wallet>>, Record<string, (...args: any[]) => ContractView>, Record<string, (args?: any) => OnChainView>, unknown>
      - context: Context
      Returns T
Returns Promise<T>

batch

batch(params?: WalletParamsWithKind[]): WalletOperationBatch

- Defined in packages/taquito/src/wallet/wallet.ts:279
description

Create a batch of operation

Parameters
- Optional params: WalletParamsWithKind[]
  
  List of operation to initialize the batch with
Returns WalletOperationBatch

A batch object from which we can add more operation or send a command to the wallet to execute the batch

originate

originate<TWallet>(params: Pick<OriginateParams<PromiseReturnType<TWallet["storage"]>>, "mutez" | "fee" | "gasLimit" | "storageLimit" | "balance" | "code" | "delegate" | "init" | "storage">): { send: () => Promise<OriginationWalletOperation<TWallet>> }

- Defined in packages/taquito/src/wallet/wallet.ts:195
description

Originate a new contract according to the script in parameters.

Type parameters
- TWallet: ContractAbstraction<Wallet, Record<string, (...args: any[]) => ContractMethod<Wallet>>, Record<string, (args?: any) => ContractMethodObject<Wallet>>, Record<string, (...args: any[]) => ContractView>, Record<string, (args?: any) => OnChainView>, unknown, TWallet> = DefaultWalletType
Parameters
- params: Pick<OriginateParams<PromiseReturnType<TWallet["storage"]>>, "mutez" | "fee" | "gasLimit" | "storageLimit" | "balance" | "code" | "delegate" | "init" | "storage">
Returns { send: () => Promise<OriginationWalletOperation<TWallet>> }

An operation handle with the result from the rpc node
- send: () => Promise<OriginationWalletOperation<TWallet>>
  - - (): Promise<OriginationWalletOperation<TWallet>>
    - Returns Promise<OriginationWalletOperation<TWallet>>

pkh

pkh(__namedParameters?: PKHOption): Promise<string>

- Defined in packages/taquito/src/wallet/wallet.ts:173
description

Retrieve the PKH of the account that is currently in use by the wallet

Parameters
- __namedParameters: PKHOption = {}
Returns Promise<string>

registerDelegate

registerDelegate(): { send: () => Promise<DelegationWalletOperation> }

- Defined in packages/taquito/src/wallet/wallet.ts:239
description

Register the current address as delegate.

Returns { send: () => Promise<DelegationWalletOperation> }

An operation handle with the result from the rpc node
- send: () => Promise<DelegationWalletOperation>
  - - (): Promise<DelegationWalletOperation>
    - Returns Promise<DelegationWalletOperation>

setDelegate

setDelegate(params: Pick<DelegateParams, "fee" | "gasLimit" | "storageLimit" | "delegate">): { send: () => Promise<DelegationWalletOperation> }

- Defined in packages/taquito/src/wallet/wallet.ts:219
description

Set the delegate for a contract.

Parameters
- params: Pick<DelegateParams, "fee" | "gasLimit" | "storageLimit" | "delegate">
Returns { send: () => Promise<DelegationWalletOperation> }

An operation handle with the result from the rpc node
- send: () => Promise<DelegationWalletOperation>
  - - (): Promise<DelegationWalletOperation>
    - Returns Promise<DelegationWalletOperation>

transfer

transfer(params: Pick<TransferParams, "mutez" | "to" | "amount" | "fee" | "parameter" | "gasLimit" | "storageLimit">): { send: () => Promise<TransactionWalletOperation> }

- Defined in packages/taquito/src/wallet/wallet.ts:258
description

Transfer tezos tokens from current address to a specific address or call a smart contract.

Parameters
- params: Pick<TransferParams, "mutez" | "to" | "amount" | "fee" | "parameter" | "gasLimit" | "storageLimit">
  
  operation parameter
Returns { send: () => Promise<TransactionWalletOperation> }

A wallet command from which we can send the operation to the wallet
- send: () => Promise<TransactionWalletOperation>
  - - (): Promise<TransactionWalletOperation>
    - Returns Promise<TransactionWalletOperation>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

context: Context

Returns Wallet

Methods

at

Type parameters

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

Parameters

address: string

Parameters

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

context: Context

Returns T

Returns Promise<T>

batch

Parameters

Optional params: WalletParamsWithKind[]

Returns WalletOperationBatch

originate

Type parameters

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

Parameters

params: Pick<OriginateParams<PromiseReturnType<TWallet["storage"]>>, "mutez" | "fee" | "gasLimit" | "storageLimit" | "balance" | "code" | "delegate" | "init" | "storage">

Returns { send: () => Promise<OriginationWalletOperation<TWallet>> }

send: () => Promise<OriginationWalletOperation<TWallet>>

Returns Promise<OriginationWalletOperation<TWallet>>

pkh

Parameters

__namedParameters: PKHOption = {}

Returns Promise<string>

registerDelegate

Returns { send: () => Promise<DelegationWalletOperation> }

send: () => Promise<DelegationWalletOperation>

Returns Promise<DelegationWalletOperation>

setDelegate

Parameters

params: Pick<DelegateParams, "fee" | "gasLimit" | "storageLimit" | "delegate">

Returns { send: () => Promise<DelegationWalletOperation> }

send: () => Promise<DelegationWalletOperation>

Returns Promise<DelegationWalletOperation>

transfer

Parameters

params: Pick<TransferParams, "mutez" | "to" | "amount" | "fee" | "parameter" | "gasLimit" | "storageLimit">

Returns { send: () => Promise<TransactionWalletOperation> }

send: () => Promise<TransactionWalletOperation>

Returns Promise<TransactionWalletOperation>