@helium/idls 0.2.5 → 0.2.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/lib/cjs/helium_entity_manager.js +487 -239
  2. package/lib/cjs/helium_entity_manager.js.map +1 -1
  3. package/lib/cjs/helium_sub_daos.js +84 -26
  4. package/lib/cjs/helium_sub_daos.js.map +1 -1
  5. package/lib/cjs/lazy_distributor.js +1 -1
  6. package/lib/cjs/mobile_entity_manager.js +30 -3
  7. package/lib/cjs/mobile_entity_manager.js.map +1 -1
  8. package/lib/cjs/rewards_oracle.js +76 -0
  9. package/lib/cjs/rewards_oracle.js.map +1 -1
  10. package/lib/cjs/voter_stake_registry.js +301 -160
  11. package/lib/cjs/voter_stake_registry.js.map +1 -1
  12. package/lib/esm/helium_entity_manager.js +487 -239
  13. package/lib/esm/helium_entity_manager.js.map +1 -1
  14. package/lib/esm/helium_sub_daos.js +84 -26
  15. package/lib/esm/helium_sub_daos.js.map +1 -1
  16. package/lib/esm/lazy_distributor.js +1 -1
  17. package/lib/esm/mobile_entity_manager.js +30 -3
  18. package/lib/esm/mobile_entity_manager.js.map +1 -1
  19. package/lib/esm/rewards_oracle.js +76 -0
  20. package/lib/esm/rewards_oracle.js.map +1 -1
  21. package/lib/esm/voter_stake_registry.js +301 -160
  22. package/lib/esm/voter_stake_registry.js.map +1 -1
  23. package/lib/types/helium_entity_manager.d.ts +486 -238
  24. package/lib/types/helium_entity_manager.d.ts.map +1 -1
  25. package/lib/types/helium_sub_daos.d.ts +84 -26
  26. package/lib/types/helium_sub_daos.d.ts.map +1 -1
  27. package/lib/types/lazy_distributor.d.ts +1 -1
  28. package/lib/types/mobile_entity_manager.d.ts +30 -3
  29. package/lib/types/mobile_entity_manager.d.ts.map +1 -1
  30. package/lib/types/rewards_oracle.d.ts +76 -0
  31. package/lib/types/rewards_oracle.d.ts.map +1 -1
  32. package/lib/types/voter_stake_registry.d.ts +301 -160
  33. package/lib/types/voter_stake_registry.d.ts.map +1 -1
  34. package/package.json +2 -2
package/lib/cjs/voter_stake_registry.js CHANGED
@@ -1238,61 +1238,299 @@ exports.IDL = {
1238
1238
  }
1239
1239
  ],
1240
1240
  "args": []
1241
+ },
1242
+ {
1243
+ "name": "voteV0",
1244
+ "accounts": [
1245
+ {
1246
+ "name": "payer",
1247
+ "isMut": true,
1248
+ "isSigner": true
1249
+ },
1250
+ {
1251
+ "name": "marker",
1252
+ "isMut": true,
1253
+ "isSigner": false,
1254
+ "pda": {
1255
+ "seeds": [
1256
+ {
1257
+ "kind": "const",
1258
+ "type": "string",
1259
+ "value": "marker"
1260
+ },
1261
+ {
1262
+ "kind": "account",
1263
+ "type": "publicKey",
1264
+ "account": "Mint",
1265
+ "path": "mint"
1266
+ },
1267
+ {
1268
+ "kind": "account",
1269
+ "type": "publicKey",
1270
+ "account": "ProposalV0",
1271
+ "path": "proposal"
1272
+ }
1273
+ ]
1274
+ }
1275
+ },
1276
+ {
1277
+ "name": "registrar",
1278
+ "isMut": false,
1279
+ "isSigner": false
1280
+ },
1281
+ {
1282
+ "name": "voter",
1283
+ "isMut": false,
1284
+ "isSigner": true
1285
+ },
1286
+ {
1287
+ "name": "position",
1288
+ "isMut": true,
1289
+ "isSigner": false,
1290
+ "relations": [
1291
+ "mint",
1292
+ "registrar"
1293
+ ]
1294
+ },
1295
+ {
1296
+ "name": "mint",
1297
+ "isMut": false,
1298
+ "isSigner": false
1299
+ },
1300
+ {
1301
+ "name": "tokenAccount",
1302
+ "isMut": false,
1303
+ "isSigner": false
1304
+ },
1305
+ {
1306
+ "name": "proposal",
1307
+ "isMut": true,
1308
+ "isSigner": false,
1309
+ "relations": [
1310
+ "proposal_config"
1311
+ ]
1312
+ },
1313
+ {
1314
+ "name": "proposalConfig",
1315
+ "isMut": false,
1316
+ "isSigner": false,
1317
+ "relations": [
1318
+ "on_vote_hook",
1319
+ "state_controller"
1320
+ ]
1321
+ },
1322
+ {
1323
+ "name": "stateController",
1324
+ "isMut": true,
1325
+ "isSigner": false
1326
+ },
1327
+ {
1328
+ "name": "onVoteHook",
1329
+ "isMut": false,
1330
+ "isSigner": false
1331
+ },
1332
+ {
1333
+ "name": "proposalProgram",
1334
+ "isMut": false,
1335
+ "isSigner": false
1336
+ },
1337
+ {
1338
+ "name": "systemProgram",
1339
+ "isMut": false,
1340
+ "isSigner": false
1341
+ }
1342
+ ],
1343
+ "args": [
1344
+ {
1345
+ "name": "args",
1346
+ "type": {
1347
+ "defined": "VoteArgsV0"
1348
+ }
1349
+ }
1350
+ ]
1351
+ },
1352
+ {
1353
+ "name": "relinquishVoteV1",
1354
+ "accounts": [
1355
+ {
1356
+ "name": "refund",
1357
+ "isMut": true,
1358
+ "isSigner": false,
1359
+ "docs": [
1360
+ "Account to receive sol refund if marker is closed"
1361
+ ]
1362
+ },
1363
+ {
1364
+ "name": "marker",
1365
+ "isMut": true,
1366
+ "isSigner": false,
1367
+ "pda": {
1368
+ "seeds": [
1369
+ {
1370
+ "kind": "const",
1371
+ "type": "string",
1372
+ "value": "marker"
1373
+ },
1374
+ {
1375
+ "kind": "account",
1376
+ "type": "publicKey",
1377
+ "account": "Mint",
1378
+ "path": "mint"
1379
+ },
1380
+ {
1381
+ "kind": "account",
1382
+ "type": "publicKey",
1383
+ "account": "ProposalV0",
1384
+ "path": "proposal"
1385
+ }
1386
+ ]
1387
+ },
1388
+ "relations": [
1389
+ "registrar",
1390
+ "mint"
1391
+ ]
1392
+ },
1393
+ {
1394
+ "name": "registrar",
1395
+ "isMut": false,
1396
+ "isSigner": false
1397
+ },
1398
+ {
1399
+ "name": "voter",
1400
+ "isMut": false,
1401
+ "isSigner": true
1402
+ },
1403
+ {
1404
+ "name": "position",
1405
+ "isMut": true,
1406
+ "isSigner": false,
1407
+ "relations": [
1408
+ "mint",
1409
+ "registrar"
1410
+ ]
1411
+ },
1412
+ {
1413
+ "name": "mint",
1414
+ "isMut": false,
1415
+ "isSigner": false
1416
+ },
1417
+ {
1418
+ "name": "tokenAccount",
1419
+ "isMut": false,
1420
+ "isSigner": false
1421
+ },
1422
+ {
1423
+ "name": "proposal",
1424
+ "isMut": true,
1425
+ "isSigner": false,
1426
+ "relations": [
1427
+ "proposal_config"
1428
+ ]
1429
+ },
1430
+ {
1431
+ "name": "proposalConfig",
1432
+ "isMut": false,
1433
+ "isSigner": false,
1434
+ "relations": [
1435
+ "on_vote_hook",
1436
+ "state_controller"
1437
+ ]
1438
+ },
1439
+ {
1440
+ "name": "stateController",
1441
+ "isMut": true,
1442
+ "isSigner": false
1443
+ },
1444
+ {
1445
+ "name": "onVoteHook",
1446
+ "isMut": false,
1447
+ "isSigner": false
1448
+ },
1449
+ {
1450
+ "name": "proposalProgram",
1451
+ "isMut": false,
1452
+ "isSigner": false
1453
+ },
1454
+ {
1455
+ "name": "systemProgram",
1456
+ "isMut": false,
1457
+ "isSigner": false
1458
+ }
1459
+ ],
1460
+ "args": [
1461
+ {
1462
+ "name": "args",
1463
+ "type": {
1464
+ "defined": "RelinquishVoteArgsV1"
1465
+ }
1466
+ }
1467
+ ]
1241
1468
  }
1242
1469
  ],
1243
1470
  "accounts": [
1471
+ {
1472
+ "name": "voteMarkerV0",
1473
+ "type": {
1474
+ "kind": "struct",
1475
+ "fields": [
1476
+ {
1477
+ "name": "voter",
1478
+ "type": "publicKey"
1479
+ },
1480
+ {
1481
+ "name": "registrar",
1482
+ "type": "publicKey"
1483
+ },
1484
+ {
1485
+ "name": "proposal",
1486
+ "type": "publicKey"
1487
+ },
1488
+ {
1489
+ "name": "mint",
1490
+ "type": "publicKey"
1491
+ },
1492
+ {
1493
+ "name": "choices",
1494
+ "type": {
1495
+ "vec": "u16"
1496
+ }
1497
+ },
1498
+ {
1499
+ "name": "weight",
1500
+ "type": "u128"
1501
+ },
1502
+ {
1503
+ "name": "bumpSeed",
1504
+ "type": "u8"
1505
+ }
1506
+ ]
1507
+ }
1508
+ },
1244
1509
  {
1245
1510
  "name": "maxVoterWeightRecord",
1246
- "docs": [
1247
- "MaxVoterWeightRecord account as defined in spl-governance-addin-api",
1248
- "It's redefined here without account_discriminator for Anchor to treat it as native account",
1249
- "",
1250
- "The account is used as an api interface to provide max voting power to the governance program from external addin contracts"
1251
- ],
1252
1511
  "type": {
1253
1512
  "kind": "struct",
1254
1513
  "fields": [
1255
1514
  {
1256
1515
  "name": "realm",
1257
- "docs": [
1258
- "The Realm the MaxVoterWeightRecord belongs to"
1259
- ],
1260
1516
  "type": "publicKey"
1261
1517
  },
1262
1518
  {
1263
1519
  "name": "governingTokenMint",
1264
- "docs": [
1265
- "Governing Token Mint the MaxVoterWeightRecord is associated with",
1266
- "Note: The addin can take deposits of any tokens and is not restricted to the community or council tokens only"
1267
- ],
1268
1520
  "type": "publicKey"
1269
1521
  },
1270
1522
  {
1271
1523
  "name": "maxVoterWeight",
1272
- "docs": [
1273
- "Max voter weight",
1274
- "The max voter weight provided by the addin for the given realm and governing_token_mint"
1275
- ],
1276
1524
  "type": "u64"
1277
1525
  },
1278
1526
  {
1279
1527
  "name": "maxVoterWeightExpiry",
1280
- "docs": [
1281
- "The slot when the max voting weight expires",
1282
- "It should be set to None if the weight never expires",
1283
- "If the max vote weight decays with time, for example for time locked based weights, then the expiry must be set",
1284
- "As a pattern Revise instruction to update the max weight should be invoked before governance instruction within the same transaction",
1285
- "and the expiry set to the current slot to provide up to date weight"
1286
- ],
1287
1528
  "type": {
1288
1529
  "option": "u64"
1289
1530
  }
1290
1531
  },
1291
1532
  {
1292
1533
  "name": "reserved",
1293
- "docs": [
1294
- "Reserved space for future versions"
1295
- ],
1296
1534
  "type": {
1297
1535
  "array": [
1298
1536
  "u8",
@@ -1305,34 +1543,19 @@ exports.IDL = {
1305
1543
  },
1306
1544
  {
1307
1545
  "name": "nftVoteRecord",
1308
- "docs": [
1309
- "Vote record indicating the given NFT voted on the Proposal",
1310
- "The PDA of the record is [\"nft-vote-record\",proposal,nft_mint]",
1311
- "It guarantees uniques and ensures the same NFT can't vote twice"
1312
- ],
1313
1546
  "type": {
1314
1547
  "kind": "struct",
1315
1548
  "fields": [
1316
1549
  {
1317
1550
  "name": "proposal",
1318
- "docs": [
1319
- "Proposal which was voted on"
1320
- ],
1321
1551
  "type": "publicKey"
1322
1552
  },
1323
1553
  {
1324
1554
  "name": "nftMint",
1325
- "docs": [
1326
- "The mint of the NFT which was used for the vote"
1327
- ],
1328
1555
  "type": "publicKey"
1329
1556
  },
1330
1557
  {
1331
1558
  "name": "governingTokenOwner",
1332
- "docs": [
1333
- "The voter who casted this vote",
1334
- "It's a Realm member pubkey corresponding to TokenOwnerRecord.governing_token_owner"
1335
- ],
1336
1559
  "type": "publicKey"
1337
1560
  }
1338
1561
  ]
@@ -1359,13 +1582,6 @@ exports.IDL = {
1359
1582
  },
1360
1583
  {
1361
1584
  "name": "amountDepositedNative",
1362
- "docs": [
1363
- "Amount in deposited, in native currency. Withdraws of vested tokens",
1364
- "directly reduce this amount.",
1365
- "",
1366
- "This directly tracks the total amount added by the user. They may",
1367
- "never withdraw more than this amount."
1368
- ],
1369
1585
  "type": "u64"
1370
1586
  },
1371
1587
  {
@@ -1383,15 +1599,16 @@ exports.IDL = {
1383
1599
  {
1384
1600
  "name": "bumpSeed",
1385
1601
  "type": "u8"
1602
+ },
1603
+ {
1604
+ "name": "voteController",
1605
+ "type": "publicKey"
1386
1606
  }
1387
1607
  ]
1388
1608
  }
1389
1609
  },
1390
1610
  {
1391
1611
  "name": "registrar",
1392
- "docs": [
1393
- "Instance of a voting rights distributor."
1394
- ],
1395
1612
  "type": {
1396
1613
  "kind": "struct",
1397
1614
  "fields": [
@@ -1413,25 +1630,16 @@ exports.IDL = {
1413
1630
  },
1414
1631
  {
1415
1632
  "name": "timeOffset",
1416
- "docs": [
1417
- "Debug only: time offset, to allow tests to move forward in time."
1418
- ],
1419
1633
  "type": "i64"
1420
1634
  },
1421
1635
  {
1422
1636
  "name": "positionUpdateAuthority",
1423
- "docs": [
1424
- "Allows a program to wrap updates to the position (transfer or reset lockup)"
1425
- ],
1426
1637
  "type": {
1427
1638
  "option": "publicKey"
1428
1639
  }
1429
1640
  },
1430
1641
  {
1431
1642
  "name": "collection",
1432
- "docs": [
1433
- "Storage for voting mints and their configuration."
1434
- ],
1435
1643
  "type": "publicKey"
1436
1644
  },
1437
1645
  {
@@ -1473,66 +1681,33 @@ exports.IDL = {
1473
1681
  },
1474
1682
  {
1475
1683
  "name": "voterWeightRecord",
1476
- "docs": [
1477
- "VoterWeightRecord account as defined in spl-governance-addin-api",
1478
- "It's redefined here without account_discriminator for Anchor to treat it as native account",
1479
- "",
1480
- "The account is used as an api interface to provide voting power to the governance program from external addin contracts"
1481
- ],
1482
1684
  "type": {
1483
1685
  "kind": "struct",
1484
1686
  "fields": [
1485
1687
  {
1486
1688
  "name": "realm",
1487
- "docs": [
1488
- "The Realm the VoterWeightRecord belongs to"
1489
- ],
1490
1689
  "type": "publicKey"
1491
1690
  },
1492
1691
  {
1493
1692
  "name": "governingTokenMint",
1494
- "docs": [
1495
- "Governing Token Mint the VoterWeightRecord is associated with",
1496
- "Note: The addin can take deposits of any tokens and is not restricted to the community or council tokens only"
1497
- ],
1498
1693
  "type": "publicKey"
1499
1694
  },
1500
1695
  {
1501
1696
  "name": "governingTokenOwner",
1502
- "docs": [
1503
- "The owner of the governing token and voter",
1504
- "This is the actual owner (voter) and corresponds to TokenOwnerRecord.governing_token_owner"
1505
- ],
1506
1697
  "type": "publicKey"
1507
1698
  },
1508
1699
  {
1509
1700
  "name": "voterWeight",
1510
- "docs": [
1511
- "Voter's weight",
1512
- "The weight of the voter provided by the addin for the given realm, governing_token_mint and governing_token_owner (voter)"
1513
- ],
1514
1701
  "type": "u64"
1515
1702
  },
1516
1703
  {
1517
1704
  "name": "voterWeightExpiry",
1518
- "docs": [
1519
- "The slot when the voting weight expires",
1520
- "It should be set to None if the weight never expires",
1521
- "If the voter weight decays with time, for example for time locked based weights, then the expiry must be set",
1522
- "As a common pattern Revise instruction to update the weight should be invoked before governance instruction within the same transaction",
1523
- "and the expiry set to the current slot to provide up to date weight"
1524
- ],
1525
1705
  "type": {
1526
1706
  "option": "u64"
1527
1707
  }
1528
1708
  },
1529
1709
  {
1530
1710
  "name": "weightAction",
1531
- "docs": [
1532
- "The governance action the voter's weight pertains to",
1533
- "It allows to provided voter's weight specific to the particular action the weight is evaluated for",
1534
- "When the action is provided then the governance program asserts the executing action is the same as specified by the addin"
1535
- ],
1536
1711
  "type": {
1537
1712
  "option": {
1538
1713
  "defined": "VoterWeightAction"
@@ -1541,21 +1716,12 @@ exports.IDL = {
1541
1716
  },
1542
1717
  {
1543
1718
  "name": "weightActionTarget",
1544
- "docs": [
1545
- "The target the voter's weight action pertains to",
1546
- "It allows to provided voter's weight specific to the target the weight is evaluated for",
1547
- "For example when addin supplies weight to vote on a particular proposal then it must specify the proposal as the action target",
1548
- "When the target is provided then the governance program asserts the target is the same as specified by the addin"
1549
- ],
1550
1719
  "type": {
1551
1720
  "option": "publicKey"
1552
1721
  }
1553
1722
  },
1554
1723
  {
1555
1724
  "name": "reserved",
1556
- "docs": [
1557
- "Reserved space for future versions"
1558
- ],
1559
1725
  "type": {
1560
1726
  "array": [
1561
1727
  "u8",
@@ -1664,6 +1830,18 @@ exports.IDL = {
1664
1830
  ]
1665
1831
  }
1666
1832
  },
1833
+ {
1834
+ "name": "RelinquishVoteArgsV1",
1835
+ "type": {
1836
+ "kind": "struct",
1837
+ "fields": [
1838
+ {
1839
+ "name": "choice",
1840
+ "type": "u16"
1841
+ }
1842
+ ]
1843
+ }
1844
+ },
1667
1845
  {
1668
1846
  "name": "ResetLockupArgsV0",
1669
1847
  "type": {
@@ -1712,6 +1890,18 @@ exports.IDL = {
1712
1890
  ]
1713
1891
  }
1714
1892
  },
1893
+ {
1894
+ "name": "VoteArgsV0",
1895
+ "type": {
1896
+ "kind": "struct",
1897
+ "fields": [
1898
+ {
1899
+ "name": "choice",
1900
+ "type": "u16"
1901
+ }
1902
+ ]
1903
+ }
1904
+ },
1715
1905
  {
1716
1906
  "name": "WithdrawArgsV0",
1717
1907
  "type": {
@@ -1731,29 +1921,14 @@ exports.IDL = {
1731
1921
  "fields": [
1732
1922
  {
1733
1923
  "name": "startTs",
1734
- "docs": [
1735
- "Start of the lockup.",
1736
- "",
1737
- "Note, that if start_ts is in the future, the funds are nevertheless",
1738
- "locked up!",
1739
- "",
1740
- "Similarly vote power computations don't care about start_ts and always",
1741
- "assume the full interval from now to end_ts."
1742
- ],
1743
1924
  "type": "i64"
1744
1925
  },
1745
1926
  {
1746
1927
  "name": "endTs",
1747
- "docs": [
1748
- "End of the lockup."
1749
- ],
1750
1928
  "type": "i64"
1751
1929
  },
1752
1930
  {
1753
1931
  "name": "kind",
1754
- "docs": [
1755
- "Type of lockup."
1756
- ],
1757
1932
  "type": {
1758
1933
  "defined": "LockupKind"
1759
1934
  }
@@ -1763,73 +1938,35 @@ exports.IDL = {
1763
1938
  },
1764
1939
  {
1765
1940
  "name": "VotingMintConfigV0",
1766
- "docs": [
1767
- "Exchange rate for an asset that can be used to mint voting rights.",
1768
- "",
1769
- "See documentation of configure_voting_mint for details on how",
1770
- "native token amounts convert to vote weight."
1771
- ],
1772
1941
  "type": {
1773
1942
  "kind": "struct",
1774
1943
  "fields": [
1775
1944
  {
1776
1945
  "name": "mint",
1777
- "docs": [
1778
- "Mint for this entry."
1779
- ],
1780
1946
  "type": "publicKey"
1781
1947
  },
1782
1948
  {
1783
1949
  "name": "baselineVoteWeightScaledFactor",
1784
- "docs": [
1785
- "Vote weight factor for all funds in the account, no matter if locked or not.",
1786
- "",
1787
- "In 1/SCALED_FACTOR_BASE units."
1788
- ],
1789
1950
  "type": "u64"
1790
1951
  },
1791
1952
  {
1792
1953
  "name": "maxExtraLockupVoteWeightScaledFactor",
1793
- "docs": [
1794
- "Maximum extra vote weight factor for lockups.",
1795
- "",
1796
- "This is the extra votes gained for lockups lasting lockup_saturation_secs or",
1797
- "longer. Shorter lockups receive only a fraction of the maximum extra vote weight,",
1798
- "based on lockup_time divided by lockup_saturation_secs.",
1799
- "",
1800
- "In 1/SCALED_FACTOR_BASE units."
1801
- ],
1802
1954
  "type": "u64"
1803
1955
  },
1804
1956
  {
1805
1957
  "name": "genesisVotePowerMultiplier",
1806
- "docs": [
1807
- "Genesis vote power multipliers for lockups.",
1808
- "",
1809
- "This is a multiplier applied to voting power for lockups created before",
1810
- "genesis_extra_lockup_expiration"
1811
- ],
1812
1958
  "type": "u8"
1813
1959
  },
1814
1960
  {
1815
1961
  "name": "genesisVotePowerMultiplierExpirationTs",
1816
- "docs": [
1817
- "Timestamp of when to stop applying the genesis_extra_lockup_vote_weight_scaled_factor"
1818
- ],
1819
1962
  "type": "i64"
1820
1963
  },
1821
1964
  {
1822
1965
  "name": "lockupSaturationSecs",
1823
- "docs": [
1824
- "Number of seconds of lockup needed to reach the maximum lockup bonus."
1825
- ],
1826
1966
  "type": "u64"
1827
1967
  },
1828
1968
  {
1829
1969
  "name": "digitShift",
1830
- "docs": [
1831
- "Number of digits to shift native amounts, applying a 10^digit_shift factor."
1832
- ],
1833
1970
  "type": "i8"
1834
1971
  }
1835
1972
  ]
@@ -1854,10 +1991,6 @@ exports.IDL = {
1854
1991
  },
1855
1992
  {
1856
1993
  "name": "VoterWeightAction",
1857
- "docs": [
1858
- "VoterWeightAction enum as defined in spl-governance-addin-api",
1859
- "It's redefined here for Anchor to export it to IDL"
1860
- ],
1861
1994
  "type": {
1862
1995
  "kind": "enum",
1863
1996
  "variants": [
@@ -2170,6 +2303,14 @@ exports.IDL = {
2170
2303
  "code": 6057,
2171
2304
  "name": "SamePosition",
2172
2305
  "msg": "Cannot transfer to the same position"
2306
+ },
2307
+ {
2308
+ "code": 6058,
2309
+ "name": "MaxChoicesExceeded"
2310
+ },
2311
+ {
2312
+ "code": 6059,
2313
+ "name": "NoVoteForThisChoice"
2173
2314
  }
2174
2315
  ]
2175
2316
  };