Skip to content

docs: update lsp-factory.js — remove deprecated, polish for v4#1365

Merged
frozeman merged 4 commits intolukso-network:mainfrom
emmet-bot:docs/update-lsp-factory-v4
Apr 17, 2026
Merged

docs: update lsp-factory.js — remove deprecated, polish for v4#1365
frozeman merged 4 commits intolukso-network:mainfrom
emmet-bot:docs/update-lsp-factory-v4

Conversation

@emmet-bot
Copy link
Copy Markdown
Contributor

Summary

Updates the lsp-factory.js documentation to reflect its active, maintained status after the v4 refactor.

Changes

_category_.yml

  • Removed (deprecated) from the sidebar label
  • Set collapsed: false so it's visible by default

getting-started.md

  • Added Requirements info block (Node.js >= 22, TypeScript >= 5.9)
  • Split the install command: @lukso/lsp-factory.js is the only required package; @erc725/erc725.js is now shown as optional (only needed for encoding LSP3 metadata or custom permissions)
  • Added Version History section documenting v4 (ethers.js → viem, IPFS removed, LSP23 atomic deployment) vs v3 and earlier

What's NOT changed (already correct)

  • All code examples (viem setup, deployment calls, LSP7/LSP8, events) — already accurate for v4 API
  • tokenType values match LSP4_TOKEN_TYPES enum
  • keccak256(bytes) verification method is correct
  • Internal doc links and Docusaurus redirects are intact

Context

The library was fully refactored:

  • ethers.js → viem
  • IPFS upload functionality removed
  • Deployment via LSP23LinkedContractsFactory (atomic UP + KeyManager deployment)
  • Latest npm release: 3.3.3
  • Node.js 22+ required, TypeScript 6 compatible

emmet-bot and others added 2 commits April 17, 2026 14:16
- Remove '(deprecated)' label and uncollapse category sidebar
- Add Node.js 22+ and TypeScript 5.9+ requirements note
- Split install: erc725.js is now optional (only for LSP3 encoding)
- Add Version History section noting v4 rewrite (ethers.js → viem, LSP23 atomic deployment)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Lead with what the library does and why, not just what it deploys
- Move Quick Start (install → deploy in one flow) to the top
- Restructure sections by user intent: UP options, tokens, events
- Replace jargon with plain explanations (e.g., 'smart accounts' not just 'LSP0')
- Move Supported Networks to the bottom (reference, not intro)
- Add token ID format table for LSP8
- Remove Version History section (not user-facing)
- Keep all code examples accurate to v4 API
@emmet-bot emmet-bot force-pushed the docs/update-lsp-factory-v4 branch from 094142d to 8ebca35 Compare April 17, 2026 12:23
@emmet-bot emmet-bot force-pushed the docs/update-lsp-factory-v4 branch from a27b74b to 7c7686d Compare April 17, 2026 13:21
@frozeman frozeman merged commit f85ed6d into lukso-network:main Apr 17, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants