Supportive methods

Fetching list of vaults

Returns a promise that resolves to an array of vault objects (that include address, name, timestamp and blocknumber of creation).

const vaults = await sdk.vaults.getVaults();

Fetching client data

Returns a range of pool IDs (mix to max) associated with given client as well as client name.

const integratorAddress = '0x555';
const vault = '0x1234';
const { minPool, maxPool, clientName } = await sdk.vaults.clientData(integratorAddress, vault);

Activate pool

After Yelay team assigns pool range to the given client and their integratorAddress, each poolId must be activated before deposits can be allowed. This can be done either by Yelay team, or by the client themselves using above method. Such method must be called by the whitelisted address - please send 'operator' address to Yelay team for whitelisting.

const poolToActivate = minPool + 5; // should be in range: minPool < poolToActivate < maxPool
const isPoolActive = await sdk.vaults.poolActive(vault, poolToActivate);
if (!isPoolActive) {
	await sdk.vaults.activatePool(vault, poolToActivate);
}

Migrate user deposits between pools

Allows withdrawing user's liquidity from the pool A and depositing it to the pool B (operated by the same client) in one transaction.

const fromPool = 123;
const toPool = 456;
const migrateTx = await sdk.vaults.migrate(vault, fromPool, toPool, amount);
await migrateTx.wait();