Interface IWBTCContract

Description

This interface represents the WBTC contract. IWBTCContract

Cathegory

Contracts

interface IWBTCContract {
    address: BitcoinAddressLike;
    allowance(owner: BitcoinAddressLike, spender: BitcoinAddressLike): Promise<BaseContractProperty>;
    approve(spender: BitcoinAddressLike, value: bigint): Promise<BaseContractProperty>;
    balanceOf(address: BitcoinAddressLike): Promise<BaseContractProperty>;
    burn(to: BitcoinAddressLike, value: bigint): Promise<BaseContractProperty>;
    claim(): Promise<BaseContractProperties>;
    decimals(): Promise<BaseContractProperty>;
    decodeEvent(event: NetEvent): OPNetEvent<{}>;
    decodeEvents(events: ContractEvents | NetEvent[]): OPNetEvent<{}>[];
    encodeCalldata(method: string, ...args: unknown[]): Buffer;
    isAddressOwner(address: BitcoinAddressLike): Promise<BaseContractProperty>;
    mint(to: BitcoinAddressLike, value: bigint): Promise<BaseContractProperty>;
    name(): Promise<BaseContractProperty>;
    owner(): Promise<BaseContractProperty>;
    requestWithdrawal(amount: bigint): Promise<BaseContractProperty>;
    rewardPool(): Promise<BaseContractProperties>;
    setSender(sender: BitcoinAddressLike): void;
    stake(amount: bigint): Promise<BaseContractProperties>;
    stakedAmount(address: string): Promise<BaseContractProperties>;
    stakedReward(address: string): Promise<BaseContractProperties>;
    symbol(): Promise<BaseContractProperty>;
    totalStaked(): Promise<BaseContractProperties>;
    totalSupply(): Promise<BaseContractProperty>;
    transfer(to: BitcoinAddressLike, value: bigint): Promise<BaseContractProperty>;
    transferFrom(from: BitcoinAddressLike, to: BitcoinAddressLike, value: bigint): Promise<BaseContractProperty>;
    unstake(): Promise<BaseContractProperties>;
    withdrawableBalanceOf(address: string): Promise<BaseContractProperty>;
}

Hierarchy (view full)

MergedOP_20AndStackingContract
- IWBTCContract

Properties

`Readonly`address

address: BitcoinAddressLike

Methods

allowance

allowance(owner, spender): Promise<BaseContractProperty>
Parameters
- owner: BitcoinAddressLike
- spender: BitcoinAddressLike
Returns Promise<BaseContractProperty>
Inherited from MergedOP_20AndStackingContract.allowance
- Defined in src/abi/shared/interfaces/IOP_20Contract.ts:53

approve

approve(spender, value): Promise<BaseContractProperty>
Parameters
- spender: BitcoinAddressLike
- value: bigint
Returns Promise<BaseContractProperty>
Inherited from MergedOP_20AndStackingContract.approve
- Defined in src/abi/shared/interfaces/IOP_20Contract.ts:51

balanceOf

balanceOf(address): Promise<BaseContractProperty>
Parameters
- address: BitcoinAddressLike
Returns Promise<BaseContractProperty>
Inherited from MergedOP_20AndStackingContract.balanceOf
- Defined in src/abi/shared/interfaces/IOP_20Contract.ts:33

burn

burn(to, value): Promise<BaseContractProperty>
Parameters
- to: BitcoinAddressLike
- value: bigint
Returns Promise<BaseContractProperty>
Inherited from MergedOP_20AndStackingContract.burn
- Defined in src/abi/shared/interfaces/IOP_20Contract.ts:60

claim

claim(): Promise<BaseContractProperties>
Returns Promise<BaseContractProperties>
Inherited from MergedOP_20AndStackingContract.claim
- Defined in src/abi/shared/interfaces/IStackingContract.ts:19

decimals

decimals(): Promise<BaseContractProperty>
Returns Promise<BaseContractProperty>
Inherited from MergedOP_20AndStackingContract.decimals
- Defined in src/abi/shared/interfaces/IOP_20Contract.ts:41

decodeEvent

decodeEvent(event): OPNetEvent<{}>
Parameters
- event: NetEvent
Returns OPNetEvent<{}>
Inherited from MergedOP_20AndStackingContract.decodeEvent
- Defined in src/contracts/interfaces/IContract.ts:18

decodeEvents

decodeEvents(events): OPNetEvent<{}>[]
Parameters
- events: ContractEvents | NetEvent[]
Returns OPNetEvent<{}>[]
Inherited from MergedOP_20AndStackingContract.decodeEvents
- Defined in src/contracts/interfaces/IContract.ts:16

encodeCalldata

encodeCalldata(method, ...args): Buffer
Parameters
- method: string
- Rest...args: unknown[]
Returns Buffer
Inherited from MergedOP_20AndStackingContract.encodeCalldata
- Defined in src/contracts/interfaces/IContract.ts:20

isAddressOwner

isAddressOwner(address): Promise<BaseContractProperty>
Parameters
- address: BitcoinAddressLike
Returns Promise<BaseContractProperty>
Inherited from MergedOP_20AndStackingContract.isAddressOwner
- Defined in src/abi/shared/interfaces/IOP_NETContract.ts:14

mint

mint(to, value): Promise<BaseContractProperty>
Parameters
- to: BitcoinAddressLike
- value: bigint
Returns Promise<BaseContractProperty>
Inherited from MergedOP_20AndStackingContract.mint
- Defined in src/abi/shared/interfaces/IOP_20Contract.ts:58

name

name(): Promise<BaseContractProperty>
Returns Promise<BaseContractProperty>
Inherited from MergedOP_20AndStackingContract.name
- Defined in src/abi/shared/interfaces/IOP_20Contract.ts:35

owner

owner(): Promise<BaseContractProperty>
Returns Promise<BaseContractProperty>
Inherited from MergedOP_20AndStackingContract.owner
- Defined in src/abi/shared/interfaces/IOP_NETContract.ts:12

requestWithdrawal

requestWithdrawal(amount): Promise<BaseContractProperty>
Parameters
- amount: bigint
  The amount to withdraw.
Returns Promise<BaseContractProperty>
A promise that resolves to a boolean indicating if the withdrawal was successful.

Description
Request a withdrawal of the specified amount.
- Defined in src/abi/shared/interfaces/IWBTCContract.ts:26

rewardPool

rewardPool(): Promise<BaseContractProperties>
Returns Promise<BaseContractProperties>
Inherited from MergedOP_20AndStackingContract.rewardPool
- Defined in src/abi/shared/interfaces/IStackingContract.ts:21

setSender

setSender(sender): void
Parameters
- sender: BitcoinAddressLike
Returns void
Inherited from MergedOP_20AndStackingContract.setSender
- Defined in src/contracts/interfaces/IContract.ts:14

stake

stake(amount): Promise<BaseContractProperties>
Parameters
- amount: bigint
Returns Promise<BaseContractProperties>
Inherited from MergedOP_20AndStackingContract.stake
- Defined in src/abi/shared/interfaces/IStackingContract.ts:11

stakedAmount

stakedAmount(address): Promise<BaseContractProperties>
Parameters
- address: string
Returns Promise<BaseContractProperties>
Inherited from MergedOP_20AndStackingContract.stakedAmount
- Defined in src/abi/shared/interfaces/IStackingContract.ts:15

stakedReward

stakedReward(address): Promise<BaseContractProperties>
Parameters
- address: string
Returns Promise<BaseContractProperties>
Inherited from MergedOP_20AndStackingContract.stakedReward
- Defined in src/abi/shared/interfaces/IStackingContract.ts:17

symbol

symbol(): Promise<BaseContractProperty>
Returns Promise<BaseContractProperty>
Inherited from MergedOP_20AndStackingContract.symbol
- Defined in src/abi/shared/interfaces/IOP_20Contract.ts:37

totalStaked

totalStaked(): Promise<BaseContractProperties>
Returns Promise<BaseContractProperties>
Inherited from MergedOP_20AndStackingContract.totalStaked
- Defined in src/abi/shared/interfaces/IStackingContract.ts:23

totalSupply

totalSupply(): Promise<BaseContractProperty>
Returns Promise<BaseContractProperty>
Inherited from MergedOP_20AndStackingContract.totalSupply
- Defined in src/abi/shared/interfaces/IOP_20Contract.ts:39

transfer

transfer(to, value): Promise<BaseContractProperty>
Parameters
- to: BitcoinAddressLike
- value: bigint
Returns Promise<BaseContractProperty>
Inherited from MergedOP_20AndStackingContract.transfer
- Defined in src/abi/shared/interfaces/IOP_20Contract.ts:43

transferFrom

transferFrom(from, to, value): Promise<BaseContractProperty>
Parameters
- from: BitcoinAddressLike
- to: BitcoinAddressLike
- value: bigint
Returns Promise<BaseContractProperty>
Inherited from MergedOP_20AndStackingContract.transferFrom
- Defined in src/abi/shared/interfaces/IOP_20Contract.ts:45

unstake

unstake(): Promise<BaseContractProperties>
Returns Promise<BaseContractProperties>
Inherited from MergedOP_20AndStackingContract.unstake
- Defined in src/abi/shared/interfaces/IStackingContract.ts:13

withdrawableBalanceOf

withdrawableBalanceOf(address): Promise<BaseContractProperty>
Parameters
- address: string
  The address to check.
Returns Promise<BaseContractProperty>
A promise that resolves to the balance.

Description
Get the withdrawable balance of the specified address.
- Defined in src/abi/shared/interfaces/IWBTCContract.ts:33