ocean.js/docs/classes/VeOcean.md

@oceanprotocol/lib / Exports / VeOcean

Class: VeOcean

Provides an interface for veOcean contract

Hierarchy

• SmartContractWithAddress

  ↳ VeOcean

Table of contents

Constructors

• constructor

Properties

• abi
• address
• config
• contract
• signer

Methods

• amountToUnits
• depositFor
• getContract
• getDefaultAbi
• getFairGasPrice
• getLockedAmount
• getToken
• getVotingPower
• increaseAmount
• increaseUnlockTime
• lockEnd
• lockTokens
• totalSupply
• unitsToAmount
• withdraw

Constructors

constructor

• new VeOcean(address, signer, network?, config?, abi?)

Instantiate the smart contract.

Parameters

Name	Type	Description
address	string	The address of the contract.
signer	Signer	The signer object.
network?	string | number	Network id or name
config?	Config	The configuration object.
abi?	AbiItem[]	ABI array of the smart contract

Inherited from

SmartContractWithAddress.constructor

Defined in

contracts/SmartContractWithAddress.ts:17

Properties

abi

• abi: AbiItem[]

Inherited from

SmartContractWithAddress.abi

Defined in

contracts/SmartContract.ts:14

---

address

• address: string

Inherited from

SmartContractWithAddress.address

Defined in

contracts/SmartContractWithAddress.ts:6

---

config

• config: Config

Inherited from

SmartContractWithAddress.config

Defined in

contracts/SmartContract.ts:13

---

contract

• contract: Contract

Inherited from

SmartContractWithAddress.contract

Defined in

contracts/SmartContractWithAddress.ts:7

---

signer

• signer: Signer

Inherited from

SmartContractWithAddress.signer

Defined in

contracts/SmartContract.ts:12

Methods

amountToUnits

▸ Protected amountToUnits(token, amount, tokenDecimals?): Promise<string>

Converts an amount of tokens to units

Parameters

Name	Type	Description
token	string	The token to convert
amount	string	The amount of tokens to convert
tokenDecimals?	number	The number of decimals of the token

Returns

Promise<string>

• The converted amount in units

Inherited from

SmartContractWithAddress.amountToUnits

Defined in

contracts/SmartContract.ts:43

---

depositFor

▸ depositFor<G>(toAddress, amount, estimateGas?): Promise<ReceiptOrEstimate<G>>

Deposit amount tokens for toAddress and add to the existing lock Anyone (even a smart contract) can deposit for someone else, but cannot extend their locktime and deposit for a brand new user

Type parameters

Name	Type
G	extends boolean = false

Parameters

Name	Type	Description
toAddress	string	user address to deposit for
amount	string	Amount of tokens to be locked
estimateGas?	G	if True, return gas estimate

Returns

Promise<ReceiptOrEstimate<G>>

Defined in

contracts/ve/VeOcean.ts:52

---

getContract

▸ Protected getContract(address, abi?): Contract

Returns a contract instance for the given address

Parameters

Name	Type	Description
address	string	The address of the contract
abi?	AbiItem[]	The ABI of the contract

Returns

Contract

• The contract instance

Inherited from

SmartContractWithAddress.getContract

Defined in

contracts/SmartContract.ts:80

---

getDefaultAbi

▸ getDefaultAbi(): AbiItem[]

Returns

AbiItem[]

Overrides

SmartContractWithAddress.getDefaultAbi

Defined in

contracts/ve/VeOcean.ts:9

---

getFairGasPrice

▸ Protected getFairGasPrice(): Promise<string>

Retruns the gas price

Returns

Promise<string>

• The fair gas price

Inherited from

SmartContractWithAddress.getFairGasPrice

Defined in

contracts/SmartContract.ts:70

---

getLockedAmount

▸ getLockedAmount(userAddress): Promise<string>

Get locked balance

Parameters

Name	Type	Description
userAddress	string	user address

Returns

Promise<string>

Defined in

contracts/ve/VeOcean.ts:156

---

getToken

▸ getToken(): Promise<string>

Get token

Returns

Promise<string>

Defined in

contracts/ve/VeOcean.ts:189

---

getVotingPower

▸ getVotingPower(userAddress): Promise<number>

Get voting power for address

Parameters

Name	Type	Description
userAddress	string	user address

Returns

Promise<number>

Defined in

contracts/ve/VeOcean.ts:147

---

increaseAmount

▸ increaseAmount<G>(amount, estimateGas?): Promise<ReceiptOrEstimate<G>>

Deposit amount additional tokens for userAddress without modifying the unlock time

Type parameters

Name	Type
G	extends boolean = false

Parameters

Name	Type	Description
amount	string	Amount of tokens to be locked
estimateGas?	G	if True, return gas estimate

Returns

Promise<ReceiptOrEstimate<G>>

Defined in

contracts/ve/VeOcean.ts:79

---

increaseUnlockTime

▸ increaseUnlockTime<G>(unlockTime, estimateGas?): Promise<ReceiptOrEstimate<G>>

Extend the unlock time for userAddress to unlockTime

Type parameters

Name	Type
G	extends boolean = false

Parameters

Name	Type	Description
unlockTime	number	Timestamp for new unlock time
estimateGas?	G	if True, return gas estimate

Returns

Promise<ReceiptOrEstimate<G>>

Defined in

contracts/ve/VeOcean.ts:104

---

lockEnd

▸ lockEnd(userAddress): Promise<number>

Get untilLock for address

Parameters

Name	Type	Description
userAddress	string	user address

Returns

Promise<number>

Defined in

contracts/ve/VeOcean.ts:170

---

lockTokens

▸ lockTokens<G>(amount, unlockTime, estimateGas?): Promise<ReceiptOrEstimate<G>>

Deposit amount tokens for userAddress and lock until unlockTime

Type parameters

Name	Type
G	extends boolean = false

Parameters

Name	Type	Description
amount	string	Amount of tokens to be locked
unlockTime	number	Timestamp for unlock
estimateGas?	G	if True, return gas estimate

Returns

Promise<ReceiptOrEstimate<G>>

Defined in

contracts/ve/VeOcean.ts:20

---

totalSupply

▸ totalSupply(): Promise<string>

Get total supply

Returns

Promise<string>

Defined in

contracts/ve/VeOcean.ts:178

---

unitsToAmount

▸ Protected unitsToAmount(token, amount, tokenDecimals?): Promise<string>

Converts an amount of units to tokens

Parameters

Name	Type	Description
token	string	The token to convert
amount	string	The amount of units to convert
tokenDecimals?	number	The number of decimals in the token

Returns

Promise<string>

• The converted amount in tokens

Inherited from

SmartContractWithAddress.unitsToAmount

Defined in

contracts/SmartContract.ts:58

---

withdraw

▸ withdraw<G>(estimateGas?): Promise<ReceiptOrEstimate<G>>

Withdraw all tokens for userAddress

Type parameters

Name	Type
G	extends boolean = false

Parameters

Name	Type	Description
estimateGas?	G	if True, return gas estimate

Returns

Promise<ReceiptOrEstimate<G>>

Defined in

contracts/ve/VeOcean.ts:127