on 4c8c607 help sign in
bridge/src/lib/starRelease.js
154 lines 4.6 kB history raw
1import { linearSR, conditionalSR } from 'azimuth-js';
3function mapRange(amount, cb) {
4 return [...Array(amount).keys()].map(cb);
5}
7// Preferentially withdraw from conditional contracts and use linear
8// to mop up the rest
9export function generateWithdrawTxs(contracts, batchLimits, amount, to) {
10 const [left, ...csrTxs] = generateConditionalWithdrawTxs(
11 contracts,
12 batchLimits,
13 amount,
14 to
15 );
16 const lsrTxs = generateLinearWithdrawTxs(contracts, left, to);
17 return [...csrTxs, ...lsrTxs];
20/**
21 * Recurse over batchLimits to generate a valid number of withdraw txs.
22 * amount may exceed the number of withdraw txs available in the consolidated SR contract.
23 *
24 * @param {object} contracts - The azimuth contracts object
25 * @param {array} batchLimits - An array of the maximum withdraw limit for each batch
26 * @param {amount} amount - The number of txs to be generated
27 * @param {string} to - The addresss to withdraw to
28 * @return {array} An array with the number of transactions missing as the head
29 * (i.e. requested amount exceeded available), and the generated transactions
30 * as the rest of the list
31 */
32function generateConditionalWithdrawTxs(
33 contracts,
34 batchLimits,
35 amount,
36 to,
37 offset = 0
38) {
39 // Successfully withdrawn all requested, none missing
40 if (amount <= 0) {
41 return [0];
42 }
43 // Return missing amount in head of list
44 if (batchLimits.length === 0) {
45 return [amount];
46 }
47 const [next, ...rest] = batchLimits;
48 const currentAmount = Math.min(amount, next);
49 return [
50 ...generateConditionalWithdrawTxs(
51 contracts,
52 rest,
53 amount - currentAmount,
54 to,
55 offset + 1
56 ),
57 ...mapRange(currentAmount, () =>
58 conditionalSR.withdrawTo(contracts, offset, to)
59 ),
60 ];
63function generateLinearWithdrawTxs(contracts, amount, to) {
64 return mapRange(amount, () => linearSR.withdrawTo(contracts, to));
67export async function getLockupKind(contracts, address) {
68 const conditional = await conditionalSR.getCommitment(contracts, address);
69 const linear = await linearSR.getBatch(contracts, address);
70 const haveConditional = conditional.total > 0;
71 const haveLinear = linear.amount > 0;
72 if (haveConditional && !haveLinear) return 'conditional';
73 if (!haveConditional && haveLinear) return 'linear';
74 if (haveConditional && haveLinear) return 'both';
75 return 'none';
78export async function getConditional(contracts, address) {
79 const [commitment, batches, remaining] = await Promise.all([
80 conditionalSR.getCommitment(contracts, address),
81 conditionalSR.getBatches(contracts, address),
82 conditionalSR.getRemainingStars(contracts, address),
83 ]);
85 if (commitment === null || batches === null) {
86 return { total: 0, available: 0, withdrawn: 0, batchLimits: [] };
87 }
89 const total = remaining.length;
90 let balance = total;
92 // does not account for forfeiting or withdrawl
93 const limits = await Promise.all(
94 batches.map((_, idx) =>
95 conditionalSR.getWithdrawLimit(contracts, address, idx)
96 )
97 );
99 const withdrawn = await conditionalSR.getWithdrawn(contracts, address);
101 const forfeited = await conditionalSR.getForfeited(contracts, address);
103 const batchLimits = [];
105 for (let i = 0; i < limits.length; i++) {
106 // skip batch if forfeited or no stars left
107 if (forfeited[i] || balance === 0) {
108 batchLimits.push(0);
109 continue;
110 }
111 const availableInBatch = limits[i] - withdrawn[i];
112 if (balance < availableInBatch) {
113 batchLimits.push(balance);
114 balance = 0;
115 continue;
116 }
117 batchLimits.push(availableInBatch);
118 balance = balance - availableInBatch;
119 }
121 const withdrawnTotal = withdrawn.reduce((acc, val) => acc + val, 0);
122 const available = batchLimits.reduce((acc, val) => acc + val, 0);
124 return {
125 total,
126 available,
127 withdrawn: withdrawnTotal,
128 batchLimits,
129 approvedTransferTo: commitment.approvedTransferTo,
130 };
133export async function getLinear(contracts, address) {
134 const batch = await linearSR.getBatch(contracts, address);
135 if (batch.amount === 0) {
136 return { available: 0, withdrawn: 0, total: 0 };
137 }
139 const remaining = (await linearSR.getRemainingStars(contracts, address))
140 .length;
141 const { amount, withdrawn } = batch;
143 const limit = await linearSR.getWithdrawLimit(contracts, address);
144 const available = Math.min(limit - withdrawn, remaining);
146 const total = Math.min(amount, remaining);
148 return {
149 available,
150 withdrawn,
151 total,
152 approvedTransferTo: batch.approvedTransferTo,
153 };