Class Wallet

Index

Constructors

Methods

at atExactBlock batch finalizeUnstake increasePaidStorage originate pk pkh registerDelegate registerGlobalConstant setDelegate signFailingNoop stake transfer transferTicket unstake

Constructors

constructor

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

Methods

at

at<
    T extends
        ContractAbstraction<
            Wallet,
            DefaultMethodsObject<Wallet>,
            DefaultViews,
            DefaultContractViews,
            unknown,
        >,
>(
    address: string,
    contractAbstractionComposer?: (
        abs: ContractAbstraction<Wallet>,
        context: Context,
    ) => T,
    block?: BlockIdentifier,
): Promise<T>
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 extends ContractAbstraction<
      Wallet,
      DefaultMethodsObject<Wallet>,
      DefaultViews,
      DefaultContractViews,
      unknown,
  >
Parameters
- address: string
  Smart contract address
- contractAbstractionComposer: (abs: ContractAbstraction<Wallet>, context: Context) => T = ...
- block: BlockIdentifier = 'head'
Returns Promise<T>
Throws
InvalidContractAddressError If the contract address is not valid
- Defined in packages/taquito/src/wallet/wallet.ts:503

atExactBlock

atExactBlock<
    T extends
        ContractAbstraction<
            Wallet,
            DefaultMethodsObject<Wallet>,
            DefaultViews,
            DefaultContractViews,
            unknown,
        >,
>(
    address: string,
    contractAbstractionComposer?: (
        abs: ContractAbstraction<Wallet>,
        context: Context,
    ) => T,
    block: BlockIdentifier,
): Promise<T>
Type Parameters
- T extends ContractAbstraction<
      Wallet,
      DefaultMethodsObject<Wallet>,
      DefaultViews,
      DefaultContractViews,
      unknown,
  >
Parameters
- address: string
- contractAbstractionComposer: (abs: ContractAbstraction<Wallet>, context: Context) => T = ...
- block: BlockIdentifier
Returns Promise<T>
- Defined in packages/taquito/src/wallet/wallet.ts:558

batch

batch(params?: WalletParamsWithKind[]): WalletOperationBatch
Create a batch of operation
Parameters
- Optionalparams: 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
- Defined in packages/taquito/src/wallet/wallet.ts:487

finalizeUnstake

finalizeUnstake(
params: WalletFinalizeUnstakeParams,
): { send: () => Promise<TransactionWalletOperation> }
Transfer all the finalizable unstaked funds of the source to their liquid balance
Parameters
- params: WalletFinalizeUnstakeParams
  Finalize_unstake pseudo-operation parameter
Returns { send: () => Promise<TransactionWalletOperation> }
a TransactionWalletOperation promise object when followed by .send()
- Defined in packages/taquito/src/wallet/wallet.ts:425

increasePaidStorage

increasePaidStorage(
params: WalletIncreasePaidStorageParams,
): { send: () => Promise<IncreasePaidStorageWalletOperation> }
Increase the paid storage of a smart contract.
Parameters
- params: WalletIncreasePaidStorageParams
  operation parameter
Returns { send: () => Promise<IncreasePaidStorageWalletOperation> }
a IncreasePaidStorageWalletOperation promise object when followed by .send()
- Defined in packages/taquito/src/wallet/wallet.ts:453

originate

originate<TWallet extends DefaultWalletType = DefaultWalletType>(
params: WalletOriginateParams<ContractStorageType<TWallet>>,
): { send: () => Promise<OriginationWalletOperation<TWallet>> }
Originate a new contract according to the script in parameters.
Type Parameters
- TWallet extends DefaultWalletType = DefaultWalletType
Parameters
- params: WalletOriginateParams<ContractStorageType<TWallet>>
  Originate operation parameter
Returns { send: () => Promise<OriginationWalletOperation<TWallet>> }
a OriginationWalletOperation promise object when followed by .send()
- Defined in packages/taquito/src/wallet/wallet.ts:252

pk

pk(option?: PKHOption): Promise<string>
Retrieve the PK of the account that is currently in use by the wallet
Parameters
- option: PKHOption = {}
  Option to use while fetching the PK. If forceRefetch is specified the wallet provider implementation will refetch the PK from the wallet
Returns Promise<string>
- Defined in packages/taquito/src/wallet/wallet.ts:234

pkh

pkh(option?: PKHOption): Promise<string>
Retrieve the PKH of the account that is currently in use by the wallet
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>
- Defined in packages/taquito/src/wallet/wallet.ts:222

registerDelegate

registerDelegate(): { send: () => Promise<DelegationWalletOperation> }
Register the current address as delegate.

Returns { send: () => Promise<DelegationWalletOperation> }
a DelegationWalletOperation promise object when followed by .send()
- Defined in packages/taquito/src/wallet/wallet.ts:322

registerGlobalConstant

registerGlobalConstant(
params: WalletRegisterGlobalConstantParams,
): { send: () => Promise<RegisterGlobalConstantWalletOperation> }
Register a Micheline expression in a global table of constants.
Parameters
- params: WalletRegisterGlobalConstantParams
  operation parameter
Returns { send: () => Promise<RegisterGlobalConstantWalletOperation> }
a RegisterGlobalConstantWalletOperation promise object when followed by .send()
- Defined in packages/taquito/src/wallet/wallet.ts:472

setDelegate

setDelegate(
params: WalletDelegateParams,
): { send: () => Promise<DelegationWalletOperation> }
Set the delegate for a contract.
Parameters
- params: WalletDelegateParams
  operation parameter
Returns { send: () => Promise<DelegationWalletOperation> }
a WalletDelegateParams promise object when followed by .send()
- Defined in packages/taquito/src/wallet/wallet.ts:273

signFailingNoop

signFailingNoop(
    params: WalletFailingNoopParams,
): Promise<
    {
        bytes: string;
        signature: string;
        signedContent: {
            branch: string;
            contents: { arbitrary: string; kind: OpKind }[];
        };
    },
>
failing_noop operation that is guaranteed to fail. DISCLAIMER: Not all wallets support signing failing_noop operations.
Parameters
- params: WalletFailingNoopParams
  operation parameter
Returns Promise<
    {
        bytes: string;
        signature: string;
        signedContent: {
            branch: string;
            contents: { arbitrary: string; kind: OpKind }[];
        };
    },
>
Signature for a failing_noop
- Defined in packages/taquito/src/wallet/wallet.ts:292

stake

stake(
params: WalletStakeParams,
): { send: () => Promise<TransactionWalletOperation> }
Stake a given amount for the source address
Parameters
- params: WalletStakeParams
  Stake pseudo-operation parameter
Returns { send: () => Promise<TransactionWalletOperation> }
a TransactionWalletOperation promise object when followed by .send()
- Defined in packages/taquito/src/wallet/wallet.ts:377

transfer

transfer(
params: WalletTransferParams,
): { send: () => Promise<TransactionWalletOperation> }
Transfer tezos tokens from current address to a specific address or call a smart contract.
Parameters
- params: WalletTransferParams
  operation parameter
Returns { send: () => Promise<TransactionWalletOperation> }
a TransactionWalletOperation promise object when followed by .send()
- Defined in packages/taquito/src/wallet/wallet.ts:338

transferTicket

transferTicket(
params: WalletTransferTicketParams,
): { send: () => Promise<TransferTicketWalletOperation> }
Transfer tezos tickets from current address to a specific address or a smart contract
Parameters
- params: WalletTransferTicketParams
  operation parameter
Returns { send: () => Promise<TransferTicketWalletOperation> }
a TransferTicketWalletOperation promise object when followed by .send()
- Defined in packages/taquito/src/wallet/wallet.ts:357

unstake

unstake(
params: WalletUnstakeParams,
): { send: () => Promise<TransactionWalletOperation> }
Unstake the given amount. If "everything" is given as amount, unstakes everything from the staking balance. Unstaked tez remains frozen for a set amount of cycles (the slashing period) after the operation. Once this period is over, the operation "finalize unstake" must be called for the funds to appear in the liquid balance.
Parameters
- params: WalletUnstakeParams
  Unstake pseudo-operation parameter
Returns { send: () => Promise<TransactionWalletOperation> }
a TransactionWalletOperation promise object when followed by .send()
- Defined in packages/taquito/src/wallet/wallet.ts:402

Class Wallet

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Wallet

Methods

at

Type Parameters

Parameters

Returns Promise<T>

Throws

atExactBlock

Type Parameters

Parameters

Returns Promise<T>

batch

Parameters

Returns WalletOperationBatch

finalizeUnstake

Parameters

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

increasePaidStorage

Parameters

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

originate

Type Parameters

Parameters

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

pk

Parameters

Returns Promise<string>

pkh

Parameters

Returns Promise<string>

registerDelegate

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

registerGlobalConstant

Parameters

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

setDelegate

Parameters

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

signFailingNoop

Parameters

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

stake

Parameters

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

transfer

Parameters

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

transferTicket

Parameters

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

unstake

Parameters

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

Settings

On This Page

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