-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathallocation.ts
More file actions
238 lines (204 loc) · 7.79 KB
/
Copy pathallocation.ts
File metadata and controls
238 lines (204 loc) · 7.79 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
import {
BtdTokenId,
assertNonEmptyString,
assertNonNegativeSafeInteger,
assertPositiveSafeInteger,
toBigIntAmount,
} from './constants';
export interface BtdContributorMeasure {
contributorId: string;
walletId: string;
normalizedContributionVolume: bigint | number | string;
fitBps: number;
qualityBps: number;
provenanceBps: number;
noveltyBps: number;
antiNoiseBps: number;
}
export interface BtdContributorAllocation {
contributorId: string;
walletId: string;
tokenCount: number;
rangeStart?: BtdTokenId;
rangeEndExclusive?: BtdTokenId;
weight: string;
}
export interface BtdContributorAllocationReceipt {
kind: 'btd.contributor_allocation';
assetPackId: string;
rangeStart: BtdTokenId;
rangeEndExclusive: BtdTokenId;
tokenCount: number;
allocationMethod: 'hare_niemeyer_weighted_fit';
allocations: BtdContributorAllocation[];
issuedAt: string;
}
export function allocateBtdContributorCells(input: {
assetPackId: string;
rangeStart: BtdTokenId;
rangeEndExclusive: BtdTokenId;
contributors: BtdContributorMeasure[];
issuedAt?: string;
}): BtdContributorAllocationReceipt {
const assetPackId = assertNonEmptyString(input.assetPackId, 'assetPackId');
const rangeStart = assertNonNegativeSafeInteger(input.rangeStart, 'rangeStart');
const rangeEndExclusive = assertPositiveSafeInteger(
input.rangeEndExclusive,
'rangeEndExclusive',
);
if (rangeEndExclusive <= rangeStart) {
throw new Error('Allocation range must be non-empty.');
}
const tokenCount = rangeEndExclusive - rangeStart;
const seenContributorIds = new Set<string>();
const weighted = input.contributors.map((contributor) => {
const contributorId = assertNonEmptyString(contributor.contributorId, 'contributorId');
if (seenContributorIds.has(contributorId)) {
throw new Error(`Duplicate contributor allocation id: ${contributorId}.`);
}
seenContributorIds.add(contributorId);
const normalizedContributionVolume = toBigIntAmount(
contributor.normalizedContributionVolume,
'normalizedContributionVolume',
);
if (normalizedContributionVolume <= 0n) {
throw new Error('Contributor normalizedContributionVolume must be positive.');
}
return {
contributorId,
walletId: assertNonEmptyString(contributor.walletId, 'walletId'),
weight:
normalizedContributionVolume *
BigInt(assertBasisPoints(contributor.fitBps, 'fitBps')) *
BigInt(assertBasisPoints(contributor.qualityBps, 'qualityBps')) *
BigInt(assertBasisPoints(contributor.provenanceBps, 'provenanceBps')) *
BigInt(assertBasisPoints(contributor.noveltyBps, 'noveltyBps')) *
BigInt(assertBasisPoints(contributor.antiNoiseBps, 'antiNoiseBps')),
};
});
if (weighted.length === 0) {
throw new Error('Contributor allocation requires at least one contributor.');
}
const totalWeight = weighted.reduce((sum, contributor) => sum + contributor.weight, 0n);
if (totalWeight <= 0n) {
throw new Error('Contributor allocation total weight must be positive.');
}
const preliminary = weighted.map((contributor) => {
const numerator = BigInt(tokenCount) * contributor.weight;
return {
...contributor,
base: Number(numerator / totalWeight),
remainder: numerator % totalWeight,
};
});
const baseTotal = preliminary.reduce((sum, contributor) => sum + contributor.base, 0);
let remaining = tokenCount - baseTotal;
const sortedForRemainder = [...preliminary].sort((left, right) => {
if (left.remainder === right.remainder) {
return left.contributorId.localeCompare(right.contributorId);
}
return left.remainder > right.remainder ? -1 : 1;
});
const extraByContributor = new Map<string, number>();
for (const contributor of sortedForRemainder) {
if (remaining <= 0) break;
extraByContributor.set(contributor.contributorId, 1);
remaining -= 1;
}
let cursor = rangeStart;
const allocations = [...preliminary]
.sort((left, right) => left.contributorId.localeCompare(right.contributorId))
.map((contributor): BtdContributorAllocation => {
const count = contributor.base + (extraByContributor.get(contributor.contributorId) ?? 0);
const allocation: BtdContributorAllocation = {
contributorId: contributor.contributorId,
walletId: contributor.walletId,
tokenCount: count,
rangeStart: count > 0 ? cursor : undefined,
rangeEndExclusive: count > 0 ? cursor + count : undefined,
weight: contributor.weight.toString(),
};
cursor += count;
return allocation;
});
const allocated = allocations.reduce((sum, allocation) => sum + allocation.tokenCount, 0);
if (allocated !== tokenCount || cursor !== rangeEndExclusive) {
throw new Error('Contributor allocation failed to conserve the AssetPack range.');
}
return {
kind: 'btd.contributor_allocation',
assetPackId,
rangeStart,
rangeEndExclusive,
tokenCount,
allocationMethod: 'hare_niemeyer_weighted_fit',
allocations,
issuedAt: input.issuedAt ?? new Date().toISOString(),
};
}
export function assertBtdContributorAllocationReceipt(
receipt: BtdContributorAllocationReceipt,
): BtdContributorAllocationReceipt {
if (receipt.kind !== 'btd.contributor_allocation') {
throw new Error('Invalid BTD contributor allocation receipt kind.');
}
assertNonEmptyString(receipt.assetPackId, 'assetPackId');
const rangeStart = assertNonNegativeSafeInteger(receipt.rangeStart, 'rangeStart');
const rangeEndExclusive = assertPositiveSafeInteger(
receipt.rangeEndExclusive,
'rangeEndExclusive',
);
if (rangeEndExclusive <= rangeStart) {
throw new Error('Contributor allocation range must be non-empty.');
}
if (receipt.tokenCount !== rangeEndExclusive - rangeStart) {
throw new Error('Contributor allocation tokenCount does not match range boundaries.');
}
if (receipt.allocationMethod !== 'hare_niemeyer_weighted_fit') {
throw new Error('Unsupported contributor allocation method.');
}
assertNonEmptyString(receipt.issuedAt, 'issuedAt');
if (!receipt.allocations.length) {
throw new Error('Contributor allocation receipt requires at least one allocation.');
}
let allocated = 0;
let cursor = rangeStart;
const seenContributorIds = new Set<string>();
for (const allocation of receipt.allocations) {
const contributorId = assertNonEmptyString(allocation.contributorId, 'contributorId');
if (seenContributorIds.has(contributorId)) {
throw new Error(`Duplicate contributor allocation id: ${contributorId}.`);
}
seenContributorIds.add(contributorId);
assertNonEmptyString(allocation.walletId, 'walletId');
assertNonNegativeSafeInteger(allocation.tokenCount, 'allocation.tokenCount');
assertNonEmptyString(allocation.weight, 'allocation.weight');
if (allocation.tokenCount === 0) {
if (
allocation.rangeStart !== undefined ||
allocation.rangeEndExclusive !== undefined
) {
throw new Error('Zero-cell allocation cannot carry range boundaries.');
}
continue;
}
if (allocation.rangeStart !== cursor) {
throw new Error('Contributor allocation rangeStart drift.');
}
if (allocation.rangeEndExclusive !== cursor + allocation.tokenCount) {
throw new Error('Contributor allocation rangeEndExclusive drift.');
}
allocated += allocation.tokenCount;
cursor += allocation.tokenCount;
}
if (allocated !== receipt.tokenCount || cursor !== rangeEndExclusive) {
throw new Error('Contributor allocation does not conserve the AssetPack range.');
}
return receipt;
}
function assertBasisPoints(value: number, label: string): number {
if (!Number.isSafeInteger(value) || value < 0 || value > 10_000) {
throw new Error(`${label} must be an integer from 0 to 10000.`);
}
return value;
}