@chorus-one/polygon 1.0.0

package/dist/cjs/types.d.ts

@@ -0,0 +1,40 @@
+import type { Hex, TransactionReceipt } from 'viem';
+import type { PolygonNetworks } from './constants';
+export interface PolygonNetworkConfig {
+    /** Network to use: 'mainnet' (Ethereum L1) or 'testnet' (Sepolia L1) */
+    network: PolygonNetworks;
+    /** Optional RPC endpoint URL override. If not provided, uses viem's default for the network. */
+    rpcUrl?: string;
+}
+export interface Transaction {
+    /** The recipient (contract) address in hexadecimal format */
+    to: Hex;
+    /** The data to be included in the transaction in hexadecimal format (includes referrer tracking suffix) */
+    data: Hex;
+    /** The amount of ETH (in wei) to be sent with the transaction */
+    value?: bigint;
+}
+export interface PolygonTxStatus {
+    /** Status of the transaction */
+    status: 'success' | 'failure' | 'unknown';
+    /** Transaction receipt (null if unknown) */
+    receipt: TransactionReceipt | null;
+}
+export interface StakeInfo {
+    /** Total staked amount formatted in POL */
+    balance: string;
+    /** Total shares held by the delegator */
+    shares: bigint;
+    /** Current exchange rate between shares and POL (with high precision) */
+    exchangeRate: bigint;
+}
+export interface UnbondInfo {
+    /** Amount pending unbonding in POL */
+    amount: string;
+    /** Whether the unbond can be withdrawn now */
+    isWithdrawable: boolean;
+    /** Shares amount pending unbonding */
+    shares: bigint;
+    /** Epoch number when the unbond becomes claimable */
+    withdrawEpoch: bigint;
+}

package/dist/cjs/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/mjs/constants.d.ts

@@ -0,0 +1,187 @@
+import type { Address } from 'viem';
+export type PolygonNetworks = 'mainnet' | 'testnet';
+export interface NetworkContracts {
+    stakeManagerAddress: Address;
+    stakingTokenAddress: Address;
+}
+/** Contract addresses per network (mainnet = Ethereum L1, testnet = Sepolia L1) */
+export declare const NETWORK_CONTRACTS: Record<PolygonNetworks, NetworkContracts>;
+/** Chorus One Polygon ValidatorShare contract addresses */
+export declare const CHORUS_ONE_POLYGON_VALIDATORS: {
+    readonly mainnet: `0x${string}`;
+    readonly testnet: `0x${string}`;
+};
+export declare const VALIDATOR_SHARE_ABI: readonly [{
+    readonly type: "function";
+    readonly name: "buyVoucherPOL";
+    readonly inputs: readonly [{
+        readonly name: "_amount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "_minSharesToMint";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "amountToDeposit";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "sellVoucher_newPOL";
+    readonly inputs: readonly [{
+        readonly name: "claimAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "maximumSharesToBurn";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "unstakeClaimTokens_newPOL";
+    readonly inputs: readonly [{
+        readonly name: "unbondNonce";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "withdrawRewardsPOL";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "restakePOL";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "amountRestaked";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "liquidReward";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "getTotalStake";
+    readonly inputs: readonly [{
+        readonly name: "user";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "unbondNonces";
+    readonly inputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "unbonds_new";
+    readonly inputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "shares";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "withdrawEpoch";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getLiquidRewards";
+    readonly inputs: readonly [{
+        readonly name: "user";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "validatorId";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "withdrawExchangeRate";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}];
+export declare const EXCHANGE_RATE_PRECISION = 100n;
+export declare const EXCHANGE_RATE_HIGH_PRECISION: bigint;
+export declare const STAKE_MANAGER_ABI: readonly [{
+    readonly type: "function";
+    readonly name: "epoch";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "withdrawalDelay";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}];

package/dist/mjs/constants.js

@@ -0,0 +1,138 @@
+/** Contract addresses per network (mainnet = Ethereum L1, testnet = Sepolia L1) */
+// Reference: https://docs.polygon.technology/pos/reference/rpc-endpoints/
+export const NETWORK_CONTRACTS = {
+    mainnet: {
+        stakeManagerAddress: '0x5e3Ef299fDDf15eAa0432E6e66473ace8c13D908',
+        stakingTokenAddress: '0x455e53CBB86018Ac2B8092FdCd39d8444aFFC3F6'
+    },
+    testnet: {
+        stakeManagerAddress: '0x4AE8f648B1Ec892B6cc68C89cc088583964d08bE',
+        stakingTokenAddress: '0x44499312f493F62f2DFd3C6435Ca3603EbFCeeBa'
+    }
+};
+/** Chorus One Polygon ValidatorShare contract addresses */
+// Reference mainnet: https://staking.polygon.technology/validators/106
+// Reference testnet (Random Validator): https://staking.polygon.technology/validators/31
+export const CHORUS_ONE_POLYGON_VALIDATORS = {
+    mainnet: '0xD9E6987D77bf2c6d0647b8181fd68A259f838C36',
+    testnet: '0x91344055cb0511b3aa36c561d741ee356b95f1c9'
+};
+// Reference: https://github.com/0xPolygon/pos-contracts/blob/main/contracts/staking/validatorShare/ValidatorShare.sol
+export const VALIDATOR_SHARE_ABI = [
+    {
+        type: 'function',
+        name: 'buyVoucherPOL',
+        inputs: [
+            { name: '_amount', type: 'uint256', internalType: 'uint256' },
+            { name: '_minSharesToMint', type: 'uint256', internalType: 'uint256' }
+        ],
+        outputs: [{ name: 'amountToDeposit', type: 'uint256', internalType: 'uint256' }],
+        stateMutability: 'nonpayable'
+    },
+    {
+        type: 'function',
+        name: 'sellVoucher_newPOL',
+        inputs: [
+            { name: 'claimAmount', type: 'uint256', internalType: 'uint256' },
+            { name: 'maximumSharesToBurn', type: 'uint256', internalType: 'uint256' }
+        ],
+        outputs: [],
+        stateMutability: 'nonpayable'
+    },
+    {
+        type: 'function',
+        name: 'unstakeClaimTokens_newPOL',
+        inputs: [{ name: 'unbondNonce', type: 'uint256', internalType: 'uint256' }],
+        outputs: [],
+        stateMutability: 'nonpayable'
+    },
+    {
+        type: 'function',
+        name: 'withdrawRewardsPOL',
+        inputs: [],
+        outputs: [],
+        stateMutability: 'nonpayable'
+    },
+    {
+        type: 'function',
+        name: 'restakePOL',
+        inputs: [],
+        outputs: [
+            { name: 'amountRestaked', type: 'uint256', internalType: 'uint256' },
+            { name: 'liquidReward', type: 'uint256', internalType: 'uint256' }
+        ],
+        stateMutability: 'nonpayable'
+    },
+    {
+        type: 'function',
+        name: 'getTotalStake',
+        inputs: [{ name: 'user', type: 'address', internalType: 'address' }],
+        outputs: [
+            { name: '', type: 'uint256', internalType: 'uint256' },
+            { name: '', type: 'uint256', internalType: 'uint256' }
+        ],
+        stateMutability: 'view'
+    },
+    {
+        type: 'function',
+        name: 'unbondNonces',
+        inputs: [{ name: '', type: 'address', internalType: 'address' }],
+        outputs: [{ name: '', type: 'uint256', internalType: 'uint256' }],
+        stateMutability: 'view'
+    },
+    {
+        type: 'function',
+        name: 'unbonds_new',
+        inputs: [
+            { name: '', type: 'address', internalType: 'address' },
+            { name: '', type: 'uint256', internalType: 'uint256' }
+        ],
+        outputs: [
+            { name: 'shares', type: 'uint256', internalType: 'uint256' },
+            { name: 'withdrawEpoch', type: 'uint256', internalType: 'uint256' }
+        ],
+        stateMutability: 'view'
+    },
+    {
+        type: 'function',
+        name: 'getLiquidRewards',
+        inputs: [{ name: 'user', type: 'address', internalType: 'address' }],
+        outputs: [{ name: '', type: 'uint256', internalType: 'uint256' }],
+        stateMutability: 'view'
+    },
+    {
+        type: 'function',
+        name: 'validatorId',
+        inputs: [],
+        outputs: [{ name: '', type: 'uint256', internalType: 'uint256' }],
+        stateMutability: 'view'
+    },
+    {
+        type: 'function',
+        name: 'withdrawExchangeRate',
+        inputs: [],
+        outputs: [{ name: '', type: 'uint256', internalType: 'uint256' }],
+        stateMutability: 'view'
+    }
+];
+// Exchange rate precision constants from the ValidatorShare contract
+// Reference: https://github.com/0xPolygon/pos-contracts/blob/main/contracts/staking/validatorShare/ValidatorShare.sol
+export const EXCHANGE_RATE_PRECISION = 100n;
+export const EXCHANGE_RATE_HIGH_PRECISION = 10n ** 29n;
+// Reference: https://github.com/0xPolygon/pos-contracts/blob/main/contracts/staking/stakeManager/StakeManager.sol
+export const STAKE_MANAGER_ABI = [
+    {
+        type: 'function',
+        name: 'epoch',
+        inputs: [],
+        outputs: [{ name: '', type: 'uint256', internalType: 'uint256' }],
+        stateMutability: 'view'
+    },
+    {
+        type: 'function',
+        name: 'withdrawalDelay',
+        inputs: [],
+        outputs: [{ name: '', type: 'uint256', internalType: 'uint256' }],
+        stateMutability: 'view'
+    }
+];

package/dist/mjs/index.d.ts

@@ -0,0 +1,4 @@
+export { PolygonStaker } from './staker';
+export { PolygonNetworkConfig, Transaction, PolygonTxStatus, StakeInfo, UnbondInfo } from './types';
+export { NETWORK_CONTRACTS, CHORUS_ONE_POLYGON_VALIDATORS, VALIDATOR_SHARE_ABI, STAKE_MANAGER_ABI, EXCHANGE_RATE_PRECISION, EXCHANGE_RATE_HIGH_PRECISION } from './constants';
+export type { PolygonNetworks, NetworkContracts } from './constants';

package/dist/mjs/index.js

@@ -0,0 +1,2 @@
+export { PolygonStaker } from './staker';
+export { NETWORK_CONTRACTS, CHORUS_ONE_POLYGON_VALIDATORS, VALIDATOR_SHARE_ABI, STAKE_MANAGER_ABI, EXCHANGE_RATE_PRECISION, EXCHANGE_RATE_HIGH_PRECISION } from './constants';

package/dist/mjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "module"
+}

package/dist/mjs/referrer.d.ts

@@ -0,0 +1,2 @@
+import type { Hex } from 'viem';
+export declare const appendReferrerTracking: (data: Hex, referrer?: string) => Hex;

package/dist/mjs/referrer.js

@@ -0,0 +1,11 @@
+import { keccak256, toHex } from 'viem';
+const DEFAULT_REFERRER = 'sdk-chorusone-staking';
+const REFERRER_MARKER = 'c1c1';
+const encodeReferrer = (referrer) => {
+    const hash = keccak256(toHex(referrer));
+    return `0x${REFERRER_MARKER}${hash.slice(2, 8)}`;
+};
+export const appendReferrerTracking = (data, referrer) => {
+    const encoded = encodeReferrer(referrer ?? DEFAULT_REFERRER);
+    return `${data}${encoded.slice(2)}`;
+};