harb/kraiken-lib/README.md

31 lines
393 B
Markdown
Raw Permalink Normal View History

2024-04-03 21:43:12 +02:00
## Test
```
yarn test
```
## Import
```
2025-09-23 16:57:49 +02:00
yarn add kraiken-lib
2024-04-03 21:43:12 +02:00
```
then
```
refactor: migrate kraiken-lib to explicit subpath imports (BREAKING CHANGE) (#89) Removes the barrel export pattern in favor of explicit subpath imports for better tree-shaking and clearer dependencies. ## Breaking Changes - Removed `src/helpers.ts` barrel export - Removed `./helpers` from package.json exports - Root `kraiken-lib` import now raises build errors - Consumers MUST use explicit subpaths: - `kraiken-lib/abis` - Contract ABIs - `kraiken-lib/staking` - Staking helpers - `kraiken-lib/snatch` - Snatch selection - `kraiken-lib/ids` - Position ID utilities - `kraiken-lib/subgraph` - Byte conversion utilities - `kraiken-lib/taxRates` - Tax rate constants - `kraiken-lib/version` - Version validation ## Changes - kraiken-lib: - Bumped version to 1.0.0 (breaking change) - Updated src/index.ts to raise build errors - Added backward-compatible ABI aliases (KraikenAbi, StakeAbi) - Updated all test files to use .js extensions and new imports - Updated documentation (README, AGENTS.md) - Consumer updates: - services/ponder: Updated ponder.config.ts to use kraiken-lib/abis - web-app: Updated all imports to use subpaths - composables/usePositions.ts: kraiken-lib/subgraph - contracts/harb.ts: kraiken-lib/abis - contracts/stake.ts: kraiken-lib/abis ## Migration Guide ```typescript // OLD import { getSnatchList } from 'kraiken-lib/helpers'; import { KraikenAbi } from 'kraiken-lib'; // NEW import { getSnatchList } from 'kraiken-lib/snatch'; import { KraikenAbi } from 'kraiken-lib/abis'; ``` Fixes #86 Co-authored-by: openhands <openhands@all-hands.dev> Reviewed-on: https://codeberg.org/johba/harb/pulls/89
2025-11-20 18:54:53 +01:00
import { bytesToUint256LittleEndian, uint256ToBytesLittleEndian } from "kraiken-lib/subgraph";
2024-04-03 21:43:12 +02:00
uint256ToBytesLittleEndian(3n);
2024-04-04 22:34:16 +02:00
```
## get Snatch List
```
refactor: migrate kraiken-lib to explicit subpath imports (BREAKING CHANGE) (#89) Removes the barrel export pattern in favor of explicit subpath imports for better tree-shaking and clearer dependencies. ## Breaking Changes - Removed `src/helpers.ts` barrel export - Removed `./helpers` from package.json exports - Root `kraiken-lib` import now raises build errors - Consumers MUST use explicit subpaths: - `kraiken-lib/abis` - Contract ABIs - `kraiken-lib/staking` - Staking helpers - `kraiken-lib/snatch` - Snatch selection - `kraiken-lib/ids` - Position ID utilities - `kraiken-lib/subgraph` - Byte conversion utilities - `kraiken-lib/taxRates` - Tax rate constants - `kraiken-lib/version` - Version validation ## Changes - kraiken-lib: - Bumped version to 1.0.0 (breaking change) - Updated src/index.ts to raise build errors - Added backward-compatible ABI aliases (KraikenAbi, StakeAbi) - Updated all test files to use .js extensions and new imports - Updated documentation (README, AGENTS.md) - Consumer updates: - services/ponder: Updated ponder.config.ts to use kraiken-lib/abis - web-app: Updated all imports to use subpaths - composables/usePositions.ts: kraiken-lib/subgraph - contracts/harb.ts: kraiken-lib/abis - contracts/stake.ts: kraiken-lib/abis ## Migration Guide ```typescript // OLD import { getSnatchList } from 'kraiken-lib/helpers'; import { KraikenAbi } from 'kraiken-lib'; // NEW import { getSnatchList } from 'kraiken-lib/snatch'; import { KraikenAbi } from 'kraiken-lib/abis'; ``` Fixes #86 Co-authored-by: openhands <openhands@all-hands.dev> Reviewed-on: https://codeberg.org/johba/harb/pulls/89
2025-11-20 18:54:53 +01:00
import { getSnatchList } from "kraiken-lib/snatch";
2024-04-04 22:34:16 +02:00
2025-09-23 16:57:49 +02:00
const positionIds = getSnatchList(positions, neededShares, maxTaxRateDecimal, stakeTotalSupply);
2024-04-04 22:34:16 +02:00
```