Merge pull request #315 from zeeshanakram3/YPP-api-free-signup-workflow

YPP API free Signup Workflow
Joystream · Aug 3, 2024 · 188482d · 188482d
2 parents e2972c7 + 7c26ddc
commit 188482d
Show file tree

Hide file tree

Showing 52 changed files with 10,802 additions and 4,660 deletions.
diff --git a/config.yml b/config.yml
@@ -34,10 +34,8 @@ logs:
   #     username: elastic-username
   #     password: elastic-password
 youtube:
-  clientId: google-client-id
-  clientSecret: google-client-secret
-  # adcKeyFilePath: path/to/adc-key-file.json
-  # maxAllowedQuotaUsageInPercentage: 95
+  operationalApi:
+    url: http://127.0.0.1:8889
 proxy:
   url: socks5://chisel-client:1080
   chiselProxy:
@@ -52,9 +50,6 @@ httpApi:
   port: 3001
   ownerKey: ypp-owner-key
 joystream:
-  faucet:
-    endpoint: http://localhost:3002/register
-    captchaBypassKey: some-random-key
   app:
     name: app-name
     accountSeed: 'example_string_seed'

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -28,17 +28,14 @@ services:
       YT_SYNCH__ENDPOINTS__REDIS__PORT: ${YT_SYNCH__ENDPOINTS__REDIS__PORT}
       # YT_SYNCH__HTTP_API__PORT: ${YT_SYNCH__HTTP_API__PORT}
       # YT_SYNCH__HTTP_API__OWNER_KEY: ${YT_SYNCH__HTTP_API__OWNER_KEY}
-      # YT_SYNCH__YOUTUBE__CLIENT_ID: ${YT_SYNCH__YOUTUBE__CLIENT_ID}
-      # YT_SYNCH__YOUTUBE__CLIENT_SECRET: ${YT_SYNCH__YOUTUBE__CLIENT_SECRET}
+      YT_SYNCH__YOUTUBE__OPERATIONAL_API__URL: http://youtube-operational-api
       # YT_SYNCH__AWS__ENDPOINT: http://host.docker.internal:4566
       # YT_SYNCH__AWS__CREDENTIALS__ACCESS_KEY_ID: ${YT_SYNCH__AWS__CREDENTIALS__ACCESS_KEY_ID}
       # YT_SYNCH__AWS__CREDENTIALS__SECRET_ACCESS_KEY: ${YT_SYNCH__AWS__CREDENTIALS__SECRET_ACCESS_KEY}
       # YT_SYNCH__JOYSTREAM__CHANNEL_COLLABORATOR__ACCOUNT: ${YT_SYNCH__JOYSTREAM__CHANNEL_COLLABORATOR__ACCOUNT}
       # YT_SYNCH__JOYSTREAM__CHANNEL_COLLABORATOR__MEMBER_ID: ${YT_SYNCH__JOYSTREAM__CHANNEL_COLLABORATOR__MEMBER_ID}
       # YT_SYNCH__JOYSTREAM__APP__NAME: ${YT_SYNCH__JOYSTREAM__APP__NAME}
       # YT_SYNCH__JOYSTREAM__APP__ACCOUNT_SEED: ${YT_SYNCH__JOYSTREAM__APP__ACCOUNT_SEED}
-      # YT_SYNCH__JOYSTREAM__FAUCET__ENDPOINT: ${YT_SYNCH__JOYSTREAM__FAUCET__ENDPOINT}
-      # YT_SYNCH__JOYSTREAM__FAUCET__CAPTCHA_BYPASS_KEY: ${YT_SYNCH__JOYSTREAM__FAUCET__CAPTCHA_BYPASS_KEY}
       OTEL_EXPORTER_OTLP_ENDPOINT: ${TELEMETRY_ENDPOINT}
     ports:
       - 127.0.0.1:${YT_SYNCH__HTTP_API__PORT}:${YT_SYNCH__HTTP_API__PORT}
@@ -78,17 +75,14 @@ services:
       YT_SYNCH__ENDPOINTS__REDIS__PORT: ${YT_SYNCH__ENDPOINTS__REDIS__PORT}
       # YT_SYNCH__HTTP_API__PORT: ${YT_SYNCH__HTTP_API__PORT}
       # YT_SYNCH__HTTP_API__OWNER_KEY: ${YT_SYNCH__HTTP_API__OWNER_KEY}
-      # YT_SYNCH__YOUTUBE__CLIENT_ID: ${YT_SYNCH__YOUTUBE__CLIENT_ID}
-      # YT_SYNCH__YOUTUBE__CLIENT_SECRET: ${YT_SYNCH__YOUTUBE__CLIENT_SECRET}
-      # YT_SYNCH__AWS__ENDPOINT: http://host.docker.internal:4566
+      YT_SYNCH__YOUTUBE__OPERATIONAL_API__URL: http://youtube-operational-api
+      # YT_SYNCH__AWS__ENDPOINT: ${YT_SYNCH__AWS__ENDPOINT}
       # YT_SYNCH__AWS__CREDENTIALS__ACCESS_KEY_ID: ${YT_SYNCH__AWS__CREDENTIALS__ACCESS_KEY_ID}
       # YT_SYNCH__AWS__CREDENTIALS__SECRET_ACCESS_KEY: ${YT_SYNCH__AWS__CREDENTIALS__SECRET_ACCESS_KEY}
       # YT_SYNCH__JOYSTREAM__CHANNEL_COLLABORATOR__ACCOUNT: ${YT_SYNCH__JOYSTREAM__CHANNEL_COLLABORATOR__ACCOUNT}
       # YT_SYNCH__JOYSTREAM__CHANNEL_COLLABORATOR__MEMBER_ID: ${YT_SYNCH__JOYSTREAM__CHANNEL_COLLABORATOR__MEMBER_ID}
       # YT_SYNCH__JOYSTREAM__APP__NAME: ${YT_SYNCH__JOYSTREAM__APP__NAME}
       # YT_SYNCH__JOYSTREAM__APP__ACCOUNT_SEED: ${YT_SYNCH__JOYSTREAM__APP__ACCOUNT_SEED}
-      # YT_SYNCH__JOYSTREAM__FAUCET__ENDPOINT: ${YT_SYNCH__JOYSTREAM__FAUCET__ENDPOINT}
-      # YT_SYNCH__JOYSTREAM__FAUCET__CAPTCHA_BYPASS_KEY: ${YT_SYNCH__JOYSTREAM__FAUCET__CAPTCHA_BYPASS_KEY}
     networks:
       - youtube-synch
     command: ['./bin/run', 'start', '--service', 'sync']
@@ -103,6 +97,13 @@ services:
       - youtube-synch
     volumes:
       - redis-data:/data
+  youtube-operational-api:
+    image: benjaminloison/youtube-operational-api
+    container_name: youtube-operational-api
+    ports:
+      - 127.0.0.1:8889:80
+    networks:
+      - youtube-synch
 
 volumes:
   logs:

diff --git a/...efinition-properties-joystream-properties-faucet-properties-captchabypasskey.md b/...efinition-properties-joystream-properties-faucet-properties-captchabypasskey.md
diff --git a/...config/definition-properties-joystream-properties-faucet-properties-endpoint.md b/...config/definition-properties-joystream-properties-faucet-properties-endpoint.md
diff --git a/docs/config/definition-properties-joystream-properties-faucet.md b/docs/config/definition-properties-joystream-properties-faucet.md
diff --git a/docs/config/definition-properties-joystream.md b/docs/config/definition-properties-joystream.md
@@ -6,28 +6,9 @@
 
 | Property                                    | Type     | Required | Nullable       | Defined by                                                                                                                                                                                                                                             |
 | :------------------------------------------ | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [faucet](#faucet)                           | `object` | Required | cannot be null | [Youtube Sync node configuration](definition-properties-joystream-properties-faucet.md "https://joystream.org/schemas/youtube-synch/config#/properties/joystream/properties/faucet")                                                                   |
 | [app](#app)                                 | `object` | Required | cannot be null | [Youtube Sync node configuration](definition-properties-joystream-properties-app.md "https://joystream.org/schemas/youtube-synch/config#/properties/joystream/properties/app")                                                                         |
 | [channelCollaborator](#channelcollaborator) | `object` | Required | cannot be null | [Youtube Sync node configuration](definition-properties-joystream-properties-joystream-channel-collaborator-used-for-syncing-the-content.md "https://joystream.org/schemas/youtube-synch/config#/properties/joystream/properties/channelCollaborator") |
 
-## faucet
-
-Joystream's faucet configuration (needed for captcha-free membership creation)
-
-`faucet`
-
-*   is required
-
-*   Type: `object` ([Details](definition-properties-joystream-properties-faucet.md))
-
-*   cannot be null
-
-*   defined in: [Youtube Sync node configuration](definition-properties-joystream-properties-faucet.md "https://joystream.org/schemas/youtube-synch/config#/properties/joystream/properties/faucet")
-
-### faucet Type
-
-`object` ([Details](definition-properties-joystream-properties-faucet.md))
-
 ## app
 
 Joystream Metaprotocol App specific configuration

diff --git a/...onfig/definition-properties-youtube-oauth2-client-configuration-dependencies.md b/...onfig/definition-properties-youtube-oauth2-client-configuration-dependencies.md
diff --git a/...ion-properties-youtube-oauth2-client-configuration-properties-adckeyfilepath.md b/...ion-properties-youtube-oauth2-client-configuration-properties-adckeyfilepath.md
diff --git a/...efinition-properties-youtube-oauth2-client-configuration-properties-clientid.md b/...efinition-properties-youtube-oauth2-client-configuration-properties-clientid.md
diff --git a/...ition-properties-youtube-oauth2-client-configuration-properties-clientsecret.md b/...ition-properties-youtube-oauth2-client-configuration-properties-clientsecret.md
diff --git a/...tube-oauth2-client-configuration-properties-maxallowedquotausageinpercentage.md b/...tube-oauth2-client-configuration-properties-maxallowedquotausageinpercentage.md
diff --git a/docs/config/definition-properties-youtube-oauth2-client-configuration.md b/docs/config/definition-properties-youtube-oauth2-client-configuration.md
diff --git a/...githubcombenjamin-loisonyoutube-operational-api-configuration-properties-url.md b/...githubcombenjamin-loisonyoutube-operational-api-configuration-properties-url.md
@@ -0,0 +1,3 @@
+## url Type
+
+`string`
diff --git a/...ional-api-httpsgithubcombenjamin-loisonyoutube-operational-api-configuration.md b/...ional-api-httpsgithubcombenjamin-loisonyoutube-operational-api-configuration.md
@@ -0,0 +1,27 @@
+## operationalApi Type
+
+`object` ([Youtube Operational API (https://github.com/Benjamin-Loison/YouTube-operational-API) configuration](definition-properties-youtube-related-configuration-properties-youtube-operational-api-httpsgithubcombenjamin-loisonyoutube-operational-api-configuration.md))
+
+# operationalApi Properties
+
+| Property    | Type     | Required | Nullable       | Defined by                                                                                                                                                                                                                                                                                                                       |
+| :---------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [url](#url) | `string` | Required | cannot be null | [Youtube Sync node configuration](definition-properties-youtube-related-configuration-properties-youtube-operational-api-httpsgithubcombenjamin-loisonyoutube-operational-api-configuration-properties-url.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/operationalApi/properties/url") |
+
+## url
+
+URL of the Youtube Operational API server (for example: <http://localhost:8080>)
+
+`url`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [Youtube Sync node configuration](definition-properties-youtube-related-configuration-properties-youtube-operational-api-httpsgithubcombenjamin-loisonyoutube-operational-api-configuration-properties-url.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/operationalApi/properties/url")
+
+### url Type
+
+`string`
diff --git a/docs/config/definition-properties-youtube-related-configuration.md b/docs/config/definition-properties-youtube-related-configuration.md
@@ -0,0 +1,27 @@
+## youtube Type
+
+`object` ([Youtube related configuration](definition-properties-youtube-related-configuration.md))
+
+# youtube Properties
+
+| Property                          | Type     | Required | Nullable       | Defined by                                                                                                                                                                                                                                                                                         |
+| :-------------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [operationalApi](#operationalapi) | `object` | Required | cannot be null | [Youtube Sync node configuration](definition-properties-youtube-related-configuration-properties-youtube-operational-api-httpsgithubcombenjamin-loisonyoutube-operational-api-configuration.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/operationalApi") |
+
+## operationalApi
+
+Youtube Operational API (<https://github.com/Benjamin-Loison/YouTube-operational-API>) configuration
+
+`operationalApi`
+
+*   is required
+
+*   Type: `object` ([Youtube Operational API (https://github.com/Benjamin-Loison/YouTube-operational-API) configuration](definition-properties-youtube-related-configuration-properties-youtube-operational-api-httpsgithubcombenjamin-loisonyoutube-operational-api-configuration.md))
+
+*   cannot be null
+
+*   defined in: [Youtube Sync node configuration](definition-properties-youtube-related-configuration-properties-youtube-operational-api-httpsgithubcombenjamin-loisonyoutube-operational-api-configuration.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/operationalApi")
+
+### operationalApi Type
+
+`object` ([Youtube Operational API (https://github.com/Benjamin-Loison/YouTube-operational-API) configuration](definition-properties-youtube-related-configuration-properties-youtube-operational-api-httpsgithubcombenjamin-loisonyoutube-operational-api-configuration.md))