Class Wallet

Hierarchy

Wallet

Index

Constructors

constructor

Methods

at batch getPK increasePaidStorage originate pkh registerDelegate setDelegate signFailingNoop transfer

Constructors

constructor

new Wallet(context): Wallet
Parameters
- context: Context
Returns Wallet
- Defined in packages/taquito/src/wallet/wallet.ts:191

Methods

at

at<T>(address, contractAbstractionComposer?): Promise<T>
Type Parameters
- T extends ContractAbstraction<Wallet, DefaultMethods<Wallet>, DefaultMethodsObject<Wallet>, DefaultViews, DefaultContractViews, unknown>
Parameters
- address: string
  
  Smart contract address
- contractAbstractionComposer: ((abs, context) => T) = ...
  - - (abs, context): T
    - Parameters
      
      abs: ContractAbstraction<Wallet, DefaultMethods<Wallet>, DefaultMethodsObject<Wallet>, DefaultViews, DefaultContractViews, unknown>
      
      context: Context
      
      Returns T
Returns Promise<T>

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

Throws
InvalidContractAddressError If the contract address is not valid
- Defined in packages/taquito/src/wallet/wallet.ts:387

batch

batch(params?): WalletOperationBatch
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

Description
Create a batch of operation
- Defined in packages/taquito/src/wallet/wallet.ts:369

getPK

getPK(): Promise<string>
Returns Promise<string>
- Defined in packages/taquito/src/wallet/wallet.ts:412

increasePaidStorage

increasePaidStorage(params): {
send: (() => Promise<IncreasePaidStorageWalletOperation>);
}
Parameters
- params: WalletIncreasePaidStorageParams
Returns {
send: (() => Promise<IncreasePaidStorageWalletOperation>);
}
- send: (() => Promise<IncreasePaidStorageWalletOperation>)
  - - (): Promise<IncreasePaidStorageWalletOperation>
    - Returns Promise<IncreasePaidStorageWalletOperation>
Description
- Defined in packages/taquito/src/wallet/wallet.ts:347

originate

originate<TWallet>(params): {
send: (() => Promise<OriginationWalletOperation<TWallet>>);
}
Type Parameters
- TWallet extends DefaultWalletType = DefaultWalletType
Parameters
- params: WalletOriginateParams<ContractStorageType<TWallet>>
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>>
Description
Originate a new contract according to the script in parameters.
- Defined in packages/taquito/src/wallet/wallet.ts:227

pkh

pkh(option?): Promise<string>
Parameters
- option: PKHOption = {}
  
  Option to use while fetching the PKH. If forceRefetch is specified the wallet provider implementation will refetch the PKH from the wallet
Returns Promise<string>

Description
Retrieve the PKH of the account that is currently in use by the wallet
- Defined in packages/taquito/src/wallet/wallet.ts:205

registerDelegate

registerDelegate(): {
send: (() => Promise<DelegationWalletOperation>);
}
Returns {
send: (() => Promise<DelegationWalletOperation>);
}
An operation handle with the result from the rpc node
- send: (() => Promise<DelegationWalletOperation>)
  - - (): Promise<DelegationWalletOperation>
    - Returns Promise<DelegationWalletOperation>
Description
Register the current address as delegate.
- Defined in packages/taquito/src/wallet/wallet.ts:306

setDelegate

setDelegate(params): {
send: (() => Promise<DelegationWalletOperation>);
}
Parameters
- params: WalletDelegateParams
Returns {
send: (() => Promise<DelegationWalletOperation>);
}
An operation handle with the result from the rpc node
- send: (() => Promise<DelegationWalletOperation>)
  - - (): Promise<DelegationWalletOperation>
    - Returns Promise<DelegationWalletOperation>
Description
Set the delegate for a contract.
- Defined in packages/taquito/src/wallet/wallet.ts:251

signFailingNoop

signFailingNoop(params): Promise<{
    bytes: string;
    signature: string;
    signedContent: {
        branch: string;
        contents: {
            arbitrary: string;
            kind: OpKind;
        }[];
    };
}>
Parameters
- params: WalletFailingNoopParams
  
  operation parameter
Returns Promise<{
    bytes: string;
    signature: string;
    signedContent: {
        branch: string;
        contents: {
            arbitrary: string;
            kind: OpKind;
        }[];
    };
}>
Signature for a failing_noop

Description
failing_noop operation that is guaranteed to fail. DISCLAIMER: Not all wallets support signing failing_noop operations.
- Defined in packages/taquito/src/wallet/wallet.ts:273

transfer

transfer(params): {
send: (() => Promise<TransactionWalletOperation>);
}
Parameters
- params: WalletTransferParams
  
  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>
Description
Transfer tezos tokens from current address to a specific address or call a smart contract.
- Defined in packages/taquito/src/wallet/wallet.ts:325

Class Wallet

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

context: Context

Returns Wallet

Methods

at

Type Parameters

T extends ContractAbstraction<Wallet, DefaultMethods<Wallet>, DefaultMethodsObject<Wallet>, DefaultViews, DefaultContractViews, unknown>

Parameters

address: string

contractAbstractionComposer: ((abs, context) => T) = ...

Parameters

abs: ContractAbstraction<Wallet, DefaultMethods<Wallet>, DefaultMethodsObject<Wallet>, DefaultViews, DefaultContractViews, unknown>

context: Context

Returns T

Returns Promise<T>

Description

Throws

batch

Parameters

Optional params: WalletParamsWithKind[]

Returns WalletOperationBatch

Description

getPK

Returns Promise<string>

increasePaidStorage

Parameters

params: WalletIncreasePaidStorageParams

Returns { send: (() => Promise<IncreasePaidStorageWalletOperation>); }

send: (() => Promise<IncreasePaidStorageWalletOperation>)

Returns Promise<IncreasePaidStorageWalletOperation>

Description

originate

Type Parameters

TWallet extends DefaultWalletType = DefaultWalletType

Parameters

params: WalletOriginateParams<ContractStorageType<TWallet>>

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

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

Returns Promise<OriginationWalletOperation<TWallet>>

Description

pkh

Parameters

option: PKHOption = {}

Returns Promise<string>

Description

registerDelegate

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

send: (() => Promise<DelegationWalletOperation>)

Returns Promise<DelegationWalletOperation>

Description

setDelegate

Parameters

params: WalletDelegateParams

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

send: (() => Promise<DelegationWalletOperation>)

Returns Promise<DelegationWalletOperation>

Description

signFailingNoop

Parameters

params: WalletFailingNoopParams

Returns Promise<{ bytes: string; signature: string; signedContent: { branch: string; contents: { arbitrary: string; kind: OpKind; }[]; }; }>

Description

transfer

Parameters

params: WalletTransferParams

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

send: (() => Promise<TransactionWalletOperation>)

Returns Promise<TransactionWalletOperation>

Description

Settings

Member Visibility

Theme

On This Page

`Optional` params: WalletParamsWithKind[]

Returns {
send: (() => Promise<IncreasePaidStorageWalletOperation>);
}

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

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

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

Returns Promise<{
bytes: string;
signature: string;
signedContent: {
branch: string;
contents: {
arbitrary: string;
kind: OpKind;
}[];
};
}>

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