Skip to main content

Index

Table of contents​

Contracts​

Libraries​

Interfaces​

Structs​

Variables​

Functions​

Variables​

AFTER_BURN_FLAG​

• Const AFTER_BURN_FLAG: u32

Defined in​

assembly/libraries/Hooks.ts:14


AFTER_FLASH_LOAN_FLAG​

• Const AFTER_FLASH_LOAN_FLAG: u32

Defined in​

assembly/libraries/Hooks.ts:10


AFTER_MINT_FLAG​

• Const AFTER_MINT_FLAG: u32

Defined in​

assembly/libraries/Hooks.ts:12


AFTER_SWAP_FLAG​

• Const AFTER_SWAP_FLAG: u32

Defined in​

assembly/libraries/Hooks.ts:8


AFTER_TRANSFER_FLAG​

• Const AFTER_TRANSFER_FLAG: u32

Defined in​

assembly/libraries/Hooks.ts:16


BALANCE_KEY_PREFIX_LENGTH​

• Const BALANCE_KEY_PREFIX_LENGTH: 7

Defined in​

assembly/libraries/Utils.ts:168


BASIS_POINT_MAX​

• Const BASIS_POINT_MAX: u16 = 10_000

Defined in​

assembly/libraries/Constants.ts:7


BEFORE_BURN_FLAG​

• Const BEFORE_BURN_FLAG: u32

Defined in​

assembly/libraries/Hooks.ts:13


BEFORE_FLASH_LOAN_FLAG​

• Const BEFORE_FLASH_LOAN_FLAG: u32

Defined in​

assembly/libraries/Hooks.ts:9


BEFORE_MINT_FLAG​

• Const BEFORE_MINT_FLAG: u32

Defined in​

assembly/libraries/Hooks.ts:11


BEFORE_SWAP_FLAG​

• Const BEFORE_SWAP_FLAG: u32

Defined in​

assembly/libraries/Hooks.ts:7


BEFORE_TRANSFER_FLAG​

• Const BEFORE_TRANSFER_FLAG: u32

Defined in​

assembly/libraries/Hooks.ts:15


DELIMITER​

• Const DELIMITER: ":"

Defined in​

assembly/libraries/Utils.ts:16


EVENT_DELIMITER​

• Const EVENT_DELIMITER: ";?!"

Defined in​

assembly/libraries/Utils.ts:101


ID_ONE​

• Const ID_ONE: u32

Defined in​

assembly/libraries/Constants.ts:6


MAX​

• Const MAX: u256 = u256.Max

Defined in​

assembly/libraries/Constants.ts:16


MAX_BIN_STEP​

• Const MAX_BIN_STEP: 100

Defined in​

assembly/libraries/Constants.ts:12


MAX_FEE​

• Const MAX_FEE: u64

Defined in​

assembly/libraries/Constants.ts:13


MAX_U128​

• Const MAX_U128: u256

Defined in​

assembly/libraries/Constants.ts:20


MIN_BIN_STEP​

• Const MIN_BIN_STEP: 1

Defined in​

assembly/libraries/Constants.ts:11


ONE​

• Const ONE: u256 = u256.One

Defined in​

assembly/libraries/Constants.ts:14


ONE_COIN​

• Const ONE_COIN: u64

Defined in​

assembly/libraries/Constants.ts:9


PRECISION​

• Const PRECISION: u256

Defined in​

assembly/libraries/Constants.ts:8


REAL_ID_SHIFT​

• Const REAL_ID_SHIFT: i64

Defined in​

assembly/libraries/Constants.ts:5


SCALE_OFFSET​

• Const SCALE_OFFSET: 128

Defined in​

assembly/libraries/Constants.ts:10


STORAGE_BYTE_COST​

• Const STORAGE_BYTE_COST: 100000

Defined in​

assembly/libraries/Utils.ts:166


STORAGE_PREFIX_LENGTH​

• Const STORAGE_PREFIX_LENGTH: 4

Defined in​

assembly/libraries/Utils.ts:167


THREE​

• Const THREE: u256

Defined in​

assembly/libraries/Constants.ts:18


TWO​

• Const TWO: u256

Defined in​

assembly/libraries/Constants.ts:17


ZERO​

• Const ZERO: u256 = u256.Zero

Defined in​

assembly/libraries/Constants.ts:15


ZERO_ADDRESS​

• Const ZERO_ADDRESS: Address

Defined in​

assembly/libraries/Constants.ts:19


_KEY_ELEMENT_SUFFIX​

• Const _KEY_ELEMENT_SUFFIX: "::"

Defined in​

assembly/libraries/PersistentMap.ts:17

Functions​

BinHelper__BinStepOverflows​

▸ BinHelper__BinStepOverflows(bp): string

BinHelper errors

Parameters​

NameType
bpu16

Returns​

string

Defined in​

assembly/libraries/Errors.ts:203


BinHelper__IdOverflows​

▸ BinHelper__IdOverflows(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:205


LBFactory__BinStepHasNoPreset​

▸ LBFactory__BinStepHasNoPreset(binStep): string

Parameters​

NameType
binStepu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:150


LBFactory__BinStepRequirementsBreached​

▸ LBFactory__BinStepRequirementsBreached(lowerBound, binStep, higherBound): string

Parameters​

NameType
lowerBoundu64
binStepu32
higherBoundu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:134


LBFactory__DecreasingPeriods​

▸ LBFactory__DecreasingPeriods(filterPeriod, decayPeriod): string

Parameters​

NameType
filterPeriodu32
decayPeriodu32

Returns​

string

Defined in​

assembly/libraries/Errors.ts:116


LBFactory__FactoryLockIsAlreadyInTheSameState​

▸ LBFactory__FactoryLockIsAlreadyInTheSameState(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:146


LBFactory__FeesAboveMax​

▸ LBFactory__FeesAboveMax(baseFee, _maxVariableFee, maxFees): string

Parameters​

NameType
baseFeeu64
_maxVariableFeeu64
maxFeesu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:124


LBFactory__FlashLoanFeeAboveMax​

▸ LBFactory__FlashLoanFeeAboveMax(fees, maxFees): string

Parameters​

NameType
feesu64
maxFeesu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:130


LBFactory__FunctionIsLockedForUsers​

▸ LBFactory__FunctionIsLockedForUsers(user): string

Parameters​

NameType
userAddress

Returns​

string

Defined in​

assembly/libraries/Errors.ts:144


LBFactory__IdenticalAddresses​

▸ LBFactory__IdenticalAddresses(token): string

LBFactory errors

Parameters​

NameType
tokenAddress

Returns​

string

Defined in​

assembly/libraries/Errors.ts:102


LBFactory__LBPairAlreadyExists​

▸ LBFactory__LBPairAlreadyExists(tokenX, tokenY, _binStep): string

Parameters​

NameType
tokenXAddress
tokenYAddress
_binStepu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:110


LBFactory__LBPairIgnoredIsAlreadyInTheSameState​

▸ LBFactory__LBPairIgnoredIsAlreadyInTheSameState(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:148


LBFactory__LBPairNotCreated​

▸ LBFactory__LBPairNotCreated(tokenX, tokenY, binStep): string

Parameters​

NameType
tokenXAddress
tokenYAddress
binStepu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:156


LBFactory__ProtocolShareOverflows​

▸ LBFactory__ProtocolShareOverflows(protocolShare, max): string

Parameters​

NameType
protocolShareu32
maxu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:140


LBFactory__QuoteAssetAlreadyWhitelisted​

▸ LBFactory__QuoteAssetAlreadyWhitelisted(quoteAsset): string

Parameters​

NameType
quoteAssetAddress

Returns​

string

Defined in​

assembly/libraries/Errors.ts:107


LBFactory__QuoteAssetNotWhitelisted​

▸ LBFactory__QuoteAssetNotWhitelisted(quoteAsset): string

Parameters​

NameType
quoteAssetAddress

Returns​

string

Defined in​

assembly/libraries/Errors.ts:104


LBFactory__ReductionFactorOverflows​

▸ LBFactory__ReductionFactorOverflows(reductionFactor, max): string

Parameters​

NameType
reductionFactoru32
maxu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:120


LBFactory__SameFeeRecipient​

▸ LBFactory__SameFeeRecipient(feeRecipient): string

Parameters​

NameType
feeRecipientAddress

Returns​

string

Defined in​

assembly/libraries/Errors.ts:152


LBFactory__SameFlashLoanFee​

▸ LBFactory__SameFlashLoanFee(flashLoanFee): string

Parameters​

NameType
flashLoanFeeu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:154


LBFactory__SameHooksParameters​

▸ LBFactory__SameHooksParameters(hooksParameters): string

Parameters​

NameType
hooksParametersHooksParameters

Returns​

string

Defined in​

assembly/libraries/Errors.ts:161


LBPair__AddressZero​

▸ LBPair__AddressZero(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:170


LBPair__AddressZeroOrThis​

▸ LBPair__AddressZeroOrThis(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:171


LBPair__BinStepNotSame​

▸ LBPair__BinStepNotSame(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:199


LBPair__CompositionFactorFlawed​

▸ LBPair__CompositionFactorFlawed(id): string

Parameters​

NameType
idu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:173


LBPair__DistributionsOverflow​

▸ LBPair__DistributionsOverflow(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:183


LBPair__FlashLoanCallbackFailed​

▸ LBPair__FlashLoanCallbackFailed(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:193


LBPair__FlashLoanInvalidBalance​

▸ LBPair__FlashLoanInvalidBalance(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:195


LBPair__FlashLoanInvalidToken​

▸ LBPair__FlashLoanInvalidToken(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:197


LBPair__InsufficientAmounts​

▸ LBPair__InsufficientAmounts(): string

LBPair errors

Returns​

string

Defined in​

assembly/libraries/Errors.ts:168


LBPair__InsufficientLiquidityBurned​

▸ LBPair__InsufficientLiquidityBurned(id): string

Parameters​

NameType
idu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:177


LBPair__InsufficientLiquidityMinted​

▸ LBPair__InsufficientLiquidityMinted(id): string

Parameters​

NameType
idu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:175


LBPair__OnlyFactory​

▸ LBPair__OnlyFactory(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:182


LBPair__OnlyFeeRecipient​

▸ LBPair__OnlyFeeRecipient(feeRecipient, sender): string

Parameters​

NameType
feeRecipientAddress
senderAddress

Returns​

string

Defined in​

assembly/libraries/Errors.ts:185


LBPair__OnlyStrictlyIncreasingId​

▸ LBPair__OnlyStrictlyIncreasingId(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:180


LBPair__OracleNewSizeTooSmall​

▸ LBPair__OracleNewSizeTooSmall(newSize, oracleSize): string

Parameters​

NameType
newSizeu64
oracleSizeu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:189


LBPair__WrongLengths​

▸ LBPair__WrongLengths(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:179


LBQuoter_InvalidLength​

▸ LBQuoter_InvalidLength(): string

LBQuoter errors

Returns​

string

Defined in​

assembly/libraries/Errors.ts:251


LBRouter__AmountSlippageCaught​

▸ LBRouter__AmountSlippageCaught(amountXMin, amountX, amountYMin, amountY): string

Parameters​

NameType
amountXMinu256
amountXu256
amountYMinu256
amountYu256

Returns​

string

Defined in​

assembly/libraries/Errors.ts:30


LBRouter__BrokenSwapSafetyCheck​

▸ LBRouter__BrokenSwapSafetyCheck(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:12


LBRouter__DeadlineExceeded​

▸ LBRouter__DeadlineExceeded(deadline, currentTimestamp): string

Parameters​

NameType
deadlineu64
currentTimestampu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:43


LBRouter__IdDesiredOverflows​

▸ LBRouter__IdDesiredOverflows(idDesired, idSlippage): string

Parameters​

NameType
idDesiredu64
idSlippageu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:39


LBRouter__IdOverflows​

▸ LBRouter__IdOverflows(id): string

Parameters​

NameType
idi64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:18


LBRouter__IdSlippageCaught​

▸ LBRouter__IdSlippageCaught(activeIdDesired, idSlippage, activeId): string

Parameters​

NameType
activeIdDesiredu64
idSlippageu64
activeIdu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:24


LBRouter__InsufficientAmountOut​

▸ LBRouter__InsufficientAmountOut(amountOutMin, amountOut): string

Parameters​

NameType
amountOutMinu256
amountOutu256

Returns​

string

Defined in​

assembly/libraries/Errors.ts:47


LBRouter__InvalidTokenPath​

▸ LBRouter__InvalidTokenPath(wrongToken): string

Parameters​

NameType
wrongTokenAddress

Returns​

string

Defined in​

assembly/libraries/Errors.ts:61


LBRouter__LengthsMismatch​

▸ LBRouter__LengthsMismatch(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:20


LBRouter__MaxAmountInExceeded​

▸ LBRouter__MaxAmountInExceeded(amountInMax, amountIn): string

Parameters​

NameType
amountInMaxu256
amountInu256

Returns​

string

Defined in​

assembly/libraries/Errors.ts:54


LBRouter__NotFactoryOwner​

▸ LBRouter__NotFactoryOwner(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:14


LBRouter__SwapOverflows​

▸ LBRouter__SwapOverflows(id): string

Parameters​

NameType
idu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:10


LBRouter__TooMuchTokensIn​

▸ LBRouter__TooMuchTokensIn(excess): string

Parameters​

NameType
excessu256

Returns​

string

Defined in​

assembly/libraries/Errors.ts:16


LBRouter__WrongAmounts​

▸ LBRouter__WrongAmounts(amount, reserve): string

LBRouter errors

Parameters​

NameType
amountu256
reserveu256

Returns​

string

Defined in​

assembly/libraries/Errors.ts:8


LBRouter__WrongMasLiquidityParameters​

▸ LBRouter__WrongMasLiquidityParameters(tokenX, tokenY, amountX, amountY, msgValue): string

Parameters​

NameType
tokenXAddress
tokenYAddress
amountXu256
amountYu256
msgValueu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:63


LBRouter__WrongTokenOrder​

▸ LBRouter__WrongTokenOrder(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:22


LBToken__BurnExceedsBalance​

▸ LBToken__BurnExceedsBalance(from, id, amount): string

Parameters​

NameType
fromAddress
idu64
amountu256

Returns​

string

Defined in​

assembly/libraries/Errors.ts:80


LBToken__LengthMismatch​

▸ LBToken__LengthMismatch(accountsLength, idsLength): string

Parameters​

NameType
accountsLengthu64
idsLengthu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:86


LBToken__SelfApproval​

▸ LBToken__SelfApproval(owner): string

Parameters​

NameType
ownerAddress

Returns​

string

Defined in​

assembly/libraries/Errors.ts:90


LBToken__SpenderNotApproved​

▸ LBToken__SpenderNotApproved(owner, spender): string

LBToken errors

Parameters​

NameType
ownerAddress
spenderAddress

Returns​

string

Defined in​

assembly/libraries/Errors.ts:76


LBToken__TransferExceedsBalance​

▸ LBToken__TransferExceedsBalance(from, id, amount): string

Parameters​

NameType
fromAddress
idu64
amountu256

Returns​

string

Defined in​

assembly/libraries/Errors.ts:92


LBToken__TransferToSelf​

▸ LBToken__TransferToSelf(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:98


Math128x128__PowerUnderflow​

▸ Math128x128__PowerUnderflow(x, y): string

Math128x128 errors

Parameters​

NameType
xu256
yi64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:209


Math512Bits__MulDivOverflow​

▸ Math512Bits__MulDivOverflow(prod1, denominator): string

Math512Bits errors

Parameters​

NameType
prod1u256
denominatoru256

Returns​

string

Defined in​

assembly/libraries/Errors.ts:214


Math512Bits__MulShiftOverflow​

▸ Math512Bits__MulShiftOverflow(prod1, offset): string

Parameters​

NameType
prod1u256
offsetu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:221


Math512Bits__OffsetOverflows​

▸ Math512Bits__OffsetOverflows(offset): string

Parameters​

NameType
offsetu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:225


Oracle__LookUpTimestampTooOld​

▸ Oracle__LookUpTimestampTooOld(_minTimestamp, _lookUpTimestamp): string

Oracle errors

Parameters​

NameType
_minTimestampu64
_lookUpTimestampu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:230


Oracle__NotInitialized​

▸ Oracle__NotInitialized(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:235


ReentrancyGuardUpgradeable__AlreadyInitialized​

▸ ReentrancyGuardUpgradeable__AlreadyInitialized(): string

Returns​

string

Defined in​

assembly/libraries/Errors.ts:241


ReentrancyGuardUpgradeable__ReentrantCall​

▸ ReentrancyGuardUpgradeable__ReentrantCall(): string

ReentrancyGuardUpgradeable errors

Returns​

string

Defined in​

assembly/libraries/Errors.ts:239


Storage__NotEnoughCoinsSent​

▸ Storage__NotEnoughCoinsSent(spent, sent): string

Storage errors

Parameters​

NameType
spentu64
sentu64

Returns​

string

Defined in​

assembly/libraries/Errors.ts:255


TreeMath__ErrorDepthSearch​

▸ TreeMath__ErrorDepthSearch(): string

TreeMath errors

Returns​

string

Defined in​

assembly/libraries/Errors.ts:246


_sortTokens​

▸ _sortTokens(_tokenA, _tokenB): SortTokensReturn

Parameters​

NameTypeDescription
_tokenAAddressThe first token
_tokenBAddressThe second token

Returns​

SortTokensReturn

SortTokensReturn: token0, token1

Notice

Private view function to sort 2 tokens in ascending order

Defined in​

assembly/libraries/Utils.ts:34


createEvent​

▸ createEvent(key, args): string

Parameters​

NameTypeDescription
keystringthe string event key.
argsstring[]the string array arguments.

Returns​

string

the stringified event.

Notice

Overrides Massa default createEvent function (use a custom delimiter to avoid collisions)

Constructs a pretty formatted event with given key and arguments.

Remarks

The result is meant to be used with the generateEvent function. It is useful to generate events from an array.

Defined in​

assembly/libraries/Utils.ts:118


createKey​

▸ createKey(args): string

Parameters​

NameType
argsstring[]

Returns​

string

Defined in​

assembly/libraries/Utils.ts:17


spreadLiquidity​

▸ spreadLiquidity(amountYIn, startId, numbersBins, gap, binStep): SpreadLiqudityReturn

Parameters​

NameType
amountYInu256
startIdu32
numbersBinsu32
gapu32
binStepu32

Returns​

SpreadLiqudityReturn

Defined in​

assembly/libraries/Utils.ts:54


transferRemaining​

▸ transferRemaining(balanceInit, balanceFinal, sent, to): void

Parameters​

NameTypeDescription
balanceInitu64Initial balance of the SC (transferred coins + balance of the SC)
balanceFinalu64Balance of the SC at the end of the call
sentu64Number of coins sent to the SC
toAddressCaller of the function to transfer the remaining coins to

Returns​

void

Notice

Function to transfer remaining Massa coins to a recipient at the end of a call

Defined in​

assembly/libraries/Utils.ts:137


u256ToString​

▸ u256ToString(u): string

Parameters​

NameType
uu256

Returns​

string

Notice

Function to convert a u256 to a UTF-16 bytes then to a string

Dev

u256.toString() is too expensive in as-bignum so we use this instead

Defined in​

assembly/libraries/Utils.ts:126