NexusMutual / smart-contracts

87%

release-candidate: 70%

LAST BUILD ON BRANCH docs/staking-pool-factory-contract-docs

branch: docs/staking-pool-factory-contract-docs

CHANGE BRANCH

x

Reset

• docs/staking-pool-factory-contract-docs
• assessment-unit-tests
• audit/batch-nxm-withdrawal
• audit/cover-products
• audit/fix-reward-shares
• audit/fix-staking-pool-batch-nxm-withdrawals
• audit/governance-and-assessments-august-2025
• audit/ioshiro-nexus-v2
• audit/limit-order-fix
• audit/long-term-limit-order
• audit/long-term-limit-order-fixes
• audit/march-2025
• audit/march-2025-limit-orders-fixes
• audit/master-fixes
• audit/move-staking-pool-metadata
• audit/nexus-v2
• audit/price-feed-oracle-usd-price-feed-support
• audit/product-pricing-updates
• audit/product-pricing-updates-fix
• audit/safe-tracker
• audit/safe-tracker-report-fix
• audit/staking-pool-fixes-and-batch-withdrawal
• audit/tokenomics
• backup/feature/active-cover-amount
• backup/generate-allocation-id
• breaking/v3
• bug/cover-amount-validation
• bug/failing-tests-with-new-hardhat
• bug/initial-deposit-revert
• chore/ALLOCATION_UNITS_PER_NXM-mock
• chore/add-cbbtc-address-to-address-json
• chore/add-cbbtc-oracle-address
• chore/add-cover-asset-check-on-edit
• chore/add-ramm-vote-lock-check
• chore/add-semantic-commit-branch-hooks-validation
• chore/adjust-pricing-parameters
• chore/aggregator-fn
• chore/bring-back-the-cover-edited-event
• chore/bump-version-to-2.10.1
• chore/cleanup
• chore/compilation-optimize-warning
• chore/const-assertion-abis
• chore/continuing-cleanup
• chore/contract-code-cleanup
• chore/cover-broker-deployments
• chore/cover-multicall
• chore/cover-products-deployments
• chore/cover-products-viewer-contracts-deployment
• chore/cover-size
• chore/create2-scripts
• chore/data-types-namespacing
• chore/design-comments
• chore/dev-docs
• chore/dev-docs-backup
• chore/disable-edit-cover
• chore/dotenv-and-compilers
• chore/drop-governance-scripts
• chore/event-indexing
• chore/extra-basic-functionality-tests
• chore/fix-product-scripts
• chore/fix-tenderly-simulate-tx-decode-input
• chore/fork-tests-for-migrated-covers-claim-process
• chore/fork-tokenomics-and-bft-fork-tests-fixes
• chore/gatway-cleanup
• chore/generate-storage-layout-v2.11.0
• chore/generate-v2.6.2-storage-layout
• chore/get-v2-products-map
• chore/github-actions
• chore/gov-fixes-cherrypick
• chore/governance-scripts
• chore/governance-simulation-script
• chore/immutable-token
• chore/increase_price_change_per_day
• chore/kms-signer-cleanup
• chore/math-min-max
• chore/migrate-cover-data-script-changes
• chore/nft-id-start-at-1
• chore/npm-audit-fix
• chore/process-expirations-fn-on-staking-viewer
• chore/process-expirations-true-on-withdraw
• chore/readme
• chore/reduce-cover-size
• chore/release-2-4-2
• chore/release-2.12.1
• chore/release-2.12.2
• chore/release-v2.12.0
• chore/remove-comments
• chore/remove-cover-migrator-and-gateway-contracts
• chore/remove-deployments-abi
• chore/remove-fallback-function-from-pool
• chore/remove-legacy-contracts
• chore/remove-migrate-cover-products
• chore/remove-old-deps
• chore/remove-oz-test-helpers
• chore/remove-product-listing-scripts
• chore/remove-web3-truffle
• chore/rename-bucket-tranche-expiry
• chore/rename-ic-to-ci-and-yc-to-cg
• chore/rename-next-price-to-bumped-price
• chore/repack-ramm-storage
• chore/script-migrate-cover-data
• chore/small-fixes-and-todo-comments
• chore/solidity-hardhat-upgrade
• chore/staking-cleanup
• chore/staking-pool-8-cleanup
• chore/staking-pool-mock-rename
• chore/staking-update-kms-signer
• chore/staking-viewer-pull-staking-products-from-master
• chore/tc-cleanup
• chore/tc-storage-fix-and-pool-dai-params
• chore/tenderly-simulation-setProductTypes
• chore/testnet-address-whitelisting
• chore/testnet-member-join-function
• chore/tests-cleanup
• chore/tests-housekeeping
• chore/tokencontroller-cleanup
• chore/update-@nexusmutual-deploymenets-package-to-2.8.0
• chore/update-and-cleanup-deps
• chore/update-ci-cache-key
• chore/update-cover-broker-address
• chore/update-cover-docs
• chore/update-deploy-script
• chore/update-deployment-package-lock-2.8.0
• chore/update-deployments-2.10.0
• chore/update-deployments-build-script
• chore/update-deployments-staking-swap-operator
• chore/update-deployments-to-2.10.0
• chore/update-deposit-to-staking-pools-js
• chore/update-local-deploy-script
• chore/update-nexusmutual-deployments-to-2.10.0
• chore/update-solcover-config
• chore/update-solidity-version
• chore/update-twap-early-exit
• chore/update-version-2.11.0
• chore/upgrade-deployments-package-to-v3
• chore/upgrade-deployments-to-2.9.0
• chore/upgrade-hardhat
• chore/upgrade-price-oracle-master
• chore/upgrade_hardhat
• chore/v1-prices-script-cleanup
• chore/v3-migration-phase-2-fork-test
• chore/version-upgrade-2.9.0
• chore/vnet-scripts-deployments-package-update
• chore/warnings-and-deploy-script
• ci/release-and-release-next-workflows
• danoctavian-patch-1
• dependabot/npm_and_yarn/follow-redirects-1.15.4
• dependabot/npm_and_yarn/word-wrap-1.2.5
• dist-fix-rebased
• docs/assessment-contract-docs
• docs/cover-buyer-user-flows
• docs/cover-contract-docs
• docs/existing-contract-docs-improvements
• docs/individual-claims-contract-docs
• docs/manager-user-flows
• docs/pool-contract-docs
• docs/release-3.0-deployment-docs
• docs/smart-contract-docs-diagrams-update
• docs/smart-contracts-documentation
• docs/staker-user-flow
• docs/staking-products-contract-docs
• docs/symbiotic-integration
• docs/token-controller-contract-docs
• docs/v3-contracts-docs
• docs/v3-migration-md
• feat/514-index-claim-submitted
• feat/add-library-linking-create2
• feat/add-metadataIpfsHash-to-pool-struct-staking-viewer
• feat/add-verify-tenderly-harhat-task
• feat/alchemy-compatible-nft-indexer-script
• feat/assessment-claims-configurable-payout-redemption-period
• feat/assessment-stake-lockup-expiry
• feat/aws-kms-signer
• feat/backwards-compatible-membership-switch-nxm-approval
• feat/batch-nxm-withdraw-modify-underlying-methods
• feat/batch-nxm-withdrawal
• feat/batch-nxm-withdrawal-backup
• feat/contract-viewer-get-total-nxm
• feat/cover-broker
• feat/cover-edits
• feat/cover-ipfs-metadata-migrate-to-storage-script
• feat/cover-ri-pool
• feat/create-staking-pools-mock-script
• feat/deploy-script-debug
• feat/enzyme-vault-swap-operator
• feat/ext-lib-link-improvements
• feat/fork-test-disk-storage
• feat/generate-final-contracts
• feat/get-member-claims
• feat/gov-proposal-deploy-scripts
• feat/governance-revamp
• feat/governance-scripts-add-asset-to-pool-category-42
• feat/legacy-assessment-master-transfer-ownership-to-registry
• feat/limit-orders
• feat/member-roles-migrate-ab-members-claims-cleanup
• feat/move-ipfs-hashes-to-storage
• feat/move-staking-pool-metadata
• feat/parallel-workers-create1-find-address
• feat/permissioned-assessment
• feat/price-feed-oracle-cbbtc-usd-support
• feat/product-listing-script-improvements
• feat/product-min-price
• feat/product-pricing-updates
• feat/product-pricing-updates-fork-test
• feat/product-pricing-updates-test-branch
• feat/proposal-id-with-proposal-details
• feat/replace-ab-with-governance
• feat/script-improvements-and-docs
• feat/staking-events
• feat/staking-viewer-dashboard-updates
• feat/staking-viewer-temp
• feat/swap-operator-asset-to-asset-order
• feat/token-controller-revamp
• feat/token-controller-unstake-for-all
• feat/typescript
• feat/updates-for-fe-support
• feat/v1-nxm
• feat/v1-nxm-data-json
• feat/v3-legacy-assessment
• feat/v3-solidity-todos
• feat/validate-deposit-nft-owner
• feat/vote-power-with-governor
• feature/active-cover-amount
• feature/add-expire-cover
• feature/add-product-types-script
• feature/add-viewer-for-segment-allocations
• feature/assessment-data-ipfs-hash
• feature/assessment-events
• feature/assessment-stake-unstake-unit-tests
• feature/assessment-unit-tests
• feature/assessment-v2
• feature/audit/cover-products-fix
• feature/bumpedPriceUpdateTime-in-staking-viewer
• feature/burns-for-edited-covers
• feature/cover-product-management
• feature/cover-products-contract
• feature/cover-products-contract-backup
• feature/cover-products-contract-rebased
• feature/cover-products-fork
• feature/cover-products-listing-script
• feature/cover-re
• feature/cover-re-usdc
• feature/cover-tests
• feature/cover-v2
• feature/cover-v2-updates
• feature/cover_nft_solmate
• feature/cow-operator
• feature/custom-error-nfts
• feature/custom-errors
• feature/deploy-script
• feature/deployments
• feature/deprecate-product
• feature/distributor-relocation
• feature/docker-image
• feature/edit-cover
• feature/edit-cover-functionality
• feature/edit-cover-increase-amount
• feature/edit-existing-product-cover
• feature/edit-product-grace-period
• feature/edit-product-types
• feature/eslint-avoid-dot-only
• feature/expiration-event
• feature/expiry-based-active-cover-amount
• feature/extra-cover-tests
• feature/fork-test-check-cover-buys
• feature/generalized-fork-tests
• feature/generate-setProducts-tx.js
• feature/get-mcr-out-of-amsterdam
• feature/increase-swap-operator-limits
• feature/integrate-enzyme-v2
• feature/integration-tests-cover
• feature/integration-tests-yield-token
• feature/interfaces-for-all-contracts
• feature/leftover-adjustments
• feature/long-term-limit-order
• feature/manager-deposit-lock
• feature/master-aware-unification
• feature/master-aware-v2-suggestions
• feature/master-fixes
• feature/masterawarev2-normalization
• feature/masterawarev2-normalization-backup
• feature/membership-witdrawal-event
• feature/migrate-pooledstaking
• feature/migration-action-scripts
• feature/pack-staking-variables
• feature/pool-swap-value
• feature/prevent-cover-amount-precision-loss
• feature/ramm-circuit-breaker
• feature/recalculate-effective-weight
• feature/recalculate-totalCoverAmount
• feature/remove-mcr-floor
• feature/remove-waffle
• feature/router-views
• feature/script-for-setProducts-tx
• feature/skip-pool-edit-cover
• feature/solmate_cover_nft
• feature/staking-burn
• feature/staking-burns-100-percent
• feature/staking-pool
• feature/staking-pool-description
• feature/staking-pool-management
• feature/staking-timelock
• feature/staking-v2
• feature/swap-operator-community-fund
• feature/system-pause
• feature/test-feature
• feature/test-migrating-v1-covers
• feature/test-second-feature
• feature/tests-and-pricing
• feature/token-uri
• feature/tokenomics
• feature/tokenomics-abi-functions-annotations
• feature/tokenomics-accumulator-precision
• feature/tokenomics-add-eth-injected-extracted-events
• feature/tokenomics-add-events-to-ramm
• feature/tokenomics-audit-ramm-code-refactor
• feature/tokenomics-context-struct
• feature/tokenomics-fix-ratchet-elapsed-time
• feature/tokenomics-fork-test
• feature/tokenomics-get-internal-price
• feature/tokenomics-getReserves-budget-zero
• feature/tokenomics-initial-observations
• feature/tokenomics-injection-extraction-fix
• feature/tokenomics-integration
• feature/tokenomics-interation-tests-rebase
• feature/tokenomics-internal-constants
• feature/tokenomics-layout-tests
• feature/tokenomics-leftovers
• feature/tokenomics-leftovers-getReserves-unit-test
• feature/tokenomics-leftovers-main-unit-tests
• feature/tokenomics-leftovers-temp-rocky
• feature/tokenomics-min-max
• feature/tokenomics-missing-unit-tests
• feature/tokenomics-mocks-common-directory
• feature/tokenomics-observation-packing
• feature/tokenomics-oracle-unit-tests
• feature/tokenomics-pool-contract-missed-coverage-unit-tests
• feature/tokenomics-protocol-internal-price
• feature/tokenomics-ramm-swap-getReserves-clean-up
• feature/tokenomics-ramm-swap-integration-tests
• feature/tokenomics-refactor-swap-remove-var-mutation
• feature/tokenomics-reuse-results
• feature/tokenomics-skipped-tests
• feature/tokenomics-swap-emergency-pause
• feature/tokenomics-swap-implementation
• feature/tokenomics-todos
• feature/tokenomics-todos-custom-errors
• feature/tokenomics-update-twap
• feature/total-balance-of-tests
• feature/total-cover-update-in-expirCover
• feature/tranche-cover-amount-tracking
• feature/update-pool-tests-to-ethers
• feature/upgrade-capital-pool-assets
• feature/upgrade-oz-signature
• feature/v2-migration-claim-assessment-migration
• feature/v2-migration-fork-test
• feature/withdraw-rewards-to-destination
• feature/yield-vault
• fix/GV-upgrade
• fix/active-cover-track-payout
• fix/add-initialize-to-cover
• fix/add-missing-rc-version-bump-on-root
• fix/allocation-carry-over
• fix/allowed-pools-migration
• fix/assessment-deploy
• fix/assessment-status-and-struct
• fix/audit-findings
• fix/audit-fixes
• fix/audit-patch-findings
• fix/build-coverage
• fix/build-coverage-2
• fix/burn-stake-halt-at-one-capacity-unit
• fix/burns-in-grace-period
• fix/burns-refunds
• fix/buy-cover-fund-pool
• fix/buyCover-allocate-correct-cover-id
• fix/calcualte-fixed-price-premium
• fix/change-operator-and-nft-descriptor
• fix/check-membership-when-minting
• fix/check-weight-on-all-tranches
• fix/ci-node-version-bump
• fix/claim-method-enum
• fix/claim-unit-tests
• fix/commision-calculation
• fix/cover-global-capacity-factor
• fix/cover-migration-amount-error
• fix/cover-tests-enable
• fix/create-staking-pool-product-check
• fix/deploy-assessment
• fix/deploy-scripts
• fix/deploy-scripts-verify-all-contracts
• fix/depositTo
• fix/distributor-relocation-build
• fix/effective-weight-bug-actualWeight-formula
• fix/effective-weight-calculation
• fix/emergency-admin-init
• fix/event-for-cover-migration
• fix/expand-deposit-with-locked-nxm
• fix/expiration-bucket-check-on-cover-expiration
• fix/extend-deposit-new-tranche-rewards-shares
• fix/failing-test-process-expiration-bucket-mismatch
• fix/feature/fork-cover-buys-on-migrated-pools
• fix/fix-accumulator-size-to-allow-overflows
• fix/fixed-price-products
• fix/gas-optimization
• fix/halt-when-below-1-capacity-unit
• fix/immunefi-bugs
• fix/informational-fixes
• fix/integration-tests
• fix/integration-tests-cleanup
• fix/limit-orders-renewal-bug
• fix/limit-orders-whitelisting
• fix/manager-deposit
• fix/manager-deposit-fix-fix
• fix/migration-v2-stakingpool-pricing-asserts
• fix/migration-v2-stakingpool-pricing-asserts-ok-rebase
• fix/migration-v2-stakingpool-pricing-asserts-original
• fix/multicall-error-handling
• fix/multiple-rewards-withdrawal
• fix/npm-deps
• fix/overflowing-small-uints
• fix/pool-8-staking-pool-bug-fix
• fix/prevent-disposable-tc-from-enrolling-itself
• fix/pricing-calculation
• fix/process-expirations-up-to-current-time
• fix/ramm-only-member-check
• fix/recalculate-weights-for-all-products
• fix/registry-get-methods
• fix/reject
• fix/request-allocation-broken-unit-tests
• fix/reward-shares
• fix/separate-allowed-pooles-from-fixed-price
• fix/separate-allowed-pools-from-fixed-price
• fix/set-products-script-metadata-path
• fix/set-products-script-unlink
• fix/skip-redundant-iterations
• fix/solidity-linting-errors
• fix/staking-pool-expirations-buckets-underflow
• fix/staking-product-check
• fix/total-cover-amount
• fix/typechain-not-generating
• fix/undoVotes-extendVotingPeriod-in-cooldown-period-validation
• fix/update-tranches
• fix/updateTranches-not-expiring-tranche
• fix/use-correct-ratchet-speed
• fix/v1-active-amount-tracking
• fork/enzyme-withdrawal
• fork/fix-yield-token-deposit
• fork/pool-8-buy-cover
• fork/swap-eth-reth
• fork/transfer-8k-eth-community
• forktest/enzyme-deposit
• gh-readonly-queue/test-release-candidate/pr-1239-e1768c28cf27bb10cce596319e96e796b1ca4215
• hack-money
• master
• merge-rc-in-nexus-v2
• nexus-v1
• nexus-v2
• nexus-v2-fixes
• nexus-v2-unreviewed
• refactor/assessment-claims-clean-up
• refactor/remove-yield-token-incidents
• refactor/use-require-for-errors
• release-candidate
• staking/calculate-premium
• temp/add-product-type-onchain
• temp/edit-product-type
• temp/new-products-79-80-81
• temp/script-for-deprecation
• temp/simulate-staking-maths
• test-master
• test-release-candidate
• test/add-asset-usdc
• test/add-coverage
• test/add-fixture
• test/assessment-claims-bfc
• test/assessment-start-assessment-cast-votes-unit-tests
• test/assessment-submit-process-fraud-unit-tests
• test/assessment-withdraw-rewards-unit-tests
• test/basic-functionality-v2
• test/constructor-initialize-assessment
• test/constructor-initialize-stakingPool
• test/contract-upgrade
• test/cover-active-cover-amount-tracking-unit-tests
• test/cover-broker-tests
• test/cover-broker-upgrade-basic-functionality
• test/cover-buycover-revert-unit-tests
• test/cover-buycover-unit-tests
• test/cover-constructor-initialization
• test/cover-create-pool-stake-burn-unit-tests
• test/cover-edit-cover-unit-tests
• test/cover-expire-cover-integration-tests
• test/cover-integration-ethers-v6
• test/cover-products-staking-pool-fork-tests
• test/cover-unit-tests
• test/cover-yieldtokenincidents-integration-tests
• test/coverNFT
• test/cowswap-prod-swaps
• test/create-staking-pool-unit
• test/effective-weight-fork-test
• test/enable-skipped-tests
• test/fix-basic-functionality-fork-tests
• test/fix-branch-changes
• test/fix-tests-after-allocate-and-edit
• test/fix-tranches
• test/fix-v3-fork-tests
• test/fix-v3-update-product-types-ipfs-hash
• test/fork-safe-tracker
• test/fork-tests-assessment-claims
• test/governance-tests
• test/governor-integration-tests
• test/governor-unit-tests
• test/improve-effective-weight-fork-test
• test/improve-effective-weight-fork-test-rebase
• test/individual-claims-assessment
• test/individual-claims-integration-tests
• test/initialize-with-ethers-remove-truffle
• test/integration-registry-governor-cover-tests
• test/integration-tests-fixes
• test/layout-fix
• test/limit-orders-integration-ethers-v6
• test/loose-ends
• test/mcr-integration-active-cover
• test/member-roles
• test/pool-ramm-staking-pool-integration-ethers-v6
• test/pool-tests
• test/pricing-unit-tests
• test/recalculate-effective-weight
• test/registry-integration-tests
• test/registry-join-investigate
• test/setPoolFee-setPoolPrivacy-unit-tests
• test/staking-nft-and-factory-tests
• test/staking-pool-bug-fork
• test/staking-pool-burn-stake-unit-tests
• test/staking-pool-process-expirations-unit-tests
• test/staking-pool-request-allocation-unit-tests
• test/staking-products-integration-ethers-v6
• test/staking-products-unit
• test/staking-rewards-update
• test/staking-scripts
• test/swap-operator-tests
• test/swapOperator-tests-refactor
• test/temporarily-skipping-last-bucket-id-test
• test/test-branch
• test/token-controller-operator-unit-tests
• test/token-controller-pool-unit-tests
• test/token-controller-withdraw-pending-rewards-unit-tests
• test/totalEffectiveWeight
• test/unit-tests-ramm-ethers-v6-migration
• test/updateUintParameters
• test/v2-migration-fork-test-storage-slots
• test/v2-selector-clash
• test/v3-assessment-claims-fork-tests
• test/v3-assessment-integration-tests
• test/v3-basic-functionality-tests
• test/v3-claims-assessment-fork-tests
• test/v3-deploy-create2-and-verify-state
• test/v3-deploy-migration
• test/v3-fork-tests-via-safe
• test/v3-push-legacy-stake-rewards-fork-integration
• test/v3-set-assessment-group-for-all-product-types
• test/yield-token-incidents-tests
• tokenomics-add-events-to-ramm-backup
• wip/investment-safe

Build # #1113

Build Type

Pull #1317

Committed by rackstar

Commit Message

docs: add StakingPoolFactory docs

Pull Request Pull Request #1317: docs: add StakingPoolFactory contract docs

Run Details

1050 of 1322 branches covered (79.43%)

Branch coverage included in aggregate %.

3081 of 3440 relevant lines covered (89.56%)

170.25 hits per line