@chorus-one/polygon 1.0.1 → 1.0.3

package/README.md

@@ -99,7 +99,9 @@ const { txHash } = await staker.broadcast({ signedTx })
 
 ### Stake (Delegate) to Validator
 
-Delegate POL tokens to a validator via their ValidatorShare contract:
+Delegate POL tokens to a validator via their ValidatorShare contract.
+
+You must provide exactly one of `slippageBps` or `minSharesToMint` (not both). There is no default — omitting both will throw an error.
 
 ```javascript
 const { tx } = await staker.buildStakeTx({
@@ -121,7 +123,9 @@ const { txHash } = await staker.broadcast({ signedTx })
 
 ### Unstake (Unbond) from Validator
 
-Create an unbond request to unstake POL tokens. After the unbonding period (~80 epochs, approximately 3-4 days), call withdraw to claim funds:
+Create an unbond request to unstake POL tokens. After the unbonding period (~80 epochs, approximately 3-4 days), call withdraw to claim funds.
+
+You must provide exactly one of `slippageBps` or `maximumSharesToBurn` (not both). There is no default — omitting both will throw an error.
 
 ```javascript
 const { tx } = await staker.buildUnstakeTx({
@@ -215,7 +219,7 @@ console.log(status) // 'success', 'failure', or 'unknown'
 - **Ethereum L1 Based**: Polygon PoS staking operates via ValidatorShare contracts deployed on Ethereum mainnet (or Sepolia for testnet)
 - **POL Token Staking**: Stake the native POL token (formerly MATIC) to validators
 - **Human-Readable Amounts**: Pass token amounts as strings (e.g., '1.5'), conversion to wei is handled automatically
-- **Slippage Protection**: Stake and unstake operations support `slippageBps` (basis points) for automatic slippage calculation, or manual `minSharesToMint`/`maximumSharesToBurn` parameters
+- **Slippage Protection**: Stake and unstake operations require either `slippageBps` (basis points) for automatic slippage calculation, or manual `minSharesToMint`/`maximumSharesToBurn` parameters. Exactly one must be provided — there is no default.
 - **Query Methods**: Read stake balances, rewards, allowances, unbond status (with POL amount and withdrawability), and epoch information
 - **Rewards Management**: Claim rewards to wallet or compound them back into your delegation
 

package/dist/cjs/staker.d.ts

@@ -54,8 +54,8 @@ export declare class PolygonStaker {
      * @param params.delegatorAddress - The delegator's Ethereum address
      * @param params.validatorShareAddress - The validator's ValidatorShare contract address
      * @param params.amount - The amount to stake in POL
-     * @param params.slippageBps - (Optional) Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate minSharesToMint.
-     * @param params.minSharesToMint - (Optional) Minimum validator shares to receive. Use this OR slippageBps, not both.
+     * @param params.slippageBps - Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate minSharesToMint. Exactly one of `slippageBps` or `minSharesToMint` must be provided (not both, no default).
+     * @param params.minSharesToMint - Minimum validator shares to receive. Exactly one of `slippageBps` or `minSharesToMint` must be provided (not both, no default).
      * @param params.referrer - (Optional) Custom referrer string for tracking. If not provided, uses 'sdk-chorusone-staking'.
      *
      * @returns Returns a promise that resolves to a Polygon staking transaction
@@ -80,8 +80,8 @@ export declare class PolygonStaker {
      * @param params.delegatorAddress - The delegator's address
      * @param params.validatorShareAddress - The validator's ValidatorShare contract address
      * @param params.amount - The amount to unstake in POL (will be converted to wei internally)
-     * @param params.slippageBps - (Optional) Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate maximumSharesToBurn.
-     * @param params.maximumSharesToBurn - (Optional) Maximum validator shares willing to burn. Use this OR slippageBps, not both.
+     * @param params.slippageBps - Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate maximumSharesToBurn. Exactly one of `slippageBps` or `maximumSharesToBurn` must be provided (not both, no default).
+     * @param params.maximumSharesToBurn - Maximum validator shares willing to burn. Exactly one of `slippageBps` or `maximumSharesToBurn` must be provided (not both, no default).
      * @param params.referrer - (Optional) Custom referrer string for tracking. If not provided, uses 'sdk-chorusone-staking'.
      *
      * @returns Returns a promise that resolves to a Polygon unstaking transaction

package/dist/cjs/staker.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PolygonStaker = void 0;
 const viem_1 = require("viem");
 const chains_1 = require("viem/chains");
-const secp256k1_js_1 = require("@noble/curves/secp256k1.js");
+const secp256k1_1 = require("@noble/curves/secp256k1");
 const referrer_1 = require("./referrer");
 const constants_1 = require("./constants");
 /**
@@ -46,7 +46,8 @@ class PolygonStaker {
      * @returns Returns an array containing the derived address.
      */
     static getAddressDerivationFn = () => async (publicKey) => {
-        const pkUncompressed = secp256k1_js_1.secp256k1.Point.fromBytes(publicKey).toBytes(false);
+        const point = secp256k1_1.secp256k1.Point.fromHex(publicKey);
+        const pkUncompressed = point.toBytes(false);
         const hash = (0, viem_1.keccak256)(pkUncompressed.subarray(1));
         const ethAddress = hash.slice(-40);
         return [ethAddress];
@@ -108,8 +109,8 @@ class PolygonStaker {
      * @param params.delegatorAddress - The delegator's Ethereum address
      * @param params.validatorShareAddress - The validator's ValidatorShare contract address
      * @param params.amount - The amount to stake in POL
-     * @param params.slippageBps - (Optional) Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate minSharesToMint.
-     * @param params.minSharesToMint - (Optional) Minimum validator shares to receive. Use this OR slippageBps, not both.
+     * @param params.slippageBps - Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate minSharesToMint. Exactly one of `slippageBps` or `minSharesToMint` must be provided (not both, no default).
+     * @param params.minSharesToMint - Minimum validator shares to receive. Exactly one of `slippageBps` or `minSharesToMint` must be provided (not both, no default).
      * @param params.referrer - (Optional) Custom referrer string for tracking. If not provided, uses 'sdk-chorusone-staking'.
      *
      * @returns Returns a promise that resolves to a Polygon staking transaction
@@ -165,8 +166,8 @@ class PolygonStaker {
      * @param params.delegatorAddress - The delegator's address
      * @param params.validatorShareAddress - The validator's ValidatorShare contract address
      * @param params.amount - The amount to unstake in POL (will be converted to wei internally)
-     * @param params.slippageBps - (Optional) Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate maximumSharesToBurn.
-     * @param params.maximumSharesToBurn - (Optional) Maximum validator shares willing to burn. Use this OR slippageBps, not both.
+     * @param params.slippageBps - Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate maximumSharesToBurn. Exactly one of `slippageBps` or `maximumSharesToBurn` must be provided (not both, no default).
+     * @param params.maximumSharesToBurn - Maximum validator shares willing to burn. Exactly one of `slippageBps` or `maximumSharesToBurn` must be provided (not both, no default).
      * @param params.referrer - (Optional) Custom referrer string for tracking. If not provided, uses 'sdk-chorusone-staking'.
      *
      * @returns Returns a promise that resolves to a Polygon unstaking transaction

package/dist/mjs/staker.d.ts

@@ -54,8 +54,8 @@ export declare class PolygonStaker {
      * @param params.delegatorAddress - The delegator's Ethereum address
      * @param params.validatorShareAddress - The validator's ValidatorShare contract address
      * @param params.amount - The amount to stake in POL
-     * @param params.slippageBps - (Optional) Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate minSharesToMint.
-     * @param params.minSharesToMint - (Optional) Minimum validator shares to receive. Use this OR slippageBps, not both.
+     * @param params.slippageBps - Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate minSharesToMint. Exactly one of `slippageBps` or `minSharesToMint` must be provided (not both, no default).
+     * @param params.minSharesToMint - Minimum validator shares to receive. Exactly one of `slippageBps` or `minSharesToMint` must be provided (not both, no default).
      * @param params.referrer - (Optional) Custom referrer string for tracking. If not provided, uses 'sdk-chorusone-staking'.
      *
      * @returns Returns a promise that resolves to a Polygon staking transaction
@@ -80,8 +80,8 @@ export declare class PolygonStaker {
      * @param params.delegatorAddress - The delegator's address
      * @param params.validatorShareAddress - The validator's ValidatorShare contract address
      * @param params.amount - The amount to unstake in POL (will be converted to wei internally)
-     * @param params.slippageBps - (Optional) Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate maximumSharesToBurn.
-     * @param params.maximumSharesToBurn - (Optional) Maximum validator shares willing to burn. Use this OR slippageBps, not both.
+     * @param params.slippageBps - Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate maximumSharesToBurn. Exactly one of `slippageBps` or `maximumSharesToBurn` must be provided (not both, no default).
+     * @param params.maximumSharesToBurn - Maximum validator shares willing to burn. Exactly one of `slippageBps` or `maximumSharesToBurn` must be provided (not both, no default).
      * @param params.referrer - (Optional) Custom referrer string for tracking. If not provided, uses 'sdk-chorusone-staking'.
      *
      * @returns Returns a promise that resolves to a Polygon unstaking transaction

package/dist/mjs/staker.js

@@ -1,6 +1,6 @@
 import { createPublicClient, http, encodeFunctionData, parseEther, formatEther, isAddress, keccak256, serializeTransaction, createWalletClient, maxUint256, erc20Abi } from 'viem';
 import { mainnet, sepolia } from 'viem/chains';
-import { secp256k1 } from '@noble/curves/secp256k1.js';
+import { secp256k1 } from '@noble/curves/secp256k1';
 import { appendReferrerTracking } from './referrer';
 import { VALIDATOR_SHARE_ABI, STAKE_MANAGER_ABI, NETWORK_CONTRACTS, EXCHANGE_RATE_PRECISION, EXCHANGE_RATE_HIGH_PRECISION } from './constants';
 /**
@@ -43,7 +43,8 @@ export class PolygonStaker {
      * @returns Returns an array containing the derived address.
      */
     static getAddressDerivationFn = () => async (publicKey) => {
-        const pkUncompressed = secp256k1.Point.fromBytes(publicKey).toBytes(false);
+        const point = secp256k1.Point.fromHex(publicKey);
+        const pkUncompressed = point.toBytes(false);
         const hash = keccak256(pkUncompressed.subarray(1));
         const ethAddress = hash.slice(-40);
         return [ethAddress];
@@ -105,8 +106,8 @@ export class PolygonStaker {
      * @param params.delegatorAddress - The delegator's Ethereum address
      * @param params.validatorShareAddress - The validator's ValidatorShare contract address
      * @param params.amount - The amount to stake in POL
-     * @param params.slippageBps - (Optional) Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate minSharesToMint.
-     * @param params.minSharesToMint - (Optional) Minimum validator shares to receive. Use this OR slippageBps, not both.
+     * @param params.slippageBps - Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate minSharesToMint. Exactly one of `slippageBps` or `minSharesToMint` must be provided (not both, no default).
+     * @param params.minSharesToMint - Minimum validator shares to receive. Exactly one of `slippageBps` or `minSharesToMint` must be provided (not both, no default).
      * @param params.referrer - (Optional) Custom referrer string for tracking. If not provided, uses 'sdk-chorusone-staking'.
      *
      * @returns Returns a promise that resolves to a Polygon staking transaction
@@ -162,8 +163,8 @@ export class PolygonStaker {
      * @param params.delegatorAddress - The delegator's address
      * @param params.validatorShareAddress - The validator's ValidatorShare contract address
      * @param params.amount - The amount to unstake in POL (will be converted to wei internally)
-     * @param params.slippageBps - (Optional) Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate maximumSharesToBurn.
-     * @param params.maximumSharesToBurn - (Optional) Maximum validator shares willing to burn. Use this OR slippageBps, not both.
+     * @param params.slippageBps - Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate maximumSharesToBurn. Exactly one of `slippageBps` or `maximumSharesToBurn` must be provided (not both, no default).
+     * @param params.maximumSharesToBurn - Maximum validator shares willing to burn. Exactly one of `slippageBps` or `maximumSharesToBurn` must be provided (not both, no default).
      * @param params.referrer - (Optional) Custom referrer string for tracking. If not provided, uses 'sdk-chorusone-staking'.
      *
      * @returns Returns a promise that resolves to a Polygon unstaking transaction

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chorus-one/polygon",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "All-in-one toolkit for building staking dApps on Polygon network",
   "scripts": {
     "build": "rm -fr dist/* && tsc -p tsconfig.mjs.json --outDir dist/mjs && tsc -p tsconfig.cjs.json --outDir dist/cjs && bash ../../scripts/fix-package-json",
@@ -38,7 +38,7 @@
   "type": "module",
   "dependencies": {
     "@chorus-one/signer": "^1.0.0",
-    "@noble/curves": "^2.0.1",
+    "@noble/curves": "^1.9.2",
     "viem": "^2.28.0"
   },
   "devDependencies": {

package/src/staker.ts

@@ -16,7 +16,7 @@ import {
   type Chain
 } from 'viem'
 import { mainnet, sepolia } from 'viem/chains'
-import { secp256k1 } from '@noble/curves/secp256k1.js'
+import { secp256k1 } from '@noble/curves/secp256k1'
 import type { Signer } from '@chorus-one/signer'
 import type { Transaction, PolygonNetworkConfig, PolygonTxStatus, StakeInfo, UnbondInfo } from './types'
 import { appendReferrerTracking } from './referrer'
@@ -75,7 +75,8 @@ export class PolygonStaker {
   static getAddressDerivationFn =
     () =>
     async (publicKey: Uint8Array): Promise<Array<string>> => {
-      const pkUncompressed = secp256k1.Point.fromBytes(publicKey).toBytes(false)
+      const point = secp256k1.Point.fromHex(publicKey)
+      const pkUncompressed = point.toBytes(false)
       const hash = keccak256(pkUncompressed.subarray(1))
       const ethAddress = hash.slice(-40)
       return [ethAddress]
@@ -144,8 +145,8 @@ export class PolygonStaker {
    * @param params.delegatorAddress - The delegator's Ethereum address
    * @param params.validatorShareAddress - The validator's ValidatorShare contract address
    * @param params.amount - The amount to stake in POL
-   * @param params.slippageBps - (Optional) Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate minSharesToMint.
-   * @param params.minSharesToMint - (Optional) Minimum validator shares to receive. Use this OR slippageBps, not both.
+   * @param params.slippageBps - Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate minSharesToMint. Exactly one of `slippageBps` or `minSharesToMint` must be provided (not both, no default).
+   * @param params.minSharesToMint - Minimum validator shares to receive. Exactly one of `slippageBps` or `minSharesToMint` must be provided (not both, no default).
    * @param params.referrer - (Optional) Custom referrer string for tracking. If not provided, uses 'sdk-chorusone-staking'.
    *
    * @returns Returns a promise that resolves to a Polygon staking transaction
@@ -218,8 +219,8 @@ export class PolygonStaker {
    * @param params.delegatorAddress - The delegator's address
    * @param params.validatorShareAddress - The validator's ValidatorShare contract address
    * @param params.amount - The amount to unstake in POL (will be converted to wei internally)
-   * @param params.slippageBps - (Optional) Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate maximumSharesToBurn.
-   * @param params.maximumSharesToBurn - (Optional) Maximum validator shares willing to burn. Use this OR slippageBps, not both.
+   * @param params.slippageBps - Slippage tolerance in basis points (e.g., 50 = 0.5%). Used to calculate maximumSharesToBurn. Exactly one of `slippageBps` or `maximumSharesToBurn` must be provided (not both, no default).
+   * @param params.maximumSharesToBurn - Maximum validator shares willing to burn. Exactly one of `slippageBps` or `maximumSharesToBurn` must be provided (not both, no default).
    * @param params.referrer - (Optional) Custom referrer string for tracking. If not provided, uses 'sdk-chorusone-staking'.
    *
    * @returns Returns a promise that resolves to a Polygon unstaking transaction

package/test/lib/networks.json

@@ -2,7 +2,7 @@
   "networks": {
     "ethereum": {
       "name": "ethereum",
-      "url": "https://ethereum-rpc.publicnode.com"
+      "url": "https://eth.drpc.org"
     }
   },
   "accounts": [