@patchworkdev/common/src/codegen/generators/overrideFuncGen.ts

Patchwork Development Kit

import { Feature } from "../../types";
import { ContractSchema } from "../contractSchema";
import { Generator, ind } from "../generator";

export class OverrideFuncGen implements Generator {
    gen(schema: ContractSchema): string {
        let features = schema.features;
        let out = schema.hasLiteRef() ? `` +
        `function _checkWriteAuth() internal override(Patchwork721, PatchworkLiteRef) view returns (bool allow) {\n` +
        `    return Patchwork721._checkWriteAuth();\n` +
        `}\n` : "";
        // weakref overrides all other implementations
        if (features.includes(Feature.WEAKREF)) {
            let ownerOfParent = 'ERC721';
            let lockedParent = 'Patchwork721';
            let transferFromParent = 'ERC721';
            let overrideParents = '';
            if (features.includes(Feature.PATCH) && features.includes(Feature.FRAGMENTSINGLE)) {
                overrideParents = '(PatchworkFragmentSingle, PatchworkPatch)';
            }
            if ((features.includes(Feature.ACCOUNTPATCH) || features.includes(Feature['1155PATCH'])) && features.includes(Feature.FRAGMENTSINGLE)) {
                overrideParents = '(ERC721, IERC721, PatchworkFragmentSingle)';
            }
            out += `\n`;
            out += `/**\n`;
            out += `@dev See {IERC721-ownerOf}\n`;
            out += `*/\n`;
            out += `function ownerOf(uint256 tokenId) public view virtual override${overrideParents} returns (address) {\n`;
            out += `    // Weak assignment uses normal ownership\n`;
            out += `    return ${ownerOfParent}.ownerOf(tokenId);\n`;
            out += `}\n`;
            if ((features.includes(Feature.ACCOUNTPATCH) || features.includes(Feature['1155PATCH'])) && features.includes(Feature.FRAGMENTSINGLE)) {
                overrideParents = '(Patchwork721, PatchworkFragmentSingle)';
            }
            out += `\n`;
            out += `/**\n`;
            out += `@dev See {IPatchwork721-locked}\n`;
            out += `*/\n`;
            out += `function locked(uint256 tokenId) public view virtual override${overrideParents} returns (bool) {\n`;
            out += `    // Weak assignment uses base 721 locking behavior\n`;
            out += `    return ${lockedParent}.locked(tokenId);\n`;
            out += `}\n`;
            out += `\n`;
            out += `/**\n`;
            out += `@dev See {IPatchwork721-setLocked}\n`;
            out += `*/\n`;
            out += `function setLocked(uint256 tokenId, bool locked_) public virtual override${overrideParents} {\n`;
            out += `    // Weak assignment uses base 721 locking behavior\n`;
            out += `    ${lockedParent}.setLocked(tokenId, locked_);\n`;
            out += `}\n`;
            out += `\n`;
            if (features.includes(Feature.PATCH) && features.includes(Feature.FRAGMENTSINGLE)) {
                let _overrideParents = '(PatchworkFragmentSingle, PatchworkPatch)';
                if (features.includes(Feature.REVERSIBLE)) {
                    _overrideParents = '(PatchworkFragmentSingle, PatchworkPatch, IPatchworkPatch)';
                }
                out += `/**\n`
                out += `@dev See {IPatchworkAssignableNFT-updateOwnership}\n`
                out += `*/\n`
                out += `function updateOwnership(uint256 tokenId) public virtual override${_overrideParents} {\n`
                out += `    // Weak assignment uses normal ownership updater\n`
                out += `    PatchworkFragmentSingle.updateOwnership(tokenId);\n`
                out += `}\n`;
                out += `\n`;
            }
            out += `/**\n`;
            out += `@dev See {IERC721-transferFrom}.\n`;
            out += `*/\n`;
            out += `function transferFrom(address from, address to, uint256 tokenId) public virtual override {\n`;
            out += `    // Weak assignment skips calling PatchworkProtocol.applyTransfer()\n`;
            out += `    if (locked(tokenId)) {\n`;
            out += `        revert IPatchworkProtocol.Locked(address(this), tokenId);\n`;
            out += `    }\n`;
            out += `    ${transferFromParent}.transferFrom(from, to, tokenId);\n`;
            out += `}\n`;
            out += `\n`;
            out += `/**\n`;
            out += `@dev See {IERC721-safeTransferFrom}.\n`;
            out += `*/\n`;
            out += `function safeTransferFrom(address from, address to, uint256 tokenId, bytes memory data) public virtual override {\n`;
            out += `    // Weak assignment skips calling PatchworkProtocol.applyTransfer()\n`;
            out += `    if (locked(tokenId)) {\n`;
            out += `        revert IPatchworkProtocol.Locked(address(this), tokenId);\n`;
            out += `    }\n`;
            out += `    ${transferFromParent}.safeTransferFrom(from, to, tokenId, data);\n`;
            out += `}\n`;
        } else {
            if (features.includes(Feature.PATCH) && features.includes(Feature.FRAGMENTSINGLE)) {
                let IPatchworkPatch = features.includes(Feature.REVERSIBLE) ? 'IPatchworkPatch, ' : '';
                let parentContract = 'PatchworkPatch';
                out += `\n`;
                out += `function setLocked(uint256 tokenId, bool locked_) public virtual override(${parentContract}, PatchworkFragmentSingle) {\n`;
                out += `    return ${parentContract}.setLocked(tokenId, locked_);\n`;
                out += `}\n`;
                out += `\n`;
                out += `function locked(uint256 /* tokenId */) public pure virtual override(${parentContract}, PatchworkFragmentSingle) returns (bool) {\n`;
                out += `    return false;\n`;
                out += `}\n`;
                out += `\n`;
                out += `function ownerOf(uint256 tokenId) public view virtual override(${parentContract}, PatchworkFragmentSingle) returns (address) {\n`;
                out += `    return ${parentContract}.ownerOf(tokenId);\n`;
                out += `}\n`;
                out += `\n`;
                out += `function updateOwnership(uint256 tokenId) public virtual override(${parentContract}, ${IPatchworkPatch}PatchworkFragmentSingle) {\n`;
                out += `    ${parentContract}.updateOwnership(tokenId);\n`;
                out += `}\n`;
            }
            if (features.includes(Feature.PATCH) && features.includes(Feature.FRAGMENTMULTI)) {
                let parentContract = 'PatchworkPatch';
                out += `\n`;
                out += `function setLocked(uint256 tokenId, bool locked_) public virtual override(${parentContract}, Patchwork721) {\n`;
                out += `    return ${parentContract}.setLocked(tokenId, locked_);\n`;
                out += `}\n`;
                out += `\n`;
                out += `function locked(uint256 /* tokenId */) public pure virtual override(${parentContract}, Patchwork721) returns (bool) {\n`;
                out += `    return false;\n`;
                out += `}\n`;
                out += `\n`;
                out += `function ownerOf(uint256 tokenId) public view virtual override(${parentContract}, ERC721, IERC721) returns (address) {\n`;
                out += `    return ${parentContract}.ownerOf(tokenId);\n`;
                out += `}\n`;
            }
            if ((features.includes(Feature.ACCOUNTPATCH) || features.includes(Feature['1155PATCH'])) && features.includes(Feature.FRAGMENTSINGLE)) {
                out += `\n`;
                out += `function setLocked(uint256 tokenId, bool locked_) public virtual override(Patchwork721, PatchworkFragmentSingle) {\n`;
                out += `    PatchworkFragmentSingle.setLocked(tokenId, locked_);\n`;
                out += `}\n`;
                out += `\n`;
                out += `function locked(uint256 tokenId) public view virtual override(Patchwork721, PatchworkFragmentSingle) returns (bool) {\n`;
                out += `    return PatchworkFragmentSingle.locked(tokenId);\n`;
                out += `}\n`;
                out += `\n`;
                out += `function ownerOf(uint256 tokenId) public view virtual override(ERC721, IERC721, PatchworkFragmentSingle) returns (address) {\n`;
                out += `    return PatchworkFragmentSingle.ownerOf(tokenId);\n`;
                out += `}\n`;
            }
        }
        
        return ind(4, `${out}`);
    }
}