aivia v1.11.6

AIVIA JavaScript SDK

JavaScript Wrapper for interaction with AIVIA Protocol.

:white_check_mark: Crypto Hedge Fund Template is supported

Please note that THIS version is running on Ropsten TestNet.

Please DO NOT add your MainNet wallet. You may lose your funds.

How to connect to the Ropsten TestNet with Infura

Register with Infura

You need to register for an Infura Access Token.

Fill out the form and you will receive your access token. Use your access token in url of the HTTP_PROVIDER, like:

  const HTTP_PROVIDER = "https://ropsten.infura.io/v3/0db7ff8aff88e_demo_key"

Installation

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js. Node.js 10.0 or higher is required.

  npm install aivia -S

Example

const AIVIA_SDK = require("aivia"); // es6
const AIVIA_SDK = require("aivia/sdk"); // es5

const ENTRY_POINT = "0x0000000000000000000000000000000000000000" // protocol entry point contract address
const HTTP_PROVIDER = "https://ropsten.infura.io/v3/YOUR-ACCESS-TOKEN";
const DEFAULT_GAS_PRICE = 10000000000 // in wei, default value 50000000000 (50 gWei)
const SDK = new AIVIA_SDK(ENTRY_POINT, HTTP_PROVIDER, DEFAULT_GAS_PRICE );

Modules

Asset

• Asset
  • .getAuditDBAddress(addressOrSymbol) ⇒ AuditDBAddress
  • .getRPCAddress(addressOrSymbol) ⇒ RPCAddress
  • .getRate(addressOrSymbol) ⇒ rate
  • .updateRate(assetAddress, AUM, checksum, options, callback, estimate) ⇒ event
  • .NET(addressOrSymbol) ⇒ NET
  • .getInvestors(addressOrSymbol) ⇒ investors
  • .getConfig(assetAddress) ⇒ object

SDK.asset.getAuditDBAddress(addressOrSymbol) ⇒ AuditDBAddress

returns AuditDB address

Kind: static method of Asset
Returns: AuditDBAddress - AuditDB address

SDK.asset.getRPCAddress(addressOrSymbol) ⇒ RPCAddress

returns asset RPC address

Kind: static method of Asset
Returns: RPCAddress - RPC address

SDK.asset.getRate(addressOrSymbol) ⇒ rate

returns asset rate by address or symbol

Kind: static method of Asset
Returns: rate - current(last) rate

SDK.asset.updateRate(assetAddress, AUM, checksum, options, callback, estimate) ⇒ event

function to update the price of the asset rate

Kind: static method of Asset
Returns: event - transaction event {rate, auditor}

SDK.asset.NET(addressOrSymbol) ⇒ NET

returns asset NET by address or symbol

Kind: static method of Asset

SDK.asset.getInvestors(addressOrSymbol) ⇒ investors

returns asset investors count by address

Kind: static method of Asset

SDK.asset.getConfig(assetAddress) ⇒ object

returns config by config address

Kind: static method of Asset
Returns: object - config

AssetsRegistry

• AssetsRegistry
  • .getList() ⇒ Array.<assetsList>
  • .getAssetAddress(symbol) ⇒ address
  • .getAssetSymbol(assetAddress) ⇒ symbol

SDK.asset.getList() ⇒ Array.<assetsList>

returns assets list array

Kind: static method of AssetsRegistry
Properties

SDK.asset.getAssetAddress(symbol) ⇒ address

returns asset address by symbol

Kind: static method of AssetsRegistry
Returns: address - asset address

SDK.asset.getAssetSymbol(assetAddress) ⇒ symbol

returns asset symbol by address

Kind: static method of AssetsRegistry
Returns: symbol - asset symbol

Project

• Project
  • .getConfigAddress(assetAddress) ⇒ address
  • .getConfig(configAddress) ⇒ object
  • .update(configAddress, key, value, options, callback, estimate) ⇒ transaction
  • .updatePermissionRule(configAddress, rule, options, callback, estimate) ⇒ transaction
  • .updatePermission(configAddress, countryID, walletTypes, options, callback, estimate) ⇒ transaction
  • .getPermissionsRule(configAddress) ⇒ boolean
  • .getPermissionsList(configAddress, countryID)

SDK.project.getConfigAddress(assetAddress) ⇒ address

returns config address

Kind: static method of Project
Returns: address - config address

SDK.project.getConfig(configAddress) ⇒ object

returns config by config address

Kind: static method of Project
Returns: object - config

SDK.project.update(configAddress, key, value, options, callback, estimate) ⇒ transaction

update project config

Kind: static method of Project

SDK.project.updatePermissionRule(configAddress, rule, options, callback, estimate) ⇒ transaction

update project permissions rule

Kind: static method of Project

SDK.project.updatePermission(configAddress, countryID, walletTypes, options, callback, estimate) ⇒ transaction

update project permissions wallet types

Kind: static method of Project

SDK.project.getPermissionsRule(configAddress) ⇒ boolean

returns permissions rule(tru or false)

Kind: static method of Project
Returns: boolean - rule

SDK.project.getPermissionsList(configAddress, countryID)

returns permissions rule(tru or false)

Kind: static method of Project
Returns{array.<number>}: wallets types array

Deploy

SDK.project.deploy(type, params, options, callback, estimate) ⇒ components

deploy project

Kind: static method of Deploy
Returns: components - deployed project components

ERC20

• ERC20
  • .getBalance(wallet, [assetAddress]) ⇒ balance
  • .totalSupply(assetAddress) ⇒ totalSupply
  • .allowance(assetAddress, owner, spender) ⇒ allowance
  • .approve(assetAddress, spender, value, options, callback, estimate) ⇒ event
  • .transfer(to, value, assetAddress, options, callback, estimate) ⇒ event
  • .transferETH(to, value, options, callback, estimate) ⇒ event
  • .mint(value, to, assetAddress, options, callback, estimate) ⇒ event

SDK.asset.getBalance(wallet, assetAddress) ⇒ balance

returns asset balance by assetAddress or ETH balance

Kind: static method of ERC20

SDK.asset.totalSupply(assetAddress) ⇒ totalSupply

returns asset totalSupply

Kind: static method of ERC20

SDK.asset.allowance(assetAddress, owner, spender) ⇒ allowance

returns amount approved by owner to spender

Kind: static method of ERC20

SDK.asset.approve(assetAddress, spender, value, options, callback, estimate) ⇒ event

allows spender to manage a certain amount of assets

Kind: static method of ERC20
Returns: event - transaction event {from, to, value}

SDK.asset.transfer(to, value, assetAddress, options, callback, estimate) ⇒ event

transfer ERC20 asset value to other address

Kind: static method of ERC20
Returns: event - transaction event {from, to, value}

SDK.asset.transferETH(to, value, options, callback, estimate) ⇒ event

transfer ETH value to other address

Kind: static method of ERC20
Returns: event - transaction event {from, to, value}

SDK.asset.mint(value, to, assetAddress, options, callback, estimate) ⇒ event

mint asset value to other wallet from contract owner

Kind: static method of ERC20
Returns: event - transaction event {from, to, value}

Platform

• Platform
  • .getPlatformWallet() ⇒ address
  • .getPlatformToken() ⇒ address

SDK.platform.getPlatformWallet() ⇒ address

returns platform wallet address

Kind: static method of Platform

SDK.platform.getPlatformToken() ⇒ address

returns platform token address

Kind: static method of Platform

Buy/Sell

• Buy/Sell
  • .checkBeforeBuy(value, assetAddress, currencyAddress, from) ⇒ true | error
  • .buyAsset(value, assetAddress, currencyAddress, options, callback, estimate) ⇒ event
  • .checkBeforeSell(value, assetAddress, options) ⇒ true | error
  • .sellAsset(value, assetAddress, options, callback, estimate) ⇒ event
  • .estimate(value, assetAddress, [currencyAddress]) ⇒ estimate

SDK.trade.checkBeforeBuy(value, assetAddress, currencyAddress, from) ⇒ true | error

the method by which you can first check the parameters before buy

Kind: static method of Buy/Sell
Returns: true | error - ;

SDK.trade.buyAsset(value, assetAddress, currencyAddress, options, callback, estimate) ⇒ event

purchase of tokens

Kind: static method of Buy/Sell
Returns: event - transaction event {spend, received, fees: { manager, platform } }

SDK.trade.checkBeforeSell(value, assetAddress, options) ⇒ true | error

the method by which you can first check the parameters before sell

Kind: static method of Buy/Sell
Returns: true | error - ;

SDK.trade.sellAsset(value, assetAddress, options, callback, estimate) ⇒ event

sale of tokens

Kind: static method of Buy/Sell
Returns: event - transaction event {spend, received, fees: { manager, platform } }

SDK.trade.estimate(value, assetAddress, currencyAddress) ⇒ estimate

Kind: static method of Buy/Sell
Returns: estimate - ;

Currency

• Currency
  • .getList() ⇒ Array.<currenciesList>
  • .getRate(addressOrSymbol) ⇒ rate
  • .getAddress(symbol) ⇒ address
  • .getSymbol(currencyAddress) ⇒ symbol

SDK.platform.currency.getList() ⇒ Array.<currenciesList>

returns platform currencies list

Kind: static method of Currency
Properties

SDK.platform.currency.getRate(addressOrSymbol) ⇒ rate

returns currency rate by address or symbol

Kind: static method of Currency
Returns: rate - - rate of currency

SDK.platform.currency.getAddress(symbol) ⇒ address

returns currency address by symbol

Kind: static method of Currency
Returns: address - currency address

SDK.platform.currency.getSymbol(currencyAddress) ⇒ symbol

returns currency symbol by address

Kind: static method of Currency
Returns: symbol - currency symbol

TPLRegistry

• TPLRegistry
  • .addUser(userAddress, countryID, walletType, [expirationDate], options, callback, estimate) ⇒ event
  • .getUserDetails(userAddress) ⇒ object
  • .getUsersList() ⇒ Array.<userList>

SDK.auditor.addUser(userAddress, countryID, walletType, expirationDate, options, callback, estimate) ⇒ event

add or update user

Kind: static method of TPLRegistry
Returns: event - transaction event {eventName, address}

SDK.auditor.getUserDetails(userAddress) ⇒ object

returns user details by address

Kind: static method of TPLRegistry
Returns: object - userDetails

Properties

SDK.auditor.getUsersList() ⇒ Array.<userList>

returns user list list

Kind: static method of TPLRegistry
Properties

utils

• utils
  • .toHex(string) ⇒ hex
  • .toWei(value) ⇒ value
  • .fromWei(value) ⇒ value
  • .isAddress(address) ⇒ boolean
  • .toUtf8(hex) ⇒ string
  • .toFixed(value, [digits]) ⇒ value
  • .numberToHex(value, [inWei]) ⇒ string
  • .BN(value) ⇒ BN

SDK.utils.toHex(string) ⇒ hex

convert string to hex

Kind: static method of utils
Returns: hex - the resulting HEX string;

SDK.utils.toWei(value) ⇒ value

converts any value value into wei

Kind: static method of utils

SDK.utils.fromWei(value) ⇒ value

converts any value from wei

Kind: static method of utils
Returns: value - ;

SDK.utils.isAddress(address) ⇒ boolean

check if a given string is a valid Ethereum address

Kind: static method of utils
Returns: boolean - status;

SDK.utils.toUtf8(hex) ⇒ string

converts any value from hex to string

Kind: static method of utils
Returns: string - ;

SDK.utils.toFixed(value, digits) ⇒ value

formats a number using fixed-point notation

Kind: static method of utils

SDK.utils.numberToHex(value, inWei) ⇒ string

covert number to hex

Kind: static method of utils
Returns: string - number;

SDK.utils.BN(value) ⇒ BN

covert number to BN

Kind: static method of utils
Returns: BN - BN;