@aastar/sdk 0.14.0 → 0.14.3
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.
- package/.eslintrc.js +28 -0
- package/.gitmodules +9 -0
- package/README.md +170 -0
- package/aastar-sdk.code-workspace +14 -0
- package/abis/BLSAggregator.json +572 -0
- package/abis/BLSValidator.json +26 -0
- package/abis/DVTValidator.json +370 -0
- package/abis/Eip7702Support.json +24 -0
- package/abis/EntryPoint.json +1379 -0
- package/abis/GToken.json +479 -0
- package/abis/GTokenStaking.json +944 -0
- package/abis/LegacyAccount.json +625 -0
- package/abis/MySBT.json +1586 -0
- package/abis/Paymaster.json +1205 -0
- package/abis/PaymasterFactory.json +650 -0
- package/abis/PaymasterV4_2.json +1183 -0
- package/abis/Registry.json +1636 -0
- package/abis/ReputationSystem.json +477 -0
- package/abis/SenderCreator.json +99 -0
- package/abis/Simple7702Account.json +395 -0
- package/abis/SimpleAccount.json +625 -0
- package/abis/SimpleAccountFactory.json +108 -0
- package/abis/SimpleAccountFactoryV08.json +87 -0
- package/abis/SimpleAccountV08.json +557 -0
- package/abis/SuperPaymaster.json +1399 -0
- package/abis/UserOperationLib.json +57 -0
- package/abis/aPNTs.json +1173 -0
- package/abis/xPNTsFactory.json +728 -0
- package/abis/xPNTsToken.json +1173 -0
- package/config/networks/README.md +54 -0
- package/config/networks/mainnet.env.example +39 -0
- package/config/networks/optimism-sepolia.env.example +35 -0
- package/config/networks/optimism.env.example +36 -0
- package/config/networks/sepolia.env.example +36 -0
- package/data/experiment_data.csv +36 -0
- package/data/industry_baseline_2025-12-23.json +154 -0
- package/data/industry_baseline_latest.json +154 -0
- package/docs/API_REFERENCE.md +796 -0
- package/docs/DAO_Mining_Distribution_Plan.md +522 -0
- package/docs/DOCUMENTATION_PLAN.md +455 -0
- package/docs/Plan.md +266 -0
- package/docs/Regression_Testing_Guide.md +70 -0
- package/docs/SDK_Optimization_Evaluation_Plan.md +51 -0
- package/docs/SEPOLIA_ENV_REFERENCE.md +51 -0
- package/docs/STAGE_3_SCENARIO_EXP_PLAN.md +77 -0
- package/docs/Script_Comparison_Report.md +91 -0
- package/docs/Sepolia_Latest_Deployment.md +117 -0
- package/docs/TEST_COVERAGE_MATRIX.md +72 -0
- package/docs/TODO_SDK_COVERAGE.md +55 -0
- package/docs/USER_CASE_DESIGN.md +110 -0
- package/docs/api/@aastar/account/README.md +15 -0
- package/docs/api/@aastar/account/classes/UserOpClient.md +87 -0
- package/docs/api/@aastar/account/functions/createEOAWalletClient.md +21 -0
- package/docs/api/@aastar/account/functions/getUserOpHash.md +23 -0
- package/docs/api/@aastar/account/functions/packUserOpLimits.md +19 -0
- package/docs/api/@aastar/account/functions/toSimpleSmartAccount.md +83 -0
- package/docs/api/@aastar/account/type-aliases/EOAWalletClient.md +37 -0
- package/docs/api/@aastar/account/type-aliases/SimpleSmartAccount.md +39 -0
- package/docs/api/@aastar/core/README.md +136 -0
- package/docs/api/@aastar/core/classes/BLSSigner.md +147 -0
- package/docs/api/@aastar/core/enumerations/NodeType.md +33 -0
- package/docs/api/@aastar/core/functions/aggregatorActions.md +2714 -0
- package/docs/api/@aastar/core/functions/createAAStarPublicClient.md +3105 -0
- package/docs/api/@aastar/core/functions/dvtActions.md +2714 -0
- package/docs/api/@aastar/core/functions/factoryActions.md +2714 -0
- package/docs/api/@aastar/core/functions/getAddressUrl.md +32 -0
- package/docs/api/@aastar/core/functions/getAllCommunityConfigs.md +9 -0
- package/docs/api/@aastar/core/functions/getAllV2Contracts.md +20 -0
- package/docs/api/@aastar/core/functions/getBlockExplorer.md +26 -0
- package/docs/api/@aastar/core/functions/getChainId.md +26 -0
- package/docs/api/@aastar/core/functions/getCommunities.md +76 -0
- package/docs/api/@aastar/core/functions/getCommunity.md +32 -0
- package/docs/api/@aastar/core/functions/getCommunityConfig.md +15 -0
- package/docs/api/@aastar/core/functions/getContract.md +37 -0
- package/docs/api/@aastar/core/functions/getContractNetworks.md +18 -0
- package/docs/api/@aastar/core/functions/getContracts.md +178 -0
- package/docs/api/@aastar/core/functions/getCoreContracts.md +55 -0
- package/docs/api/@aastar/core/functions/getDeploymentDate.md +32 -0
- package/docs/api/@aastar/core/functions/getEntryPoint.md +25 -0
- package/docs/api/@aastar/core/functions/getNetwork.md +26 -0
- package/docs/api/@aastar/core/functions/getPaymasterV4_1.md +25 -0
- package/docs/api/@aastar/core/functions/getRpcUrl.md +25 -0
- package/docs/api/@aastar/core/functions/getSimpleAccountFactory.md +25 -0
- package/docs/api/@aastar/core/functions/getSuperPaymasterV2.md +25 -0
- package/docs/api/@aastar/core/functions/getTestAccounts.md +30 -0
- package/docs/api/@aastar/core/functions/getTestTokenContracts.md +38 -0
- package/docs/api/@aastar/core/functions/getTokenContracts.md +31 -0
- package/docs/api/@aastar/core/functions/getTxUrl.md +32 -0
- package/docs/api/@aastar/core/functions/getV2ContractByAddress.md +28 -0
- package/docs/api/@aastar/core/functions/getV2ContractByName.md +28 -0
- package/docs/api/@aastar/core/functions/getV2ContractsByDate.md +26 -0
- package/docs/api/@aastar/core/functions/isContractNetworkSupported.md +27 -0
- package/docs/api/@aastar/core/functions/isRegisteredCommunity.md +15 -0
- package/docs/api/@aastar/core/functions/isV2Contract.md +27 -0
- package/docs/api/@aastar/core/functions/paymasterV4Actions.md +2719 -0
- package/docs/api/@aastar/core/functions/registryActions.md +2720 -0
- package/docs/api/@aastar/core/functions/reputationActions.md +2720 -0
- package/docs/api/@aastar/core/functions/sbtActions.md +2720 -0
- package/docs/api/@aastar/core/functions/stakingActions.md +2720 -0
- package/docs/api/@aastar/core/functions/superPaymasterActions.md +2720 -0
- package/docs/api/@aastar/core/functions/tokenActions.md +2714 -0
- package/docs/api/@aastar/core/interfaces/CommunityConfig.md +81 -0
- package/docs/api/@aastar/core/interfaces/ContractVersion.md +63 -0
- package/docs/api/@aastar/core/type-aliases/AggregatorActions.md +79 -0
- package/docs/api/@aastar/core/type-aliases/ContractCategory.md +5 -0
- package/docs/api/@aastar/core/type-aliases/ContractNetwork.md +5 -0
- package/docs/api/@aastar/core/type-aliases/DVTActions.md +139 -0
- package/docs/api/@aastar/core/type-aliases/FactoryActions.md +99 -0
- package/docs/api/@aastar/core/type-aliases/NetworkContracts.md +5 -0
- package/docs/api/@aastar/core/type-aliases/PaymasterV4Actions.md +422 -0
- package/docs/api/@aastar/core/type-aliases/RegistryActions.md +263 -0
- package/docs/api/@aastar/core/type-aliases/ReputationActions.md +47 -0
- package/docs/api/@aastar/core/type-aliases/RoleConfig.md +83 -0
- package/docs/api/@aastar/core/type-aliases/SBTActions.md +203 -0
- package/docs/api/@aastar/core/type-aliases/StakingActions.md +179 -0
- package/docs/api/@aastar/core/type-aliases/SuperPaymasterActions.md +219 -0
- package/docs/api/@aastar/core/type-aliases/SupportedNetwork.md +3 -0
- package/docs/api/@aastar/core/type-aliases/TokenActions.md +151 -0
- package/docs/api/@aastar/core/variables/AASTAR_COMMUNITY.md +8 -0
- package/docs/api/@aastar/core/variables/ALL_ADDRESSES.md +71 -0
- package/docs/api/@aastar/core/variables/BLSAggregatorABI.md +3 -0
- package/docs/api/@aastar/core/variables/BLSHelpers.md +91 -0
- package/docs/api/@aastar/core/variables/BPS_DENOMINATOR.md +5 -0
- package/docs/api/@aastar/core/variables/BRANDING.md +67 -0
- package/docs/api/@aastar/core/variables/BREAD_COMMUNITY.md +8 -0
- package/docs/api/@aastar/core/variables/COMMUNITIES.md +5 -0
- package/docs/api/@aastar/core/variables/COMMUNITY_OWNERS.md +15 -0
- package/docs/api/@aastar/core/variables/CONTRACTS.md +163 -0
- package/docs/api/@aastar/core/variables/CONTRACT_METADATA.md +67 -0
- package/docs/api/@aastar/core/variables/CORE_ADDRESSES.md +35 -0
- package/docs/api/@aastar/core/variables/DEFAULT_APNTS_PRICE_USD.md +5 -0
- package/docs/api/@aastar/core/variables/DEFAULT_GAS_TOKEN_MINT_AMOUNT.md +5 -0
- package/docs/api/@aastar/core/variables/DEFAULT_USDT_MINT_AMOUNT.md +5 -0
- package/docs/api/@aastar/core/variables/DVTValidatorABI.md +3 -0
- package/docs/api/@aastar/core/variables/EntryPointABI.md +3 -0
- package/docs/api/@aastar/core/variables/FAUCET_API_URL.md +5 -0
- package/docs/api/@aastar/core/variables/GTokenABI.md +3 -0
- package/docs/api/@aastar/core/variables/GTokenStakingABI.md +3 -0
- package/docs/api/@aastar/core/variables/LINKS.md +33 -0
- package/docs/api/@aastar/core/variables/MAX_SERVICE_FEE.md +5 -0
- package/docs/api/@aastar/core/variables/MONITORING_ADDRESSES.md +15 -0
- package/docs/api/@aastar/core/variables/MySBTABI.md +3 -0
- package/docs/api/@aastar/core/variables/NETWORKS.md +79 -0
- package/docs/api/@aastar/core/variables/NODE_STAKE_AMOUNTS.md +31 -0
- package/docs/api/@aastar/core/variables/OFFICIAL_ADDRESSES.md +11 -0
- package/docs/api/@aastar/core/variables/PAYMASTER_ADDRESSES.md +15 -0
- package/docs/api/@aastar/core/variables/PaymasterABI.md +3 -0
- package/docs/api/@aastar/core/variables/PaymasterFactoryABI.md +3 -0
- package/docs/api/@aastar/core/variables/PaymasterV4ABI.md +3 -0
- package/docs/api/@aastar/core/variables/ROLE_ANODE.md +3 -0
- package/docs/api/@aastar/core/variables/ROLE_COMMUNITY.md +3 -0
- package/docs/api/@aastar/core/variables/ROLE_ENDUSER.md +5 -0
- package/docs/api/@aastar/core/variables/ROLE_KMS.md +3 -0
- package/docs/api/@aastar/core/variables/ROLE_PAYMASTER_AOA.md +3 -0
- package/docs/api/@aastar/core/variables/ROLE_PAYMASTER_SUPER.md +3 -0
- package/docs/api/@aastar/core/variables/RegistryABI.md +3 -0
- package/docs/api/@aastar/core/variables/ReputationSystemABI.md +3 -0
- package/docs/api/@aastar/core/variables/ReputationSystemV3ABI.md +3 -0
- package/docs/api/@aastar/core/variables/SEPOLIA_CONTRACTS.md +159 -0
- package/docs/api/@aastar/core/variables/SEPOLIA_V2_VERSIONS.md +67 -0
- package/docs/api/@aastar/core/variables/SERVICE_FEE_RATE.md +5 -0
- package/docs/api/@aastar/core/variables/Simple7702AccountABI.md +3 -0
- package/docs/api/@aastar/core/variables/SimpleAccountABI.md +3 -0
- package/docs/api/@aastar/core/variables/SimpleAccountFactoryABI.md +3 -0
- package/docs/api/@aastar/core/variables/SimpleAccountFactoryV08ABI.md +3 -0
- package/docs/api/@aastar/core/variables/SimpleAccountV08ABI.md +3 -0
- package/docs/api/@aastar/core/variables/SuperPaymasterABI.md +3 -0
- package/docs/api/@aastar/core/variables/SuperPaymasterV3ABI.md +3 -0
- package/docs/api/@aastar/core/variables/TEST_ACCOUNT_ADDRESSES.md +11 -0
- package/docs/api/@aastar/core/variables/TEST_ACCOUNT_POOL_SIZE.md +5 -0
- package/docs/api/@aastar/core/variables/TEST_COMMUNITIES.md +19 -0
- package/docs/api/@aastar/core/variables/TEST_TOKEN_ADDRESSES.md +19 -0
- package/docs/api/@aastar/core/variables/TOKEN_ADDRESSES.md +11 -0
- package/docs/api/@aastar/core/variables/V2_SUMMARY.md +39 -0
- package/docs/api/@aastar/core/variables/xPNTsFactoryABI.md +3 -0
- package/docs/api/@aastar/core/variables/xPNTsTokenABI.md +3 -0
- package/docs/api/@aastar/paymaster/README.md +14 -0
- package/docs/api/@aastar/paymaster/classes/SuperPaymasterClient.md +163 -0
- package/docs/api/@aastar/paymaster/functions/checkEligibility.md +28 -0
- package/docs/api/@aastar/paymaster/functions/getPaymasterV4Middleware.md +32 -0
- package/docs/api/@aastar/paymaster/functions/getSuperPaymasterMiddleware.md +32 -0
- package/docs/api/@aastar/paymaster/type-aliases/PaymasterConfig.md +35 -0
- package/docs/api/@aastar/paymaster/type-aliases/PaymasterV4MiddlewareConfig.md +35 -0
- package/docs/api/@aastar/tokens/README.md +3 -0
- package/docs/api/@aastar/tokens/classes/FinanceClient.md +8653 -0
- package/docs/api/README.md +6 -0
- package/docs/examples/community-flow.md +28 -0
- package/docs/examples/enduser-flow.md +24 -0
- package/docs/examples/index.md +18 -0
- package/docs/examples/multi-chain.md +31 -0
- package/docs/examples/operator-flow.md +28 -0
- package/docs/guide/CLI_GUIDE.md +65 -0
- package/docs/guide/DOCUMENTATION_PLAN.md +455 -0
- package/docs/guide/Security-solution.md +106 -0
- package/docs/guide/TEST_COMMANDS.md +320 -0
- package/docs/guide/getting-started.md +133 -0
- package/docs/guide/installation.md +40 -0
- package/docs/guide/paper-data-collection.md +69 -0
- package/docs/guide/quick-start.md +52 -0
- package/docs/guide/task_breakdown.md +121 -0
- package/docs/old-solution.md +1078 -0
- package/docs/paper-data-collection.md +69 -0
- package/docs/technical_plan.md +510 -0
- package/docs/zh/examples/community-flow.md +38 -0
- package/docs/zh/examples/complete-workflow.md +10 -0
- package/docs/zh/examples/enduser-flow.md +33 -0
- package/docs/zh/examples/index.md +18 -0
- package/docs/zh/examples/multi-chain.md +46 -0
- package/docs/zh/examples/operator-flow.md +37 -0
- package/docs/zh/guide/CLI_GUIDE.md +48 -0
- package/docs/zh/guide/DOCUMENTATION_PLAN.md +455 -0
- package/docs/zh/guide/Plan.md +266 -0
- package/docs/zh/guide/SDK_Optimization_Evaluation_Plan.md +51 -0
- package/docs/zh/guide/Security-solution.md +106 -0
- package/docs/zh/guide/TEST_COMMANDS.md +125 -0
- package/docs/zh/guide/TEST_COVERAGE_MATRIX.md +72 -0
- package/docs/zh/guide/concepts/account-abstraction.md +95 -0
- package/docs/zh/guide/concepts/rainbow-bridge.md +68 -0
- package/docs/zh/guide/concepts/reputation.md +95 -0
- package/docs/zh/guide/concepts/superpaymaster.md +141 -0
- package/docs/zh/guide/getting-started.md +133 -0
- package/docs/zh/guide/installation.md +107 -0
- package/docs/zh/guide/old-solution.md +1078 -0
- package/docs/zh/guide/paper-data-collection.md +69 -0
- package/docs/zh/guide/quick-start.md +134 -0
- package/docs/zh/guide/sdk-readme.md +253 -0
- package/docs/zh/guide/task_breakdown.md +76 -0
- package/docs/zh/guide/technical_plan.md +510 -0
- package/docs/zh/guide/use-cases/community-management.md +141 -0
- package/docs/zh/guide/use-cases/gasless-transactions.md +71 -0
- package/docs/zh/guide/use-cases/operator-staking.md +84 -0
- package/docs/zh/guide/use-cases/yop.md +72 -0
- package/examples/sdk-demo/DEVELOPER_GUIDE.md +159 -0
- package/examples/sdk-demo/README.md +30 -0
- package/examples/sdk-demo/usage.ts +137 -0
- package/ext/aastar-shared-config/.env.example +6 -0
- package/ext/aastar-shared-config/.github/workflows/check-secrets.yml +257 -0
- package/ext/aastar-shared-config/AGENTS.md +21 -0
- package/ext/aastar-shared-config/CHANGELOG.md +99 -0
- package/ext/aastar-shared-config/LICENSE +21 -0
- package/ext/aastar-shared-config/QUICK_START.md +215 -0
- package/ext/aastar-shared-config/README.md +412 -0
- package/ext/aastar-shared-config/SHARED_CONFIG_SUMMARY.md +273 -0
- package/ext/aastar-shared-config/check-locker-status.mjs +7 -0
- package/ext/aastar-shared-config/favicon.ico +0 -0
- package/ext/aastar-shared-config/generate-comparison-table.sh +67 -0
- package/ext/aastar-shared-config/package.json +46 -0
- package/ext/aastar-shared-config/pnpm-lock.yaml +1182 -0
- package/ext/aastar-shared-config/src/abis/BLSAggregator.json +1 -0
- package/ext/aastar-shared-config/src/abis/DVTValidator.json +1 -0
- package/ext/aastar-shared-config/src/abis/GToken.json +1 -0
- package/ext/aastar-shared-config/src/abis/GTokenStaking.json +1 -0
- package/ext/aastar-shared-config/src/abis/MySBT.json +1 -0
- package/ext/aastar-shared-config/src/abis/PaymasterFactory.json +1 -0
- package/ext/aastar-shared-config/src/abis/PaymasterV4.json +1098 -0
- package/ext/aastar-shared-config/src/abis/Registry.json +1 -0
- package/ext/aastar-shared-config/src/abis/SimpleAccount.json +557 -0
- package/ext/aastar-shared-config/src/abis/SimpleAccountFactory.json +87 -0
- package/ext/aastar-shared-config/src/abis/SuperPaymasterV2.json +1 -0
- package/ext/aastar-shared-config/src/abis/index.ts +45 -0
- package/ext/aastar-shared-config/src/abis/xPNTsFactory.json +1 -0
- package/ext/aastar-shared-config/src/abis/xPNTsToken.json +1 -0
- package/ext/aastar-shared-config/src/branding.ts +32 -0
- package/ext/aastar-shared-config/src/communities.ts +93 -0
- package/ext/aastar-shared-config/src/constants.ts +67 -0
- package/ext/aastar-shared-config/src/contract-addresses.ts +95 -0
- package/ext/aastar-shared-config/src/contract-versions.ts +374 -0
- package/ext/aastar-shared-config/src/contracts.ts +414 -0
- package/ext/aastar-shared-config/src/index.ts +14 -0
- package/ext/aastar-shared-config/src/networks.ts +117 -0
- package/ext/aastar-shared-config/sync-abis.sh +92 -0
- package/ext/aastar-shared-config/sync-versions.mjs +150 -0
- package/ext/aastar-shared-config/tsconfig.json +18 -0
- package/ext/aastar-shared-config/tsup.config.ts +10 -0
- package/ext/aastar-shared-config/verify-all.sh +207 -0
- package/ext/aastar-shared-config/verify-contracts.sh +85 -0
- package/ext/aastar-shared-config/verify-mysbt-v243.mjs +27 -0
- package/ext/aastar-shared-config/verify-onchain-versions.mjs +93 -0
- package/ext/permissionless.js/.changeset/README.md +8 -0
- package/ext/permissionless.js/.changeset/config.json +11 -0
- package/ext/permissionless.js/.env-example +2 -0
- package/ext/permissionless.js/.github/actions/install-dependencies/action.yml +17 -0
- package/ext/permissionless.js/.github/dependabot.yaml +10 -0
- package/ext/permissionless.js/.github/workflows/canary.yml +49 -0
- package/ext/permissionless.js/.github/workflows/on-pull-request.yml +61 -0
- package/ext/permissionless.js/.github/workflows/on-push-to-main.yml +59 -0
- package/ext/permissionless.js/.github/workflows/prune-tags.yml +92 -0
- package/ext/permissionless.js/.github/workflows/verify.yml +114 -0
- package/ext/permissionless.js/.size-limit.json +13 -0
- package/ext/permissionless.js/LICENSE +21 -0
- package/ext/permissionless.js/assets/banner.png +0 -0
- package/ext/permissionless.js/biome.json +46 -0
- package/ext/permissionless.js/bun.lock +2340 -0
- package/ext/permissionless.js/bun.lockb +0 -0
- package/ext/permissionless.js/package.json +82 -0
- package/ext/permissionless.js/packages/mock-paymaster/CHANGELOG.md +31 -0
- package/ext/permissionless.js/packages/mock-paymaster/constants.ts +84 -0
- package/ext/permissionless.js/packages/mock-paymaster/helpers/abi.ts +1048 -0
- package/ext/permissionless.js/packages/mock-paymaster/helpers/erc20-utils.ts +105 -0
- package/ext/permissionless.js/packages/mock-paymaster/helpers/schema.ts +307 -0
- package/ext/permissionless.js/packages/mock-paymaster/helpers/utils.ts +78 -0
- package/ext/permissionless.js/packages/mock-paymaster/index.ts +63 -0
- package/ext/permissionless.js/packages/mock-paymaster/package.json +33 -0
- package/ext/permissionless.js/packages/mock-paymaster/relay.ts +424 -0
- package/ext/permissionless.js/packages/mock-paymaster/setup.ts +163 -0
- package/ext/permissionless.js/packages/mock-paymaster/singletonPaymasters.ts +230 -0
- package/ext/permissionless.js/packages/permissionless/CHANGELOG.md +893 -0
- package/ext/permissionless.js/packages/permissionless/README.md +122 -0
- package/ext/permissionless.js/packages/permissionless/accounts/biconomy/abi/BiconomySmartAccountAbi.ts +128 -0
- package/ext/permissionless.js/packages/permissionless/accounts/biconomy/toBiconomySmartAccount.ts +374 -0
- package/ext/permissionless.js/packages/permissionless/accounts/decodeCalls.test.ts +505 -0
- package/ext/permissionless.js/packages/permissionless/accounts/etherspot/abi/EtherspotBootstrapAbi.ts +94 -0
- package/ext/permissionless.js/packages/permissionless/accounts/etherspot/constants.ts +27 -0
- package/ext/permissionless.js/packages/permissionless/accounts/etherspot/toEtherspotSmartAccount.ts +369 -0
- package/ext/permissionless.js/packages/permissionless/accounts/etherspot/utils/getInitMSAData.ts +56 -0
- package/ext/permissionless.js/packages/permissionless/accounts/etherspot/utils/getNonceKey.ts +21 -0
- package/ext/permissionless.js/packages/permissionless/accounts/etherspot/utils/wrapMessageHash.ts +43 -0
- package/ext/permissionless.js/packages/permissionless/accounts/index.ts +86 -0
- package/ext/permissionless.js/packages/permissionless/accounts/kernel/abi/KernelAccountAbi.ts +87 -0
- package/ext/permissionless.js/packages/permissionless/accounts/kernel/abi/KernelV3AccountAbi.ts +813 -0
- package/ext/permissionless.js/packages/permissionless/accounts/kernel/abi/KernelV3FactoryAbi.ts +12 -0
- package/ext/permissionless.js/packages/permissionless/accounts/kernel/abi/KernelV3MetaFactoryAbi.ts +17 -0
- package/ext/permissionless.js/packages/permissionless/accounts/kernel/constants.ts +14 -0
- package/ext/permissionless.js/packages/permissionless/accounts/kernel/to7702KernelSmartAccount.ts +63 -0
- package/ext/permissionless.js/packages/permissionless/accounts/kernel/toEcdsaKernelSmartAccount.ts +62 -0
- package/ext/permissionless.js/packages/permissionless/accounts/kernel/toKernelSmartAccount.ts +984 -0
- package/ext/permissionless.js/packages/permissionless/accounts/kernel/utils/decodeCallData.ts +43 -0
- package/ext/permissionless.js/packages/permissionless/accounts/kernel/utils/encodeCallData.ts +57 -0
- package/ext/permissionless.js/packages/permissionless/accounts/kernel/utils/getNonceKey.ts +33 -0
- package/ext/permissionless.js/packages/permissionless/accounts/kernel/utils/isKernelV2.ts +6 -0
- package/ext/permissionless.js/packages/permissionless/accounts/kernel/utils/isWebAuthnAccount.ts +8 -0
- package/ext/permissionless.js/packages/permissionless/accounts/kernel/utils/signMessage.ts +115 -0
- package/ext/permissionless.js/packages/permissionless/accounts/kernel/utils/signTypedData.ts +97 -0
- package/ext/permissionless.js/packages/permissionless/accounts/kernel/utils/wrapMessageHash.ts +44 -0
- package/ext/permissionless.js/packages/permissionless/accounts/light/toLightSmartAccount.ts +496 -0
- package/ext/permissionless.js/packages/permissionless/accounts/nexus/toNexusSmartAccount.ts +351 -0
- package/ext/permissionless.js/packages/permissionless/accounts/safe/index.ts +14 -0
- package/ext/permissionless.js/packages/permissionless/accounts/safe/signUserOperation.test.ts +275 -0
- package/ext/permissionless.js/packages/permissionless/accounts/safe/signUserOperation.ts +316 -0
- package/ext/permissionless.js/packages/permissionless/accounts/safe/toSafeSmartAccount.ts +1980 -0
- package/ext/permissionless.js/packages/permissionless/accounts/simple/to7702SimpleSmartAccount.ts +51 -0
- package/ext/permissionless.js/packages/permissionless/accounts/simple/toSimpleSmartAccount.ts +585 -0
- package/ext/permissionless.js/packages/permissionless/accounts/thirdweb/toThirdwebSmartAccount.ts +221 -0
- package/ext/permissionless.js/packages/permissionless/accounts/thirdweb/utils/decodeCallData.ts +87 -0
- package/ext/permissionless.js/packages/permissionless/accounts/thirdweb/utils/encodeCallData.ts +81 -0
- package/ext/permissionless.js/packages/permissionless/accounts/thirdweb/utils/getAccountAddress.ts +48 -0
- package/ext/permissionless.js/packages/permissionless/accounts/thirdweb/utils/getFactoryData.ts +40 -0
- package/ext/permissionless.js/packages/permissionless/accounts/thirdweb/utils/signMessage.ts +33 -0
- package/ext/permissionless.js/packages/permissionless/accounts/thirdweb/utils/signTypedData.ts +67 -0
- package/ext/permissionless.js/packages/permissionless/accounts/trust/toTrustSmartAccount.ts +232 -0
- package/ext/permissionless.js/packages/permissionless/accounts/trust/utils/decodeCallData.ts +87 -0
- package/ext/permissionless.js/packages/permissionless/accounts/trust/utils/encodeCallData.ts +81 -0
- package/ext/permissionless.js/packages/permissionless/accounts/trust/utils/getFactoryData.ts +51 -0
- package/ext/permissionless.js/packages/permissionless/actions/erc7579/accountId.test.ts +39 -0
- package/ext/permissionless.js/packages/permissionless/actions/erc7579/accountId.ts +93 -0
- package/ext/permissionless.js/packages/permissionless/actions/erc7579/installModule.test.ts +216 -0
- package/ext/permissionless.js/packages/permissionless/actions/erc7579/installModule.ts +99 -0
- package/ext/permissionless.js/packages/permissionless/actions/erc7579/installModules.test.ts +237 -0
- package/ext/permissionless.js/packages/permissionless/actions/erc7579/installModules.ts +96 -0
- package/ext/permissionless.js/packages/permissionless/actions/erc7579/isModuleInstalled.test.ts +72 -0
- package/ext/permissionless.js/packages/permissionless/actions/erc7579/isModuleInstalled.ts +132 -0
- package/ext/permissionless.js/packages/permissionless/actions/erc7579/supportsExecutionMode.test.ts +108 -0
- package/ext/permissionless.js/packages/permissionless/actions/erc7579/supportsExecutionMode.ts +158 -0
- package/ext/permissionless.js/packages/permissionless/actions/erc7579/supportsModule.test.ts +35 -0
- package/ext/permissionless.js/packages/permissionless/actions/erc7579/supportsModule.ts +120 -0
- package/ext/permissionless.js/packages/permissionless/actions/erc7579/uninstallModule.test.ts +129 -0
- package/ext/permissionless.js/packages/permissionless/actions/erc7579/uninstallModule.ts +98 -0
- package/ext/permissionless.js/packages/permissionless/actions/erc7579/uninstallModules.test.ts +117 -0
- package/ext/permissionless.js/packages/permissionless/actions/erc7579/uninstallModules.ts +87 -0
- package/ext/permissionless.js/packages/permissionless/actions/erc7579.ts +103 -0
- package/ext/permissionless.js/packages/permissionless/actions/etherspot/getUserOperationGasPrice.ts +32 -0
- package/ext/permissionless.js/packages/permissionless/actions/etherspot.ts +4 -0
- package/ext/permissionless.js/packages/permissionless/actions/index.ts +9 -0
- package/ext/permissionless.js/packages/permissionless/actions/package.json +6 -0
- package/ext/permissionless.js/packages/permissionless/actions/passkeyServer/getCredentials.ts +47 -0
- package/ext/permissionless.js/packages/permissionless/actions/passkeyServer/startAuthentication.ts +39 -0
- package/ext/permissionless.js/packages/permissionless/actions/passkeyServer/startRegistration.ts +126 -0
- package/ext/permissionless.js/packages/permissionless/actions/passkeyServer/verifyAuthentication.ts +142 -0
- package/ext/permissionless.js/packages/permissionless/actions/passkeyServer/verifyRegistration.ts +132 -0
- package/ext/permissionless.js/packages/permissionless/actions/passkeyServer.ts +17 -0
- package/ext/permissionless.js/packages/permissionless/actions/pimlico/estimateErc20PaymasterCost.ts +102 -0
- package/ext/permissionless.js/packages/permissionless/actions/pimlico/getTokenQuotes.test.ts +90 -0
- package/ext/permissionless.js/packages/permissionless/actions/pimlico/getTokenQuotes.ts +77 -0
- package/ext/permissionless.js/packages/permissionless/actions/pimlico/getUserOperationGasPrice.test.ts +82 -0
- package/ext/permissionless.js/packages/permissionless/actions/pimlico/getUserOperationGasPrice.ts +67 -0
- package/ext/permissionless.js/packages/permissionless/actions/pimlico/getUserOperationStatus.test.ts +199 -0
- package/ext/permissionless.js/packages/permissionless/actions/pimlico/getUserOperationStatus.ts +49 -0
- package/ext/permissionless.js/packages/permissionless/actions/pimlico/sendCompressedUserOperation.ts +59 -0
- package/ext/permissionless.js/packages/permissionless/actions/pimlico/sponsorUserOperation.test.ts +236 -0
- package/ext/permissionless.js/packages/permissionless/actions/pimlico/sponsorUserOperation.ts +151 -0
- package/ext/permissionless.js/packages/permissionless/actions/pimlico/validateSponsorshipPolicies.test.ts +153 -0
- package/ext/permissionless.js/packages/permissionless/actions/pimlico/validateSponsorshipPolicies.ts +74 -0
- package/ext/permissionless.js/packages/permissionless/actions/pimlico.ts +38 -0
- package/ext/permissionless.js/packages/permissionless/actions/public/getAccountNonce.test.ts +96 -0
- package/ext/permissionless.js/packages/permissionless/actions/public/getAccountNonce.ts +75 -0
- package/ext/permissionless.js/packages/permissionless/actions/public/getSenderAddress.test.ts +154 -0
- package/ext/permissionless.js/packages/permissionless/actions/public/getSenderAddress.ts +129 -0
- package/ext/permissionless.js/packages/permissionless/actions/smartAccount/getCallsStatus.test.ts +255 -0
- package/ext/permissionless.js/packages/permissionless/actions/smartAccount/getCallsStatus.ts +91 -0
- package/ext/permissionless.js/packages/permissionless/actions/smartAccount/sendCalls.test.ts +571 -0
- package/ext/permissionless.js/packages/permissionless/actions/smartAccount/sendCalls.ts +38 -0
- package/ext/permissionless.js/packages/permissionless/actions/smartAccount/sendTransaction.test.ts +416 -0
- package/ext/permissionless.js/packages/permissionless/actions/smartAccount/sendTransaction.ts +133 -0
- package/ext/permissionless.js/packages/permissionless/actions/smartAccount/signMessage.test.ts +219 -0
- package/ext/permissionless.js/packages/permissionless/actions/smartAccount/signMessage.ts +73 -0
- package/ext/permissionless.js/packages/permissionless/actions/smartAccount/signTypedData.test.ts +228 -0
- package/ext/permissionless.js/packages/permissionless/actions/smartAccount/signTypedData.ts +157 -0
- package/ext/permissionless.js/packages/permissionless/actions/smartAccount/writeContract.ts +70 -0
- package/ext/permissionless.js/packages/permissionless/actions/smartAccount.ts +7 -0
- package/ext/permissionless.js/packages/permissionless/clients/createSmartAccountClient.ts +181 -0
- package/ext/permissionless.js/packages/permissionless/clients/decorators/passkeyServer.ts +57 -0
- package/ext/permissionless.js/packages/permissionless/clients/decorators/pimlico.ts +189 -0
- package/ext/permissionless.js/packages/permissionless/clients/decorators/smartAccount.ts +350 -0
- package/ext/permissionless.js/packages/permissionless/clients/index.ts +2 -0
- package/ext/permissionless.js/packages/permissionless/clients/passkeyServer.ts +69 -0
- package/ext/permissionless.js/packages/permissionless/clients/pimlico.ts +124 -0
- package/ext/permissionless.js/packages/permissionless/errors/index.ts +17 -0
- package/ext/permissionless.js/packages/permissionless/experimental/pimlico/index.ts +1 -0
- package/ext/permissionless.js/packages/permissionless/experimental/pimlico/utils/prepareUserOperationForErc20Paymaster.test.ts +523 -0
- package/ext/permissionless.js/packages/permissionless/experimental/pimlico/utils/prepareUserOperationForErc20Paymaster.ts +369 -0
- package/ext/permissionless.js/packages/permissionless/index.ts +3 -0
- package/ext/permissionless.js/packages/permissionless/package.json +102 -0
- package/ext/permissionless.js/packages/permissionless/types/etherspot.ts +12 -0
- package/ext/permissionless.js/packages/permissionless/types/package.json +6 -0
- package/ext/permissionless.js/packages/permissionless/types/passkeyServer.ts +125 -0
- package/ext/permissionless.js/packages/permissionless/types/pimlico.ts +151 -0
- package/ext/permissionless.js/packages/permissionless/utils/decode7579Calls.ts +133 -0
- package/ext/permissionless.js/packages/permissionless/utils/decodeNonce.test.ts +40 -0
- package/ext/permissionless.js/packages/permissionless/utils/decodeNonce.ts +10 -0
- package/ext/permissionless.js/packages/permissionless/utils/deepHexlify.test.ts +57 -0
- package/ext/permissionless.js/packages/permissionless/utils/deepHexlify.ts +35 -0
- package/ext/permissionless.js/packages/permissionless/utils/encode7579Calls.test.ts +69 -0
- package/ext/permissionless.js/packages/permissionless/utils/encode7579Calls.ts +114 -0
- package/ext/permissionless.js/packages/permissionless/utils/encodeInstallModule.ts +91 -0
- package/ext/permissionless.js/packages/permissionless/utils/encodeNonce.test.ts +38 -0
- package/ext/permissionless.js/packages/permissionless/utils/encodeNonce.ts +8 -0
- package/ext/permissionless.js/packages/permissionless/utils/encodeUninstallModule.ts +88 -0
- package/ext/permissionless.js/packages/permissionless/utils/erc20AllowanceOverride.test.ts +59 -0
- package/ext/permissionless.js/packages/permissionless/utils/erc20AllowanceOverride.ts +66 -0
- package/ext/permissionless.js/packages/permissionless/utils/erc20BalanceOverride.test.ts +57 -0
- package/ext/permissionless.js/packages/permissionless/utils/erc20BalanceOverride.ts +49 -0
- package/ext/permissionless.js/packages/permissionless/utils/getAddressFromInitCodeOrPaymasterAndData.test.ts +31 -0
- package/ext/permissionless.js/packages/permissionless/utils/getAddressFromInitCodeOrPaymasterAndData.ts +13 -0
- package/ext/permissionless.js/packages/permissionless/utils/getEstimationCallData.ts +297 -0
- package/ext/permissionless.js/packages/permissionless/utils/getPackedUserOperation.test.ts +204 -0
- package/ext/permissionless.js/packages/permissionless/utils/getPackedUserOperation.ts +122 -0
- package/ext/permissionless.js/packages/permissionless/utils/getRequiredPrefund.test.ts +90 -0
- package/ext/permissionless.js/packages/permissionless/utils/getRequiredPrefund.ts +56 -0
- package/ext/permissionless.js/packages/permissionless/utils/index.ts +43 -0
- package/ext/permissionless.js/packages/permissionless/utils/isSmartAccountDeployed.ts +13 -0
- package/ext/permissionless.js/packages/permissionless/utils/ox.ts +48 -0
- package/ext/permissionless.js/packages/permissionless/utils/toOwner.ts +89 -0
- package/ext/permissionless.js/packages/permissionless/vitest.config.ts +31 -0
- package/ext/permissionless.js/packages/permissionless-test/mock-aa-infra/alto/constants/accounts/biconomy.ts +22 -0
- package/ext/permissionless.js/packages/permissionless-test/mock-aa-infra/alto/constants/accounts/etherspot.ts +12 -0
- package/ext/permissionless.js/packages/permissionless-test/mock-aa-infra/alto/constants/accounts/kernel.ts +63 -0
- package/ext/permissionless.js/packages/permissionless-test/mock-aa-infra/alto/constants/accounts/light.ts +10 -0
- package/ext/permissionless.js/packages/permissionless-test/mock-aa-infra/alto/constants/accounts/nexus.ts +16 -0
- package/ext/permissionless.js/packages/permissionless-test/mock-aa-infra/alto/constants/accounts/safe.ts +75 -0
- package/ext/permissionless.js/packages/permissionless-test/mock-aa-infra/alto/constants/accounts/simple.ts +16 -0
- package/ext/permissionless.js/packages/permissionless-test/mock-aa-infra/alto/constants/accounts/thirdweb.ts +7 -0
- package/ext/permissionless.js/packages/permissionless-test/mock-aa-infra/alto/constants/accounts/trust.ts +26 -0
- package/ext/permissionless.js/packages/permissionless-test/mock-aa-infra/alto/constants/core.ts +24 -0
- package/ext/permissionless.js/packages/permissionless-test/mock-aa-infra/alto/constants/index.ts +10 -0
- package/ext/permissionless.js/packages/permissionless-test/mock-aa-infra/alto/index.ts +783 -0
- package/ext/permissionless.js/packages/permissionless-test/mock-aa-infra/alto/instance.ts +290 -0
- package/ext/permissionless.js/packages/permissionless-test/src/testWithRpc.ts +128 -0
- package/ext/permissionless.js/packages/permissionless-test/src/types.ts +12 -0
- package/ext/permissionless.js/packages/permissionless-test/src/utils.ts +1091 -0
- package/ext/permissionless.js/packages/wagmi/CHANGELOG.md +53 -0
- package/ext/permissionless.js/packages/wagmi/README.md +93 -0
- package/ext/permissionless.js/packages/wagmi/context.ts +22 -0
- package/ext/permissionless.js/packages/wagmi/hooks/useAvailableCapabilities.ts +43 -0
- package/ext/permissionless.js/packages/wagmi/hooks/useSendTransaction.ts +164 -0
- package/ext/permissionless.js/packages/wagmi/hooks/useWaitForTransactionReceipt.ts +427 -0
- package/ext/permissionless.js/packages/wagmi/index.ts +15 -0
- package/ext/permissionless.js/packages/wagmi/package.json +26 -0
- package/ext/permissionless.js/packages/wagmi/utils/observe.ts +76 -0
- package/ext/permissionless.js/packages/wagmi-demo/README.md +1 -0
- package/ext/permissionless.js/packages/wagmi-demo/biome.json +13 -0
- package/ext/permissionless.js/packages/wagmi-demo/index.html +12 -0
- package/ext/permissionless.js/packages/wagmi-demo/package.json +16 -0
- package/ext/permissionless.js/packages/wagmi-demo/src/App.tsx +98 -0
- package/ext/permissionless.js/packages/wagmi-demo/src/PasskeyServerDemo.tsx +286 -0
- package/ext/permissionless.js/packages/wagmi-demo/src/PasskeysDemo.tsx +457 -0
- package/ext/permissionless.js/packages/wagmi-demo/src/index.css +21 -0
- package/ext/permissionless.js/packages/wagmi-demo/src/main.tsx +275 -0
- package/ext/permissionless.js/packages/wagmi-demo/src/vite-env.d.ts +1 -0
- package/ext/permissionless.js/packages/wagmi-demo/src/wagmi.ts +33 -0
- package/ext/permissionless.js/packages/wagmi-demo/tsconfig.json +25 -0
- package/ext/permissionless.js/packages/wagmi-demo/tsconfig.node.json +12 -0
- package/ext/permissionless.js/packages/wagmi-demo/vite.config.ts +7 -0
- package/ext/permissionless.js/tsconfig/tsconfig.base.json +42 -0
- package/ext/permissionless.js/tsconfig/tsconfig.mock-paymaster.cjs.json +11 -0
- package/ext/permissionless.js/tsconfig/tsconfig.mock-paymaster.esm.json +9 -0
- package/ext/permissionless.js/tsconfig/tsconfig.mock-paymaster.json +17 -0
- package/ext/permissionless.js/tsconfig/tsconfig.mock-paymaster.types.json +13 -0
- package/ext/permissionless.js/tsconfig/tsconfig.permissionless.cjs.json +11 -0
- package/ext/permissionless.js/tsconfig/tsconfig.permissionless.esm.json +9 -0
- package/ext/permissionless.js/tsconfig/tsconfig.permissionless.json +18 -0
- package/ext/permissionless.js/tsconfig/tsconfig.permissionless.types.json +13 -0
- package/ext/permissionless.js/tsconfig/tsconfig.wagmi.esm.json +8 -0
- package/ext/permissionless.js/tsconfig/tsconfig.wagmi.json +19 -0
- package/ext/permissionless.js/tsconfig/tsconfig.wagmi.types.json +12 -0
- package/extract_abis.sh +140 -0
- package/extract_addresses_to_env.sh +67 -0
- package/final_safe_harmonize.py +77 -0
- package/lib/SHARED_CONFIG_REFERENCE.md +133 -0
- package/lib/shared-config/.env.example +6 -0
- package/lib/shared-config/.github/workflows/check-secrets.yml +257 -0
- package/lib/shared-config/AGENTS.md +21 -0
- package/lib/shared-config/CHANGELOG.md +99 -0
- package/lib/shared-config/LICENSE +21 -0
- package/lib/shared-config/QUICK_START.md +215 -0
- package/lib/shared-config/README.md +412 -0
- package/lib/shared-config/SHARED_CONFIG_SUMMARY.md +273 -0
- package/lib/shared-config/check-locker-status.mjs +7 -0
- package/lib/shared-config/favicon.ico +0 -0
- package/lib/shared-config/generate-comparison-table.sh +67 -0
- package/lib/shared-config/package.json +46 -0
- package/lib/shared-config/pnpm-lock.yaml +1182 -0
- package/lib/shared-config/src/abis/BLSAggregator.json +1 -0
- package/lib/shared-config/src/abis/DVTValidator.json +1 -0
- package/lib/shared-config/src/abis/GToken.json +1 -0
- package/lib/shared-config/src/abis/GTokenStaking.json +1 -0
- package/lib/shared-config/src/abis/MySBT.json +1 -0
- package/lib/shared-config/src/abis/PaymasterFactory.json +1 -0
- package/lib/shared-config/src/abis/PaymasterV4.json +1098 -0
- package/lib/shared-config/src/abis/Registry.json +1 -0
- package/lib/shared-config/src/abis/SimpleAccount.json +557 -0
- package/lib/shared-config/src/abis/SimpleAccountFactory.json +87 -0
- package/lib/shared-config/src/abis/SuperPaymasterV2.json +1 -0
- package/lib/shared-config/src/abis/index.ts +45 -0
- package/lib/shared-config/src/abis/xPNTsFactory.json +1 -0
- package/lib/shared-config/src/abis/xPNTsToken.json +1 -0
- package/lib/shared-config/src/branding.ts +32 -0
- package/lib/shared-config/src/communities.ts +93 -0
- package/lib/shared-config/src/constants.ts +67 -0
- package/lib/shared-config/src/contract-addresses.ts +95 -0
- package/lib/shared-config/src/contract-versions.ts +374 -0
- package/lib/shared-config/src/contracts.ts +414 -0
- package/lib/shared-config/src/index.ts +14 -0
- package/lib/shared-config/src/networks.ts +117 -0
- package/lib/shared-config/sync-abis.sh +92 -0
- package/lib/shared-config/sync-versions.mjs +150 -0
- package/lib/shared-config/tsconfig.json +18 -0
- package/lib/shared-config/tsup.config.ts +10 -0
- package/lib/shared-config/verify-all.sh +207 -0
- package/lib/shared-config/verify-contracts.sh +85 -0
- package/lib/shared-config/verify-mysbt-v243.mjs +27 -0
- package/lib/shared-config/verify-onchain-versions.mjs +93 -0
- package/package.json +53 -21
- package/packages/account/package.json +20 -0
- package/packages/account/src/accounts/simple.ts +84 -0
- package/packages/account/src/eoa.ts +31 -0
- package/packages/account/src/index.ts +61 -0
- package/packages/account/tsconfig.json +12 -0
- package/packages/analytics/package.json +21 -0
- package/packages/analytics/src/index.ts +145 -0
- package/packages/analytics/tsconfig.json +16 -0
- package/packages/community/package.json +22 -0
- package/packages/community/src/index.ts +306 -0
- package/packages/community/tsconfig.json +8 -0
- package/packages/core/package.json +22 -0
- package/packages/core/src/abis/BLSAggregator.json +572 -0
- package/packages/core/src/abis/BLSValidator.json +26 -0
- package/packages/core/src/abis/DVTValidator.json +370 -0
- package/packages/core/src/abis/Eip7702Support.json +24 -0
- package/packages/core/src/abis/EntryPoint.json +1379 -0
- package/packages/core/src/abis/GToken.json +523 -0
- package/packages/core/src/abis/GTokenStaking.json +931 -0
- package/packages/core/src/abis/LegacyAccount.json +625 -0
- package/packages/core/src/abis/MySBT.json +1586 -0
- package/packages/core/src/abis/Paymaster.json +1205 -0
- package/packages/core/src/abis/PaymasterFactory.json +650 -0
- package/packages/core/src/abis/PaymasterV4_2.json +1183 -0
- package/packages/core/src/abis/Registry.json +1636 -0
- package/packages/core/src/abis/ReputationSystem.json +477 -0
- package/packages/core/src/abis/SenderCreator.json +99 -0
- package/packages/core/src/abis/Simple7702Account.json +395 -0
- package/packages/core/src/abis/SimpleAccount.json +625 -0
- package/packages/core/src/abis/SimpleAccountFactory.json +108 -0
- package/packages/core/src/abis/SimpleAccountFactoryV08.json +87 -0
- package/packages/core/src/abis/SimpleAccountV08.json +557 -0
- package/packages/core/src/abis/SuperPaymaster.json +1399 -0
- package/packages/core/src/abis/UserOperationLib.json +57 -0
- package/packages/core/src/abis/aPNTs.json +1173 -0
- package/packages/core/src/abis/index.ts +68 -0
- package/packages/core/src/abis/xPNTsFactory.json +728 -0
- package/packages/core/src/abis/xPNTsToken.json +1173 -0
- package/packages/core/src/actions/aggregator.ts +41 -0
- package/packages/core/src/actions/dvt.ts +53 -0
- package/packages/core/src/actions/factory.ts +41 -0
- package/packages/core/src/actions/index.ts +10 -0
- package/packages/core/src/actions/paymasterV4.ts +263 -0
- package/packages/core/src/actions/registry.ts +120 -0
- package/packages/core/src/actions/reputation.ts +27 -0
- package/packages/core/src/actions/sbt.ts +97 -0
- package/packages/core/src/actions/staking.ts +79 -0
- package/packages/core/src/actions/superPaymaster.ts +117 -0
- package/packages/core/src/actions/tokens.ts +65 -0
- package/packages/core/src/branding.ts +32 -0
- package/packages/core/src/clients.ts +13 -0
- package/packages/core/src/communities.ts +93 -0
- package/packages/core/src/constants.ts +81 -0
- package/packages/core/src/contract-addresses.ts +101 -0
- package/packages/core/src/contract-versions.ts +374 -0
- package/packages/core/src/contracts.ts +414 -0
- package/packages/core/src/crypto/blsSigner.ts +124 -0
- package/packages/core/src/crypto/index.ts +1 -0
- package/packages/core/src/index.ts +19 -0
- package/packages/core/src/networks.ts +127 -0
- package/packages/core/src/requirementChecker.ts +225 -0
- package/packages/core/src/roles.ts +244 -0
- package/packages/core/src/utils.ts +23 -0
- package/packages/core/tsconfig.json +12 -0
- package/packages/dapp/package.json +27 -0
- package/packages/dapp/src/index.ts +4 -0
- package/packages/dapp/src/ui/components/EvaluationPanel.tsx +40 -0
- package/packages/dapp/src/ui/hooks/useCreditScore.ts +44 -0
- package/packages/dapp/src/ui/hooks/useSuperPaymaster.ts +31 -0
- package/packages/dapp/src/ui/index.ts +22 -0
- package/packages/dapp/tsconfig.json +13 -0
- package/packages/enduser/package.json +21 -0
- package/packages/enduser/src/index.ts +138 -0
- package/packages/enduser/tsconfig.json +8 -0
- package/packages/identity/package.json +22 -0
- package/packages/identity/src/index.ts +82 -0
- package/packages/identity/src/mysbt.ts +48 -0
- package/packages/identity/tsconfig.json +12 -0
- package/packages/operator/package.json +21 -0
- package/packages/operator/src/index.ts +172 -0
- package/packages/operator/tsconfig.json +8 -0
- package/packages/paymaster/package.json +22 -0
- package/packages/paymaster/src/SuperPaymaster/index.ts +168 -0
- package/packages/paymaster/src/V4/index.ts +123 -0
- package/packages/paymaster/src/index.ts +5 -0
- package/packages/paymaster/tsconfig.json +12 -0
- package/packages/sdk/README.md +150 -0
- package/packages/sdk/aastar/package.json +21 -0
- package/packages/sdk/aastar/src/index.ts +3 -0
- package/packages/sdk/aastar/tsconfig.json +8 -0
- package/packages/sdk/examples/config.json +1 -0
- package/packages/sdk/examples/regression_test.ts +106 -0
- package/packages/sdk/package.json +32 -0
- package/packages/sdk/src/clients/admin.ts +54 -0
- package/packages/sdk/src/clients/community.ts +403 -0
- package/packages/sdk/src/clients/endUser.ts +173 -0
- package/packages/sdk/src/clients/operator.ts +277 -0
- package/packages/sdk/src/errors/decoder.ts +48 -0
- package/{dist/index.js → packages/sdk/src/index.ts} +9 -1
- package/packages/sdk/src/utils/errorHandler.ts +167 -0
- package/packages/sdk/src/utils/funding.ts +280 -0
- package/packages/sdk/src/utils/keys.ts +159 -0
- package/packages/sdk/src/utils/roleData.ts +151 -0
- package/packages/sdk/src/utils/validation.ts +356 -0
- package/packages/sdk/tsconfig.json +12 -0
- package/packages/tokens/package.json +22 -0
- package/packages/tokens/src/index.ts +245 -0
- package/packages/tokens/tsconfig.json +12 -0
- package/pnpm-workspace.yaml +2 -0
- package/run_full_regression.sh +215 -0
- package/run_sdk_regression.sh +213 -0
- package/safe_harmonize.py +107 -0
- package/scripts/00_utils.ts +59 -0
- package/scripts/00_verify_phase1.ts +130 -0
- package/scripts/01_1_prep_gtoken.ts +81 -0
- package/scripts/01_2_register_sbt.ts +88 -0
- package/scripts/01_3_prep_tokens_paymaster.ts +102 -0
- package/scripts/01_prepare_all.ts +271 -0
- package/scripts/02_test_eoa.ts +50 -0
- package/scripts/03_test_standard_aa.ts +173 -0
- package/scripts/04_0_check_deploy.ts +24 -0
- package/scripts/04_1_check_allowance.ts +44 -0
- package/scripts/04_2_construct_verify.ts +96 -0
- package/scripts/04_3_verify_estimate.ts +66 -0
- package/scripts/04_4_verify_pack.ts +74 -0
- package/scripts/04_test_paymaster_v4.ts +217 -0
- package/scripts/05_1_deposit.ts +48 -0
- package/scripts/05_test_superpaymaster.ts +380 -0
- package/scripts/06_local_test_v3_admin.ts +163 -0
- package/scripts/06_local_test_v3_execution.ts +132 -0
- package/scripts/06_local_test_v3_full.ts +490 -0
- package/scripts/06_local_test_v3_funding.ts +124 -0
- package/scripts/06_local_test_v3_reputation.ts +234 -0
- package/scripts/07_local_test_v3_audit.ts +181 -0
- package/scripts/08_local_test_registry_lifecycle.ts +382 -0
- package/scripts/09_local_test_community_lifecycle.ts +384 -0
- package/scripts/09_local_test_community_simple.ts +108 -0
- package/scripts/09_scenario_bread_independent.ts +247 -0
- package/scripts/10_scenario_super_shared.ts +196 -0
- package/scripts/10_test_protocol_admin_full.ts +173 -0
- package/scripts/11_scenario_hacker_defense.ts +104 -0
- package/scripts/11_test_core_flows_full.ts +279 -0
- package/scripts/12_test_slash_mechanism.ts +205 -0
- package/scripts/12_test_slash_queries.ts +83 -0
- package/scripts/12_test_staking_exit.ts +152 -0
- package/scripts/12_test_staking_slash.ts +301 -0
- package/scripts/12_test_tier2_slash.ts +139 -0
- package/scripts/13_test_sbt_burn_linkage.ts +266 -0
- package/scripts/14_test_credit_redesign.ts +266 -0
- package/scripts/15_test_bls_full.ts +125 -0
- package/scripts/15_test_dvt_bls_full.ts +133 -0
- package/scripts/17_test_cross_role_collaboration.ts +95 -0
- package/scripts/18_sdk_e2e_verification.ts +67 -0
- package/scripts/18_test_dvt_sdk_flow.ts +138 -0
- package/scripts/18_test_lifecycle_completion.ts +144 -0
- package/scripts/19_sdk_experiment_runner.ts +89 -0
- package/scripts/19_sdk_experiment_runner.ts.backup +391 -0
- package/scripts/20_sdk_full_capability.ts +95 -0
- package/scripts/20_test_superpaymaster_new_apis.ts +193 -0
- package/scripts/21_test_paymasterv4_complete.ts +341 -0
- package/scripts/22_test_bls_signing.ts +260 -0
- package/scripts/23_test_middleware.ts +197 -0
- package/scripts/98_edge_reentrancy.ts +85 -0
- package/scripts/99_bug_hunting_fast.ts +216 -0
- package/scripts/collect_industry_baseline.ts +236 -0
- package/scripts/complete_env_config.ts +97 -0
- package/scripts/debug_account_c.ts +43 -0
- package/scripts/debug_bls.ts +58 -0
- package/scripts/debug_config_v036.ts +13 -0
- package/scripts/debug_contracts.ts +2 -0
- package/scripts/debug_env.ts +69 -0
- package/scripts/debug_find_paymaster.ts +98 -0
- package/scripts/debug_isolated_registration.ts +256 -0
- package/scripts/debug_paymaster_config.ts +19 -0
- package/scripts/debug_pim_addr.ts +23 -0
- package/scripts/debug_pm_status.ts +51 -0
- package/scripts/debug_registry.ts +39 -0
- package/scripts/debug_registry_setup.ts +129 -0
- package/scripts/debug_sanity.ts +32 -0
- package/scripts/debug_shared_config.ts +10 -0
- package/scripts/debug_token_compat.ts +51 -0
- package/scripts/debug_tokens.ts +41 -0
- package/scripts/debug_vcheck.ts +33 -0
- package/scripts/deploy_and_init_v3.sh +134 -0
- package/scripts/deploy_anvil_accounts.ts +144 -0
- package/scripts/deploy_paymaster_v4.ts +139 -0
- package/scripts/deploy_test_accounts.ts +401 -0
- package/scripts/experiment/stage3/SETUP_GUIDE.md +258 -0
- package/scripts/experiment/stage3/archived_scripts/00_token_distribution.ts +78 -0
- package/scripts/experiment/stage3/archived_scripts/01_dao_launch.ts +96 -0
- package/scripts/experiment/stage3/archived_scripts/01b_bread_launch.ts +112 -0
- package/scripts/experiment/stage3/archived_scripts/02_operator_setup.ts +84 -0
- package/scripts/experiment/stage3/archived_scripts/02b_operator_b_setup.ts +104 -0
- package/scripts/experiment/stage3/archived_scripts/02c_finalize_operators.ts +86 -0
- package/scripts/experiment/stage3/archived_scripts/02d_operator_collateral.ts +89 -0
- package/scripts/experiment/stage3/archived_scripts/03_user_onboarding.ts +83 -0
- package/scripts/experiment/stage3/archived_scripts/03b_deploy_aa_account.ts +61 -0
- package/scripts/experiment/stage3/archived_scripts/03c_aa_onboarding.ts +104 -0
- package/scripts/experiment/stage3/archived_scripts/03d_mint_points.ts +60 -0
- package/scripts/experiment/stage3/archived_scripts/04_benchmarking.ts +100 -0
- package/scripts/experiment/stage3/archived_scripts/05_multi_op_setup.ts +149 -0
- package/scripts/experiment/stage3/archived_scripts/README.md +58 -0
- package/scripts/experiment/stage3/archived_scripts/check_roles.ts +29 -0
- package/scripts/experiment/stage3/archived_scripts/decode_error.ts +23 -0
- package/scripts/experiment/stage3/archived_scripts/fund_user.ts +51 -0
- package/scripts/experiment/stage3/archived_scripts/gen_b_key.ts +3 -0
- package/scripts/experiment/stage3/archived_scripts/gen_keys.ts +4 -0
- package/scripts/experiment/stage3/archived_scripts/setup.ts +105 -0
- package/scripts/experiment/stage3/archived_scripts/test_key.ts +4 -0
- package/scripts/experiment/stage3/archived_scripts/verify_state.ts +59 -0
- package/scripts/experiment/stage3/refactored/00_token_distribution.ts +46 -0
- package/scripts/experiment/stage3/refactored/02_operator_setup.ts +65 -0
- package/scripts/experiment/stage3/refactored/03_user_onboarding.ts +68 -0
- package/scripts/experiment/stage3/refactored/05_multi_op_setup.ts +63 -0
- package/scripts/experiment/stage3/refactored/README.md +71 -0
- package/scripts/extract-docs.sh +72 -0
- package/scripts/generate_env_from_deployment.ts +109 -0
- package/scripts/publish_all.sh +39 -0
- package/scripts/quick_setup.ts +124 -0
- package/scripts/run_automated_experiment.sh +121 -0
- package/scripts/run_daily_experiment.ts +70 -0
- package/scripts/security_audit.sh +172 -0
- package/scripts/sync_config_to_env.ts +88 -0
- package/scripts/test_groups.ts +267 -0
- package/scripts/test_multi_community_anvil.ts +276 -0
- package/scripts/test_new_sdk_apis_sepolia.ts +115 -0
- package/scripts/test_sdk_join_idempotent.ts +233 -0
- package/scripts/test_simple_sepolia.ts +44 -0
- package/scripts/v2_regression/00_validate_env.ts +77 -0
- package/scripts/v2_regression/01_setup_and_fund.ts +132 -0
- package/scripts/v2_regression/02_operator_onboarding.ts +300 -0
- package/scripts/v2_regression/03_community_registry.ts +173 -0
- package/scripts/v2_regression/04_enduser_flow.ts +174 -0
- package/scripts/v2_regression/05_admin_audit.ts +157 -0
- package/scripts/v2_regression/README.md +161 -0
- package/scripts/validate_env.ts +112 -0
- package/scripts/validate_environment.ts +140 -0
- package/sdk_experiment_data.csv +2 -0
- package/surgical_harmonize.py +83 -0
- package/tsconfig.json +15 -0
- package/typedoc.json +25 -0
- package/dist/clients/admin.d.ts +0 -12
- package/dist/clients/admin.d.ts.map +0 -1
- package/dist/clients/admin.js +0 -20
- package/dist/clients/admin.js.map +0 -1
- package/dist/clients/community.d.ts +0 -12
- package/dist/clients/community.d.ts.map +0 -1
- package/dist/clients/community.js +0 -18
- package/dist/clients/community.js.map +0 -1
- package/dist/clients/endUser.d.ts +0 -12
- package/dist/clients/endUser.d.ts.map +0 -1
- package/dist/clients/endUser.js +0 -20
- package/dist/clients/endUser.js.map +0 -1
- package/dist/clients/operator.d.ts +0 -18
- package/dist/clients/operator.d.ts.map +0 -1
- package/dist/clients/operator.js +0 -65
- package/dist/clients/operator.js.map +0 -1
- package/dist/index.d.ts +0 -11
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js.map +0 -1
|
@@ -0,0 +1,1078 @@
|
|
|
1
|
+
|
|
2
|
+
A nodejs sdk for all developers to integrate AAStar's power abilities.
|
|
3
|
+
|
|
4
|
+
AAStar npm packages collection:
|
|
5
|
+
You can use
|
|
6
|
+
```
|
|
7
|
+
pnpm install @aastar/airaccount
|
|
8
|
+
@aastar/superpaymaster
|
|
9
|
+
@aastar/cometens
|
|
10
|
+
@aastar/openpnts
|
|
11
|
+
@aastar/opencards
|
|
12
|
+
@aastar/arcadia
|
|
13
|
+
@aastar/cos72
|
|
14
|
+
```
|
|
15
|
+
or
|
|
16
|
+
```
|
|
17
|
+
pnpm install aastar
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## For developers
|
|
21
|
+
Why do you install this package?
|
|
22
|
+
### airaccount
|
|
23
|
+
Provide a moveable\self-custody\crypto account with life cycle service.
|
|
24
|
+
Permissionless.
|
|
25
|
+
Trustless.
|
|
26
|
+
Decentralized.
|
|
27
|
+
In 3 steps: bind, send, claim, move(recover)
|
|
28
|
+
|
|
29
|
+
### superpaymaster
|
|
30
|
+
Embbeded into AirAccount, but provide ERC20 gas token ability for any community individually.
|
|
31
|
+
|
|
32
|
+
### cometens
|
|
33
|
+
Embbeded into AirAccount, but provide set your own ENS name for your community individually.
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
# 从零开始开发和发布 npm 包:完整指南
|
|
37
|
+
|
|
38
|
+
## 目录
|
|
39
|
+
|
|
40
|
+
1. [前期准备](#前期准备)
|
|
41
|
+
2. [初始化项目](#初始化项目)
|
|
42
|
+
3. [配置开发环境](#配置开发环境)
|
|
43
|
+
4. [开发 SDK](#开发-sdk)
|
|
44
|
+
5. [测试](#测试)
|
|
45
|
+
6. [构建和打包](#构建和打包)
|
|
46
|
+
7. [发布到 npm](#发布到-npm)
|
|
47
|
+
8. [文档和示例](#文档和示例)
|
|
48
|
+
9. [版本管理和更新](#版本管理和更新)
|
|
49
|
+
10. [持续集成和自动发布](#持续集成和自动发布)
|
|
50
|
+
11. [SDK 开发最佳实践](#sdk-开发最佳实践)
|
|
51
|
+
12. [问题排查](#问题排查)
|
|
52
|
+
|
|
53
|
+
## 前期准备
|
|
54
|
+
|
|
55
|
+
### 1. 安装必要工具
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
# 安装 Node.js (推荐使用 nvm 管理 Node.js 版本)
|
|
59
|
+
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
|
|
60
|
+
nvm install node # 安装最新版
|
|
61
|
+
nvm install --lts # 或安装长期支持版
|
|
62
|
+
|
|
63
|
+
# 确认安装
|
|
64
|
+
node --version
|
|
65
|
+
npm --version
|
|
66
|
+
|
|
67
|
+
# 安装一些全局工具
|
|
68
|
+
npm install -g typescript ts-node np
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### 2. 创建 npm 账号
|
|
72
|
+
|
|
73
|
+
1. 访问 [npm 官网](https://www.npmjs.com/) 并注册
|
|
74
|
+
2. 在命令行登录 npm (后续发布时需要)
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
npm login
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### 3. 规划你的 SDK
|
|
81
|
+
|
|
82
|
+
在开始编码前,确定以下内容:
|
|
83
|
+
|
|
84
|
+
- SDK 的目标和用途
|
|
85
|
+
- 核心功能和 API 设计
|
|
86
|
+
- 依赖关系
|
|
87
|
+
- 支持的平台 (浏览器、Node.js、React Native 等)
|
|
88
|
+
- 命名规范 (包名必须唯一)
|
|
89
|
+
- 核心 API 结构
|
|
90
|
+
|
|
91
|
+
## 初始化项目
|
|
92
|
+
|
|
93
|
+
### 1. 创建项目目录
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
# 创建项目目录 (使用你希望的包名)
|
|
97
|
+
mkdir my-awesome-sdk
|
|
98
|
+
cd my-awesome-sdk
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### 2. 初始化 npm 项目
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
npm init
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
按照提示填写信息:
|
|
108
|
+
|
|
109
|
+
- `name`: 包名 (可以使用 `@组织名/包名` 格式)
|
|
110
|
+
- `version`: 版本号 (推荐从 0.1.0 开始)
|
|
111
|
+
- `description`: 简短描述
|
|
112
|
+
- `main`: 入口文件 (通常是 `dist/index.js`)
|
|
113
|
+
- `scripts`: 构建脚本
|
|
114
|
+
- `repository`: 代码仓库地址
|
|
115
|
+
- `keywords`: 关键词,帮助用户发现你的包
|
|
116
|
+
- `author`: 作者信息
|
|
117
|
+
- `license`: 许可证 (如 MIT)
|
|
118
|
+
|
|
119
|
+
### 3. 初始化 Git 仓库
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
git init
|
|
123
|
+
echo "node_modules\ndist\n.env\n*.log" > .gitignore
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### 4. 创建基本目录结构
|
|
127
|
+
|
|
128
|
+
```bash
|
|
129
|
+
mkdir src tests examples docs
|
|
130
|
+
touch src/index.ts README.md LICENSE
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
## 配置开发环境
|
|
134
|
+
|
|
135
|
+
### 1. 配置 TypeScript
|
|
136
|
+
|
|
137
|
+
```bash
|
|
138
|
+
# 安装 TypeScript
|
|
139
|
+
npm install typescript --save-dev
|
|
140
|
+
|
|
141
|
+
# 初始化 TypeScript 配置
|
|
142
|
+
npx tsc --init
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
编辑 `tsconfig.json`:
|
|
146
|
+
|
|
147
|
+
```json
|
|
148
|
+
{
|
|
149
|
+
"compilerOptions": {
|
|
150
|
+
"target": "es2018",
|
|
151
|
+
"module": "commonjs",
|
|
152
|
+
"declaration": true,
|
|
153
|
+
"outDir": "./dist",
|
|
154
|
+
"strict": true,
|
|
155
|
+
"esModuleInterop": true,
|
|
156
|
+
"skipLibCheck": true,
|
|
157
|
+
"forceConsistentCasingInFileNames": true,
|
|
158
|
+
"rootDir": "./src"
|
|
159
|
+
},
|
|
160
|
+
"include": ["src"],
|
|
161
|
+
"exclude": ["node_modules", "tests", "examples", "dist"]
|
|
162
|
+
}
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
### 2. 配置代码格式化和 Lint
|
|
166
|
+
|
|
167
|
+
```bash
|
|
168
|
+
# 安装 ESLint 和 Prettier
|
|
169
|
+
npm install eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin prettier eslint-config-prettier eslint-plugin-prettier --save-dev
|
|
170
|
+
|
|
171
|
+
# 创建 ESLint 配置
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
创建 `.eslintrc.js`:
|
|
175
|
+
|
|
176
|
+
```javascript
|
|
177
|
+
module.exports = {
|
|
178
|
+
parser: "@typescript-eslint/parser",
|
|
179
|
+
extends: [
|
|
180
|
+
"plugin:@typescript-eslint/recommended",
|
|
181
|
+
"plugin:prettier/recommended",
|
|
182
|
+
],
|
|
183
|
+
parserOptions: {
|
|
184
|
+
ecmaVersion: 2018,
|
|
185
|
+
sourceType: "module",
|
|
186
|
+
},
|
|
187
|
+
rules: {
|
|
188
|
+
// 自定义规则
|
|
189
|
+
},
|
|
190
|
+
};
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
创建 `.prettierrc`:
|
|
194
|
+
|
|
195
|
+
```json
|
|
196
|
+
{
|
|
197
|
+
"singleQuote": true,
|
|
198
|
+
"trailingComma": "es5",
|
|
199
|
+
"printWidth": 100,
|
|
200
|
+
"tabWidth": 2,
|
|
201
|
+
"semi": true
|
|
202
|
+
}
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
### 3. 配置测试环境
|
|
206
|
+
|
|
207
|
+
```bash
|
|
208
|
+
# 安装 Jest
|
|
209
|
+
npm install jest ts-jest @types/jest --save-dev
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
创建 `jest.config.js`:
|
|
213
|
+
|
|
214
|
+
```javascript
|
|
215
|
+
module.exports = {
|
|
216
|
+
preset: "ts-jest",
|
|
217
|
+
testEnvironment: "node",
|
|
218
|
+
testMatch: ["**/tests/**/*.test.ts"],
|
|
219
|
+
collectCoverage: true,
|
|
220
|
+
coverageDirectory: "coverage",
|
|
221
|
+
collectCoverageFrom: ["src/**/*.ts"],
|
|
222
|
+
};
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
### 4. 更新 package.json 脚本
|
|
226
|
+
|
|
227
|
+
编辑 `package.json` 添加以下脚本:
|
|
228
|
+
|
|
229
|
+
```json
|
|
230
|
+
"scripts": {
|
|
231
|
+
"build": "tsc",
|
|
232
|
+
"test": "jest",
|
|
233
|
+
"lint": "eslint 'src/**/*.ts'",
|
|
234
|
+
"format": "prettier --write 'src/**/*.ts'",
|
|
235
|
+
"prepare": "npm run build",
|
|
236
|
+
"prepublishOnly": "npm test && npm run lint",
|
|
237
|
+
"preversion": "npm run lint",
|
|
238
|
+
"version": "npm run format && git add -A src",
|
|
239
|
+
"postversion": "git push && git push --tags"
|
|
240
|
+
}
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
## 开发 SDK
|
|
244
|
+
|
|
245
|
+
### 1. 创建基本结构
|
|
246
|
+
|
|
247
|
+
在 `src/index.ts` 创建 SDK 的入口点:
|
|
248
|
+
|
|
249
|
+
```typescript
|
|
250
|
+
// 导出所有公共 API
|
|
251
|
+
export * from "./client";
|
|
252
|
+
export * from "./types";
|
|
253
|
+
// ... 其他导出
|
|
254
|
+
|
|
255
|
+
// 导出默认客户端
|
|
256
|
+
import { Client } from "./client";
|
|
257
|
+
export default Client;
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
### 2. 创建核心模块
|
|
261
|
+
|
|
262
|
+
例如,创建 `src/client.ts` 实现主要客户端类:
|
|
263
|
+
|
|
264
|
+
```typescript
|
|
265
|
+
import { ApiResponse, ClientOptions } from "./types";
|
|
266
|
+
|
|
267
|
+
export class Client {
|
|
268
|
+
private apiKey: string;
|
|
269
|
+
private baseUrl: string;
|
|
270
|
+
|
|
271
|
+
constructor(options: ClientOptions) {
|
|
272
|
+
this.apiKey = options.apiKey;
|
|
273
|
+
this.baseUrl = options.baseUrl || "https://api.example.com/v1";
|
|
274
|
+
}
|
|
275
|
+
|
|
276
|
+
async makeRequest<T>(
|
|
277
|
+
endpoint: string,
|
|
278
|
+
method: string = "GET",
|
|
279
|
+
data?: any,
|
|
280
|
+
): Promise<ApiResponse<T>> {
|
|
281
|
+
const url = `${this.baseUrl}/${endpoint}`;
|
|
282
|
+
|
|
283
|
+
try {
|
|
284
|
+
const response = await fetch(url, {
|
|
285
|
+
method,
|
|
286
|
+
headers: {
|
|
287
|
+
"Content-Type": "application/json",
|
|
288
|
+
"Authorization": `Bearer ${this.apiKey}`,
|
|
289
|
+
},
|
|
290
|
+
body: data ? JSON.stringify(data) : undefined,
|
|
291
|
+
});
|
|
292
|
+
|
|
293
|
+
const responseData = await response.json();
|
|
294
|
+
|
|
295
|
+
if (!response.ok) {
|
|
296
|
+
throw new Error(responseData.message || "API request failed");
|
|
297
|
+
}
|
|
298
|
+
|
|
299
|
+
return {
|
|
300
|
+
data: responseData,
|
|
301
|
+
status: response.status,
|
|
302
|
+
headers: response.headers,
|
|
303
|
+
};
|
|
304
|
+
} catch (error) {
|
|
305
|
+
throw error;
|
|
306
|
+
}
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
// 公共 API 方法
|
|
310
|
+
async getUser(userId: string) {
|
|
311
|
+
return this.makeRequest<any>(`users/${userId}`);
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
// 更多 API 方法...
|
|
315
|
+
}
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
### 3. 定义类型
|
|
319
|
+
|
|
320
|
+
创建 `src/types.ts` 定义类型:
|
|
321
|
+
|
|
322
|
+
```typescript
|
|
323
|
+
export interface ClientOptions {
|
|
324
|
+
apiKey: string;
|
|
325
|
+
baseUrl?: string;
|
|
326
|
+
}
|
|
327
|
+
|
|
328
|
+
export interface ApiResponse<T> {
|
|
329
|
+
data: T;
|
|
330
|
+
status: number;
|
|
331
|
+
headers: Headers;
|
|
332
|
+
}
|
|
333
|
+
|
|
334
|
+
// 更多类型定义...
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
### 4. 使用模块化设计
|
|
338
|
+
|
|
339
|
+
将 SDK 拆分为多个模块,例如:
|
|
340
|
+
|
|
341
|
+
```
|
|
342
|
+
src/
|
|
343
|
+
index.ts # 主入口
|
|
344
|
+
client.ts # 核心客户端类
|
|
345
|
+
types.ts # 类型定义
|
|
346
|
+
modules/
|
|
347
|
+
auth.ts # 认证相关功能
|
|
348
|
+
users.ts # 用户相关功能
|
|
349
|
+
products.ts # 产品相关功能
|
|
350
|
+
utils/
|
|
351
|
+
request.ts # 请求工具
|
|
352
|
+
validation.ts # 验证工具
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
## 测试
|
|
356
|
+
|
|
357
|
+
### 1. 编写单元测试
|
|
358
|
+
|
|
359
|
+
在 `tests` 目录中创建测试文件,例如 `tests/client.test.ts`:
|
|
360
|
+
|
|
361
|
+
```typescript
|
|
362
|
+
import { Client } from "../src/client";
|
|
363
|
+
|
|
364
|
+
// 模拟 fetch API
|
|
365
|
+
global.fetch = jest.fn();
|
|
366
|
+
|
|
367
|
+
describe("Client", () => {
|
|
368
|
+
let client: Client;
|
|
369
|
+
|
|
370
|
+
beforeEach(() => {
|
|
371
|
+
client = new Client({ apiKey: "test-api-key" });
|
|
372
|
+
(global.fetch as jest.Mock).mockClear();
|
|
373
|
+
});
|
|
374
|
+
|
|
375
|
+
test("makeRequest should call fetch with correct parameters", async () => {
|
|
376
|
+
(global.fetch as jest.Mock).mockResolvedValueOnce({
|
|
377
|
+
ok: true,
|
|
378
|
+
status: 200,
|
|
379
|
+
json: async () => ({ id: "123", name: "Test User" }),
|
|
380
|
+
headers: new Headers(),
|
|
381
|
+
});
|
|
382
|
+
|
|
383
|
+
const result = await client.makeRequest("users/123");
|
|
384
|
+
|
|
385
|
+
expect(global.fetch).toHaveBeenCalledWith(
|
|
386
|
+
"https://api.example.com/v1/users/123",
|
|
387
|
+
expect.objectContaining({
|
|
388
|
+
method: "GET",
|
|
389
|
+
headers: expect.objectContaining({
|
|
390
|
+
"Authorization": "Bearer test-api-key",
|
|
391
|
+
}),
|
|
392
|
+
}),
|
|
393
|
+
);
|
|
394
|
+
|
|
395
|
+
expect(result.data).toEqual({ id: "123", name: "Test User" });
|
|
396
|
+
});
|
|
397
|
+
|
|
398
|
+
// 更多测试...
|
|
399
|
+
});
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
### 2. 运行测试
|
|
403
|
+
|
|
404
|
+
```bash
|
|
405
|
+
npm test
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
### 3. 编写集成测试
|
|
409
|
+
|
|
410
|
+
创建与真实 API 交互的集成测试,例如 `tests/integration.test.ts`:
|
|
411
|
+
|
|
412
|
+
```typescript
|
|
413
|
+
import { Client } from "../src/client";
|
|
414
|
+
|
|
415
|
+
// 这些测试需要一个有效的 API 密钥
|
|
416
|
+
// 通常通过环境变量提供
|
|
417
|
+
const apiKey = process.env.API_KEY;
|
|
418
|
+
|
|
419
|
+
// 只在提供 API 密钥时运行集成测试
|
|
420
|
+
(apiKey ? describe : describe.skip)("Integration tests", () => {
|
|
421
|
+
let client: Client;
|
|
422
|
+
|
|
423
|
+
beforeAll(() => {
|
|
424
|
+
client = new Client({ apiKey });
|
|
425
|
+
});
|
|
426
|
+
|
|
427
|
+
test("can get a user", async () => {
|
|
428
|
+
const result = await client.getUser("test-user-id");
|
|
429
|
+
expect(result.status).toBe(200);
|
|
430
|
+
expect(result.data).toHaveProperty("id");
|
|
431
|
+
});
|
|
432
|
+
|
|
433
|
+
// 更多集成测试...
|
|
434
|
+
});
|
|
435
|
+
```
|
|
436
|
+
|
|
437
|
+
## 构建和打包
|
|
438
|
+
|
|
439
|
+
### 1. 配置 npm 包文件
|
|
440
|
+
|
|
441
|
+
编辑 `package.json` 指定要包含的文件:
|
|
442
|
+
|
|
443
|
+
```json
|
|
444
|
+
{
|
|
445
|
+
"main": "dist/index.js",
|
|
446
|
+
"types": "dist/index.d.ts",
|
|
447
|
+
"files": [
|
|
448
|
+
"dist",
|
|
449
|
+
"LICENSE",
|
|
450
|
+
"README.md"
|
|
451
|
+
]
|
|
452
|
+
}
|
|
453
|
+
```
|
|
454
|
+
|
|
455
|
+
### 2. 支持不同的模块格式 (可选)
|
|
456
|
+
|
|
457
|
+
如果你想同时支持 CommonJS 和 ES 模块,可以使用 `rollup` 或 `tsup` 等工具。
|
|
458
|
+
|
|
459
|
+
使用 `tsup` 示例:
|
|
460
|
+
|
|
461
|
+
```bash
|
|
462
|
+
# 安装 tsup
|
|
463
|
+
npm install tsup --save-dev
|
|
464
|
+
```
|
|
465
|
+
|
|
466
|
+
更新 `package.json`:
|
|
467
|
+
|
|
468
|
+
```json
|
|
469
|
+
{
|
|
470
|
+
"main": "dist/index.js",
|
|
471
|
+
"module": "dist/index.mjs",
|
|
472
|
+
"types": "dist/index.d.ts",
|
|
473
|
+
"exports": {
|
|
474
|
+
".": {
|
|
475
|
+
"require": "./dist/index.js",
|
|
476
|
+
"import": "./dist/index.mjs",
|
|
477
|
+
"types": "./dist/index.d.ts"
|
|
478
|
+
}
|
|
479
|
+
},
|
|
480
|
+
"scripts": {
|
|
481
|
+
"build": "tsup src/index.ts --format cjs,esm --dts --clean"
|
|
482
|
+
}
|
|
483
|
+
}
|
|
484
|
+
```
|
|
485
|
+
|
|
486
|
+
## 发布到 npm
|
|
487
|
+
|
|
488
|
+
### 1. 准备发布
|
|
489
|
+
|
|
490
|
+
确保你的包名是唯一的,并已登录 npm。如果使用组织名称,确保已创建组织。
|
|
491
|
+
|
|
492
|
+
```bash
|
|
493
|
+
# 检查是否登录
|
|
494
|
+
npm whoami
|
|
495
|
+
|
|
496
|
+
# 如果未登录
|
|
497
|
+
npm login
|
|
498
|
+
```
|
|
499
|
+
|
|
500
|
+
### 2. 测试包
|
|
501
|
+
|
|
502
|
+
在发布前,使用 `npm pack` 创建一个本地包进行测试:
|
|
503
|
+
|
|
504
|
+
```bash
|
|
505
|
+
npm pack
|
|
506
|
+
```
|
|
507
|
+
|
|
508
|
+
这将创建一个 `.tgz` 文件,可以在另一个项目中使用它进行测试:
|
|
509
|
+
|
|
510
|
+
```bash
|
|
511
|
+
# 在测试项目中
|
|
512
|
+
npm install ../path/to/your-package-1.0.0.tgz
|
|
513
|
+
```
|
|
514
|
+
|
|
515
|
+
### 3. 发布包
|
|
516
|
+
|
|
517
|
+
```bash
|
|
518
|
+
# 首次发布
|
|
519
|
+
npm publish
|
|
520
|
+
|
|
521
|
+
# 如果是组织包并想设为公共
|
|
522
|
+
npm publish --access public
|
|
523
|
+
```
|
|
524
|
+
|
|
525
|
+
### 4. 更新包
|
|
526
|
+
|
|
527
|
+
修改 `package.json` 中的版本号或使用 `npm version` 命令:
|
|
528
|
+
|
|
529
|
+
```bash
|
|
530
|
+
# 更新补丁版本 (1.0.0 -> 1.0.1)
|
|
531
|
+
npm version patch
|
|
532
|
+
|
|
533
|
+
# 更新小版本 (1.0.0 -> 1.1.0)
|
|
534
|
+
npm version minor
|
|
535
|
+
|
|
536
|
+
# 更新大版本 (1.0.0 -> 2.0.0)
|
|
537
|
+
npm version major
|
|
538
|
+
```
|
|
539
|
+
|
|
540
|
+
然后发布更新:
|
|
541
|
+
|
|
542
|
+
```bash
|
|
543
|
+
npm publish
|
|
544
|
+
```
|
|
545
|
+
|
|
546
|
+
## 文档和示例
|
|
547
|
+
|
|
548
|
+
### 1. 编写 README
|
|
549
|
+
|
|
550
|
+
一个好的 README 应包含:
|
|
551
|
+
|
|
552
|
+
- 项目描述
|
|
553
|
+
- 安装指南
|
|
554
|
+
- 基本用法示例
|
|
555
|
+
- API 文档链接
|
|
556
|
+
- 配置选项
|
|
557
|
+
- 常见问题
|
|
558
|
+
|
|
559
|
+
示例 README 结构:
|
|
560
|
+
|
|
561
|
+
````markdown
|
|
562
|
+
# My Awesome SDK
|
|
563
|
+
|
|
564
|
+
A JavaScript/TypeScript SDK for interacting with the Example API.
|
|
565
|
+
|
|
566
|
+
## Installation
|
|
567
|
+
|
|
568
|
+
```bash
|
|
569
|
+
npm install my-awesome-sdk
|
|
570
|
+
```
|
|
571
|
+
````
|
|
572
|
+
|
|
573
|
+
## Quick Start
|
|
574
|
+
|
|
575
|
+
```javascript
|
|
576
|
+
import Client from "my-awesome-sdk";
|
|
577
|
+
|
|
578
|
+
const client = new Client({ apiKey: "your-api-key" });
|
|
579
|
+
|
|
580
|
+
// Get a user
|
|
581
|
+
client.getUser("user123")
|
|
582
|
+
.then((response) => console.log(response.data))
|
|
583
|
+
.catch((error) => console.error(error));
|
|
584
|
+
```
|
|
585
|
+
|
|
586
|
+
## Documentation
|
|
587
|
+
|
|
588
|
+
For full documentation, visit [docs.example.com](https://docs.example.com).
|
|
589
|
+
|
|
590
|
+
## Configuration
|
|
591
|
+
|
|
592
|
+
The client accepts the following options:
|
|
593
|
+
|
|
594
|
+
| Option | Type | Required | Default | Description |
|
|
595
|
+
| ------- | ------ | -------- | -------------------------- | ---------------- |
|
|
596
|
+
| apiKey | string | Yes | - | Your API key |
|
|
597
|
+
| baseUrl | string | No | https://api.example.com/v1 | The API base URL |
|
|
598
|
+
|
|
599
|
+
## License
|
|
600
|
+
|
|
601
|
+
MIT
|
|
602
|
+
|
|
603
|
+
````
|
|
604
|
+
### 2. 示例代码
|
|
605
|
+
|
|
606
|
+
在 `examples` 目录中创建示例代码:
|
|
607
|
+
|
|
608
|
+
```typescript
|
|
609
|
+
// examples/basic-usage.ts
|
|
610
|
+
import Client from '../src';
|
|
611
|
+
|
|
612
|
+
async function main() {
|
|
613
|
+
const client = new Client({ apiKey: 'your-api-key' });
|
|
614
|
+
|
|
615
|
+
try {
|
|
616
|
+
const user = await client.getUser('user123');
|
|
617
|
+
console.log('User:', user.data);
|
|
618
|
+
|
|
619
|
+
// More examples...
|
|
620
|
+
} catch (error) {
|
|
621
|
+
console.error('Error:', error);
|
|
622
|
+
}
|
|
623
|
+
}
|
|
624
|
+
|
|
625
|
+
main();
|
|
626
|
+
````
|
|
627
|
+
|
|
628
|
+
### 3. 生成 API 文档
|
|
629
|
+
|
|
630
|
+
可以使用 TypeDoc 生成 API 文档:
|
|
631
|
+
|
|
632
|
+
```bash
|
|
633
|
+
npm install typedoc --save-dev
|
|
634
|
+
```
|
|
635
|
+
|
|
636
|
+
添加 `package.json` 脚本:
|
|
637
|
+
|
|
638
|
+
```json
|
|
639
|
+
"scripts": {
|
|
640
|
+
"docs": "typedoc --out docs src/index.ts"
|
|
641
|
+
}
|
|
642
|
+
```
|
|
643
|
+
|
|
644
|
+
## 版本管理和更新
|
|
645
|
+
|
|
646
|
+
### 1. 遵循语义化版本规范
|
|
647
|
+
|
|
648
|
+
- **补丁版本**(1.0.x):修复 bug,小改进
|
|
649
|
+
- **小版本**(1.x.0):添加向后兼容的新功能
|
|
650
|
+
- **大版本**(x.0.0):不向后兼容的变更
|
|
651
|
+
|
|
652
|
+
### 2. 维护更新日志
|
|
653
|
+
|
|
654
|
+
创建 `CHANGELOG.md` 并记录每个版本的变更:
|
|
655
|
+
|
|
656
|
+
```markdown
|
|
657
|
+
# Changelog
|
|
658
|
+
|
|
659
|
+
## [1.1.0] - 2023-05-01
|
|
660
|
+
|
|
661
|
+
### Added
|
|
662
|
+
|
|
663
|
+
- New feature X
|
|
664
|
+
- Support for Y
|
|
665
|
+
|
|
666
|
+
### Changed
|
|
667
|
+
|
|
668
|
+
- Improved error handling
|
|
669
|
+
- Better performance for Z
|
|
670
|
+
|
|
671
|
+
### Fixed
|
|
672
|
+
|
|
673
|
+
- Bug in getUser method
|
|
674
|
+
|
|
675
|
+
## [1.0.0] - 2023-04-01
|
|
676
|
+
|
|
677
|
+
Initial release
|
|
678
|
+
```
|
|
679
|
+
|
|
680
|
+
## 持续集成和自动发布
|
|
681
|
+
|
|
682
|
+
### 1. 设置 GitHub Actions
|
|
683
|
+
|
|
684
|
+
创建 `.github/workflows/ci.yml`:
|
|
685
|
+
|
|
686
|
+
```yaml
|
|
687
|
+
name: CI
|
|
688
|
+
|
|
689
|
+
on:
|
|
690
|
+
push:
|
|
691
|
+
branches: [ main ]
|
|
692
|
+
pull_request:
|
|
693
|
+
branches: [ main ]
|
|
694
|
+
|
|
695
|
+
jobs:
|
|
696
|
+
test:
|
|
697
|
+
runs-on: ubuntu-latest
|
|
698
|
+
strategy:
|
|
699
|
+
matrix:
|
|
700
|
+
node-version: [14.x, 16.x, 18.x]
|
|
701
|
+
|
|
702
|
+
steps:
|
|
703
|
+
- uses: actions/checkout@v3
|
|
704
|
+
- name: Use Node.js ${{ matrix.node-version }}
|
|
705
|
+
uses: actions/setup-node@v3
|
|
706
|
+
with:
|
|
707
|
+
node-version: ${{ matrix.node-version }}
|
|
708
|
+
- run: npm ci
|
|
709
|
+
- run: npm run build
|
|
710
|
+
- run: npm test
|
|
711
|
+
- run: npm run lint
|
|
712
|
+
```
|
|
713
|
+
|
|
714
|
+
### 2. 设置自动发布
|
|
715
|
+
|
|
716
|
+
创建 `.github/workflows/publish.yml`:
|
|
717
|
+
|
|
718
|
+
```yaml
|
|
719
|
+
name: Publish
|
|
720
|
+
|
|
721
|
+
on:
|
|
722
|
+
release:
|
|
723
|
+
types: [created]
|
|
724
|
+
|
|
725
|
+
jobs:
|
|
726
|
+
publish:
|
|
727
|
+
runs-on: ubuntu-latest
|
|
728
|
+
steps:
|
|
729
|
+
- uses: actions/checkout@v3
|
|
730
|
+
- uses: actions/setup-node@v3
|
|
731
|
+
with:
|
|
732
|
+
node-version: '16.x'
|
|
733
|
+
registry-url: 'https://registry.npmjs.org'
|
|
734
|
+
- run: npm ci
|
|
735
|
+
- run: npm run build
|
|
736
|
+
- run: npm test
|
|
737
|
+
- run: npm publish
|
|
738
|
+
env:
|
|
739
|
+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
740
|
+
```
|
|
741
|
+
|
|
742
|
+
在 GitHub 仓库设置中,添加 `NPM_TOKEN` 秘密。
|
|
743
|
+
|
|
744
|
+
## SDK 开发最佳实践
|
|
745
|
+
|
|
746
|
+
### 1. API 设计原则
|
|
747
|
+
|
|
748
|
+
- **简单直观**:API 应该易于理解和使用
|
|
749
|
+
- **一致性**:保持命名和模式一致
|
|
750
|
+
- **错误处理**:提供清晰的错误信息和类型
|
|
751
|
+
- **文档完善**:每个公共方法都应有文档
|
|
752
|
+
- **链式调用**:考虑支持方法链接
|
|
753
|
+
|
|
754
|
+
### 2. 错误处理
|
|
755
|
+
|
|
756
|
+
创建自定义错误类:
|
|
757
|
+
|
|
758
|
+
```typescript
|
|
759
|
+
// src/errors.ts
|
|
760
|
+
export class ApiError extends Error {
|
|
761
|
+
statusCode: number;
|
|
762
|
+
data: any;
|
|
763
|
+
|
|
764
|
+
constructor(message: string, statusCode: number, data?: any) {
|
|
765
|
+
super(message);
|
|
766
|
+
this.name = "ApiError";
|
|
767
|
+
this.statusCode = statusCode;
|
|
768
|
+
this.data = data;
|
|
769
|
+
Object.setPrototypeOf(this, ApiError.prototype);
|
|
770
|
+
}
|
|
771
|
+
}
|
|
772
|
+
|
|
773
|
+
export class ValidationError extends Error {
|
|
774
|
+
errors: any[];
|
|
775
|
+
|
|
776
|
+
constructor(message: string, errors: any[]) {
|
|
777
|
+
super(message);
|
|
778
|
+
this.name = "ValidationError";
|
|
779
|
+
this.errors = errors;
|
|
780
|
+
Object.setPrototypeOf(this, ValidationError.prototype);
|
|
781
|
+
}
|
|
782
|
+
}
|
|
783
|
+
```
|
|
784
|
+
|
|
785
|
+
### 3. 浏览器兼容性
|
|
786
|
+
|
|
787
|
+
如果 SDK 需要在浏览器中运行,考虑:
|
|
788
|
+
|
|
789
|
+
- 使用 `fetch` 时提供兼容性封装
|
|
790
|
+
- 考虑使用 `axios` 等库处理请求
|
|
791
|
+
- 使用 polyfills 确保兼容性
|
|
792
|
+
|
|
793
|
+
### 4. 安全性
|
|
794
|
+
|
|
795
|
+
- 不要在客户端代码中存储敏感信息
|
|
796
|
+
- 使用 HTTPS
|
|
797
|
+
- 避免将敏感信息记录到控制台
|
|
798
|
+
- 提供 API 令牌轮换机制
|
|
799
|
+
|
|
800
|
+
## 问题排查
|
|
801
|
+
|
|
802
|
+
### 1. 常见问题
|
|
803
|
+
|
|
804
|
+
- **包名冲突**:在 npm 上查找是否已存在同名包
|
|
805
|
+
- **构建错误**:检查 TypeScript 配置和依赖
|
|
806
|
+
- **发布失败**:确保已登录 npm 并有权限发布
|
|
807
|
+
|
|
808
|
+
### 2. 调试技巧
|
|
809
|
+
|
|
810
|
+
```typescript
|
|
811
|
+
// 添加调试配置
|
|
812
|
+
export class Client {
|
|
813
|
+
private debug: boolean;
|
|
814
|
+
|
|
815
|
+
constructor(options: ClientOptions) {
|
|
816
|
+
this.debug = options.debug || false;
|
|
817
|
+
// ...
|
|
818
|
+
}
|
|
819
|
+
|
|
820
|
+
private log(...args: any[]) {
|
|
821
|
+
if (this.debug) {
|
|
822
|
+
console.log("[SDK]", ...args);
|
|
823
|
+
}
|
|
824
|
+
}
|
|
825
|
+
|
|
826
|
+
async makeRequest<T>(
|
|
827
|
+
endpoint: string,
|
|
828
|
+
method: string = "GET",
|
|
829
|
+
data?: any,
|
|
830
|
+
): Promise<ApiResponse<T>> {
|
|
831
|
+
this.log("Request:", method, endpoint, data);
|
|
832
|
+
|
|
833
|
+
// ...请求逻辑...
|
|
834
|
+
|
|
835
|
+
this.log("Response:", responseData);
|
|
836
|
+
return response;
|
|
837
|
+
}
|
|
838
|
+
}
|
|
839
|
+
```
|
|
840
|
+
|
|
841
|
+
### 3. 提供用户支持
|
|
842
|
+
|
|
843
|
+
- 在 GitHub 上设置 Issues 模板
|
|
844
|
+
- 提供常见问题和解决方案
|
|
845
|
+
- 考虑设置讨论区或社区渠道
|
|
846
|
+
|
|
847
|
+
# NPM包组织
|
|
848
|
+
|
|
849
|
+
您想要建立一个名为"aastar"的NPM组织,其中包含多个子包,既可以单独安装也可以整体安装。这是一个非常好的组织方式,类似于许多流行的库如Next.js、Ant
|
|
850
|
+
Design等采用的结构。
|
|
851
|
+
|
|
852
|
+
要实现这样的结构,您需要采用"Monorepo"(单体仓库)架构,以下是详细的规划和实现步骤:
|
|
853
|
+
|
|
854
|
+
## 1. 创建Monorepo项目结构
|
|
855
|
+
|
|
856
|
+
首先,建立基本的项目结构:
|
|
857
|
+
|
|
858
|
+
```
|
|
859
|
+
aastar/
|
|
860
|
+
├── packages/
|
|
861
|
+
│ ├── airaccount/ # 子包1
|
|
862
|
+
│ ├── superpaymaster/ # 子包2
|
|
863
|
+
│ └── ... # 其他子包
|
|
864
|
+
├── package.json # 根项目配置
|
|
865
|
+
├── pnpm-workspace.yaml # 工作区配置
|
|
866
|
+
├── lerna.json # (可选)Lerna配置
|
|
867
|
+
└── tsconfig.json # 基础TypeScript配置
|
|
868
|
+
```
|
|
869
|
+
|
|
870
|
+
## 2. 配置工作区
|
|
871
|
+
|
|
872
|
+
在根目录创建`pnpm-workspace.yaml`文件:
|
|
873
|
+
|
|
874
|
+
```yaml
|
|
875
|
+
packages:
|
|
876
|
+
- 'packages/*'
|
|
877
|
+
```
|
|
878
|
+
|
|
879
|
+
## 3. 配置每个子包
|
|
880
|
+
|
|
881
|
+
在每个子包目录中创建`package.json`,例如`packages/airaccount/package.json`:
|
|
882
|
+
|
|
883
|
+
```json
|
|
884
|
+
{
|
|
885
|
+
"name": "@aastar/airaccount",
|
|
886
|
+
"version": "0.1.0",
|
|
887
|
+
"description": "AIR账户管理模块",
|
|
888
|
+
"main": "dist/index.js",
|
|
889
|
+
"types": "dist/index.d.ts",
|
|
890
|
+
"scripts": {
|
|
891
|
+
"build": "tsc",
|
|
892
|
+
"test": "jest"
|
|
893
|
+
},
|
|
894
|
+
"dependencies": {
|
|
895
|
+
// 此包的依赖
|
|
896
|
+
},
|
|
897
|
+
"peerDependencies": {
|
|
898
|
+
// 可选的同级依赖
|
|
899
|
+
},
|
|
900
|
+
"publishConfig": {
|
|
901
|
+
"access": "public"
|
|
902
|
+
}
|
|
903
|
+
}
|
|
904
|
+
```
|
|
905
|
+
|
|
906
|
+
## 4. 创建主包作为入口点
|
|
907
|
+
|
|
908
|
+
在`packages`目录下创建一个集合包,例如`packages/aastar/package.json`:
|
|
909
|
+
|
|
910
|
+
```json
|
|
911
|
+
{
|
|
912
|
+
"name": "aastar",
|
|
913
|
+
"version": "0.1.0",
|
|
914
|
+
"description": "AASTAR SDK全集合",
|
|
915
|
+
"main": "dist/index.js",
|
|
916
|
+
"types": "dist/index.d.ts",
|
|
917
|
+
"scripts": {
|
|
918
|
+
"build": "tsc"
|
|
919
|
+
},
|
|
920
|
+
"dependencies": {
|
|
921
|
+
"@aastar/airaccount": "workspace:*",
|
|
922
|
+
"@aastar/superpaymaster": "workspace:*"
|
|
923
|
+
// 添加其他所有子包作为依赖
|
|
924
|
+
},
|
|
925
|
+
"publishConfig": {
|
|
926
|
+
"access": "public"
|
|
927
|
+
}
|
|
928
|
+
}
|
|
929
|
+
```
|
|
930
|
+
|
|
931
|
+
然后创建相应的入口文件`packages/aastar/src/index.ts`,导出所有子包:
|
|
932
|
+
|
|
933
|
+
```typescript
|
|
934
|
+
export * from "@aastar/airaccount";
|
|
935
|
+
export * from "@aastar/superpaymaster";
|
|
936
|
+
// 导出其他所有子包
|
|
937
|
+
```
|
|
938
|
+
|
|
939
|
+
## 5. 使用工具管理版本和发布
|
|
940
|
+
|
|
941
|
+
您可以使用以下工具之一来管理版本和发布:
|
|
942
|
+
|
|
943
|
+
### 选项1: 使用pnpm + changesets
|
|
944
|
+
|
|
945
|
+
1. 安装changesets:
|
|
946
|
+
|
|
947
|
+
```bash
|
|
948
|
+
pnpm add -D -w @changesets/cli
|
|
949
|
+
pnpm changeset init
|
|
950
|
+
```
|
|
951
|
+
|
|
952
|
+
2. 配置发布脚本:在根目录的`package.json`中添加:
|
|
953
|
+
|
|
954
|
+
```json
|
|
955
|
+
{
|
|
956
|
+
"scripts": {
|
|
957
|
+
"build": "pnpm -r build",
|
|
958
|
+
"version": "changeset version",
|
|
959
|
+
"publish": "pnpm build && changeset publish"
|
|
960
|
+
}
|
|
961
|
+
}
|
|
962
|
+
```
|
|
963
|
+
|
|
964
|
+
### 选项2: 使用Lerna
|
|
965
|
+
|
|
966
|
+
1. 安装Lerna:
|
|
967
|
+
|
|
968
|
+
```bash
|
|
969
|
+
pnpm add -D -w lerna
|
|
970
|
+
```
|
|
971
|
+
|
|
972
|
+
2. 创建`lerna.json`:
|
|
973
|
+
|
|
974
|
+
```json
|
|
975
|
+
{
|
|
976
|
+
"version": "independent",
|
|
977
|
+
"npmClient": "pnpm",
|
|
978
|
+
"useWorkspaces": true,
|
|
979
|
+
"command": {
|
|
980
|
+
"publish": {
|
|
981
|
+
"ignoreChanges": ["*.md"],
|
|
982
|
+
"message": "chore(release): publish"
|
|
983
|
+
}
|
|
984
|
+
}
|
|
985
|
+
}
|
|
986
|
+
```
|
|
987
|
+
|
|
988
|
+
## 6. 处理包之间的依赖关系
|
|
989
|
+
|
|
990
|
+
如果子包之间有依赖关系,在依赖包的`package.json`中添加:
|
|
991
|
+
|
|
992
|
+
```json
|
|
993
|
+
{
|
|
994
|
+
"dependencies": {
|
|
995
|
+
"@aastar/some-dependency": "workspace:*"
|
|
996
|
+
}
|
|
997
|
+
}
|
|
998
|
+
```
|
|
999
|
+
|
|
1000
|
+
## 7. 统一配置和构建
|
|
1001
|
+
|
|
1002
|
+
创建一个根目录的`tsconfig.json`作为基础配置:
|
|
1003
|
+
|
|
1004
|
+
```json
|
|
1005
|
+
{
|
|
1006
|
+
"compilerOptions": {
|
|
1007
|
+
"target": "ES2020",
|
|
1008
|
+
"module": "ESNext",
|
|
1009
|
+
"moduleResolution": "node",
|
|
1010
|
+
"declaration": true,
|
|
1011
|
+
"strict": true,
|
|
1012
|
+
"esModuleInterop": true,
|
|
1013
|
+
"skipLibCheck": true,
|
|
1014
|
+
"forceConsistentCasingInFileNames": true
|
|
1015
|
+
}
|
|
1016
|
+
}
|
|
1017
|
+
```
|
|
1018
|
+
|
|
1019
|
+
然后,每个子包可以扩展此配置:
|
|
1020
|
+
|
|
1021
|
+
```json
|
|
1022
|
+
{
|
|
1023
|
+
"extends": "../../tsconfig.json",
|
|
1024
|
+
"compilerOptions": {
|
|
1025
|
+
"outDir": "./dist",
|
|
1026
|
+
"rootDir": "./src"
|
|
1027
|
+
},
|
|
1028
|
+
"include": ["src/**/*"]
|
|
1029
|
+
}
|
|
1030
|
+
```
|
|
1031
|
+
|
|
1032
|
+
## 8. 发布流程
|
|
1033
|
+
|
|
1034
|
+
1. 创建npm组织:
|
|
1035
|
+
- 在npm网站上注册`aastar`组织
|
|
1036
|
+
|
|
1037
|
+
2. 发布所有包:
|
|
1038
|
+
|
|
1039
|
+
```bash
|
|
1040
|
+
# 使用changesets
|
|
1041
|
+
pnpm changeset
|
|
1042
|
+
pnpm version
|
|
1043
|
+
pnpm publish
|
|
1044
|
+
|
|
1045
|
+
# 或使用Lerna
|
|
1046
|
+
pnpm lerna publish
|
|
1047
|
+
```
|
|
1048
|
+
|
|
1049
|
+
## 使用示例
|
|
1050
|
+
|
|
1051
|
+
用户可以按您希望的方式安装和使用SDK:
|
|
1052
|
+
|
|
1053
|
+
```bash
|
|
1054
|
+
# 安装单个包
|
|
1055
|
+
pnpm install @aastar/airaccount @aastar/superpaymaster
|
|
1056
|
+
|
|
1057
|
+
# 或安装全部功能
|
|
1058
|
+
pnpm install aastar
|
|
1059
|
+
```
|
|
1060
|
+
|
|
1061
|
+
使用示例:
|
|
1062
|
+
|
|
1063
|
+
```javascript
|
|
1064
|
+
// 单个包使用方式
|
|
1065
|
+
import { someFunction } from "@aastar/airaccount";
|
|
1066
|
+
|
|
1067
|
+
// 全部功能使用方式
|
|
1068
|
+
import { airaccount, superpaymaster } from "aastar";
|
|
1069
|
+
```
|
|
1070
|
+
|
|
1071
|
+
这种结构的主要优点是:
|
|
1072
|
+
|
|
1073
|
+
1. 用户可以根据需求选择安装单个包或全部功能
|
|
1074
|
+
2. 包之间可以共享代码,但又保持独立发布
|
|
1075
|
+
3. 可以统一管理版本,简化发布流程
|
|
1076
|
+
4. 便于维护和扩展
|
|
1077
|
+
|
|
1078
|
+
您对这种结构有什么特别的需求或问题吗?
|