joystream/distributor-node/docs/commands/leader.md

joystream-distributor leader

Commands for performing Distribution Working Group leader on-chain duties (like setting distribution module limits and parameters, assigning bags and buckets etc.)

• joystream-distributor leader:cancel-invitation
• joystream-distributor leader:create-bucket
• joystream-distributor leader:create-bucket-family
• joystream-distributor leader:delete-bucket
• joystream-distributor leader:delete-bucket-family
• joystream-distributor leader:invite-bucket-operator
• joystream-distributor leader:remove-bucket-operator
• joystream-distributor leader:set-bucket-family-metadata
• joystream-distributor leader:set-buckets-per-bag-limit
• joystream-distributor leader:update-bag
• joystream-distributor leader:update-bucket-mode
• joystream-distributor leader:update-bucket-status
• joystream-distributor leader:update-dynamic-bag-policy

joystream-distributor leader:cancel-invitation

Cancel pending distribution bucket operator invitation.

Cancel pending distribution bucket operator invitation.
  Requires distribution working group leader permissions.

USAGE
  $ joystream-distributor leader:cancel-invitation

OPTIONS
  -B, --bucketId=bucketId      (required) Distribution bucket id

  -c, --configPath=configPath  [default: ./config.yml] Path to config JSON/YAML file (relative to current working
                               directory)

  -f, --familyId=familyId      (required) Distribution bucket family id

  -w, --workerId=workerId      (required) ID of the invited operator (distribution group worker)

  -y, --yes                    Answer "yes" to any prompt, skipping any manual confirmations

DESCRIPTION
  Requires distribution working group leader permissions.

See code: src/commands/leader/cancel-invitation.ts

joystream-distributor leader:create-bucket

Create new distribution bucket. Requires distribution working group leader permissions.

Create new distribution bucket. Requires distribution working group leader permissions.

USAGE
  $ joystream-distributor leader:create-bucket

OPTIONS
  -a, --acceptingBags=(yes|no)  [default: no] Whether the created bucket should accept new bags

  -c, --configPath=configPath   [default: ./config.yml] Path to config JSON/YAML file (relative to current working
                                directory)

  -f, --familyId=familyId       (required) Distribution bucket family id

  -y, --yes                     Answer "yes" to any prompt, skipping any manual confirmations

See code: src/commands/leader/create-bucket.ts

joystream-distributor leader:create-bucket-family

Create new distribution bucket family. Requires distribution working group leader permissions.

Create new distribution bucket family. Requires distribution working group leader permissions.

USAGE
  $ joystream-distributor leader:create-bucket-family

OPTIONS
  -c, --configPath=configPath  [default: ./config.yml] Path to config JSON/YAML file (relative to current working
                               directory)

  -y, --yes                    Answer "yes" to any prompt, skipping any manual confirmations

See code: src/commands/leader/create-bucket-family.ts

joystream-distributor leader:delete-bucket

Delete distribution bucket. The bucket must have no operators. Requires distribution working group leader permissions.

Delete distribution bucket. The bucket must have no operators. Requires distribution working group leader permissions.

USAGE
  $ joystream-distributor leader:delete-bucket

OPTIONS
  -B, --bucketId=bucketId      (required) Distribution bucket id

  -c, --configPath=configPath  [default: ./config.yml] Path to config JSON/YAML file (relative to current working
                               directory)

  -f, --familyId=familyId      (required) Distribution bucket family id

  -y, --yes                    Answer "yes" to any prompt, skipping any manual confirmations

See code: src/commands/leader/delete-bucket.ts

joystream-distributor leader:delete-bucket-family

Delete distribution bucket family. Requires distribution working group leader permissions.

Delete distribution bucket family. Requires distribution working group leader permissions.

USAGE
  $ joystream-distributor leader:delete-bucket-family

OPTIONS
  -c, --configPath=configPath  [default: ./config.yml] Path to config JSON/YAML file (relative to current working
                               directory)

  -f, --familyId=familyId      (required) Distribution bucket family id

  -y, --yes                    Answer "yes" to any prompt, skipping any manual confirmations

See code: src/commands/leader/delete-bucket-family.ts

joystream-distributor leader:invite-bucket-operator

Invite distribution bucket operator (distribution group worker).

Invite distribution bucket operator (distribution group worker).
  The specified bucket must not have any operator currently.
  Requires distribution working group leader permissions.

USAGE
  $ joystream-distributor leader:invite-bucket-operator

OPTIONS
  -B, --bucketId=bucketId      (required) Distribution bucket id

  -c, --configPath=configPath  [default: ./config.yml] Path to config JSON/YAML file (relative to current working
                               directory)

  -f, --familyId=familyId      (required) Distribution bucket family id

  -w, --workerId=workerId      (required) ID of the distribution group worker to invite as bucket operator

  -y, --yes                    Answer "yes" to any prompt, skipping any manual confirmations

DESCRIPTION
  The specified bucket must not have any operator currently.
     Requires distribution working group leader permissions.

See code: src/commands/leader/invite-bucket-operator.ts

joystream-distributor leader:remove-bucket-operator

Remove distribution bucket operator (distribution group worker).

Remove distribution bucket operator (distribution group worker).
  Requires distribution working group leader permissions.

USAGE
  $ joystream-distributor leader:remove-bucket-operator

OPTIONS
  -B, --bucketId=bucketId      (required) Distribution bucket id

  -c, --configPath=configPath  [default: ./config.yml] Path to config JSON/YAML file (relative to current working
                               directory)

  -f, --familyId=familyId      (required) Distribution bucket family id

  -w, --workerId=workerId      (required) ID of the operator (distribution working group worker) to remove from the
                               bucket

  -y, --yes                    Answer "yes" to any prompt, skipping any manual confirmations

DESCRIPTION
  Requires distribution working group leader permissions.

See code: src/commands/leader/remove-bucket-operator.ts

joystream-distributor leader:set-bucket-family-metadata

Set/update distribution bucket family metadata.

Set/update distribution bucket family metadata.
  Requires distribution working group leader permissions.

USAGE
  $ joystream-distributor leader:set-bucket-family-metadata

OPTIONS
  -c, --configPath=configPath  [default: ./config.yml] Path to config JSON/YAML file (relative to current working
                               directory)

  -f, --familyId=familyId      (required) Distribution bucket family id

  -i, --input=input            (required) Path to JSON metadata file

  -y, --yes                    Answer "yes" to any prompt, skipping any manual confirmations

DESCRIPTION
  Requires distribution working group leader permissions.

See code: src/commands/leader/set-bucket-family-metadata.ts

joystream-distributor leader:set-buckets-per-bag-limit

Set max. distribution buckets per bag limit. Requires distribution working group leader permissions.

Set max. distribution buckets per bag limit. Requires distribution working group leader permissions.

USAGE
  $ joystream-distributor leader:set-buckets-per-bag-limit

OPTIONS
  -c, --configPath=configPath  [default: ./config.yml] Path to config JSON/YAML file (relative to current working
                               directory)

  -l, --limit=limit            (required) New limit value

  -y, --yes                    Answer "yes" to any prompt, skipping any manual confirmations

See code: src/commands/leader/set-buckets-per-bag-limit.ts

joystream-distributor leader:update-bag

Add/remove distribution buckets from a bag.

Add/remove distribution buckets from a bag.

USAGE
  $ joystream-distributor leader:update-bag

OPTIONS
  -a, --add=add
      [default: ] ID of a bucket to add to bag

  -b, --bagId=bagId
      (required) Bag ID. Format: {bag_type}:{sub_type}:{id}.
           - Bag types: 'static', 'dynamic'
           - Sub types: 'static:council', 'static:wg', 'dynamic:member', 'dynamic:channel'
           - Id:
             - absent for 'static:council'
             - working group name for 'static:wg'
             - integer for 'dynamic:member' and 'dynamic:channel'
           Examples:
           - static:council
           - static:wg:storage
           - dynamic:member:4

  -c, --configPath=configPath
      [default: ./config.yml] Path to config JSON/YAML file (relative to current working directory)

  -f, --familyId=familyId
      (required) ID of the distribution bucket family

  -r, --remove=remove
      [default: ] ID of a bucket to remove from bag

  -y, --yes
      Answer "yes" to any prompt, skipping any manual confirmations

EXAMPLE
  $ joystream-distributor leader:update-bag -b 1 -f 1 -a 1 -a 2 -a 3 -r 4 -r 5

See code: src/commands/leader/update-bag.ts

joystream-distributor leader:update-bucket-mode

Update distribution bucket mode ("distributing" flag). Requires distribution working group leader permissions.

Update distribution bucket mode ("distributing" flag). Requires distribution working group leader permissions.

USAGE
  $ joystream-distributor leader:update-bucket-mode

OPTIONS
  -B, --bucketId=bucketId      (required) Distribution bucket id

  -c, --configPath=configPath  [default: ./config.yml] Path to config JSON/YAML file (relative to current working
                               directory)

  -d, --mode=(on|off)          (required) Whether the bucket should be "on" (distributing) or "off" (not distributing)

  -f, --familyId=familyId      (required) Distribution bucket family id

  -y, --yes                    Answer "yes" to any prompt, skipping any manual confirmations

See code: src/commands/leader/update-bucket-mode.ts

joystream-distributor leader:update-bucket-status

Update distribution bucket status ("acceptingNewBags" flag). Requires distribution working group leader permissions.

Update distribution bucket status ("acceptingNewBags" flag). Requires distribution working group leader permissions.

USAGE
  $ joystream-distributor leader:update-bucket-status

OPTIONS
  -B, --bucketId=bucketId       (required) Distribution bucket id
  -a, --acceptingBags=(yes|no)  (required) Whether the bucket should accept new bags

  -c, --configPath=configPath   [default: ./config.yml] Path to config JSON/YAML file (relative to current working
                                directory)

  -f, --familyId=familyId       (required) Distribution bucket family id

  -y, --yes                     Answer "yes" to any prompt, skipping any manual confirmations

See code: src/commands/leader/update-bucket-status.ts

joystream-distributor leader:update-dynamic-bag-policy

Update dynamic bag creation policy (number of buckets by family that should store given dynamic bag type).

Update dynamic bag creation policy (number of buckets by family that should store given dynamic bag type).
    Requires distribution working group leader permissions.

USAGE
  $ joystream-distributor leader:update-dynamic-bag-policy

OPTIONS
  -c, --configPath=configPath  [default: ./config.yml] Path to config JSON/YAML file (relative to current working
                               directory)

  -p, --policy=policy          Key-value pair of {familyId}:{numberOfBuckets}

  -t, --type=(Member|Channel)  (required) Dynamic bag type

  -y, --yes                    Answer "yes" to any prompt, skipping any manual confirmations

DESCRIPTION
  Requires distribution working group leader permissions.

EXAMPLE
  $ joystream-distributor leader:update-dynamic-bag-policy -t Member -p 1:5 -p 2:10 -p 3:5

See code: src/commands/leader/update-dynamic-bag-policy.ts