Merge branch 'Superalgos:develop' into develop

2021-08-10 01:58:20 +08:00
commit ac889bfa5b
@@ -103,7 +103,7 @@ exports.newGithubServer = function newGithubServer() {
                                page
                            });

-                            if (filesChanged.length < 100) {
+                            if (listResponse.data.length < 100) {
                                lastPage = true
                            }

@@ -125,7 +125,7 @@ exports.newGithubServer = function newGithubServer() {
                                githubListArray.push(githubUsername)
                            }
                            console.log('[INFO] Github Server -> getRepoInfo -> doGithub -> getList -> ' + method + ' Page = ' + page)
-                            console.log('[INFO] Github Server -> getRepoInfo -> doGithub -> getList -> ' + method + ' Received = ' + filesChanged.length)
+                            console.log('[INFO] Github Server -> getRepoInfo -> doGithub -> getList -> ' + method + ' Received = ' + listResponse.data.length)

                        } catch (err) {
                            console.log(err)
@@ -140,6 +140,7 @@ exports.newGithubServer = function newGithubServer() {
                                console.log('[ERROR] Github Server -> getRepoInfo -> doGithub -> getList ->token starts with = ' + token.substring(0, 10) + '...')
                                console.log('[ERROR] Github Server -> getRepoInfo -> doGithub -> getList ->token ends with = ' + '...' + token.substring(token.length - 10))
                                error = err
+                                return
                            }
                        }
                    }
@@ -188,7 +189,7 @@ exports.newGithubServer = function newGithubServer() {
                    let docs = {
                        project: 'Governance',
                        category: 'Topic',
-                        type: 'Gov Error - Merge Pull Requests',
+                        type: 'Gov Error - Pull Requests Not Processed',
                        anchor: undefined,
                        placeholder: {}
                    }
@@ -241,12 +242,12 @@ exports.newGithubServer = function newGithubServer() {
                                    lastPage = true
                                }
                                console.log('[INFO] Github Server -> mergeGithubPullRequests -> doGithub -> getPrList -> Receiving Page = ' + page)
-                                for (let i = 0; i < filesChanged.length; i++) {
-                                    let pullRequest = filesChanged[i]
+                                for (let i = 0; i < listResponse.data.length; i++) {
+                                    let pullRequest = listResponse.data[i]
                                    console.log('[INFO] Github Server -> mergeGithubPullRequests -> doGithub -> getPrList -> Pull Request "' + pullRequest.title + '" found and added to the list to validate. ')
                                    githubPrListArray.push(pullRequest)
                                }
-                                console.log('[INFO] Github Server -> mergeGithubPullRequests -> doGithub -> getPrList -> Received = ' + filesChanged.length)
+                                console.log('[INFO] Github Server -> mergeGithubPullRequests -> doGithub -> getPrList -> Received = ' + listResponse.data.length)

                            } catch (err) {
                                console.log(err)
@@ -261,6 +262,7 @@ exports.newGithubServer = function newGithubServer() {
                                    console.log('[ERROR] Github Server -> mergeGithubPullRequests -> doGithub -> getPrList ->token starts with = ' + token.substring(0, 10) + '...')
                                    console.log('[ERROR] Github Server -> mergeGithubPullRequests -> doGithub -> getPrList ->token ends with = ' + '...' + token.substring(token.length - 10))
                                    error = err
+                                    return
                                }
                            }
                        }
@@ -293,6 +295,8 @@ exports.newGithubServer = function newGithubServer() {
                            let fileContentUrl  // URL to the only file at the PR
                            let fileContent     // File content of the only file at the PR
                            let userProfile     // User Profile Object
+                            let githubUsername  // The Github user name of who is submitting the Pull Request
+                            let mergeResponse   // The response received from the call to Gihub to merge the Pull Request

                            if (await validatePrHasMoreThanOneFile() === false) { continue }
                            if (await validateFileNameEqualsGithubUsername() === false) { continue }
@@ -370,7 +374,7 @@ exports.newGithubServer = function newGithubServer() {
                                let fileName = splittedURL[splittedURL.length - 1]
                                let splittedFileName = fileName.split('.')
                                fileName = splittedFileName[0]
-                                let githubUsername = pullRequest.user.login
+                                githubUsername = pullRequest.user.login

                                if (githubUsername !== fileName) {
                                    console.log('[INFO] Github Server -> mergeGithubPullRequests -> Validation #2 Failed -> Pull Request "' + pullRequest.title + '" not merged because the Github Username is not equal to the File Name. -> Github Username = ' + githubUsername + '-> fileName = ' + fileName)
@@ -487,7 +491,7 @@ exports.newGithubServer = function newGithubServer() {

                                let testUserProfile = userProfileIdMap.get(userProfile.id)
                                if (testUserProfile === undefined) { return true }
-                                if (testUserProfile !== userProfile.name) { 
+                                if (testUserProfile !== userProfile.name) {

                                    console.log('[INFO] Github Server -> mergeGithubPullRequests -> Validation #6 Failed -> Pull Request "' + pullRequest.title + '" not merged because the User Profile Id already exists and belongs to another User Profile on record. -> Profile Id = ' + userProfile.id + '-> User Profile with the same Id = ' + testUserProfile)

@@ -515,7 +519,7 @@ exports.newGithubServer = function newGithubServer() {
                                All validations passed, we will proceed an merge this Pull Request.
                                */
                                await CL.projects.foundations.utilities.asyncFunctions.sleep(GITHUB_API_WAITING_TIME)
-                                let mergeResponse = await octokit.rest.pulls.merge({
+                                mergeResponse = await octokit.rest.pulls.merge({
                                    owner: owner,
                                    repo: repo,
                                    pull_number: pullRequest.number,
@@ -40,6 +40,14 @@
            "text": "Search the exchange's website for information describing the listing process and requirements. Study the information carefully.",
            "updated": 1618562031958
        },
+        {
+            "style": "List",
+            "text": "If not enough information is available publicly, feel free to contact their support or listing teams for more information."
+        },
+        {
+            "style": "List",
+            "text": "You may also want to start filling a dummy listing requirement form to find out what kind of information the exchange requires."
+        },
        {
            "style": "List",
            "text": "Report on your findings using the Research Requirements bullet list below.",
@@ -66,7 +74,8 @@
        },
        {
            "style": "Text",
-            "text": "If you're not familiar with the process of editing pages in the Docs and contributing the pages you create or edit, please go to the Getting Started Plugin Workspace and do the Beyond the Basics Tutorial."
+            "text": "If you're not familiar with the process of editing pages in the Docs and contributing the pages you create or edit, please go to the Getting Started Tutorials Plugin Workspace and do the Beyond the Basics Tutorial.",
+            "updated": 1628509381517
        },
        {
            "style": "Subtitle",
@@ -85,8 +94,8 @@
        },
        {
            "style": "Json",
-            "text": "docs.add Topic to Superalgos: Exchange Listing Requirements Research->Exchange Name Listing Requirements->N",
-            "updated": 1618486204475
+            "text": "docs.add Topic to Fundamentals: Exchange Listing Requirements Research->Exchange Name Listing Requirements->N",
+            "updated": 1628510137089
        },
        {
            "style": "List",
@@ -139,7 +148,8 @@
        },
        {
            "style": "List",
-            "text": "Exchange Name->exchangeURL.com"
+            "text": "Exchange URL->exchangeURL.com",
+            "updated": 1628513074678
        },
        {
            "style": "List",
@@ -161,6 +171,10 @@
            "text": "Listing request form->pageURL.com",
            "updated": 1618498025893
        },
+        {
+            "style": "List",
+            "text": "Can list BEP 20 BSC tokens: Some exchanges may not be able to list tokens in the Binance Smart Chain. Make sure you find out if listing the token is technically possible."
+        },
        {
            "style": "List",
            "text": "Listing fee: Exchanges usually charge for listing new coins. Enter the fee and include any comments, exceptions, or details that may be relevant to our particular case.",
@@ -0,0 +1,225 @@
+{
+    "topic": "Exchange Listing Requirements Research",
+    "pageNumber": "2",
+    "type": "Probit Global Listing Requirements",
+    "definition": {
+        "text": "The exchange is ready to list Superalgos. Listing fee is $25k, plus 1 BTC in project tokens.",
+        "updated": 1628512539086
+    },
+    "paragraphs": [
+        {
+            "style": "Title",
+            "text": "Listing Requirements",
+            "updated": 1628515442342
+        },
+        {
+            "style": "List",
+            "text": "Exchange name: Probit Global"
+        },
+        {
+            "style": "List",
+            "text": "CMC ranking: 27",
+            "updated": 1628510522467
+        },
+        {
+            "style": "List",
+            "text": "Exchange home page: ",
+            "updated": 1628510560296
+        },
+        {
+            "style": "Link",
+            "text": "Exchange URL->www.probit.com",
+            "updated": 1628519777927
+        },
+        {
+            "style": "List",
+            "text": "Listing requirements page: ",
+            "updated": 1628510662586
+        },
+        {
+            "style": "Link",
+            "text": "Listing requirements->www.probit.com/en-us/listing",
+            "updated": 1628510672736
+        },
+        {
+            "style": "List",
+            "text": "Listing request form page: ",
+            "updated": 1628510689962
+        },
+        {
+            "style": "Link",
+            "text": "Listing request form->docs.google.com/forms/d/e/1FAIpQLSf4b5e25olgKVVY623XBe7Pw1LxFZcCVAGaBXLgJ0sw7KwvkA/viewform",
+            "updated": 1628510737641
+        },
+        {
+            "style": "List",
+            "text": "Can list BEP 20 tokens in BSC: Yes",
+            "updated": 1628511590834
+        },
+        {
+            "style": "List",
+            "text": "Listing fee: Bronze $25k, Silver $50k, Gold $80k -- plus 1 BTC in project tokens.",
+            "updated": 1628512487779
+        },
+        {
+            "style": "List",
+            "text": "Security deposit: No",
+            "updated": 1628510838412
+        },
+        {
+            "style": "List",
+            "text": "Volume requirements: No",
+            "updated": 1628510856025
+        },
+        {
+            "style": "List",
+            "text": "Market-making requirements: Included for 1 month in all plans; not required afterwards.",
+            "updated": 1628510894252
+        },
+        {
+            "style": "List",
+            "text": "Exchange users requirement: No",
+            "updated": 1628510904049
+        },
+        {
+            "style": "List",
+            "text": "Pairs available for first listing: USDT, BTC, ETH",
+            "updated": 1628510967084
+        },
+        {
+            "style": "List",
+            "text": "Waiting period: 2 weeks.",
+            "updated": 1628510983346
+        },
+        {
+            "style": "List",
+            "text": "Legal entity: A corporation is usually required.",
+            "updated": 1628511032973
+        },
+        {
+            "style": "List",
+            "text": "Legal opinion: Usually required.",
+            "updated": 1628511045422
+        },
+        {
+            "style": "List",
+            "text": "Selection process: N/A.",
+            "updated": 1628511087443
+        },
+        {
+            "style": "List",
+            "text": "Researcher's comments: I have an open channel with the listing team and have clarified some issues, as explained under the Negotiation title below.",
+            "updated": 1628512314800
+        },
+        {
+            "style": "Png",
+            "text": "PNGs/Governance/Docs/token-task-force/probit-listing-plans.png",
+            "updated": 1628516831766
+        },
+        {
+            "style": "List",
+            "text": "Researcher's Github.com Username: julian-molina",
+            "updated": 1628511321864
+        },
+        {
+            "style": "List",
+            "text": "Researcher's Telegram Username: @julianmolina",
+            "updated": 1628511330617
+        },
+        {
+            "style": "List",
+            "text": "Date of last revision: AUG 9th, 2021.",
+            "updated": 1628511355078
+        },
+        {
+            "style": "Title",
+            "text": "Negotiation"
+        },
+        {
+            "style": "Text",
+            "text": "@julianmolina has confirmed that:",
+            "updated": 1628512180751
+        },
+        {
+            "style": "List",
+            "text": "they accept Superalgos for listing;",
+            "updated": 1628511554947
+        },
+        {
+            "style": "List",
+            "text": "we can coordinate the listing date to suit PR & Marketing campaigns."
+        },
+        {
+            "style": "List",
+            "text": "they can wave the legal opinion if it's clear the token is not a security;"
+        },
+        {
+            "style": "List",
+            "text": "they don't need a corporation to sign the listing agreement. A KYCed executive (project leadership) works too;",
+            "updated": 1628512355591
+        },
+        {
+            "style": "List",
+            "text": "we can propose new or improved language in the listing agreement for a more balanced protection of both parties;",
+            "updated": 1628511650104
+        },
+        {
+            "style": "List",
+            "text": "we can have additional zero-fee accounts for market making at $5k each.",
+            "updated": 1628511671112
+        },
+        {
+            "style": "Title",
+            "text": "Exchange Evaluation"
+        },
+        {
+            "style": "Subtitle",
+            "text": "Corporate"
+        },
+        {
+            "style": "List",
+            "text": "Country of registration:"
+        },
+        {
+            "style": "List",
+            "text": "Year of registration:"
+        },
+        {
+            "style": "List",
+            "text": "Physical offices:"
+        },
+        {
+            "style": "List",
+            "text": "Licenses:"
+        },
+        {
+            "style": "Subtitle",
+            "text": "Traction",
+            "updated": 1628516949284
+        },
+        {
+            "style": "List",
+            "text": "Alexa site rank: 3500",
+            "updated": 1628517005331
+        },
+        {
+            "style": "Link",
+            "text": "Alexa->www.alexa.com/siteinfo/probit.com"
+        },
+        {
+            "style": "List",
+            "text": "Domain authority: 45",
+            "updated": 1628517390639
+        },
+        {
+            "style": "Link",
+            "text": "DA by Moz->moz.com/domain-analysis?site=probit.com",
+            "updated": 1628517409497
+        },
+        {
+            "style": "List",
+            "text": "CMC ranking: 27",
+            "updated": 1628517194530
+        }
+    ]
+}
@@ -0,0 +1,120 @@
+{
+    "topic": "Exchange Listing Requirements Research",
+    "pageNumber": "3",
+    "type": "LBank Listing Requirements",
+    "definition": {
+        "text": "Write a summary for this topic page."
+    },
+    "paragraphs": [
+        {
+            "style": "Title",
+            "text": "Listing Requirements",
+            "updated": 1628515469804
+        },
+        {
+            "style": "List",
+            "text": "Exchange name: LBank",
+            "updated": 1628512837877
+        },
+        {
+            "style": "List",
+            "text": "CMC ranking: The position of the exchange in the ranking as of the day of the research."
+        },
+        {
+            "style": "List",
+            "text": "Exchange home page: Edit the string below with the name of the exchange and the URL (without the protocol). ",
+            "updated": 1628512823690
+        },
+        {
+            "style": "Link",
+            "text": "Exchange URL->exchangeURL.com",
+            "updated": 1628512847099
+        },
+        {
+            "style": "List",
+            "text": "Listing requirements page: Edit the string below with the URL (without the protocol) of the page where you got the core of the information in this report. ",
+            "updated": 1628512803920
+        },
+        {
+            "style": "Link",
+            "text": "Listing requirements->pageURL.com"
+        },
+        {
+            "style": "List",
+            "text": "Listing request form page: Edit the string below with the URL (without the protocol) of the page (or online form) the project should use to request the listing of the token. ",
+            "updated": 1628512810149
+        },
+        {
+            "style": "Link",
+            "text": "Listing request form->pageURL.com"
+        },
+        {
+            "style": "List",
+            "text": "Can list BEP 20 BSC tokens: Some exchanges may not be able to list tokens in the Binance Smart Chain. Make sure you find out if listing the token is technically possible."
+        },
+        {
+            "style": "List",
+            "text": "Listing fee: Exchanges usually charge for listing new coins. Enter the fee and include any comments, exceptions, or details that may be relevant to our particular case."
+        },
+        {
+            "style": "List",
+            "text": "Security deposit: Some exchanges require a security deposit to be returned to the project after the listing is completed. Describe the details of such requirements if they exist."
+        },
+        {
+            "style": "List",
+            "text": "Volume requirements: Exchanges are in the business of charging transaction fees, so they usually expect to list tokens that have traction, in the understanding that such tokens will generate a certain level of trading volume. Some exchanges have a specific requirement about the expected volume. If the exchange requires a precise volume, enter it in numbers. Otherwise, describe what is expected in words."
+        },
+        {
+            "style": "List",
+            "text": "Market-making requirements: Many times exchanges expect projects to guarantee liquidity for the token on both sides of the order book. They sometimes require projects to hire specific market-makers or ask the project how they will deal with the issue. Explain what the exchange expects in this regard."
+        },
+        {
+            "style": "List",
+            "text": "Exchange users requirement: Some exchanges require the project to drive a certain number of users to the exchange. Describe any requirements that may exist in this regard."
+        },
+        {
+            "style": "List",
+            "text": "Pairs available for first listing: Some exchanges limit the number of pairs or even the precise quote assets that may be used for first listings. Describe whatever the exchange requires or offers in this regard."
+        },
+        {
+            "style": "List",
+            "text": "Waiting period: Most exchanges have a queue of listing requests and they may be able to estimate how long it takes to process. If there is information in this regard, include it here. The exchange may not announce what the estimate is, but you may deduce it or find out in community chats, forums, etc. Do your research."
+        },
+        {
+            "style": "List",
+            "text": "Legal entity: Some exchanges may require the project to be represented by a legal entity (a foundation, corporation, etc). If that is the case, enter \"Yes\", and describe what the requirement is. If there is no such requirement, enter \"No\"."
+        },
+        {
+            "style": "List",
+            "text": "Legal opinion: Some exchanges may require the project to get legal advice in the form of a \"legal opinion letter\" or some instrument of the sort, most times about the nature of the token, in particular, to determine if the token is a security or not. If that is the case, enter \"Yes\", and describe what the requirement is. If there is no such requirement, enter \"No\"."
+        },
+        {
+            "style": "List",
+            "text": "Selection process: Some exchanges describe the nature of the decision-making process to select which tokens shall be listed. Some involve the participation of their community, a voting process, or things of the sort. Describe what the process is like if there is any information about it."
+        },
+        {
+            "style": "List",
+            "text": "Researcher's comments: If you notice any information of importance to the listing process that is not covered in this list, include it here."
+        },
+        {
+            "style": "List",
+            "text": "Researcher's Github.com Username: This helps track the author of each research contribution."
+        },
+        {
+            "style": "List",
+            "text": "Researcher's Telegram Username: Same as above."
+        },
+        {
+            "style": "List",
+            "text": "Date of last revision: This report may be updated every once in a while. Use this field to note the last time the report was updated."
+        },
+        {
+            "style": "Title",
+            "text": "Negotiation"
+        },
+        {
+            "style": "List",
+            "text": "List what progress has been made in the ongoing negotiation."
+        }
+    ]
+}
@@ -0,0 +1,118 @@
+{
+    "topic": "Exchange Listing Requirements Research",
+    "pageNumber": "4",
+    "type": "Bittrex Global Listing Requirements",
+    "definition": {
+        "text": "Write a summary for this topic page."
+    },
+    "paragraphs": [
+        {
+            "style": "Title",
+            "text": "Listing Requirements",
+            "updated": 1628515483720
+        },
+        {
+            "style": "List",
+            "text": "Exchange name: Use the official, most common name of the exchange; the same you used in the name of the page."
+        },
+        {
+            "style": "List",
+            "text": "CMC ranking: The position of the exchange in the ranking as of the day of the research."
+        },
+        {
+            "style": "List",
+            "text": "Exchange home page: Edit the string below with the name of the exchange and the URL (without the protocol). Test the link and make sure it works.",
+            "updated": 1628513218161
+        },
+        {
+            "style": "Link",
+            "text": "Exchange URL->exchangeURL.com"
+        },
+        {
+            "style": "List",
+            "text": "Listing requirements page: Edit the string below with the URL (without the protocol) of the page where you got the core of the information in this report. Test the link and make sure it works.",
+            "updated": 1628513207300
+        },
+        {
+            "style": "Link",
+            "text": "Listing requirements->pageURL.com"
+        },
+        {
+            "style": "List",
+            "text": "Listing request form page: Edit the string below with the URL (without the protocol) of the page (or online form) the project should use to request the listing of the token. Test the link and make sure it works.",
+            "updated": 1628513198400
+        },
+        {
+            "style": "Link",
+            "text": "Listing request form->pageURL.com"
+        },
+        {
+            "style": "List",
+            "text": "Can list BEP 20 BSC tokens: Some exchanges may not be able to list tokens in the Binance Smart Chain. Make sure you find out if listing the token is technically possible."
+        },
+        {
+            "style": "List",
+            "text": "Listing fee: Exchanges usually charge for listing new coins. Enter the fee and include any comments, exceptions, or details that may be relevant to our particular case."
+        },
+        {
+            "style": "List",
+            "text": "Security deposit: Some exchanges require a security deposit to be returned to the project after the listing is completed. Describe the details of such requirements if they exist."
+        },
+        {
+            "style": "List",
+            "text": "Volume requirements: Exchanges are in the business of charging transaction fees, so they usually expect to list tokens that have traction, in the understanding that such tokens will generate a certain level of trading volume. Some exchanges have a specific requirement about the expected volume. If the exchange requires a precise volume, enter it in numbers. Otherwise, describe what is expected in words."
+        },
+        {
+            "style": "List",
+            "text": "Market-making requirements: Many times exchanges expect projects to guarantee liquidity for the token on both sides of the order book. They sometimes require projects to hire specific market-makers or ask the project how they will deal with the issue. Explain what the exchange expects in this regard."
+        },
+        {
+            "style": "List",
+            "text": "Exchange users requirement: Some exchanges require the project to drive a certain number of users to the exchange. Describe any requirements that may exist in this regard."
+        },
+        {
+            "style": "List",
+            "text": "Pairs available for first listing: Some exchanges limit the number of pairs or even the precise quote assets that may be used for first listings. Describe whatever the exchange requires or offers in this regard."
+        },
+        {
+            "style": "List",
+            "text": "Waiting period: Most exchanges have a queue of listing requests and they may be able to estimate how long it takes to process. If there is information in this regard, include it here. The exchange may not announce what the estimate is, but you may deduce it or find out in community chats, forums, etc. Do your research."
+        },
+        {
+            "style": "List",
+            "text": "Legal entity: Some exchanges may require the project to be represented by a legal entity (a foundation, corporation, etc). If that is the case, enter \"Yes\", and describe what the requirement is. If there is no such requirement, enter \"No\"."
+        },
+        {
+            "style": "List",
+            "text": "Legal opinion: Some exchanges may require the project to get legal advice in the form of a \"legal opinion letter\" or some instrument of the sort, most times about the nature of the token, in particular, to determine if the token is a security or not. If that is the case, enter \"Yes\", and describe what the requirement is. If there is no such requirement, enter \"No\"."
+        },
+        {
+            "style": "List",
+            "text": "Selection process: Some exchanges describe the nature of the decision-making process to select which tokens shall be listed. Some involve the participation of their community, a voting process, or things of the sort. Describe what the process is like if there is any information about it."
+        },
+        {
+            "style": "List",
+            "text": "Researcher's comments: If you notice any information of importance to the listing process that is not covered in this list, include it here."
+        },
+        {
+            "style": "List",
+            "text": "Researcher's Github.com Username: This helps track the author of each research contribution."
+        },
+        {
+            "style": "List",
+            "text": "Researcher's Telegram Username: Same as above."
+        },
+        {
+            "style": "List",
+            "text": "Date of last revision: This report may be updated every once in a while. Use this field to note the last time the report was updated."
+        },
+        {
+            "style": "Title",
+            "text": "Negotiation"
+        },
+        {
+            "style": "Text",
+            "text": "List what progress has been made in the ongoing negotiation."
+        }
+    ]
+}