Ocean.js v1.0.0-next.43
JavaScript client library for Ocean Protocol
FixedRateCreateProgressStep
LogLevel
Aquarius
resolve
Parameters
did
signal
?
abort signal
Returns
waitForAqua
Parameters
did
DID of the asset.
txid
?
used when the did exists and we expect an update with that txid.
signal
?
abort signal
Returns
Config
constructor
authMessage
explorerUri
fixedRateExchangeAddress
fixedRateExchangeAddressABI
gasFeeMultiplier
oceanTokenSymbol
opfCommunityFeeCollector
subgraphUri
transactionBlockTimeout
transactionConfirmationBlocks
transactionPollingTimeout
ConfigHelper
constructor
getAddressesFromEnv
Parameters
network
customAddresses
?
Returns
Datatoken
addMinter
Parameters
dtAddress
Datatoken address
address
User address
minter
User which is going to be a Minter
Returns
addPaymentManager
Parameters
dtAddress
Datatoken address
address
User address
paymentManager
User which is going to be a Minter
Returns
approve
Parameters
dtAddress
Datatoken address
spender
Spender address
amount
Number of datatokens, as number. Will be converted to wei
address
User adress
Returns
balance
Parameters
datatokenAddress
address
user adress
Returns
buyFromDispenserAndOrder
Parameters
dtAddress
Datatoken address
address
User address which calls
orderParams
dispenserContract
Returns
buyFromFreAndOrder
Parameters
dtAddress
Datatoken address
address
User address which calls
Returns
cleanPermissions
Parameters
dtAddress
Datatoken address where we want to clean permissions
address
User adress
Returns
createDispenser
Parameters
dtAddress
Datatoken address
address
Caller address
dispenserAddress
ispenser contract address
dispenserParams
Returns
createFixedRate
Parameters
dtAddress
Datatoken address
address
Caller address
fixedRateParams
Returns
estGasAddMinter
Parameters
dtAddress
Datatoken address
address
User address
minter
User which is going to be a Minter
contractInstance
?
optional contract instance
Returns
estGasAddPaymentManager
Parameters
dtAddress
Datatoken address
address
User address
paymentManager
User which is going to be a Minter
contractInstance
?
optional contract instance
Returns
estGasApprove
Parameters
dtAddress
Datatoken address
spender
Spender address
amount
Number of datatokens, as number. Will be converted to wei
address
User adress
contractInstance
?
optional contract instance
Returns
estGasBuyFromDispenserAndOrder
Parameters
dtAddress
Datatoken address
address
User address which calls
orderParams
dispenserContract
contractInstance
?
optional contract instance
Returns
estGasBuyFromFreAndOrder
Parameters
dtAddress
Datatoken address
address
User address which calls
contractInstance
?
optional contract instance
Returns
estGasCleanPermissions
Parameters
dtAddress
Datatoken address where we want to clean permissions
address
User adress
contractInstance
?
optional contract instance
Returns
estGasCreateDispenser
Parameters
dtAddress
Datatoken address
address
Caller address
dispenserAddress
ispenser contract address
dispenserParams
contractInstance
?
optional contract instance
Returns
estGasCreateFixedRate
Parameters
dtAddress
Datatoken address
address
Caller address
fixedRateParams
contractInstance
?
optional contract instance
Returns
estGasMint
Parameters
dtAddress
Datatoken address
address
Minter address
amount
Number of datatokens, as number. Will be converted to wei
toAddress
?
only if toAddress is different from the minter
contractInstance
?
optional contract instance
Returns
estGasRemoveMinter
Parameters
dtAddress
Datatoken address
address
User address
minter
User which will be removed from Minter permission
contractInstance
?
optional contract instance
Returns
estGasRemovePaymentManager
Parameters
dtAddress
Datatoken address
address
User address
paymentManager
User which will be removed from paymentManager permission
contractInstance
?
optional contract instance
Returns
estGasReuseOrder
Parameters
dtAddress
Datatoken address
address
User address which calls
orderTxId
previous valid order
contractInstance
?
optional contract instance
Returns
estGasSetData
Parameters
dtAddress
Datatoken address
address
User address
value
Data to be stored into 725Y standard
contractInstance
?
optional contract instance
Returns
estGasSetPaymentCollector
Parameters
dtAddress
datatoken address
address
Caller address
paymentCollector
User to be set as new payment collector
contractInstance
?
optional contract instance
Returns
estGasStartOrder
Parameters
dtAddress
Datatoken address
address
User address which calls
consumer
Consumer Address
serviceIndex
Service index in the metadata
consumeMarketFee
?
contractInstance
?
optional contract instance
Returns
estGasTransfer
Parameters
dtAddress
Datatoken address
toAddress
Receiver address
amount
Number of datatokens, as number. Expressed as wei
address
User adress
contractInstance
?
optional contract instance
Returns
getCap
Parameters
dtAddress
Datatoken adress
Returns
getDTPermissions
Parameters
dtAddress
Datatoken adress
address
user adress
Returns
getDecimals
Parameters
dtAddress
Datatoken adress
Returns
getNFTAddress
Parameters
dtAddress
Datatoken adress
Returns
getPaymentCollector
Parameters
dtAddress
datatoken address
Returns
isERC20Deployer
Parameters
dtAddress
Datatoken adress
address
Returns
mint
Parameters
dtAddress
Datatoken address
address
Minter address
amount
Number of datatokens, as number. Will be converted to wei
toAddress
?
only if toAddress is different from the minter
Returns
removeMinter
Parameters
dtAddress
Datatoken address
address
User address
minter
User which will be removed from Minter permission
Returns
removePaymentManager
Parameters
dtAddress
Datatoken address
address
User address
paymentManager
User which will be removed from paymentManager permission
Returns
reuseOrder
Parameters
dtAddress
Datatoken address
address
User address which calls
orderTxId
previous valid order
Returns
setData
Parameters
dtAddress
Datatoken address
address
User address
value
Data to be stored into 725Y standard
Returns
setPaymentCollector
Parameters
dtAddress
datatoken address
address
Caller address
paymentCollector
User to be set as new payment collector
Returns
startOrder
Parameters
dtAddress
Datatoken address
address
User address which calls
consumer
Consumer Address
serviceIndex
Service index in the metadata
consumeMarketFee
?
Returns
transfer
Parameters
dtAddress
Datatoken address
toAddress
Receiver address
amount
Number of datatokens, as number. To be converted to wei.
address
User adress
Returns
transferWei
Parameters
dtAddress
Datatoken address
toAddress
Receiver address
amount
Number of datatokens, as number. Expressed as wei
address
User adress
Returns
Dispenser
activate
Parameters
dtAddress
refers to datatoken address.
maxTokens
max amount of tokens to dispense
maxBalance
max balance of user. If user balance is >, then dispense will be rejected
address
User address (must be owner of the datatoken)
Returns
create
Parameters
dtAddress
Datatoken address
address
Owner address
maxTokens
max tokens to dispense
maxBalance
max balance of requester
allowedSwapper
only account that can ask tokens. set address(0) if not required
Returns
deactivate
Parameters
dtAddress
refers to datatoken address.
address
User address (must be owner of the datatoken)
Returns
dispense
Parameters
dtAddress
refers to datatoken address.
address
User address
amount
amount of datatokens required.
destination
who will receive the tokens
Returns
estGasActivate
Parameters
dtAddress
maxTokens
max amount of tokens to dispense
maxBalance
max balance of user. If user balance is >, then dispense will be rejected
address
User address (must be owner of the datatoken)
Returns
estGasCreate
Parameters
dtAddress
Datatoken address
address
Owner address
maxTokens
max tokens to dispense
maxBalance
max balance of requester
allowedSwapper
if !=0, only this address can request DTs
Returns
estGasDeactivate
Parameters
dtAddress
address
User address (must be owner of the datatoken)
Returns
estGasDispense
Parameters
dtAddress
refers to datatoken address.
address
User address (must be owner of the datatoken)
amount
destination
Returns
estGasOwnerWithdraw
Parameters
dtAddress
refers to datatoken address.
address
User address (must be owner of the datatoken)
Returns
estGasSetAllowedSwapper
Parameters
dtAddress
refers to datatoken address.
address
User address (must be owner of the datatoken)
newAllowedSwapper
refers to the new allowedSwapper
Returns
isDispensable
Parameters
dtAddress
datatoken
address
User address that will receive datatokens
amount
amount of datatokens required.
Returns
ownerWithdraw
Parameters
dtAddress
refers to datatoken address.
address
User address (must be owner of the dispenser)
Returns
setAllowedSwapper
Parameters
dtAddress
refers to datatoken address.
address
User address (must be owner of the datatoken)
newAllowedSwapper
refers to the new allowedSwapper
Returns
status
Parameters
dtAdress
Returns
FixedRateExchange
constructor
activate
Parameters
address
User address
exchangeId
ExchangeId
Returns
activateMint
Parameters
address
User address
exchangeId
ExchangeId
Returns
amountToUnits
Parameters
token
amount
tokenDecimals
Returns
buyDT
Parameters
address
User address
exchangeId
ExchangeId
datatokenAmount
Amount of datatokens
maxBaseTokenAmount
max amount of baseToken we want to pay for datatokenAmount
consumeMarketAddress
consumeMarketAddress
consumeMarketFee
consumeMarketFee in fraction
Returns
calcBaseInGivenOutDT
Parameters
exchangeId
ExchangeId
datatokenAmount
Amount of datatokens user wants to buy
consumeMarketFee
consumeMarketFee in fraction
Returns
collectBT
Parameters
address
User address
exchangeId
ExchangeId
amount
amount to be collected
Returns
collectDT
Parameters
address
User address
exchangeId
ExchangeId
amount
amount to be collected
Returns
collectMarketFee
Parameters
address
User address
exchangeId
ExchangeId
Returns
collectOceanFee
Parameters
address
User address
exchangeId
ExchangeId
Returns
deactivate
Parameters
address
User address
exchangeId
ExchangeId
Returns
deactivateMint
Parameters
address
User address
exchangeId
ExchangeId
Returns
estActivate
Parameters
account
exchangeId
ExchangeId
contractInstance
?
optional contract instance
Returns
estActivateMint
Parameters
account
exchangeId
ExchangeId
contractInstance
?
optional contract instance
Returns
estBuyDT
Parameters
account
datatokenAddress
datatokenAddress
dtAmount
datatoken amount we want to buy
maxBaseTokenAmount
consumeMarketAddress
consumeMarketAddress
consumeMarketFee
fee recieved by the consume market when a dt is bought from a fixed rate exchange, percent
contractInstance
?
optional contract instance
Returns
estCollectBT
Parameters
account
exchangeId
ExchangeId
amount
amount to be collected
contractInstance
?
optional contract instance
Returns
estCollectDT
Parameters
account
exchangeId
ExchangeId
amount
amount to be collected
contractInstance
?
optional contract instance
Returns
estCollectMarketFee
Parameters
account
exchangeId
ExchangeId
contractInstance
?
optional contract instance
Returns
estCollectOceanFee
Parameters
account
exchangeId
ExchangeId
contractInstance
?
optional contract instance
Returns
estDeactivate
Parameters
account
exchangeId
ExchangeId
contractInstance
?
optional contract instance
Returns
estDeactivateMint
Parameters
account
exchangeId
ExchangeId
contractInstance
?
optional contract instance
Returns
estSellDT
Parameters
account
datatokenAddress
datatokenAddress
dtAmount
datatoken amount we want to sell
maxBaseTokenAmount
consumeMarketAddress
consumeMarketAddress
consumeMarketFee
consumeMarketFee
contractInstance
?
optional contract instance
Returns
estSetAllowedSwapper
Parameters
account
exchangeId
ExchangeId
newAllowedSwapper
new allowed swapper address
contractInstance
?
optional contract instance
Returns
estSetRate
Parameters
account
exchangeId
ExchangeId
newRate
New rate
contractInstance
?
optional contract instance
Returns
estUpdateMarketFee
Parameters
account
exchangeId
ExchangeId
newMarketFee
New market fee
contractInstance
?
optional contract instance
Returns
estUpdateMarketFeeCollector
Parameters
account
exchangeId
ExchangeId
newMarketFeeCollector
contractInstance
?
optional contract instance
Returns
generateExchangeId
Parameters
baseToken
baseToken contract address
datatoken
Datatoken contract address
Returns
getAllowedSwapper
Parameters
exchangeId
ExchangeId
Returns
getAmountBTOut
Parameters
exchangeId
ExchangeId
datatokenAmount
Amount of datatokens
consumeMarketFee
consumeMarketFee in fraction
Returns
getBTSupply
Parameters
exchangeId
ExchangeId
Returns
getDTSupply
Parameters
exchangeId
ExchangeId
Returns
getExchange
Parameters
exchangeId
ExchangeId
Returns
getExchangeOwner
Parameters
exchangeId
ExchangeId
Returns
getFeesInfo
Parameters
exchangeId
ExchangeId
Returns
getNumberOfExchanges
Returns
getRate
Parameters
exchangeId
ExchangeId
Returns
getRouter
Returns
isActive
Parameters
exchangeId
ExchangeId
Returns
sellDT
Parameters
address
User address
exchangeId
ExchangeId
datatokenAmount
Amount of datatokens
minBaseTokenAmount
min amount of baseToken we want to receive back
consumeMarketAddress
consumeMarketAddress
consumeMarketFee
consumeMarketFee in fraction
Returns
setAllowedSwapper
Parameters
address
User account
exchangeId
ExchangeId
newAllowedSwapper
newAllowedSwapper (set address zero if we want to remove allowed swapper)
Returns
setRate
Parameters
address
User account
exchangeId
ExchangeId
newRate
New rate
Returns
unitsToAmount
Parameters
token
amount
tokenDecimals
Returns
updateMarketFee
Parameters
address
user address
exchangeId
ExchangeId
newMarketFee
New market fee
Returns
updateMarketFeeCollector
Parameters
address
user address
exchangeId
ExchangeId
newMarketFeeCollector
New market fee collector
Returns
Logger
Nft
addErc20Deployer
Parameters
nftAddress
erc721 contract adress
address
NFT Manager adress
erc20Deployer
User adress which is going to have erc20Deployer permission
Returns
addManager
Parameters
nftAddress
erc721 contract adress
address
NFT Owner adress
manager
User adress which is going to be assing manager
Returns
addMetadataUpdater
Parameters
nftAddress
erc721 contract adress
address
NFT Manager adress
metadataUpdater
User adress which is going to have Metadata Updater permission
Returns
addStoreUpdater
Parameters
nftAddress
erc721 contract adress
address
NFT Manager adress
storeUpdater
User adress which is going to have Store Updater permission
Returns
cleanPermissions
Parameters
nftAddress
erc721 contract adress
address
NFT Owner adress
Returns
createErc20
Parameters
nftAddress
ERC721 addreess
address
User address
minter
User set as initial minter for the ERC20
paymentCollector
initial paymentCollector for this DT
mpFeeAddress
Consume marketplace fee address
feeToken
address of the token marketplace wants to add fee on top
feeAmount
amount of feeToken to be transferred to mpFeeAddress on top, will be converted to WEI
cap
Maximum cap (Number) - will be converted to wei
name
?
Token name
symbol
?
Token symbol
templateIndex
?
NFT template index
Returns
esGasRemoveMetadataUpdater
Parameters
nftAddress
erc721 contract adress
address
NFT Manager adress
metadataUpdater
Address of the user to be revoked Metadata updater Permission
contractInstance
?
Returns
estGasAddErc20Deployer
Parameters
nftAddress
erc721 contract adress
address
NFT Manager adress
erc20Deployer
User adress which is going to have erc20Deployer permission
contractInstance
?
Returns
estGasAddManager
Parameters
nftAddress
erc721 contract adress
address
NFT Owner adress
manager
User adress which is going to be assing manager
contractInstance
?
Returns
estGasAddMetadataUpdater
Parameters
nftAddress
erc721 contract adress
address
NFT Manager adress
metadataUpdater
User adress which is going to have Metadata Updater permission
contractInstance
?
Returns
estGasAddStoreUpdater
Parameters
nftAddress
erc721 contract adress
address
NFT Manager adress
storeUpdater
User adress which is going to have Store Updater permission
contractInstance
?
Returns
estGasCleanPermissions
Parameters
nftAddress
erc721 contract adress
address
NFT Owner adress
contractInstance
?
Returns
estGasCreateErc20
Parameters
nftAddress
ERC721 addreess
address
User address
minter
User set as initial minter for the ERC20
paymentCollector
initial paymentCollector for this DT
mpFeeAddress
Consume marketplace fee address
feeToken
address of the token marketplace wants to add fee on top
feeAmount
amount of feeToken to be transferred to mpFeeAddress on top, will be converted to WEI
cap
Maximum cap (Number) - will be converted to wei
name
?
Token name
symbol
?
Token symbol
templateIndex
?
NFT template index
contractInstance
?
Returns
estGasRemoveErc20Deployer
Parameters
nftAddress
erc721 contract adress
address
NFT Manager adress
erc20Deployer
Address of the user to be revoked ERC20Deployer Permission
contractInstance
?
Returns
estGasRemoveManager
Parameters
nftAddress
erc721 contract adress
address
NFT Owner adress
manager
User adress which is going to be removed as manager
contractInstance
?
Returns
estGasRemoveStoreUpdater
Parameters
nftAddress
erc721 contract adress
address
NFT Manager adress
storeUpdater
Address of the user to be revoked Store Updater Permission
contractInstance
?
Returns
estGasSafeTransferNft
Parameters
nftAddress
erc721 contract adress
nftOwner
Current NFT Owner adress
nftReceiver
User which will receive the NFT, will also be set as Manager
tokenId
The id of the token to be transfered
contractInstance
?
Returns
estGasSetMetadata
Parameters
nftAddress
erc721 contract adress
metadataUpdater
metadataUpdater address
metadataState
User which will receive the NFT, will also be set as Manager
metadataDecryptorUrl
metadataDecryptorAddress
flags
data
metadataHash
metadataProofs
?
contractInstance
?
Returns
estGasSetMetadataAndTokenURI
Parameters
nftAddress
erc721 contract adress
metadataUpdater
metadataUpdater address
contractInstance
?
Returns
estGasSetMetadataState
Parameters
nftAddress
erc721 contract adress
metadataUpdater
metadataState
new metadata state
contractInstance
?
Returns
estGasTransferNft
Parameters
nftAddress
erc721 contract adress
nftOwner
Current NFT Owner adress
nftReceiver
User which will receive the NFT, will also be set as Manager
tokenId
The id of the token to be transfered
contractInstance
?
Returns
estSetTokenURI
Parameters
nftAddress
erc721 contract adress
address
user adress
data
input data for TokenURI
Returns
getData
Parameters
nftAddress
erc721 contract adress
key
the key which value to retrieve
Returns
getMetadata
Parameters
nftAddress
erc721 contract adress
Returns
getNftOwner
Parameters
nftAddress
erc721 contract adress
Returns
getNftPermissions
Parameters
nftAddress
erc721 contract adress
address
user adress
Returns
getTokenURI
Parameters
nftAddress
erc721 contract adress
id
Returns
isErc20Deployer
Parameters
nftAddress
erc721 contract adress
address
user adress
Returns
removeErc20Deployer
Parameters
nftAddress
erc721 contract adress
address
NFT Manager adress
erc20Deployer
Address of the user to be revoked ERC20Deployer Permission
Returns
removeManager
Parameters
nftAddress
erc721 contract adress
address
NFT Owner adress
manager
User adress which is going to be removed as manager
Returns
removeMetadataUpdater
Parameters
nftAddress
erc721 contract adress
address
NFT Manager adress
metadataUpdater
Address of the user to be revoked Metadata updater Permission
Returns
removeStoreUpdater
Parameters
nftAddress
erc721 contract adress
address
NFT Manager adress
storeUpdater
Address of the user to be revoked Store Updater Permission
Returns
safeTransferNft
Parameters
nftAddress
erc721 contract adress
nftOwner
Current NFT Owner adress
nftReceiver
User which will receive the NFT, will also be set as Manager
tokenId
?
The id of the token to be transfered
Returns
setMetadata
Parameters
nftAddress
erc721 contract adress
address
Caller address NFT Owner adress
metadataState
metadataDecryptorUrl
metadataDecryptorAddress
flags
data
metadataHash
metadataProofs
?
Returns
setMetadataAndTokenURI
Parameters
nftAddress
erc721 contract adress
metadataUpdater
Returns
setMetadataState
Parameters
nftAddress
erc721 contract adress
address
Caller address => metadata updater
metadataState
new metadata state
Returns
setTokenURI
Parameters
nftAddress
erc721 contract adress
address
user adress
data
input data for TokenURI
Returns
transferNft
Parameters
nftAddress
erc721 contract adress
nftOwner
Current NFT Owner adress
nftReceiver
User which will receive the NFT, will also be set as Manager
tokenId
?
The id of the token to be transfered
Returns
NftFactory
addNFTTemplate
Parameters
address
templateAddress
template address to add
Returns
addTokenTemplate
Parameters
address
templateAddress
template address to add
Returns
checkDatatoken
Parameters
datatoken
Datatoken address we want to check
Returns
checkNFT
Parameters
nftAddress
nftAddress address we want to check
Returns
createNftErc20WithDispenser
Parameters
address
Caller address
Returns
createNftErc20WithFixedRate
Parameters
address
Caller address
Returns
createNftErc20WithPool
Parameters
address
Caller address
Returns
disableNFTTemplate
Parameters
address
templateIndex
index of the template we want to disable
Returns
disableTokenTemplate
Parameters
address
templateIndex
index of the template we want to disable
Returns
estGasAddNFTTemplate
Parameters
address
templateAddress
template address to add
Returns
estGasAddTokenTemplate
Parameters
address
templateAddress
template address to add
Returns
estGasCreateNFT
Returns
estGasCreateNftErc20WithDispenser
Parameters
address
Caller address
Returns
estGasCreateNftErc20WithFixedRate
Parameters
address
Caller address
Returns
estGasCreateNftErc20WithPool
Parameters
address
Caller address
Returns
estGasCreateNftWithErc20
Returns
estGasDisableNFTTemplate
Parameters
address
templateIndex
index of the template we want to disable
Returns
estGasDisableTokenTemplate
Parameters
address
templateIndex
index of the template we want to disable
Returns
estGasReactivateNFTTemplate
Parameters
address
templateIndex
index of the template we want to reactivate
Returns
estGasReactivateTokenTemplate
Parameters
address
templateIndex
index of the template we want to reactivate
Returns
estGasStartMultipleTokenOrder
Returns
getCurrentNFTCount
Returns
getCurrentNFTTemplateCount
Returns
getCurrentTokenCount
Returns
getCurrentTokenTemplateCount
Returns
getNFTTemplate
Parameters
index
Template index
Returns
getTokenTemplate
Parameters
index
Template index
Returns
reactivateNFTTemplate
Parameters
address
templateIndex
index of the template we want to reactivate
Returns
reactivateTokenTemplate
Parameters
address
templateIndex
index of the template we want to reactivate
Returns
Pool
amountToUnits
Parameters
token
amount
tokenDecimals
?
Returns
calcPoolInGivenSingleOut
Parameters
poolAddress
tokenOut
tokenOut
tokenAmountOut
expected amount of tokensOut
poolDecimals
?
optional number of decimals of the pool
tokenOutDecimals
?
optional number of decimals of the token
Returns
calcPoolOutGivenSingleIn
Parameters
poolAddress
tokenIn
tokenIn
tokenAmountIn
exact number of tokens staked
poolDecimals
?
optional number of decimals of the poool
tokenInDecimals
?
optional number of decimals of the token
Returns
calcSingleInGivenPoolOut
Parameters
poolAddress
tokenIn
tokenIn
poolAmountOut
expected amount of pool shares
poolDecimals
?
optional number of decimals of the pool
tokenInDecimals
?
optional number of decimals of the token
Returns
calcSingleOutGivenPoolIn
Parameters
poolAddress
tokenOut
tokenOut
poolAmountIn
amount of shares spent
poolDecimals
?
optional number of decimals of the pool
tokenOutDecimals
?
optional number of decimals of the token
Returns
collectMarketFee
Parameters
address
poolAddress
Returns
collectOPC
Parameters
address
poolAddress
Returns
estCollectMarketFee
Parameters
address
poolAddress
contractInstance
?
optional contract instance
Returns
estCollectOPC
Parameters
address
poolAddress
contractInstance
?
optional contract instance
Returns
estExitswapPoolAmountIn
Parameters
address
poolAddress
poolAmountIn
exact number of pool shares to spend
minTokenAmountOut
minimum amount of basetokens expected
contractInstance
?
optional contract instance
Returns
estJoinswapExternAmountIn
Parameters
address
poolAddress
tokenAmountIn
exact number of base tokens to spend
minPoolAmountOut
minimum of pool shares expectex
contractInstance
?
optional contract instance
Returns
estSetSwapFee
Parameters
account
poolAddress
fee
contractInstance
?
optional contract instance
Returns
estSwapExactAmountIn
Parameters
address
poolAddress
tokenInOutMarket
object contianing addresses like tokenIn, tokenOut, consumeMarketFeeAddress
amountsInOutMaxFee
object contianing tokenAmountIn, minAmountOut, maxPrice, consumeMarketSwapFee
contractInstance
?
optional contract instance
Returns
estSwapExactAmountOut
Parameters
address
poolAddress
tokenInOutMarket
amountsInOutMaxFee
contractInstance
?
optional contract instance
Returns
estUpdatePublishMarketFee
Parameters
address
poolAddress
newPublishMarketAddress
new market address
newPublishMarketSwapFee
new market swap fee
contractInstance
?
optional contract instance
Returns
exitswapPoolAmountIn
Parameters
account
poolAddress
poolAmountIn
exact number of pool shares to spend
minTokenAmountOut
minimum amount of basetokens expected
poolDecimals
?
optional number of decimals of the poool
Returns
getAmountInExactOut
Parameters
poolAddress
tokenIn
token to be swaped
tokenOut
token to get
tokenAmountOut
exact amount of tokenOut
swapMarketFee
consume market swap fee
tokenInDecimals
?
optional number of decimals of the token to be swaped
tokenOutDecimals
?
optional number of decimals of the token to get
Returns
getAmountOutExactIn
Parameters
poolAddress
tokenIn
token to be swaped
tokenOut
token to get
tokenAmountIn
exact amount of tokenIn
swapMarketFee
tokenInDecimals
?
optional number of decimals of the token to be swaped
tokenOutDecimals
?
optional number of decimals of the token to get
Returns
getBaseToken
Parameters
poolAddress
Returns
getCommunityFees
Parameters
poolAddress
token
token we want to check fees
tokenDecimals
?
optional number of decimals of the token
Returns
getController
Parameters
poolAddress
Returns
getCurrentMarketFees
Parameters
poolAddress
Returns
getCurrentOPCFees
Parameters
poolAddress
Returns
getCurrentTokens
Parameters
poolAddress
Returns
getDatatoken
Parameters
poolAddress
Returns
getDenormalizedWeight
Parameters
poolAddress
token
token to be checked
Returns
getFinalTokens
Parameters
poolAddress
Returns
getMarketFee
Parameters
poolAddress
Returns
getMarketFeeCollector
Parameters
poolAddress
Returns
getMarketFees
Parameters
poolAddress
token
token we want to check fees
tokenDecimals
?
optional number of decimals of the token
Returns
getNormalizedWeight
Parameters
poolAddress
token
token to be checked
Returns
getNumTokens
Parameters
poolAddress
Returns
getReserve
Parameters
poolAddress
token
Address of the token to be checked
tokenDecimals
?
optional number of decimals of the token
Returns
getSpotPrice
Parameters
poolAddress
tokenIn
in token
tokenOut
out token
swapMarketFee
Returns
getSwapFee
Parameters
poolAddress
Returns
getTotalDenormalizedWeight
Parameters
poolAddress
Returns
isBound
Parameters
poolAddress
token
Address of the token to be checked
Returns
isFinalized
Parameters
poolAddress
Returns
joinswapExternAmountIn
Parameters
account
poolAddress
tokenAmountIn
exact number of base tokens to spend
minPoolAmountOut
minimum of pool shares expectex
tokenInDecimals
?
optional number of decimals of the token
Returns
setSwapFee
Parameters
account
poolAddress
fee
swap fee (1e17 = 10 % , 1e16 = 1% , 1e15 = 0.1%, 1e14 = 0.01%)
Returns
swapExactAmountIn
Parameters
address
poolAddress
tokenInOutMarket
object contianing addresses like tokenIn, tokenOut, consumeMarketFeeAddress
amountsInOutMaxFee
object contianing tokenAmountIn, minAmountOut, maxPrice, consumeMarketSwapFee
Returns
swapExactAmountOut
Parameters
account
poolAddress
tokenInOutMarket
Object containing addresses like tokenIn, tokenOut, consumeMarketFeeAddress
amountsInOutMaxFee
Object containging maxAmountIn,tokenAmountOut,maxPrice, consumeMarketSwapFee]
Returns
unitsToAmount
Parameters
token
amount
tokenDecimals
?
Returns
updatePublishMarketFee
Parameters
address
poolAddress
newPublishMarketAddress
new market fee collector address
newPublishMarketSwapFee
fee recieved by the publisher market when a dt is swaped from a pool, percent
Returns
Provider
constructor
checkDidFiles
Parameters
did
did
serviceId
the id of the service for which to check the files
providerUri
uri of the provider that will be used to check the file
signal
?
abort signal
Returns
checkFileUrl
Parameters
url
or did
providerUri
uri of the provider that will be used to check the file
signal
?
abort signal
Returns
computeDelete
Parameters
did
consumerAddress
jobId
providerUri
web3
signal
?
abort signal
Returns
computeStart
Parameters
providerUri
web3
consumerAddress
computeEnv
dataset
algorithm
signal
?
abort signal
additionalDatasets
?
output
?
Returns
computeStatus
Parameters
providerUri
The URI of the provider we want to query
consumerAddress
The consumer ethereum address
jobId
?
The ID of a compute job.
did
?
The ID of the asset
signal
?
abort signal
Returns
computeStop
Parameters
did
consumerAddress
jobId
providerUri
web3
signal
?
abort signal
Returns
encrypt
Parameters
data
data in json format that needs to be sent , it can either be a DDO or a File array
providerUri
provider uri address
signal
?
abort signal
Returns
getComputeEnvironments
Parameters
providerUri
signal
?
Returns
getComputeResultUrl
Parameters
providerUri
The URI of the provider we want to query
web3
Web3 instance
consumerAddress
The consumer ethereum address
jobId
The ID of a compute job.
index
Result index
Returns
getDownloadUrl
Parameters
did
accountId
serviceId
fileIndex
transferTxId
providerUri
web3
userCustomParameters
?
Returns
getEndpoints
Parameters
providerUri
Returns
getNonce
Parameters
providerUri
provider uri address
consumerAddress
Publisher address
signal
?
abort signal
providerEndpoints
?
Identifier of the asset to be registered in ocean
Returns
getServiceEndpoints
Parameters
providerEndpoint
endpoints
Returns
initialize
Parameters
did
serviceId
fileIndex
consumerAddress
providerUri
Identifier of the asset to be registered in ocean
signal
?
abort signal
userCustomParameters
?
computeEnv
?
validUntil
?
Returns
initializeCompute
Parameters
assets
algorithm
computeEnv
validUntil
providerUri
Identifier of the asset to be registered in ocean
accountId
signal
?
abort signal
Returns
isValidProvider
Parameters
url
provider uri address
signal
?
abort signal
Returns
signProviderRequest
Parameters
web3
accountId
message
password
?
Returns
Router
addApprovedToken
Parameters
address
caller address
tokenAddress
token address to add
Returns
addDispenserContract
Parameters
address
tokenAddress
contract address to add
Returns
addFixedRateContract
Parameters
address
tokenAddress
contract address to add
Returns
addPoolTemplate
Parameters
address
templateAddress
template address to add
Returns
addSSContract
Parameters
address
tokenAddress
contract address to add
Returns
estGasAddApprovedToken
Parameters
address
tokenAddress
token address we want to add
contractInstance
?
Returns
estGasAddDispenserContract
Parameters
address
tokenAddress
contract address to add
Returns
estGasAddFixedRateContract
Parameters
address
tokenAddress
contract address to add
Returns
estGasAddPoolTemplate
Parameters
address
templateAddress
template address to add
Returns
estGasAddSSContract
Parameters
address
tokenAddress
contract address to add
Returns
estGasBuyDTBatch
Returns
estGasRemoveApprovedToken
Parameters
address
caller address
tokenAddress
token address we want to add
contractInstance
?
Returns
estGasRemoveDispenserContract
Parameters
address
tokenAddress
contract address to add
Returns
estGasRemoveFixedRateContract
Parameters
address
tokenAddress
contract address to add
Returns
estGasRemovePoolTemplate
Parameters
address
templateAddress
template address to remove
Returns
estGasRemoveSSContract
Parameters
address
caller address
tokenAddress
contract address to add
Returns
estGasUpdateOPCFee
Parameters
address
newSwapOceanFee
newSwapNonOceanFee
newConsumeFee
newProviderFee
Returns
getOPCFee
Parameters
baseToken
Returns
isApprovedToken
Parameters
address
Returns
isFixedPrice
Parameters
address
Returns
isPoolTemplate
Parameters
address
Returns
isSideStaking
Parameters
address
Returns
removeApprovedToken
Parameters
address
tokenAddress
address to remove
Returns
removeDispenserContract
Parameters
address
tokenAddress
contract address to add
Returns
removeFixedRateContract
Parameters
address
tokenAddress
contract address to add
Returns
removePoolTemplate
Parameters
address
templateAddress
template address to remove
Returns
removeSSContract
Parameters
address
caller address
tokenAddress
contract address to removed
Returns
updateOPCFee
Parameters
address
newSwapOceanFee
Amount charged for swapping with ocean approved tokens
newSwapNonOceanFee
Amount charged for swapping with non ocean approved tokens
newConsumeFee
Amount charged from consumeFees
newProviderFee
Amount charged for providerFees
Returns
SideStaking
estGetVesting
Parameters
account
ssAddress
side staking contract address
datatokenAddress
datatokenAddress
contractInstance
?
optional contract instance
Returns
estSetPoolSwapFee
Parameters
account
ssAddress
side staking contract address
datatokenAddress
datatokenAddress
poolAddress
swapFee
contractInstance
?
optional contract instance
Returns
getBaseToken
Parameters
ssAddress
side staking contract address
datatokenAddress
datatokenAddress
Returns
getBaseTokenBalance
Parameters
ssAddress
side staking contract address
datatokenAddress
datatokenAddress
Returns
getDatatokenBalance
Parameters
ssAddress
side staking contract address
datatokenAddress
datatokenAddress
tokenDecimals
?
optional number of decimals of the token
Returns
getDatatokenCirculatingSupply
Parameters
ssAddress
side staking contract address
datatokenAddress
datatoken address
Returns
getDatatokenCurrentCirculatingSupply
Parameters
ssAddress
side staking contract address
datatokenAddress
datatoken address
Returns
getPoolAddress
Parameters
ssAddress
side staking contract address
datatokenAddress
datatokenAddress
Returns
getPublisherAddress
Parameters
ssAddress
side staking contract address
datatokenAddress
datatoken address
Returns
getRouter
Parameters
ssAddress
side staking contract address
Returns
getVesting
Parameters
account
ssAddress
side staking contract address
datatokenAddress
datatokenAddress
Returns
getvestingAmount
Parameters
ssAddress
side staking contract address
datatokenAddress
datatokenAddress
tokenDecimals
?
optional number of decimals of the token
Returns
getvestingAmountSoFar
Parameters
ssAddress
side staking contract address
datatokenAddress
datatokenAddress
tokenDecimals
?
optional number of decimals of the token
Returns
getvestingEndBlock
Parameters
ssAddress
side staking contract address
datatokenAddress
datatokenAddress
Returns
getvestingLastBlock
Parameters
ssAddress
side staking contract address
datatokenAddress
datatokenAddress
Returns
setPoolSwapFee
Parameters
account
ssAddress
side staking contract address
datatokenAddress
datatokenAddress