Ocean.js v1.0.0-next.43
JavaScript client library for Ocean Protocol
FixedRateCreateProgressStep
LogLevel
Aquarius
resolve
Method
Resolves a DID
Parameters
did
string
signal?
AbortSignal
abort signal
Returns
Promise<Asset>
waitForAqua
Method
Blocks until Aqua will cache the did (or the update for that did) or timeouts
Parameters
did
string
DID of the asset.
txid?
string
used when the did exists and we expect an update with that txid.
signal?
AbortSignal
abort signal
Returns
Promise<Asset>
Config
constructor
Constructor
private
authMessage
Property
Message shown when the user creates its own token.
authMessage
explorerUri
Property
private
Url of the blockchain exporer ex: https://etherscan.io
explorerUri
fixedRateExchangeAddress
Property
FixedRateExchangeAddress
fixedRateExchangeAddress
fixedRateExchangeAddressABI
Property
FixedRateExchangeAddressABI
fixedRateExchangeAddressABI
gasFeeMultiplier
Property
private
Specify the multiplier for the gas fee
gasFeeMultiplier
oceanTokenSymbol
Property
private
Ocean toke symbol on the chain, it's used just for convenience to reduce number of calls
oceanTokenSymbol
opfCommunityFeeCollector
Property
OPFCommunityFeeCollector
opfCommunityFeeCollector
subgraphUri
Property
private
Url of the relevant subgraph instance ex: https://subgraph.mainnet.oceanprotocol.com
subgraphUri
transactionBlockTimeout
Property
private
Specify the transaction Block Timeout
transactionBlockTimeout
transactionConfirmationBlocks
Property
private
Specify the transaction Confirmation Blocks
transactionConfirmationBlocks
transactionPollingTimeout
Property
private
Specify the transaction Polling Blocks Timeout
transactionPollingTimeout
ConfigHelper
constructor
Constructor
private
getAddressesFromEnv
Method
Parameters
network
string
customAddresses?
any
Returns
Partial<Config>
Datatoken
addMinter
Method
Add Minter for an ERC20 datatoken
only ERC20Deployer can succeed
Parameters
dtAddress
string
Datatoken address
address
string
User address
minter
string
User which is going to be a Minter
Returns
Promise<TransactionReceipt>
addPaymentManager
Method
Add addPaymentManager (can set who's going to collect fee when consuming orders)
only ERC20Deployer can succeed
Parameters
dtAddress
string
Datatoken address
address
string
User address
paymentManager
string
User which is going to be a Minter
Returns
Promise<TransactionReceipt>
approve
Method
Approve
Parameters
dtAddress
string
Datatoken address
spender
string
Spender address
amount
string
Number of datatokens, as number. Will be converted to wei
address
string
User adress
Returns
Promise<TransactionReceipt>
balance
Method
Get Address Balance for datatoken
Parameters
datatokenAddress
string
address
string
user adress
Returns
Promise<string>
buyFromDispenserAndOrder
Method
Gets DT from dispenser and then startsOrder, while burning that DT
Parameters
dtAddress
string
Datatoken address
address
string
User address which calls
orderParams
dispenserContract
string
Returns
Promise<TransactionReceipt>
buyFromFreAndOrder
Method
Buys 1 DT from the FRE and then startsOrder, while burning that DT
Parameters
dtAddress
string
Datatoken address
address
string
User address which calls
Returns
Promise<TransactionReceipt>
cleanPermissions
Method
Clean erc20level Permissions (minters, paymentManager and reset the paymentCollector) for an ERC20 datatoken
Only NFT Owner (at 721 level) can call it.
Parameters
dtAddress
string
Datatoken address where we want to clean permissions
address
string
User adress
Returns
Promise<TransactionReceipt>
createDispenser
Method
Creates a new Dispenser
Parameters
dtAddress
string
Datatoken address
address
string
Caller address
dispenserAddress
string
ispenser contract address
dispenserParams
Returns
Promise<TransactionReceipt>
createFixedRate
Method
Creates a new FixedRateExchange setup.
Parameters
dtAddress
string
Datatoken address
address
string
Caller address
fixedRateParams
Returns
Promise<TransactionReceipt>
estGasAddMinter
Method
Estimate gas cost for addMinter method
Parameters
dtAddress
string
Datatoken address
address
string
User address
minter
string
User which is going to be a Minter
contractInstance?
Contract
optional contract instance
Returns
Promise<any>
estGasAddPaymentManager
Method
Estimate gas for addPaymentManager method
Parameters
dtAddress
string
Datatoken address
address
string
User address
paymentManager
string
User which is going to be a Minter
contractInstance?
Contract
optional contract instance
Returns
Promise<any>
estGasApprove
Method
Estimate gas cost for mint method
Parameters
dtAddress
string
Datatoken address
spender
string
Spender address
amount
string
Number of datatokens, as number. Will be converted to wei
address
string
User adress
contractInstance?
Contract
optional contract instance
Returns
Promise<any>
estGasBuyFromDispenserAndOrder
Method
Estimate gas cost for buyFromFreAndOrder method
Parameters
dtAddress
string
Datatoken address
address
string
User address which calls
orderParams
dispenserContract
string
contractInstance?
Contract
optional contract instance
Returns
Promise<any>
estGasBuyFromFreAndOrder
Method
Estimate gas cost for buyFromFreAndOrder method
Parameters
dtAddress
string
Datatoken address
address
string
User address which calls
contractInstance?
Contract
optional contract instance
Returns
Promise<any>
estGasCleanPermissions
Method
Estimate gas for cleanPermissions method
Parameters
dtAddress
string
Datatoken address where we want to clean permissions
address
string
User adress
contractInstance?
Contract
optional contract instance
Returns
Promise<any>
estGasCreateDispenser
Method
Estimate gas cost for createDispenser method
Parameters
dtAddress
string
Datatoken address
address
string
Caller address
dispenserAddress
string
ispenser contract address
dispenserParams
contractInstance?
Contract
optional contract instance
Returns
Promise<any>
estGasCreateFixedRate
Method
Estimate gas cost for createFixedRate method
Parameters
dtAddress
string
Datatoken address
address
string
Caller address
fixedRateParams
contractInstance?
Contract
optional contract instance
Returns
Promise<any>
estGasMint
Method
Estimate gas cost for mint method
Parameters
dtAddress
string
Datatoken address
address
string
Minter address
amount
string
Number of datatokens, as number. Will be converted to wei
toAddress?
string
only if toAddress is different from the minter
contractInstance?
Contract
optional contract instance
Returns
Promise<any>
estGasRemoveMinter
Method
Estimate gas for removeMinter method
Parameters
dtAddress
string
Datatoken address
address
string
User address
minter
string
User which will be removed from Minter permission
contractInstance?
Contract
optional contract instance
Returns
Promise<any>
estGasRemovePaymentManager
Method
Estimate gas for removePaymentManager method
Parameters
dtAddress
string
Datatoken address
address
string
User address
paymentManager
string
User which will be removed from paymentManager permission
contractInstance?
Contract
optional contract instance
Returns
Promise<any>
estGasReuseOrder
Method
Estimate gas cost for reuseOrder method
Parameters
dtAddress
string
Datatoken address
address
string
User address which calls
orderTxId
string
previous valid order
contractInstance?
Contract
optional contract instance
Returns
Promise<any>
estGasSetData
Method
Estimate gas for setData method
Parameters
dtAddress
string
Datatoken address
address
string
User address
value
string
Data to be stored into 725Y standard
contractInstance?
Contract
optional contract instance
Returns
Promise<any>
estGasSetPaymentCollector
Method
Estimate gas for setPaymentCollector method
Parameters
dtAddress
string
datatoken address
address
string
Caller address
paymentCollector
string
User to be set as new payment collector
contractInstance?
Contract
optional contract instance
Returns
Promise<any>
estGasStartOrder
Method
Estimate gas cost for startOrder method
Parameters
dtAddress
string
Datatoken address
address
string
User address which calls
consumer
string
Consumer Address
serviceIndex
number
Service index in the metadata
consumeMarketFee?
contractInstance?
Contract
optional contract instance
Returns
Promise<any>
estGasTransfer
Method
Estimate gas for transfer method
Parameters
dtAddress
string
Datatoken address
toAddress
string
Receiver address
amount
string
Number of datatokens, as number. Expressed as wei
address
string
User adress
contractInstance?
Contract
optional contract instance
Returns
Promise<any>
getCap
Method
Returns the Datatoken capital
Parameters
dtAddress
string
Datatoken adress
Returns
Promise<string>
getDTPermissions
Method
Returns ERC20 user's permissions for a datatoken
Parameters
dtAddress
string
Datatoken adress
address
string
user adress
Returns
Promise<Roles>
getDecimals
Method
It returns the token decimals, how many supported decimal points
Parameters
dtAddress
string
Datatoken adress
Returns
Promise<string>
getNFTAddress
Method
It returns the token decimals, how many supported decimal points
Parameters
dtAddress
string
Datatoken adress
Returns
Promise<string>
getPaymentCollector
Method
getPaymentCollector - It returns the current paymentCollector
Parameters
dtAddress
string
datatoken address
Returns
Promise<string>
isERC20Deployer
Method
Returns true if address has deployERC20 role
Parameters
dtAddress
string
Datatoken adress
address
string
Returns
Promise<boolean>
mint
Method
Mint
Parameters
dtAddress
string
Datatoken address
address
string
Minter address
amount
string
Number of datatokens, as number. Will be converted to wei
toAddress?
string
only if toAddress is different from the minter
Returns
Promise<TransactionReceipt>
removeMinter
Method
Revoke Minter permission for an ERC20 datatoken
only ERC20Deployer can succeed
Parameters
dtAddress
string
Datatoken address
address
string
User address
minter
string
User which will be removed from Minter permission
Returns
Promise<TransactionReceipt>
removePaymentManager
Method
Revoke paymentManager permission for an ERC20 datatoken
only ERC20Deployer can succeed
Parameters
dtAddress
string
Datatoken address
address
string
User address
paymentManager
string
User which will be removed from paymentManager permission
Returns
Promise<TransactionReceipt>
reuseOrder
Method
Reuse Order: called by payer or consumer having a valid order, but with expired provider access.
Pays the provider fee again, but it will not require a new datatoken payment
Requires previous approval of provider fee.
Parameters
dtAddress
string
Datatoken address
address
string
User address which calls
orderTxId
string
previous valid order
Returns
Promise<TransactionReceipt>
setData
Method
setData
This function allows to store data with a preset key (keccak256(ERC20Address)) into NFT 725 Store
only ERC20Deployer can succeed
Parameters
dtAddress
string
Datatoken address
address
string
User address
value
string
Data to be stored into 725Y standard
Returns
Promise<TransactionReceipt>
setPaymentCollector
Method
This function allows to set a new PaymentCollector (receives DT when consuming)
If not set the paymentCollector is the NFT Owner
only NFT owner can call
Parameters
dtAddress
string
datatoken address
address
string
Caller address
paymentCollector
string
User to be set as new payment collector
Returns
Promise<TransactionReceipt>
startOrder
Method
Start Order: called by payer or consumer prior ordering a service consume on a marketplace.
Parameters
dtAddress
string
Datatoken address
address
string
User address which calls
consumer
string
Consumer Address
serviceIndex
number
Service index in the metadata
consumeMarketFee?
Returns
Promise<TransactionReceipt>
transfer
Method
Transfer as number from address to toAddress
Parameters
dtAddress
string
Datatoken address
toAddress
string
Receiver address
amount
string
Number of datatokens, as number. To be converted to wei.
address
string
User adress
Returns
Promise<TransactionReceipt>
transferWei
Method
Transfer in wei from address to toAddress
Parameters
dtAddress
string
Datatoken address
toAddress
string
Receiver address
amount
string
Number of datatokens, as number. Expressed as wei
address
string
User adress
Returns
Promise<TransactionReceipt>
Dispenser
activate
Method
Activates a new dispener.
Parameters
dtAddress
string
refers to datatoken address.
maxTokens
string
max amount of tokens to dispense
maxBalance
string
max balance of user. If user balance is >, then dispense will be rejected
address
string
User address (must be owner of the datatoken)
Returns
Promise<TransactionReceipt>
create
Method
Creates a new Dispenser
Parameters
dtAddress
string
Datatoken address
address
string
Owner address
maxTokens
string
max tokens to dispense
maxBalance
string
max balance of requester
allowedSwapper
string
only account that can ask tokens. set address(0) if not required
Returns
Promise<TransactionReceipt>
deactivate
Method
Deactivate an existing dispenser.
Parameters
dtAddress
string
refers to datatoken address.
address
string
User address (must be owner of the datatoken)
Returns
Promise<TransactionReceipt>
dispense
Method
Dispense datatokens to caller.
The dispenser must be active, hold enough DT (or be able to mint more)
and respect maxTokens/maxBalance requirements
Parameters
dtAddress
string
refers to datatoken address.
address
string
User address
amount
string
amount of datatokens required.
destination
string
who will receive the tokens
Returns
Promise<TransactionReceipt>
estGasActivate
Method
Estimate gas for activate method
Parameters
dtAddress
string
maxTokens
string
max amount of tokens to dispense
maxBalance
string
max balance of user. If user balance is >, then dispense will be rejected
address
string
User address (must be owner of the datatoken)
Returns
Promise<any>
estGasCreate
Method
Estimate gas cost for create method
Parameters
dtAddress
string
Datatoken address
address
string
Owner address
maxTokens
string
max tokens to dispense
maxBalance
string
max balance of requester
allowedSwapper
string
if !=0, only this address can request DTs
Returns
Promise<any>
estGasDeactivate
Method
Estimate gas for deactivate method
Parameters
dtAddress
string
address
string
User address (must be owner of the datatoken)
Returns
Promise<any>
estGasDispense
Method
Estimate gas for dispense method
Parameters
dtAddress
string
refers to datatoken address.
address
string
User address (must be owner of the datatoken)
amount
string
destination
string
Returns
Promise<any>
estGasOwnerWithdraw
Method
Estimate gas for ownerWithdraw method
Parameters
dtAddress
string
refers to datatoken address.
address
string
User address (must be owner of the datatoken)
Returns
Promise<any>
estGasSetAllowedSwapper
Method
Estimate gas for setAllowedSwapper method
Parameters
dtAddress
string
refers to datatoken address.
address
string
User address (must be owner of the datatoken)
newAllowedSwapper
string
refers to the new allowedSwapper
Returns
Promise<any>
isDispensable
Method
Check if tokens can be dispensed
Parameters
dtAddress
string
datatoken
address
string
User address that will receive datatokens
amount
string
amount of datatokens required.
Returns
Promise<Boolean>
ownerWithdraw
Method
Withdraw all tokens from the dispenser
Parameters
dtAddress
string
refers to datatoken address.
address
string
User address (must be owner of the dispenser)
Returns
Promise<TransactionReceipt>
setAllowedSwapper
Method
Sets a new allowedSwapper.
Parameters
dtAddress
string
refers to datatoken address.
address
string
User address (must be owner of the datatoken)
newAllowedSwapper
string
refers to the new allowedSwapper
Returns
Promise<TransactionReceipt>
status
Method
Get information about a datatoken dispenser
Parameters
dtAdress
string
Returns
Promise<DispenserToken>
FixedRateExchange
constructor
Constructor
private
Instantiate FixedRateExchange
src/pools/fixedRate/FixedRateExchange.ts#L75activate
Method
Activate an exchange
Parameters
address
string
User address
exchangeId
string
ExchangeId
Returns
Promise<TransactionReceipt>
activateMint
Method
Activate minting option for fixed rate contract
Parameters
address
string
User address
exchangeId
string
ExchangeId
Returns
Promise<TransactionReceipt>
amountToUnits
Method
private
Parameters
token
string
amount
string
tokenDecimals
number
Returns
Promise<string>
buyDT
Method
Atomic swap
Parameters
address
string
User address
exchangeId
string
ExchangeId
datatokenAmount
string
Amount of datatokens
maxBaseTokenAmount
string
max amount of baseToken we want to pay for datatokenAmount
consumeMarketAddress
string
consumeMarketAddress
consumeMarketFee
string
consumeMarketFee in fraction
Returns
Promise<TransactionReceipt>
calcBaseInGivenOutDT
Method
calcBaseInGivenOutDT - Calculates how many base tokens are needed to get specified amount of datatokens
Parameters
exchangeId
string
ExchangeId
datatokenAmount
string
Amount of datatokens user wants to buy
consumeMarketFee
string
consumeMarketFee in fraction
Returns
Promise<PriceAndFees>
collectBT
Method
Collect BaseTokens in the contract (anyone can call this, funds are sent to erc20.paymentCollector)
Parameters
address
string
User address
exchangeId
string
ExchangeId
amount
string
amount to be collected
Returns
Promise<TransactionReceipt>
collectDT
Method
Collect datatokens in the contract (anyone can call this, funds are sent to erc20.paymentCollector)
Parameters
address
string
User address
exchangeId
string
ExchangeId
amount
string
amount to be collected
Returns
Promise<TransactionReceipt>
collectMarketFee
Method
Collect market fee and send it to marketFeeCollector (anyone can call it)
Parameters
address
string
User address
exchangeId
string
ExchangeId
Returns
Promise<TransactionReceipt>
collectOceanFee
Method
Collect ocean fee and send it to OPF collector (anyone can call it)
Parameters
address
string
User address
exchangeId
string
ExchangeId
Returns
Promise<TransactionReceipt>
deactivate
Method
Deactivate an exchange
Parameters
address
string
User address
exchangeId
string
ExchangeId
Returns
Promise<TransactionReceipt>
deactivateMint
Method
Deactivate minting for fixed rate
Parameters
address
string
User address
exchangeId
string
ExchangeId
Returns
Promise<TransactionReceipt>
estActivate
Method
Estimate gas cost for activate
Parameters
account
string
exchangeId
string
ExchangeId
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estActivateMint
Method
Estimate gas cost for activate
Parameters
account
string
exchangeId
string
ExchangeId
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estBuyDT
Method
Estimate gas cost for buyDT
Parameters
account
string
datatokenAddress
string
datatokenAddress
dtAmount
string
datatoken amount we want to buy
maxBaseTokenAmount
string
consumeMarketAddress
string
consumeMarketAddress
consumeMarketFee
string
fee recieved by the consume market when a dt is bought from a fixed rate exchange, percent
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estCollectBT
Method
Estimate gas cost for collectBT
Parameters
account
string
exchangeId
string
ExchangeId
amount
string
amount to be collected
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estCollectDT
Method
Estimate gas cost for collecDT
Parameters
account
string
exchangeId
string
ExchangeId
amount
string
amount to be collected
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estCollectMarketFee
Method
Estimate gas cost for collecMarketFee
Parameters
account
string
exchangeId
string
ExchangeId
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estCollectOceanFee
Method
Estimate gas cost for collectOceanFee
Parameters
account
string
exchangeId
string
ExchangeId
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estDeactivate
Method
Estimate gas cost for deactivate
Parameters
account
string
exchangeId
string
ExchangeId
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estDeactivateMint
Method
Estimate gas cost for deactivate
Parameters
account
string
exchangeId
string
ExchangeId
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estSellDT
Method
Estimate gas cost for sellDT
Parameters
account
string
datatokenAddress
string
datatokenAddress
dtAmount
string
datatoken amount we want to sell
maxBaseTokenAmount
string
consumeMarketAddress
string
consumeMarketAddress
consumeMarketFee
string
consumeMarketFee
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estSetAllowedSwapper
Method
Estimate gas cost for setRate
Parameters
account
string
exchangeId
string
ExchangeId
newAllowedSwapper
string
new allowed swapper address
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estSetRate
Method
Estimate gas cost for setRate
Parameters
account
string
exchangeId
string
ExchangeId
newRate
string
New rate
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estUpdateMarketFee
Method
Estimate gas cost for updateMarketFee
Parameters
account
string
exchangeId
string
ExchangeId
newMarketFee
string
New market fee
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estUpdateMarketFeeCollector
Method
Estimate gas cost for updateMarketFeeCollector
Parameters
account
string
exchangeId
string
ExchangeId
newMarketFeeCollector
string
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
generateExchangeId
Method
Creates unique exchange identifier.
Parameters
baseToken
string
baseToken contract address
datatoken
string
Datatoken contract address
Returns
Promise<string>
getAllowedSwapper
Method
Get Allower Swapper (if set this is the only account which can use this exchange, else is set at address(0))
Parameters
exchangeId
string
ExchangeId
Returns
Promise<string>
getAmountBTOut
Method
getBTOut - returns amount in baseToken that user will receive for datatokenAmount sold
Parameters
exchangeId
string
ExchangeId
datatokenAmount
string
Amount of datatokens
consumeMarketFee
string
consumeMarketFee in fraction
Returns
Promise<string>
getBTSupply
Method
Get BaseToken Supply in the exchange
Parameters
exchangeId
string
ExchangeId
Returns
Promise<string>
getDTSupply
Method
Get Datatoken Supply in the exchange
Parameters
exchangeId
string
ExchangeId
Returns
Promise<string>
getExchange
Method
Get exchange details
Parameters
exchangeId
string
ExchangeId
Returns
Promise<FixedPriceExchange>
getExchangeOwner
Method
private
Get Exchange Owner given an exchangeId
Parameters
exchangeId
string
ExchangeId
Returns
Promise<string>
getFeesInfo
Method
Get fee details for an exchange
Parameters
exchangeId
string
ExchangeId
Returns
Promise<FeesInfo>
getNumberOfExchanges
Method
Gets total number of exchanges
Returns
Promise<number>
getRate
Method
Get Rate
Parameters
exchangeId
string
ExchangeId
Returns
Promise<string>
getRouter
Method
private
Get Router address set in fixed rate contract
Returns
Promise<string>
isActive
Method
Check if an exchange is active
Parameters
exchangeId
string
ExchangeId
Returns
Promise<boolean>
sellDT
Method
Atomic swap
Parameters
address
string
User address
exchangeId
string
ExchangeId
datatokenAmount
string
Amount of datatokens
minBaseTokenAmount
string
min amount of baseToken we want to receive back
consumeMarketAddress
string
consumeMarketAddress
consumeMarketFee
string
consumeMarketFee in fraction
Returns
Promise<TransactionReceipt>
setAllowedSwapper
Method
Set new rate
Parameters
address
string
User account
exchangeId
string
ExchangeId
newAllowedSwapper
string
newAllowedSwapper (set address zero if we want to remove allowed swapper)
Returns
Promise<TransactionReceipt>
setRate
Method
Set new rate
Parameters
address
string
User account
exchangeId
string
ExchangeId
newRate
string
New rate
Returns
Promise<TransactionReceipt>
unitsToAmount
Method
private
Parameters
token
string
amount
string
tokenDecimals
number
Returns
Promise<string>
updateMarketFee
Method
Set new market fee, only market fee collector can update it
Parameters
address
string
user address
exchangeId
string
ExchangeId
newMarketFee
string
New market fee
Returns
Promise<TransactionReceipt>
updateMarketFeeCollector
Method
Set new market fee collector, only market fee collector can update it
Parameters
address
string
user address
exchangeId
string
ExchangeId
newMarketFeeCollector
string
New market fee collector
Returns
Promise<TransactionReceipt>
Logger
Nft
addErc20Deployer
Method
Add ERC20Deployer permission - only Manager can succeed
Parameters
nftAddress
string
erc721 contract adress
address
string
NFT Manager adress
erc20Deployer
string
User adress which is going to have erc20Deployer permission
Returns
Promise<TransactionReceipt>
addManager
Method
Add Manager for NFT Contract (only NFT Owner can succeed)
Parameters
nftAddress
string
erc721 contract adress
address
string
NFT Owner adress
manager
string
User adress which is going to be assing manager
Returns
Promise<any>
addMetadataUpdater
Method
Add Metadata Updater permission - only Manager can succeed
Parameters
nftAddress
string
erc721 contract adress
address
string
NFT Manager adress
metadataUpdater
string
User adress which is going to have Metadata Updater permission
Returns
Promise<TransactionReceipt>
addStoreUpdater
Method
Add Store Updater permission - only Manager can succeed
Parameters
nftAddress
string
erc721 contract adress
address
string
NFT Manager adress
storeUpdater
string
User adress which is going to have Store Updater permission
Returns
Promise<TransactionReceipt>
cleanPermissions
Method
This function allows to remove all ROLES at erc721 level: Managers, ERC20Deployer, MetadataUpdater, StoreUpdater
Even NFT Owner has to readd himself as Manager
Permissions at erc20 level stay.
Only NFT Owner can call it.
Parameters
nftAddress
string
erc721 contract adress
address
string
NFT Owner adress
Returns
Promise<TransactionReceipt>
createErc20
Method
Create new ERC20 datatoken - only user with ERC20Deployer permission can succeed
Parameters
nftAddress
string
ERC721 addreess
address
string
User address
minter
string
User set as initial minter for the ERC20
paymentCollector
string
initial paymentCollector for this DT
mpFeeAddress
string
Consume marketplace fee address
feeToken
string
address of the token marketplace wants to add fee on top
feeAmount
string
amount of feeToken to be transferred to mpFeeAddress on top, will be converted to WEI
cap
string
Maximum cap (Number) - will be converted to wei
name?
string
Token name
symbol?
string
Token symbol
templateIndex?
number
NFT template index
Returns
Promise<string>
esGasRemoveMetadataUpdater
Method
Estimate gas cost for removeFromMetadataList method
Parameters
nftAddress
string
erc721 contract adress
address
string
NFT Manager adress
metadataUpdater
string
Address of the user to be revoked Metadata updater Permission
contractInstance?
Contract
Returns
Promise<any>
estGasAddErc20Deployer
Method
Estimate gas cost for addToCreateERC20List method
Parameters
nftAddress
string
erc721 contract adress
address
string
NFT Manager adress
erc20Deployer
string
User adress which is going to have erc20Deployer permission
contractInstance?
Contract
Returns
Promise<any>
estGasAddManager
Method
Estimate gas cost for add manager call
Parameters
nftAddress
string
erc721 contract adress
address
string
NFT Owner adress
manager
string
User adress which is going to be assing manager
contractInstance?
Contract
Returns
Promise<any>
estGasAddMetadataUpdater
Method
Estimate gas cost for addToMetadataList method
Parameters
nftAddress
string
erc721 contract adress
address
string
NFT Manager adress
metadataUpdater
string
User adress which is going to have Metadata Updater permission
contractInstance?
Contract
Returns
Promise<any>
estGasAddStoreUpdater
Method
Estimate gas cost for addTo725StoreList method
Parameters
nftAddress
string
erc721 contract adress
address
string
NFT Manager adress
storeUpdater
string
User adress which is going to have Store Updater permission
contractInstance?
Contract
Returns
Promise<any>
estGasCleanPermissions
Method
Estimate gas cost for cleanPermissions method
Parameters
nftAddress
string
erc721 contract adress
address
string
NFT Owner adress
contractInstance?
Contract
Returns
Promise<any>
estGasCreateErc20
Method
Estimate gas cost for createERC20 token creation
Parameters
nftAddress
string
ERC721 addreess
address
string
User address
minter
string
User set as initial minter for the ERC20
paymentCollector
string
initial paymentCollector for this DT
mpFeeAddress
string
Consume marketplace fee address
feeToken
string
address of the token marketplace wants to add fee on top
feeAmount
string
amount of feeToken to be transferred to mpFeeAddress on top, will be converted to WEI
cap
string
Maximum cap (Number) - will be converted to wei
name?
string
Token name
symbol?
string
Token symbol
templateIndex?
number
NFT template index
contractInstance?
Contract
Returns
Promise<any>
estGasRemoveErc20Deployer
Method
Estimate gas cost for removeFromCreateERC20List method
Parameters
nftAddress
string
erc721 contract adress
address
string
NFT Manager adress
erc20Deployer
string
Address of the user to be revoked ERC20Deployer Permission
contractInstance?
Contract
Returns
Promise<any>
estGasRemoveManager
Method
Estimate gas cost for removeManager method
Parameters
nftAddress
string
erc721 contract adress
address
string
NFT Owner adress
manager
string
User adress which is going to be removed as manager
contractInstance?
Contract
Returns
Promise<any>
estGasRemoveStoreUpdater
Method
Estimate gas cost for removeFrom725StoreList method
Parameters
nftAddress
string
erc721 contract adress
address
string
NFT Manager adress
storeUpdater
string
Address of the user to be revoked Store Updater Permission
contractInstance?
Contract
Returns
Promise<any>
estGasSafeTransferNft
Method
Estimate gas cost for safeTransfer NFT method
Parameters
nftAddress
string
erc721 contract adress
nftOwner
string
Current NFT Owner adress
nftReceiver
string
User which will receive the NFT, will also be set as Manager
tokenId
number
The id of the token to be transfered
contractInstance?
Contract
Returns
Promise<any>
estGasSetMetadata
Method
Estimate gas cost for setMetadata method
Parameters
nftAddress
string
erc721 contract adress
metadataUpdater
string
metadataUpdater address
metadataState
number
User which will receive the NFT, will also be set as Manager
metadataDecryptorUrl
string
metadataDecryptorAddress
string
flags
string
data
string
metadataHash
string
metadataProofs?
contractInstance?
Contract
Returns
Promise<any>
estGasSetMetadataAndTokenURI
Method
Estimate gas cost for setMetadata method
Parameters
nftAddress
string
erc721 contract adress
metadataUpdater
string
metadataUpdater address
contractInstance?
Contract
Returns
Promise<any>
estGasSetMetadataState
Method
Estimate gas cost for setMetadataState method
Parameters
nftAddress
string
erc721 contract adress
metadataUpdater
string
metadataState
number
new metadata state
contractInstance?
Contract
Returns
Promise<any>
estGasTransferNft
Method
Estimate gas cost for transfer NFT method
Parameters
nftAddress
string
erc721 contract adress
nftOwner
string
Current NFT Owner adress
nftReceiver
string
User which will receive the NFT, will also be set as Manager
tokenId
number
The id of the token to be transfered
contractInstance?
Contract
Returns
Promise<any>
estSetTokenURI
Method
Estimate gas cost for setTokenURI method
Parameters
nftAddress
string
erc721 contract adress
address
string
user adress
data
string
input data for TokenURI
Returns
Promise<any>
getData
Method
Gets data at a given `key`
Parameters
nftAddress
string
erc721 contract adress
key
string
the key which value to retrieve
Returns
Promise<string>
getMetadata
Method
Get users Metadata, return Metadata details
Parameters
nftAddress
string
erc721 contract adress
Returns
Promise<Object>
getNftOwner
Method
Get Owner
Parameters
nftAddress
string
erc721 contract adress
Returns
Promise<string>
getNftPermissions
Method
Get users NFT Permissions
Parameters
nftAddress
string
erc721 contract adress
address
string
user adress
Returns
Promise<Roles>
getTokenURI
Method
Gets data at a given `key`
Parameters
nftAddress
string
erc721 contract adress
id
number
Returns
Promise<string>
isErc20Deployer
Method
Get users ERC20Deployer role
Parameters
nftAddress
string
erc721 contract adress
address
string
user adress
Returns
Promise<boolean>
removeErc20Deployer
Method
Remove ERC20Deployer permission - only Manager can succeed
Parameters
nftAddress
string
erc721 contract adress
address
string
NFT Manager adress
erc20Deployer
string
Address of the user to be revoked ERC20Deployer Permission
Returns
Promise<TransactionReceipt>
removeManager
Method
Removes a specific manager for NFT Contract (only NFT Owner can succeed)
Parameters
nftAddress
string
erc721 contract adress
address
string
NFT Owner adress
manager
string
User adress which is going to be removed as manager
Returns
Promise<any>
removeMetadataUpdater
Method
Remove Metadata Updater permission - only Manager can succeed
Parameters
nftAddress
string
erc721 contract adress
address
string
NFT Manager adress
metadataUpdater
string
Address of the user to be revoked Metadata updater Permission
Returns
Promise<TransactionReceipt>
removeStoreUpdater
Method
Remove Store Updater permission - only Manager can succeed
Parameters
nftAddress
string
erc721 contract adress
address
string
NFT Manager adress
storeUpdater
string
Address of the user to be revoked Store Updater Permission
Returns
Promise<TransactionReceipt>
safeTransferNft
Method
safeTransferNFT Used for transferring the NFT, can be used by an approved relayer
will clean all permissions both on erc721 and erc20 level.
Parameters
nftAddress
string
erc721 contract adress
nftOwner
string
Current NFT Owner adress
nftReceiver
string
User which will receive the NFT, will also be set as Manager
tokenId?
number
The id of the token to be transfered
Returns
Promise<TransactionReceipt>
setMetadata
Method
safeTransferNFT Used for transferring the NFT, can be used by an approved relayer
will clean all permissions both on erc721 and erc20 level.
Parameters
nftAddress
string
erc721 contract adress
address
string
Caller address NFT Owner adress
metadataState
number
metadataDecryptorUrl
string
metadataDecryptorAddress
string
flags
string
data
string
metadataHash
string
metadataProofs?
Returns
Promise<TransactionReceipt>
setMetadataAndTokenURI
Method
Helper function to improve UX sets both MetaData & TokenURI in one tx
Parameters
nftAddress
string
erc721 contract adress
metadataUpdater
string
Returns
Promise<TransactionReceipt>
setMetadataState
Method
setMetadataState Used for updating the metadata State
Parameters
nftAddress
string
erc721 contract adress
address
string
Caller address => metadata updater
metadataState
number
new metadata state
Returns
Promise<TransactionReceipt>
setTokenURI
Method
set TokenURI on an nft
Parameters
nftAddress
string
erc721 contract adress
address
string
user adress
data
string
input data for TokenURI
Returns
Promise<any>
transferNft
Method
Transfers the NFT
will clean all permissions both on erc721 and erc20 level.
Parameters
nftAddress
string
erc721 contract adress
nftOwner
string
Current NFT Owner adress
nftReceiver
string
User which will receive the NFT, will also be set as Manager
tokenId?
number
The id of the token to be transfered
Returns
Promise<TransactionReceipt>
NftFactory
Provides an interface for NFT Factory contract
addNFTTemplate
Method
Add a new erc721 token template - only factory Owner
Parameters
address
string
templateAddress
string
template address to add
Returns
Promise<TransactionReceipt>
addTokenTemplate
Method
Add a new erc721 token template - only factory Owner
Parameters
address
string
templateAddress
string
template address to add
Returns
Promise<TransactionReceipt>
checkDatatoken
Method
Check if ERC20 is deployed from the factory
Parameters
datatoken
string
Datatoken address we want to check
Returns
Promise<Boolean>
checkNFT
Method
Check if NFT is deployed from the factory
Parameters
nftAddress
string
nftAddress address we want to check
Returns
Promise<String>
createNftErc20WithDispenser
Method
Parameters
address
string
Caller address
Returns
Promise<TransactionReceipt>
createNftErc20WithFixedRate
Method
Parameters
address
string
Caller address
Returns
Promise<TransactionReceipt>
createNftErc20WithPool
Method
Parameters
address
string
Caller address
Returns
Promise<TransactionReceipt>
disableNFTTemplate
Method
Disable token template - only factory Owner
Parameters
address
string
templateIndex
number
index of the template we want to disable
Returns
Promise<TransactionReceipt>
disableTokenTemplate
Method
Disable token template - only factory Owner
Parameters
address
string
templateIndex
number
index of the template we want to disable
Returns
Promise<TransactionReceipt>
estGasAddNFTTemplate
Method
Estimate gas cost for add721TokenTemplate method
Parameters
address
string
templateAddress
string
template address to add
Returns
Promise<any>
estGasAddTokenTemplate
Method
Estimate gas cost for addTokenTemplate method
Parameters
address
string
templateAddress
string
template address to add
Returns
Promise<any>
estGasCreateNFT
Method
Get estimated gas cost for deployERC721Contract value
Returns
Promise<string>
estGasCreateNftErc20WithDispenser
Method
Estimate gas cost for createNftErc20WithFixedRate method
Parameters
address
string
Caller address
Returns
Promise<any>
estGasCreateNftErc20WithFixedRate
Method
Estimate gas cost for createNftErc20WithFixedRate method
Parameters
address
string
Caller address
Returns
Promise<any>
estGasCreateNftErc20WithPool
Method
Estimate gas cost for createNftErc20WithPool method
Parameters
address
string
Caller address
Returns
Promise<any>
estGasCreateNftWithErc20
Method
Estimate gas cost for createNftWithErc20 method
Returns
Promise<any>
estGasDisableNFTTemplate
Method
Estimate gas cost for disable721TokenTemplate method
Parameters
address
string
templateIndex
number
index of the template we want to disable
Returns
Promise<any>
estGasDisableTokenTemplate
Method
Estimate gas cost for disableTokenTemplate method
Parameters
address
string
templateIndex
number
index of the template we want to disable
Returns
Promise<any>
estGasReactivateNFTTemplate
Method
Reactivate a previously disabled token template - only factory Owner
Parameters
address
string
templateIndex
number
index of the template we want to reactivate
Returns
Promise<any>
estGasReactivateTokenTemplate
Method
Estimate gas cost for reactivateTokenTemplate method
Parameters
address
string
templateIndex
number
index of the template we want to reactivate
Returns
Promise<any>
estGasStartMultipleTokenOrder
Method
Estimate gas cost for startMultipleTokenOrder method
Returns
Promise<any>
getCurrentNFTCount
Method
Get Current NFT Count (NFT created)
Returns
Promise<number>
getCurrentNFTTemplateCount
Method
Get Current NFT Template Count
Returns
Promise<number>
getCurrentTokenCount
Method
Get Current Datatoken Count
Returns
Promise<number>
getCurrentTokenTemplateCount
Method
Get Current Template Datatoken (ERC20) Count
Returns
Promise<number>
getNFTTemplate
Method
Get NFT Template
Parameters
index
number
Template index
Returns
Promise<Template>
getTokenTemplate
Method
Get Datatoken(erc20) Template
Parameters
index
number
Template index
Returns
Promise<Template>
reactivateNFTTemplate
Method
Reactivate a previously disabled token template - only factory Owner
Parameters
address
string
templateIndex
number
index of the template we want to reactivate
Returns
Promise<TransactionReceipt>
reactivateTokenTemplate
Method
Reactivate a previously disabled token template - only factory Owner
Parameters
address
string
templateIndex
number
index of the template we want to reactivate
Returns
Promise<TransactionReceipt>
Pool
Provides an interface to Ocean friendly fork from Balancer BPool
amountToUnits
Method
private
Parameters
token
string
amount
string
tokenDecimals?
number
Returns
Promise<string>
calcPoolInGivenSingleOut
Method
Returns number of poolshares needed to withdraw exact tokenAmountOut tokens
Parameters
poolAddress
string
tokenOut
string
tokenOut
tokenAmountOut
string
expected amount of tokensOut
poolDecimals?
number
optional number of decimals of the pool
tokenOutDecimals?
number
optional number of decimals of the token
Returns
Promise<string>
calcPoolOutGivenSingleIn
Method
Returns number of poolshares obtain by staking exact tokenAmountIn tokens
Parameters
poolAddress
string
tokenIn
string
tokenIn
tokenAmountIn
string
exact number of tokens staked
poolDecimals?
number
optional number of decimals of the poool
tokenInDecimals?
number
optional number of decimals of the token
Returns
Promise<string>
calcSingleInGivenPoolOut
Method
Returns number of tokens to be staked to the pool in order to get an exact number of poolshares
Parameters
poolAddress
string
tokenIn
string
tokenIn
poolAmountOut
string
expected amount of pool shares
poolDecimals?
number
optional number of decimals of the pool
tokenInDecimals?
number
optional number of decimals of the token
Returns
Promise<string>
calcSingleOutGivenPoolIn
Method
Returns expected amount of tokenOut for removing exact poolAmountIn pool shares from the pool
Parameters
poolAddress
string
tokenOut
string
tokenOut
poolAmountIn
string
amount of shares spent
poolDecimals?
number
optional number of decimals of the pool
tokenOutDecimals?
number
optional number of decimals of the token
Returns
Promise<string>
collectMarketFee
Method
private
collectOPF - collect market fees - can be called by the publishMarketCollector
Parameters
address
string
poolAddress
string
Returns
Promise<TransactionReceipt>
collectOPC
Method
private
collectOPF - collect opf fee - can be called by anyone
Parameters
address
string
poolAddress
string
Returns
Promise<TransactionReceipt>
estCollectMarketFee
Method
Estimate gas cost for collectMarketFee
Parameters
address
string
poolAddress
string
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estCollectOPC
Method
Estimate gas cost for collectOPF
Parameters
address
string
poolAddress
string
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estExitswapPoolAmountIn
Method
Estimate gas cost for exitswapPoolAmountIn
Parameters
address
string
poolAddress
string
poolAmountIn
string
exact number of pool shares to spend
minTokenAmountOut
string
minimum amount of basetokens expected
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estJoinswapExternAmountIn
Method
Estimate gas cost for joinswapExternAmountIn
Parameters
address
string
poolAddress
string
tokenAmountIn
string
exact number of base tokens to spend
minPoolAmountOut
string
minimum of pool shares expectex
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estSetSwapFee
Method
Estimate gas cost for setSwapFee
Parameters
account
string
poolAddress
string
fee
string
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estSwapExactAmountIn
Method
Estimate gas cost for swapExactAmountIn
Parameters
address
string
poolAddress
string
tokenInOutMarket
object contianing addresses like tokenIn, tokenOut, consumeMarketFeeAddress
amountsInOutMaxFee
object contianing tokenAmountIn, minAmountOut, maxPrice, consumeMarketSwapFee
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estSwapExactAmountOut
Method
Estimate gas cost for swapExactAmountOut
Parameters
address
string
poolAddress
string
tokenInOutMarket
amountsInOutMaxFee
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estUpdatePublishMarketFee
Method
Estimate gas cost for updatePublishMarketFee
Parameters
address
string
poolAddress
string
newPublishMarketAddress
string
new market address
newPublishMarketSwapFee
string
new market swap fee
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
exitswapPoolAmountIn
Method
private
Single side remove liquidity from the pool,
expecting a minAmountOut of basetokens for spending poolAmountIn pool shares
Pay poolAmountIn pool shares into the pool, getting minTokenAmountOut of the baseToken
Parameters
account
string
poolAddress
string
poolAmountIn
string
exact number of pool shares to spend
minTokenAmountOut
string
minimum amount of basetokens expected
poolDecimals?
number
optional number of decimals of the poool
Returns
Promise<TransactionReceipt>
getAmountInExactOut
Method
How many tokensIn do you need in order to get exact tokenAmountOut.
Returns: tokenAmountIn, swapFee, opcFee , consumeMarketSwapFee, publishMarketSwapFee
Returns: tokenAmountIn, LPFee, opcFee , publishMarketSwapFee, consumeMarketSwapFee
Parameters
poolAddress
string
tokenIn
string
token to be swaped
tokenOut
string
token to get
tokenAmountOut
string
exact amount of tokenOut
swapMarketFee
string
consume market swap fee
tokenInDecimals?
number
optional number of decimals of the token to be swaped
tokenOutDecimals?
number
optional number of decimals of the token to get
Returns
Promise<PoolPriceAndFees>
getAmountOutExactIn
Method
How many tokensOut you will get for a exact tokenAmountIn
Returns: tokenAmountOut, LPFee, opcFee , publishMarketSwapFee, consumeMarketSwapFee
Parameters
poolAddress
string
tokenIn
string
token to be swaped
tokenOut
string
token to get
tokenAmountIn
string
exact amount of tokenIn
swapMarketFee
string
tokenInDecimals?
number
optional number of decimals of the token to be swaped
tokenOutDecimals?
number
optional number of decimals of the token to get
Returns
Promise<PoolPriceAndFees>
getBaseToken
Method
private
Returns the current baseToken address of the pool
Parameters
poolAddress
string
Returns
Promise<string>
getCommunityFees
Method
private
Get Community Fees available to be collected for a specific token
Parameters
poolAddress
string
token
string
token we want to check fees
tokenDecimals?
number
optional number of decimals of the token
Returns
Promise<string>
getController
Method
private
Returns the current controller address (ssBot)
Parameters
poolAddress
string
Returns
Promise<string>
getCurrentMarketFees
Method
private
Get Community Get the current amount of fees which can be withdrawned by the Market
Parameters
poolAddress
string
Returns
Promise<CurrentFees>
getCurrentOPCFees
Method
private
Get getCurrentOPFFees Get the current amount of fees which can be withdrawned by OPF
Parameters
poolAddress
string
Returns
Promise<CurrentFees>
getCurrentTokens
Method
private
Get tokens composing this poo
Returns tokens bounded to pool, before the pool is finalizedl
Parameters
poolAddress
string
Returns
Promise<>
getDatatoken
Method
private
Returns the current datatoken address
Parameters
poolAddress
string
Returns
Promise<string>
getDenormalizedWeight
Method
private
Returns denormalized weight of a token
Parameters
poolAddress
string
token
string
token to be checked
Returns
Promise<string>
getFinalTokens
Method
private
Get the final tokens composing this pool
Returns tokens bounded to pool, after the pool was finalized
Parameters
poolAddress
string
Returns
Promise<>
getMarketFee
Method
private
Get getMarketFee
Parameters
poolAddress
string
Returns
Promise<string>
getMarketFeeCollector
Method
private
Get marketFeeCollector of this pool
Parameters
poolAddress
string
Returns
Promise<string>
getMarketFees
Method
private
Returns the current fee of publishingMarket
Get Market Fees available to be collected for a specific token
Parameters
poolAddress
string
token
string
token we want to check fees
tokenDecimals?
number
optional number of decimals of the token
Returns
Promise<string>
getNormalizedWeight
Method
private
Returns normalized weight of a token.
The combined normalized weights of all tokens will sum up to 1.
(Note: the actual sum may be 1 plus or minus a few wei due to division precision loss)
Parameters
poolAddress
string
token
string
token to be checked
Returns
Promise<string>
getNumTokens
Method
private
Returns number of tokens bounded to pool
Parameters
poolAddress
string
Returns
Promise<string>
getReserve
Method
private
Returns the current token reserve amount
Parameters
poolAddress
string
token
string
Address of the token to be checked
tokenDecimals?
number
optional number of decimals of the token
Returns
Promise<string>
getSpotPrice
Method
private
Return the spot price of swapping tokenIn to tokenOut
Parameters
poolAddress
string
tokenIn
string
in token
tokenOut
string
out token
swapMarketFee
string
Returns
Promise<string>
getSwapFee
Method
private
Returns the current Liquidity Providers swap fee
Parameters
poolAddress
string
Returns
Promise<string>
getTotalDenormalizedWeight
Method
private
getTotalDenormalizedWeight
Returns total denormalized weught of the pool
Parameters
poolAddress
string
Returns
Promise<string>
isBound
Method
private
Get if a token is bounded to a pool
Returns true if token is bound
Parameters
poolAddress
string
token
string
Address of the token to be checked
Returns
Promise<boolean>
isFinalized
Method
private
Get if a pool is finalized
Returns true if pool is finalized
Parameters
poolAddress
string
Returns
Promise<boolean>
joinswapExternAmountIn
Method
private
Single side add liquidity to the pool,
expecting a minPoolAmountOut of shares for spending tokenAmountIn basetokens.
Pay tokenAmountIn of baseToken to join the pool, getting poolAmountOut of the pool shares.
Parameters
account
string
poolAddress
string
tokenAmountIn
string
exact number of base tokens to spend
minPoolAmountOut
string
minimum of pool shares expectex
tokenInDecimals?
number
optional number of decimals of the token
Returns
Promise<TransactionReceipt>
setSwapFee
Method
private
Allows controller to change the swapFee
Parameters
account
string
poolAddress
string
fee
string
swap fee (1e17 = 10 % , 1e16 = 1% , 1e15 = 0.1%, 1e14 = 0.01%)
Returns
Promise<TransactionReceipt>
swapExactAmountIn
Method
private
Swaps an exact amount of tokensIn to get a mimum amount of tokenOut
Trades an exact tokenAmountIn of tokenIn taken from the caller by the pool,
in exchange for at least minAmountOut of tokenOut given to the caller from the pool, with a maximum marginal price of maxPrice.
Returns (tokenAmountOut, spotPriceAfter), where tokenAmountOut is the amount of token that came out of the pool,
and spotPriceAfter is the new marginal spot price, ie, the result of getSpotPrice after the call.
(These values are what are limited by the arguments; you are guaranteed tokenAmountOut >= minAmountOut and spotPriceAfter <= maxPrice).
Parameters
address
string
poolAddress
string
tokenInOutMarket
object contianing addresses like tokenIn, tokenOut, consumeMarketFeeAddress
amountsInOutMaxFee
object contianing tokenAmountIn, minAmountOut, maxPrice, consumeMarketSwapFee
Returns
Promise<TransactionReceipt>
swapExactAmountOut
Method
private
Swaps a maximum maxAmountIn of tokensIn to get an exact amount of tokenOut
Parameters
account
string
poolAddress
string
tokenInOutMarket
Object containing addresses like tokenIn, tokenOut, consumeMarketFeeAddress
amountsInOutMaxFee
Object containging maxAmountIn,tokenAmountOut,maxPrice, consumeMarketSwapFee]
Returns
Promise<TransactionReceipt>
unitsToAmount
Method
private
Parameters
token
string
amount
string
tokenDecimals?
number
Returns
Promise<string>
updatePublishMarketFee
Method
private
updatePublishMarketFee - sets a new newPublishMarketAddress and new newPublishMarketSwapFee- can be called only by the marketFeeCollector
Parameters
address
string
poolAddress
string
newPublishMarketAddress
string
new market fee collector address
newPublishMarketSwapFee
string
fee recieved by the publisher market when a dt is swaped from a pool, percent
Returns
Promise<TransactionReceipt>
Provider
constructor
Constructor
private
checkDidFiles
Method
Get DDO File details (if possible)
Parameters
did
string
did
serviceId
number
the id of the service for which to check the files
providerUri
string
uri of the provider that will be used to check the file
signal?
AbortSignal
abort signal
Returns
Promise<>
checkFileUrl
Method
Get URL details (if possible)
Parameters
url
string
or did
providerUri
string
uri of the provider that will be used to check the file
signal?
AbortSignal
abort signal
Returns
Promise<>
computeDelete
Method
Deletes a compute job.
Parameters
did
string
consumerAddress
string
jobId
string
providerUri
string
web3
default
signal?
AbortSignal
abort signal
Returns
Promise<>
computeStart
Method
Instruct the provider to start a compute job
Parameters
providerUri
string
web3
default
consumerAddress
string
computeEnv
string
dataset
algorithm
signal?
AbortSignal
abort signal
additionalDatasets?
output?
Returns
Promise<>
computeStatus
Method
Get compute status for a specific jobId/documentId/owner.
Parameters
providerUri
string
The URI of the provider we want to query
consumerAddress
string
The consumer ethereum address
jobId?
string
The ID of a compute job.
did?
string
The ID of the asset
signal?
AbortSignal
abort signal
Returns
Promise<>
computeStop
Method
Instruct the provider to Stop the execution of a to stop a compute job.
Parameters
did
string
consumerAddress
string
jobId
string
providerUri
string
web3
default
signal?
AbortSignal
abort signal
Returns
Promise<>
encrypt
Method
Encrypt data using the Provider's own symmetric key
Parameters
data
any
data in json format that needs to be sent , it can either be a DDO or a File array
providerUri
string
provider uri address
signal?
AbortSignal
abort signal
Returns
Promise<string>
getComputeEnvironments
Method
Get Compute Environments
Parameters
providerUri
string
signal?
AbortSignal
Returns
Promise<>
getComputeResultUrl
Method
Get compute result url
Parameters
providerUri
string
The URI of the provider we want to query
web3
default
Web3 instance
consumerAddress
string
The consumer ethereum address
jobId
string
The ID of a compute job.
index
number
Result index
Returns
Promise<string>
getDownloadUrl
Method
Gets fully signed URL for download
Parameters
did
string
accountId
string
serviceId
string
fileIndex
number
transferTxId
string
providerUri
string
web3
default
userCustomParameters?
Returns
Promise<any>
getEndpoints
Method
private
Returns the provider endpoints
Parameters
providerUri
string
Returns
Promise<any>
getNonce
Method
Gets current nonce
Parameters
providerUri
string
provider uri address
consumerAddress
string
Publisher address
signal?
AbortSignal
abort signal
providerEndpoints?
any
Identifier of the asset to be registered in ocean
Returns
Promise<string>
getServiceEndpoints
Method
Returns the service endpoints that exist in provider.
Parameters
providerEndpoint
string
endpoints
any
Returns
Promise<>
initialize
Method
Initialize a service request.
Parameters
did
string
serviceId
string
fileIndex
number
consumerAddress
string
providerUri
string
Identifier of the asset to be registered in ocean
signal?
AbortSignal
abort signal
userCustomParameters?
computeEnv?
string
validUntil?
number
Returns
Promise<ProviderInitialize>
initializeCompute
Method
Initialize a compute request.
Parameters
assets
algorithm
computeEnv
string
validUntil
number
providerUri
string
Identifier of the asset to be registered in ocean
accountId
string
signal?
AbortSignal
abort signal
Returns
Promise<ProviderComputeInitializeResults>
isValidProvider
Method
Check for a valid provider at URL
Parameters
url
string
provider uri address
signal?
AbortSignal
abort signal
Returns
Promise<boolean>
signProviderRequest
Method
Parameters
web3
default
accountId
string
message
string
password?
string
Returns
Promise<string>
Router
Provides an interface for FactoryRouter contract
addApprovedToken
Method
Add a new token to oceanTokens list, pools with baseToken in this list have NO opf Fee
Parameters
address
string
caller address
tokenAddress
string
token address to add
Returns
Promise<TransactionReceipt>
addDispenserContract
Method
Add a new contract to dispenser list, after is added, can be used when deploying a new pool
Parameters
address
string
tokenAddress
string
contract address to add
Returns
Promise<TransactionReceipt>
addFixedRateContract
Method
Add a new contract to fixedRate list, after is added, can be used when deploying a new pool
Parameters
address
string
tokenAddress
string
contract address to add
Returns
Promise<TransactionReceipt>
addPoolTemplate
Method
Add a new template to poolTemplates mapping, after template is added,it can be used
Parameters
address
string
templateAddress
string
template address to add
Returns
Promise<TransactionReceipt>
addSSContract
Method
Add a new contract to ssContract list, after is added, can be used when deploying a new pool
Parameters
address
string
tokenAddress
string
contract address to add
Returns
Promise<TransactionReceipt>
estGasAddApprovedToken
Method
Estimate gas cost for addApprovedToken
Parameters
address
string
tokenAddress
string
token address we want to add
contractInstance?
Contract
Returns
Promise<any>
estGasAddDispenserContract
Method
Estimate gas cost for addDispenserContract method
Parameters
address
string
tokenAddress
string
contract address to add
Returns
Promise<any>
estGasAddFixedRateContract
Method
Estimate gas cost for addFixedRateContract method
Parameters
address
string
tokenAddress
string
contract address to add
Returns
Promise<any>
estGasAddPoolTemplate
Method
Estimate gas cost for addPoolTemplate method
Parameters
address
string
templateAddress
string
template address to add
Returns
Promise<any>
estGasAddSSContract
Method
Estimate gas cost for addSSContract method
Parameters
address
string
tokenAddress
string
contract address to add
Returns
Promise<any>
estGasBuyDTBatch
Method
Estimate gas cost for buyDTBatch method
Returns
Promise<any>
estGasRemoveApprovedToken
Method
Estimate gas cost for removeApprovedToken
Parameters
address
string
caller address
tokenAddress
string
token address we want to add
contractInstance?
Contract
Returns
Promise<any>
estGasRemoveDispenserContract
Method
Estimate gas cost for addDispenserContract method
Parameters
address
string
tokenAddress
string
contract address to add
Returns
Promise<any>
estGasRemoveFixedRateContract
Method
Estimate gas cost for addFixedRateContract method
Parameters
address
string
tokenAddress
string
contract address to add
Returns
Promise<any>
estGasRemovePoolTemplate
Method
Estimate gas cost for removePoolTemplate method
Parameters
address
string
templateAddress
string
template address to remove
Returns
Promise<any>
estGasRemoveSSContract
Method
Estimate gas cost for removeSSContract method
Parameters
address
string
caller address
tokenAddress
string
contract address to add
Returns
Promise<any>
estGasUpdateOPCFee
Method
Estimate gas cost for updateOPFFee method
Parameters
address
string
newSwapOceanFee
number
newSwapNonOceanFee
number
newConsumeFee
number
newProviderFee
number
Returns
Promise<any>
getOPCFee
Method
Get OPF Fee per token
Parameters
baseToken
string
Returns
Promise<number>
isApprovedToken
Method
Check if a token is on approved tokens list, if true opfFee is lower in pools with that token/DT
Parameters
address
string
Returns
Promise<boolean>
isFixedPrice
Method
Check if an address is a Fixed Rate contract.
Parameters
address
string
Returns
Promise<boolean>
isPoolTemplate
Method
Check if an address is a pool template contract.
Parameters
address
string
Returns
Promise<boolean>
isSideStaking
Method
Check if an address is a side staking contract.
Parameters
address
string
Returns
Promise<boolean>
removeApprovedToken
Method
Remove a token from oceanTokens list, pools without baseToken in this list have a opf Fee
Parameters
address
string
tokenAddress
string
address to remove
Returns
Promise<TransactionReceipt>
removeDispenserContract
Method
Add a new contract to dispenser list, after is added, can be used when deploying a new pool
Parameters
address
string
tokenAddress
string
contract address to add
Returns
Promise<TransactionReceipt>
removeFixedRateContract
Method
Removes a contract from fixedRate list
Parameters
address
string
tokenAddress
string
contract address to add
Returns
Promise<TransactionReceipt>
removePoolTemplate
Method
Remove template from poolTemplates mapping, after template is removed,it can be used anymore
Parameters
address
string
templateAddress
string
template address to remove
Returns
Promise<TransactionReceipt>
removeSSContract
Method
Removes a new contract from ssContract list
Parameters
address
string
caller address
tokenAddress
string
contract address to removed
Returns
Promise<TransactionReceipt>
updateOPCFee
Method
Add a new contract to fixedRate list, after is added, can be used when deploying a new pool
Parameters
address
string
newSwapOceanFee
number
Amount charged for swapping with ocean approved tokens
newSwapNonOceanFee
number
Amount charged for swapping with non ocean approved tokens
newConsumeFee
number
Amount charged from consumeFees
newProviderFee
number
Amount charged for providerFees
Returns
Promise<TransactionReceipt>
SideStaking
estGetVesting
Method
Estimate gas cost for getVesting
Parameters
account
string
ssAddress
string
side staking contract address
datatokenAddress
string
datatokenAddress
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
estSetPoolSwapFee
Method
Estimate gas cost for getVesting
Parameters
account
string
ssAddress
string
side staking contract address
datatokenAddress
string
datatokenAddress
poolAddress
string
swapFee
number
contractInstance?
Contract
optional contract instance
Returns
Promise<number>
getBaseToken
Method
private
Get
Parameters
ssAddress
string
side staking contract address
datatokenAddress
string
datatokenAddress
Returns
Promise<string>
getBaseTokenBalance
Method
private
Get baseToken balance in the contract
Parameters
ssAddress
string
side staking contract address
datatokenAddress
string
datatokenAddress
Returns
Promise<string>
getDatatokenBalance
Method
private
Get dt balance in the staking contract available for being added as liquidity
Parameters
ssAddress
string
side staking contract address
datatokenAddress
string
datatokenAddress
tokenDecimals?
number
optional number of decimals of the token
Returns
Promise<string>
getDatatokenCirculatingSupply
Method
private
Get (total vesting amount + token released from the contract when adding liquidity)
Parameters
ssAddress
string
side staking contract address
datatokenAddress
string
datatoken address
Returns
Promise<string>
getDatatokenCurrentCirculatingSupply
Method
private
Get actual dts in circulation (vested token withdrawn from the contract +
token released from the contract when adding liquidity)
Parameters
ssAddress
string
side staking contract address
datatokenAddress
string
datatoken address
Returns
Promise<string>
getPoolAddress
Method
private
Get Pool Address
Parameters
ssAddress
string
side staking contract address
datatokenAddress
string
datatokenAddress
Returns
Promise<string>
getPublisherAddress
Method
private
Get Publisher address
Parameters
ssAddress
string
side staking contract address
datatokenAddress
string
datatoken address
Returns
Promise<string>
getRouter
Method
private
Get Router address set in side staking contract
Parameters
ssAddress
string
side staking contract address
Returns
Promise<string>
getVesting
Method
private
Send vested tokens available to the publisher address, can be called by anyone
Parameters
account
string
ssAddress
string
side staking contract address
datatokenAddress
string
datatokenAddress
Returns
Promise<TransactionReceipt>
getvestingAmount
Method
private
Get total amount vesting
Parameters
ssAddress
string
side staking contract address
datatokenAddress
string
datatokenAddress
tokenDecimals?
number
optional number of decimals of the token
Returns
Promise<string>
getvestingAmountSoFar
Method
private
Get how much has been taken from the vesting amount
Parameters
ssAddress
string
side staking contract address
datatokenAddress
string
datatokenAddress
tokenDecimals?
number
optional number of decimals of the token
Returns
Promise<string>
getvestingEndBlock
Method
private
Get block when vesting ends
Parameters
ssAddress
string
side staking contract address
datatokenAddress
string
datatokenAddress
Returns
Promise<string>
getvestingLastBlock
Method
private
Get last block publisher got some vested tokens
Parameters
ssAddress
string
side staking contract address
datatokenAddress
string
datatokenAddress
Returns
Promise<string>
setPoolSwapFee
Method
private
Send vested tokens available to the publisher address, can be called by anyone
Parameters
account
string
ssAddress
string
side staking contract address
datatokenAddress
string
datatokenAddress
poolAddress
string
swapFee
number
Returns
Promise<TransactionReceipt>
unitsToAmount
Method
private
Parameters
token
string
amount
string
tokenDecimals?
number
Returns
Promise<string>
AmountsInMaxFee
AmountsOutMaxFee
Asset
chainId
Property
private
ChainId of the network the DDO was published to.
chainId
credentials
Property
private
Describes the credentials needed to access a dataset
in addition to the services definition.
credentials
datatokens
Property
private
Contains information about the ERC20 datatokens attached to asset services.
datatokens
event
Property
private
Contains information about the last transaction that created or updated the DDO.
event
id
Property
private
DID, descentralized ID.
Computed as sha256(address of ERC721 contract + chainId)
id
nft
Property
private
Contains information about the ERC721 NFT contract which represents the intellectual property of the publisher.
nft
purgatory
Property
private
Contains information about an asset's purgatory status defined in
[`list-purgatory`](https://github.com/oceanprotocol/list-purgatory).
Marketplace interfaces are encouraged to prevent certain user actions like adding liquidity on assets in purgatory.
purgatory
services
Property
private
Stores an array of services defining access to the asset.
services
stats
Property
private
The stats section contains different statistics fields.
stats
version
Property
private
Version information in SemVer notation
referring to the DDO spec version
version
AssetDatatoken
address
Property
private
Contract address of the deployed ERC20 contract.
address
serviceId
Property
private
ID of the service the datatoken is attached to.
serviceId
AssetLastEvent
AssetNft
address
Property
private
Contract address of the deployed ERC721 NFT contract.
address
state
Property
private
State of the asset reflecting the NFT contract value.
0 Active.
1 End-of-life.
2 Deprecated (by another asset).
3 Revoked by publisher.
4 Ordering is temporary disabled.
state
ComputeAlgorithm
ComputeAsset
ComputeEnvironment
ComputeJob
ComputeOutput
ComputeResult
ConsumeMarketFee
Credential
Credentials
CurrentFees
DDO
DID Descriptor Object.
Contains metadata about the asset, and define access in at least one service.
chainId
Property
private
ChainId of the network the DDO was published to.
chainId
credentials
Property
private
Describes the credentials needed to access a dataset
in addition to the services definition.
credentials
id
Property
private
DID, descentralized ID.
Computed as sha256(address of ERC721 contract + chainId)
id
services
Property
private
Stores an array of services defining access to the asset.
services
version
Property
private
Version information in SemVer notation
referring to the DDO spec version
version
DispenserCreationParams
DispenserParams
DispenserToken
Erc20CreateParams
FeesInfo
FileMetadata
FixedPriceExchange
FixedPriceSwap
FreCreationParams
FreOrderParams
HttpCallback
Metadata
additionalInformation
Property
private
Stores additional information, this is customizable by publisher
additionalInformation
algorithm
Property
private
Information about asset of typealgorithm
algorithm
author
Property
private
Name of the entity generating this data (e.g. Tfl, Disney Corp, etc.).
author
categories
Property
private
Array of categories associated to the asset. Note: recommended to use tags instead of this.
categories
contentLanguage
Property
private
The language of the content. Use one of the language codes from the IETF BCP 47 standard
contentLanguage
copyrightHolder
Property
private
The party holding the legal copyright. Empty by default.
copyrightHolder
created
Property
private
Contains the date of publishing in ISO Date Time
created
license
Property
private
Short name referencing the license of the asset.
If it’s not specified, the following value will be added: “No License Specified”.
license
links
Property
private
Mapping of URL strings for data samples, or links to find out more information.
Links may be to either a URL or another asset.
links
tags
Property
private
Array of keywords or tags used to describe this content. Empty by default.
tags
type
Property
private
Asset type. Includes "dataset" (e.g. csv file), "algorithm" (e.g. Python script).
Each type needs a different subset of metadata attributes.
type
updated
Property
private
Contains the the date of last update in ISO Date Time
updated
MetadataAlgorithm
container
Property
private
Object describing the Docker container image.
container
language
Property
private
Language used to implement the software.
language
version
Property
private
Version of the software preferably in SemVer notation.
version
MetadataAndTokenURI
MetadataProof
NftCreateData
Operation
amountsIn
Property
private
when swapExactAmountIn is EXACT amount IN
expressed in Wei
amountsIn
amountsOut
Property
private
when swapExactAmountIn is MIN amount OUT
expressed in Wei
amountsOut
exchangeIds
Property
private
used only for FixedRate or Dispenser, but needs to be filled even for pool
exchangeIds
marketFeeAddress
Property
private
market fee address to receive fees
marketFeeAddress
operation
Property
private
operation:
0 - swapExactAmountIn
1 - swapExactAmountOut
2 - FixedRateExchange
3 - Dispenser
operation
OrderParams
PoolCreationParams
PoolPriceAndFees
PriceAndFees
ProviderComputeInitialize
ProviderComputeInitializeResults
ProviderFees
ProviderInitialize
PublisherTrustedAlgorithm
containerSectionChecksum
Property
private
Hash of algorithm’s metadata.algorithm.container section.
containerSectionChecksum
did
Property
private
The DID of the algorithm which is trusted by the publisher.
did
filesChecksum
Property
private
Hash of algorithm’s files section.
filesChecksum
Purgatory
reason
Property
private
If asset is in purgatory, contains the reason for being there as defined in `list-purgatory`.
reason
Service
additionalInformation
Property
private
Stores service specific additional information, this is customizable by publisher
additionalInformation
compute
Property
private
If service is of type compute, holds information about the compute-related privacy settings & resources.
compute
serviceEndpoint
Property
private
Provider URL (schema + host).
serviceEndpoint
timeout
Property
private
Describing how long the service can be used after consumption is initiated.
timeout
ServiceComputeOptions
allowNetworkAccess
Property
private
If true, the algorithm job will have network access.
allowNetworkAccess
allowRawAlgorithm
Property
private
If true, any passed raw text will be allowed to run.
Useful for an algorithm drag & drop use case, but increases risk of data escape through malicious user input.
Should be false by default in all implementations.
allowRawAlgorithm
publisherTrustedAlgorithmPublishers
Property
private
If empty, then any published algorithm is allowed.
Otherwise, only published algorithms by some publishers are allowed
publisherTrustedAlgorithmPublishers
publisherTrustedAlgorithms
Property
private
If empty, then any published algorithm is allowed. (see below)
publisherTrustedAlgorithms