{"_id":"@dforo3/metaforo-sdk-metamask","_rev":"1-a6fbdea7523224b2c051c00d55090113","name":"@dforo3/metaforo-sdk-metamask","dist-tags":{"latest":"0.4.11-beta.0"},"versions":{"0.4.10":{"name":"@dforo3/metaforo-sdk-metamask","description":"Login method only provided through Metamask","version":"0.4.10","author":{"name":"Metaforo"},"license":"ISC","homepage":"https://github.com/metaforo/comment3#readme","bugs":{"url":"https://github.com/metaforo/comment3/issues"},"main":"./dist/cjs/index.js","module":"./dist/esm/index.js","types":"./dist/esm/index.d.js","peerDependencies":{"react":"^18.2.0","react-dom":"^18.2.0"},"dependencies":{"@emotion/react":"^11.10.4","@emotion/styled":"^11.10.4","@ensdomains/ensjs":"^3.0.0-alpha.34","@mui/icons-material":"^5.10.9","@mui/lab":"^5.0.0-alpha.102","@mui/material":"^5.10.9","ethers":"^5.7.2","everpay":"^0.5.4","quill":"^1.3.7","quill-emoji":"^0.2.0","quill-mention":"^3.1.0","quilljs-markdown":"^1.2.0","web-vitals":"^2.1.4","react-svg":"^15.1.11","react-quill":"^2.0.0","web3":"^1.8.1","typescript":"^4.9.3"},"devDependencies":{"@simbathesailor/babel-plugin-use-what-changed":"^2.1.0","@types/node":"^16.11.65","@types/react":"^18.0.25","@types/react-dom":"^18.0.6","axios":"^1.1.3","copyfiles":"^2.4.1","customize-cra":"^1.0.0","lodash":"^4.17.21","process":"^0.11.10","react-scripts":"5.0.1","rimraf":"^3.0.2","sass":"^1.56.1"},"scripts":{"build":"npm run clean && npm run build:esm && npm run build:cjs && npm run copy-files","build:esm":"tsc","build:cjs":"tsc --module commonjs --outDir dist/cjs","develop":"npm run build:esm && npm run copy-files","clean":"rimraf dist/tsc && rimraf dist/esm","copy-files":"copyfiles -u 1 src/**/*.css dist/cjs && copyfiles -u 1 src/**/*.css dist/esm","prettier":"prettier --write \"{src,tests,example/src}/**/*.{js,ts,jsx,tsx}\"","lint":"eslint \"{**/*,*}.{js,ts,jsx,tsx}\"","prepare":"npm run build","prepublishOnly":"npm run prettier && npm run lint"},"repository":{"type":"git","url":"git+https://github.com/metaforo/comment3.git"},"keywords":["metaforo","tipping","comment","web3"],"browserslist":{"production":[">0.2%","not dead","not op_mini all"],"development":["last 1 chrome version","last 1 firefox version","last 1 safari version"]},"gitHead":"58ba74213723357c1deba973842eb885d3b2b441","_id":"@dforo3/metaforo-sdk-metamask@0.4.10","_nodeVersion":"18.12.1","_npmVersion":"8.19.2","dist":{"integrity":"sha512-5+aOrNnLBQ+FS+aZ31+9BRCVc2V6YrSLkR6J4HS31pDifvc1ga+mdhwUN+AX+aruNeqfT6Qt319w96u4OFt1iA==","shasum":"9658049757f1ac9f5252ccf16f729f1bf34054a7","tarball":"https://registry.npmjs.org/@dforo3/metaforo-sdk-metamask/-/metaforo-sdk-metamask-0.4.10.tgz","fileCount":274,"unpackedSize":2923015,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCNCI5MPGDrEYd1bJ++6/immNtzVV5rCzU/9FnMhmJZHAIhAP56pOjZ8RHjebc0GV1NfdmojqMob3TSEeB2SCLlaLih"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjpXNOACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqWJg//c21Hl67AuUgjxRFspKD8kCQB2SZ+Ak5oloSBHPBoPvW/a33z\r\ncP2mrAxDlv527x5uINGUSQ6da31l83uD3kTbjcR1j/B/7ANdnjxoM0So1jHL\r\npeYF9P0dFEk+61ouiQotfNPYw5wtWPvrbP/j0bpNpErlrAZYvoMv94IoR75L\r\n5DF+bF8SFXoI2HkoEMLo0S3JwPoTTi3f0iJM2ukQlUw0Hqwle+IX97dtXN3E\r\n7m5KOFjTPBv+s3kFIUD5E4PD4I0q6bJ9ufh85IPuqhEPt+yvfqRgA7qr48iu\r\nH7U7VocO7YL81c5MUV5Rh5rEJHdz9XzWdhVWXZa84UhJ7TvlNmntjHvHVtr3\r\nOUQIg9z7lEvHBQlPr4lnF67Y8008OJbJxf9y3TxkdJHrn74B0xSBE9JbTq5O\r\nnSdIYCPG0f6nHYRHQHdd6vqazXInoo8PNekPZXrfRUulpt45eg+ZYW/+3Q9y\r\nBd/6m5zaU5c+JftWFuWKEqYxspayQnr4GZ4YTP8yFAHz1GFgBotPDKGQZ7DO\r\nKZaTz7yU6sCcN2m4GV9eJPFBLpcO7oq38Fv9BRShzSsi3zGJQgHoOrADeV+n\r\nWC+eq7aYXJrMutBlPaU/gmW+C7tXfoFUBiQEU3WuSmG2isrWctZt1mSR2J9s\r\nRkmrVp2qgOhTrExWaPruEmI2+GaLnx8z7xU=\r\n=+qEj\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"6v","email":"linvan6v@gmail.com"},"directories":{},"maintainers":[{"name":"6v","email":"linvan6v@gmail.com"},{"name":"metaforo","email":"admin@metaforo.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/metaforo-sdk-metamask_0.4.10_1671787342243_0.9971281175952353"},"_hasShrinkwrap":false},"0.4.11-beta.0":{"name":"@dforo3/metaforo-sdk-metamask","description":"Login method only provided through Metamask","version":"0.4.11-beta.0","author":{"name":"Metaforo"},"license":"ISC","homepage":"https://github.com/metaforo/comment3#readme","bugs":{"url":"https://github.com/metaforo/comment3/issues"},"main":"./dist/cjs/index.js","module":"./dist/esm/index.js","types":"./dist/esm/index.d.js","peerDependencies":{"react":"^18.2.0","react-dom":"^18.2.0"},"dependencies":{"@emotion/react":"^11.10.4","@emotion/styled":"^11.10.4","@ensdomains/ensjs":"^3.0.0-alpha.34","@mui/icons-material":"^5.10.9","@mui/lab":"^5.0.0-alpha.102","@mui/material":"^5.10.9","ethers":"^5.7.2","everpay":"^0.5.4","quill":"^1.3.7","quill-emoji":"^0.2.0","quill-mention":"^3.1.0","quilljs-markdown":"^1.2.0","web-vitals":"^2.1.4","react-svg":"^15.1.11","react-quill":"^2.0.0","web3":"^1.8.1","typescript":"^4.9.3"},"devDependencies":{"@simbathesailor/babel-plugin-use-what-changed":"^2.1.0","@types/node":"^16.11.65","@types/react":"^18.0.25","@types/react-dom":"^18.0.6","axios":"^1.1.3","copyfiles":"^2.4.1","customize-cra":"^1.0.0","lodash":"^4.17.21","process":"^0.11.10","react-scripts":"5.0.1","rimraf":"^3.0.2","sass":"^1.56.1"},"scripts":{"build":"npm run clean && npm run build:esm && npm run build:cjs && npm run copy-files","build:esm":"tsc","build:cjs":"tsc --module commonjs --outDir dist/cjs","develop":"npm run build:esm && npm run copy-files","clean":"rimraf dist/tsc && rimraf dist/esm","copy-files":"copyfiles -u 1 src/**/*.css dist/cjs && copyfiles -u 1 src/**/*.css dist/esm","prettier":"prettier --write \"{src,tests,example/src}/**/*.{js,ts,jsx,tsx}\"","lint":"eslint \"{**/*,*}.{js,ts,jsx,tsx}\"","prepare":"npm run build","prepublishOnly":"npm run prettier && npm run lint"},"repository":{"type":"git","url":"git+https://github.com/metaforo/comment3.git"},"keywords":["metaforo","tipping","comment","web3"],"browserslist":{"production":[">0.2%","not dead","not op_mini all"],"development":["last 1 chrome version","last 1 firefox version","last 1 safari version"]},"gitHead":"31ac78d1dc3f05e08b709cd4fc76c918a17e4e09","_id":"@dforo3/metaforo-sdk-metamask@0.4.11-beta.0","_nodeVersion":"18.12.1","_npmVersion":"8.19.2","dist":{"integrity":"sha512-d+f2YmX7PzC081yf04S3/q3vyus7n9z/THip0MtjN1mLwyLblSlI7SS4J12EvkQUVGAJ+8JyLUzSzzn2a1NC/Q==","shasum":"6a64385e177970c706f6ef2f2dd58d300521a149","tarball":"https://registry.npmjs.org/@dforo3/metaforo-sdk-metamask/-/metaforo-sdk-metamask-0.4.11-beta.0.tgz","fileCount":274,"unpackedSize":2922885,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEoD3HvQb+SLwj4H4JNW8xKtxi/sOhotoPK0+zzJfIq2AiBrm5HkzHcTkZ86VX++hQQlM//TdxRd/gE+cz+4rHXWHw=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjpXUcACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoeXQ//ZbPRqGH/LKSWi+YC9jDZvmew3hR4cS35CLRGGXiYWO+ZfTS9\r\njkYwqpAhFDetD8uD44k/0yjXdkRKvLMmGE0X2iNrqXq/O9VrOrJxnze4WwhI\r\nZ7frLBVtmTvctANqhJ2fMWEQJRrgywFJkXDS9ukxJqaOUB/QR4+bTEirXJnB\r\n69evtv2fQpUO70to3az2BiHyv/evsmrp3HxT9ZBX5CHt2d/Fl8we4fcY+zTx\r\nkJ/v7Ridn9+k/Xs7xBfnSLWMDD9L6t4pKy3bLUSYIBwvBWLO/4h0pj3/HoaY\r\n7SG7src+w0zXtIwnBqLU4BBnyUee4rLUd1F5Id4dehpMaYCUgFD2fEaxiR1M\r\nk9YKPrc5LedSevBHZMlw+70XbXGV6a0KLl8YeqEiVx/CQE97ED6QRv2Kai97\r\nhAW8jKjPLf5VRIyiBMXeKGeWfNilaauaOkq8f10j0SwKABjVcPC9BMshwuET\r\nZJssTa725cVp+XOPqFuDMRu5vf3/XqFb4rv8smyHamIRKCOcgQTOth30dYVh\r\nCALBvgob9dDq1v6M5LxkQ6QiBf2xUDcfel/igr2Q6pyEK+An3jEvWz1+2S8e\r\nsnoTsgVscEKID4YXx6jtnGuKDrOLBfoGbVT3CPA1dd6pC2To9rdI/I7uk6yC\r\nam/yOde11/LC7MHOPncBe4icgfG4AeJ0uuI=\r\n=r0IV\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"6v","email":"linvan6v@gmail.com"},"directories":{},"maintainers":[{"name":"6v","email":"linvan6v@gmail.com"},{"name":"metaforo","email":"admin@metaforo.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/metaforo-sdk-metamask_0.4.11-beta.0_1671787803917_0.38093318468815784"},"_hasShrinkwrap":false}},"time":{"created":"2022-12-23T09:22:22.172Z","0.4.10":"2022-12-23T09:22:22.480Z","modified":"2022-12-23T09:30:04.682Z","0.4.11-beta.0":"2022-12-23T09:30:04.542Z"},"maintainers":[{"name":"6v","email":"linvan6v@gmail.com"},{"name":"metaforo","email":"admin@metaforo.io"}],"description":"Login method only provided through Metamask","homepage":"https://github.com/metaforo/comment3#readme","keywords":["metaforo","tipping","comment","web3"],"repository":{"type":"git","url":"git+https://github.com/metaforo/comment3.git"},"author":{"name":"Metaforo"},"bugs":{"url":"https://github.com/metaforo/comment3/issues"},"license":"ISC","readme":"# Metaforo SDK\n\nMetaforo SDK contains following components:\n\n- Tipping Widget\n- Comment Widget\n- Like Widget\n\n## How to install\n\n### yarn\n\n`yarn add @dforo3/metaforo-sdk`\n\n### npm\n\n`npm install @dforo3/metaforo-sdk`\n\n## Tipping Widget\n\nMetaforo Tipping Widget is a widget for tipping to specified wallet addresses. Currently supports :\n\n- ArConnect\n- Metamask\n- WalletConnect\n\nBased on Everpay\n\n### Usage\n\n```html\nimport {MfTippingWidget} from '@dforo3/metaforo-sdk';\n<MfTippingWidget\n    siteName='INPUT_SITE_NAME'\n    pageId='INPUT_PAGE_ID'\n    receiverAddress='INPUT_WALLET_ADDRESS'\n    receiverUsername='INPUT_USERNAME'\n    receiverChainId={1}\n    theme='light'\n/>\n```\n\nYou can modify the theme attribute to specify **light** or **dark** styles.\n\n## Comment Widget\n\nMetaforo Comment Widget provides a comment box for the website, allowing users to send and view comments after logging\nin via their wallet.\n\nThe comment data will be stored in Metaforo's Group. Site owners can manage their comments via metaforo.\n\n### Usage\n\n```html\nimport {MfCommentWidget} from '@dforo3/metaforo-sdk';\n<MfCommentWidget\n    siteName='INPUT_SITE_NAME'\n    pageId='INPUT_PAGE_ID'\n    userDisplayName='INPUT_USERNAME'\n    userAvatar='INPUT_AVATAR_URL'\n    theme='light'\n/>\n```\n\n- The `siteName` field must be applied for, and we will provide you with the corresponding value.\n- The `pageId` is used to differentiate between different pages. Comments loaded with the same pageId will be the same.\n- The `userDisplayName` and `userAvatar` field is optional. It is used to specify the current user's username or avatar url, but the user can manually change\n  this value after logging in.\n- The `theme` field is optional. You can use it to specify the  **light** or **dark** styles.\n\n## Like Widget\n\nMetaforo Like Widget provides a like button for the website. The usage is similar with comment widget.\n\n### Usage\n\n\n```html\nimport {MfLikeWidget} from '@dforo3/metaforo-sdk';\n<MfLikeWidget\n    siteName='INPUT_SITE_NAME'\n    pageId='INPUT_PAGE_ID'\n    userDisplayName='INPUT_USERNAME'\n    userAvatar='INPUT_AVATAR_URL'\n    theme='light'\n/>\n```\n\nFor the meaning of the parameters, see MfCommentWidget.\n\n## Custom Style\n\nWe use mui as the component library. If you need to customize the style of the widget, you can define a variable in\nthe window with the value of mui's theme definition in mfTheme. For the full definition format, please refer\nto [this document](https://mui.com/material-ui/customization/default-theme/).\n\n```javascript\n<script>\nwindow.mfTheme = {\n    palette: {\n        primary: {\n            main: '#702AF1',\n        },\n        background: {\n            paper: '#ffffff',\n        },\n        text: {\n            primary: '#222222',\n            secondary: '#71717A',\n        },\n    }\n}\n</script>\n```\n\n# Known issues\n\n## Web3 and Create-react-app\n\nIf you are using create-react-app version >=5 you may run into issues building. This is because NodeJS polyfills are not\nincluded in the latest version of create-react-app.\n\nYou can follow this topic to solve this\nissue : [Web3.js - Web3 and Create-react-app](https://github.com/web3/web3.js#web3-and-create-react-app)","readmeFilename":"README.md"}