![\"NPM](\"https://img.shields.io/npm/v/@lukso/lsp-factory.js.svg?style=flat\")
\n \n \n ![\"Tests](\"https://github.com/lukso-network/tools-lsp-factory/actions/workflows/lint-build-test.yml/badge.svg\"){kind=icon}
\n \n\n
Helper library to allow simple deployments of Universal Profiles, LSP7 Digital Assets, and LSP8 Identifiable Digital Assets on LUKSO.
\n\n\n\n\n\n\nFor more information see the LUKSO Documentation.
\n\n## Supported Networks\n\nThis library deploys contracts via [LSP23LinkedContractsFactory](https://docs.lukso.tech/standards/accounts/lsp23-linked-contracts-factory), which is deployed at the same address on all supported chains via the [Nick Factory](https://eips.ethereum.org/EIPS/eip-2470) for deterministic addresses:\n\n**LSP23 Factory Address:** `0x2300000A84D25dF63081feAa37ba6b62C4c89a30`\n\n| Network | Chain ID |\n|---|---|\n| LUKSO Mainnet | 42 |\n| LUKSO Testnet | 4201 |\n| Ethereum Mainnet | 1 |\n| BASE | 8453 |\n\nAll base contract implementations (ERC725Account, KeyManager, UniversalReceiverDelegate, LSP7, LSP8) are also deployed at the same addresses across chains via the Nick Factory.\n\n## Install\n\n```bash\nnpm install @lukso/lsp-factory.js\n```\n\n## Setup\n\n`@lukso/lsp-factory.js` v4 uses [viem](https://viem.sh/) for blockchain interactions. You need a `PublicClient` (for reading) and a `WalletClient` (for signing transactions).\n\n```typescript\nimport { createPublicClient, createWalletClient, http } from 'viem';\nimport { privateKeyToAccount } from 'viem/accounts';\nimport { luksoTestnet } from 'viem/chains';\nimport { LSPFactory } from '@lukso/lsp-factory.js';\n\nconst account = privateKeyToAccount('0x...');\n\nconst publicClient = createPublicClient({\n chain: luksoTestnet,\n transport: http(),\n});\n\nconst walletClient = createWalletClient({\n account,\n chain: luksoTestnet,\n transport: http(),\n});\n\nconst factory = new LSPFactory(publicClient, walletClient);\n```\n\n## Usage\n\n### Deploying a Universal Profile\n\nDeploys a Universal Profile (LSP0) and KeyManager (LSP6) atomically via [LSP23LinkedContractsFactory](https://docs.lukso.tech/standards/accounts/lsp23-linked-contracts-factory), then configures controller permissions and a Universal Receiver Delegate.\n\n```typescript\nconst contracts = await factory.UniversalProfile.deploy({\n controllerAddresses: ['0x...'], // Addresses that will control the UP\n});\n\nconsole.log('UP Address:', contracts.LSP0ERC725Account.address);\nconsole.log('KeyManager Address:', contracts.LSP6KeyManager.address);\n```\n\n#### With LSP3 metadata and a deterministic salt\n\n```typescript\nconst contracts = await factory.UniversalProfile.deploy(\n {\n controllerAddresses: ['0x...'],\n lsp3DataValue: '0x...', // Pre-encoded LSP3Profile data (VerifiableURI)\n },\n {\n salt: '0x...', // bytes32 salt for deterministic address generation\n }\n);\n```\n\n#### With custom controller permissions\n\n```typescript\nconst contracts = await factory.UniversalProfile.deploy({\n controllerAddresses: [\n '0xFullPermissionsAddress', // Gets ALL_PERMISSIONS by default\n {\n address: '0xLimitedAddress',\n permissions: '0x0000000000000000000000000000000000000000000000000000000000000010',\n },\n ],\n});\n```\n\n### Pre-computing Addresses\n\nCompute the UP and KeyManager addresses before deploying:\n\n```typescript\nconst { upAddress, keyManagerAddress } = await factory.UniversalProfile.computeAddress(\n { controllerAddresses: ['0x...'] },\n { salt: '0x...' } // Use the same salt you will deploy with\n);\n```\n\n### Deploying an LSP7 Digital Asset\n\nDeploys an [LSP7 Digital Asset](https://docs.lukso.tech/standards/tokens/LSP7-Digital-Asset) (fungible token) as a minimal proxy:\n\n```typescript\nconst contracts = await factory.LSP7DigitalAsset.deploy({\n name: 'My Token',\n symbol: 'MTK',\n controllerAddress: '0x...', // Owner of the token contract\n tokenType: 0, // 0 = Token, 1 = NFT, 2 = Collection\n isNFT: false, // Whether the token is non-divisible\n});\n\nconsole.log('LSP7 Address:', contracts.LSP7DigitalAsset.address);\n```\n\n#### With metadata\n\n```typescript\nconst contracts = await factory.LSP7DigitalAsset.deploy({\n name: 'My Token',\n symbol: 'MTK',\n controllerAddress: '0x...',\n tokenType: 0,\n isNFT: false,\n digitalAssetMetadata: {\n verification: {\n method: 'keccak256(utf8)',\n data: '0x...',\n },\n url: 'ipfs://Qm...',\n },\n});\n```\n\n### Deploying an LSP8 Identifiable Digital Asset\n\nDeploys an [LSP8 Identifiable Digital Asset](https://docs.lukso.tech/standards/tokens/LSP8-Identifiable-Digital-Asset) (NFT) as a minimal proxy:\n\n```typescript\nconst contracts = await factory.LSP8IdentifiableDigitalAsset.deploy({\n name: 'My NFT Collection',\n symbol: 'MNFT',\n controllerAddress: '0x...',\n tokenType: 1, // 0 = Token, 1 = NFT, 2 = Collection\n tokenIdFormat: 1, // Token ID format (e.g., 1 = Number)\n});\n\nconsole.log('LSP8 Address:', contracts.LSP8IdentifiableDigitalAsset.address);\n```\n\n### Deployment Events\n\nAll `deploy` methods accept an `onDeployEvents` callback for tracking deployment progress:\n\n```typescript\nconst contracts = await factory.UniversalProfile.deploy(\n { controllerAddresses: ['0x...'] },\n {\n onDeployEvents: {\n next: (event) => {\n console.log(event.status, event.contractName, event.functionName);\n },\n error: (error) => {\n console.error('Deployment error:', error);\n },\n complete: (deployedContracts) => {\n console.log('Deployment complete:', deployedContracts);\n },\n },\n }\n);\n```\n\n## Development\n\n### Install dependencies\n\n```bash\nnpm install\n```\n\n### Lint\n\n```bash\nnpm run lint\nnpm run lint:fix # auto-fix\n```\n\n### Build\n\n```bash\nnpm run build\n```\n\n### Test\n\n```bash\nnpm test\n```\n\n## Contributing\n\nPlease check [CONTRIBUTING](./CONTRIBUTING.md).\n\n## License\n\nlsp-factory.js is [Apache 2.0 licensed](./LICENSE).\n","readmeFilename":"README.md"}![](\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg\"){kind=icon}
\n ![\"Issues\"](\"https://img.shields.io/github/issues/lukso-network/tools-lsp-factory?color=0088ff\")
\n ![\"GitHub](\"https://img.shields.io/github/issues-pr/lukso-network/tools-lsp-factory?color=0088ff\")
\n