Skip to content

Latest commit

 

History

History
324 lines (316 loc) · 13.4 KB

coordinator_registration.yaml

File metadata and controls

324 lines (316 loc) · 13.4 KB
NameAboutLabelsAssignees
Coordinator RegistrationBecome a RoboSats CoordinatorFederationreckless-satoshi

Coordinator Registration

This form is for registering a new default coordinator on the RoboSats client. Before proceeding, please review the RoboSats Federation Basis. The Github thread generated by this issue will serve as a communication channel between the development team and the new coordinator, if necessary. The information provided will be used to create a new entry in frontend/static/federation.json. If you're technically proficient and wish to expedite the process, you can directly edit federation.json via a pull request. Here's a template coordinator:

"temp": {
  "longAlias": "Template",
  "shortAlias": "temp",
  "description": "This is the description for an example coordinator",
  "motto": "Don't trust, verify",
  "color": "#000000",
  "contact": {
    "pgp": "keys.openpgp.org/vks/v1/by-fingerprint/....",
    "fingerprint": "...",
    "email": "contact@contact.com",
    "telegram": "examplecoordinator",
    "twitter": "examplecoordinator",
    "matrix": "#example:matrix.org",
    "website": "https://example.coordinator.com",
    "simplex": "https://....",
    "nostr": "npub....",
    "reddit": "u/..."
  },
  "badges": {
    "donatesToDevFund": 20,
  },
  "policies": {
    "Privacy Policy": "...",
    "Data Policy": "..."
    "Rule #1": "You do not talk about RoboSats Club",
    "Rule #2": "You DO NOT talk about RoboSats Club",
  },
  "mainnet": {
    "onion": "http://robosats6tkf3eva7x2voqso3a5wcorsnw34jveyxfqi2fu7oyheasid.onion",
    "clearnet": "https://coordinator-address.com"
    "i2p": "http:///.........b32.i2p"
  },
  "testnet": {
    "onion": "http://robotestagw3dcxmd66r4rgksb4nmmr43fh77bzn2ia2eucduyeafnyd.onion",
    "clearnet": "https://testnet.coordinator-address.com"
    "i2p": "http:///.........b32.i2p"
  },
  "mainnetNodesPubkeys": ["000000000000000000000000000000000000000000000000000000000000000000"],
  "testnetNodesPubkeys": ["000000000000000000000000000000000000000000000000000000000000000000"]

All fields can be updated or completed later through pull requests. Don't worry about getting everything perfect initially. A partially completed form is better than none. It's okay if your data policy, privacy policy, node ids, and endpoints aren't fully defined or are subject to change.

What name should the robots refer to you by?

Your coordinator profile picture. Ideally 200x200px.

Share something about yourself.

A brief phrase to be displayed under your profile picture.

A hex RGB color used for accent and easier identification in the RoboSats UI.

Development Funding

Donations to the Development Fund (DevFund) are voluntary with no minimum amount. The default donation rate in the Coordinator backend is 20%. The value entered here is for display purposes and can be updated later via a PR. Ideally, it should match the donation rate set in your .env file. The RoboSats client app randomly sorts coordinators weighted by their DevFund donation value. Thus, the orders of the coordinators that contribute to the development have a higher chance to appear first in the Order book. Coordinators who contribute to the DevFund are more likely to receive support if needed (note that unless the devs are under time constraints support is unlikely to be denied). These patron perks are the way developers say "thank you for your contribution!". The RoboSats development team has an exciting roadmap ahead. However, once RoboSats is decentralized, the only source of funding for further development and maintaining the codebase will be donations (we do not accept venture-capital investments).

What percentage of trade revenue will you donate to the RoboSats Development Fund?

Your permanent identity. If needed, you may have to verify your identity to robots or other coordinators by signing a message.

Coordinator Policies

The following three sections are designed to inform robots about your service expectations as a coordinator. It's perfectly acceptable to refine your policies over time, as coordinating RoboSats is a learning process. However, remember that robots appreciate clear and concise terms.

Describe how you will handle privacy. For example, what kind of evidence will be required in a dispute? How will sensitive information be treated?

Explain your data handling practices. For instance, what is your data retention policy? Will data be shared with third parties? Although a RoboSats coordinator's data collection is limited by design, a coordinator could still learn about users through heuristic analysis, payout node pubkeys, onchain addresses, dispute statements, evidence submission, etc.

Any other policies can be set here.

Coordinator Addresses

Your coordinator API should be publicly accessible via an Onion hidden service. Optionally, you can also expose your API over I2P for redundancy, ensuring robots can still use your service if TOR is under attack. Clearnet endpoints can also be added to your coordinator. You can create new tor2web aliases on services like clearnetonion.eu.org or others (do your own research).

The Onion hidden service where your MAINNET RoboSats coordinator API can be found.

The Onion hidden service where your TESTNET RoboSats coordinator API can be found.

The I2P service where your MAINNET RoboSats coordinator API can be found (Optional).

The I2P service where your TESTNET RoboSats coordinator API can be found (Optional).

The Clearnet address where your MAINNET RoboSats coordinator API can be found.

The Clearnet address where your TESTNET RoboSats coordinator API can be found.

Node Pubkeys

Enter your Lightning node pubkeys (also known as node_id). You can enter multiple pubkeys (comma-separated) for both mainnet and testnet. If you haven't created the lightning node yet, enter a placeholder. These pubkeys will be used to direct robots to explorers to find your node (e.g., 1ML or Amboss).

Mainnet Coordinator Lightning Node Pubkey(s)

Testnet Coordinator Lightning Node Pubkey(s)

Contact Methods

Only one contact method is required, but multiple are preferred. Find a balance between accessibility and operational security (too many contact methods increase the surface area and might harm OpSec).
Contact methods below are sorted by importance.

Public contact method #1: Email.

Public contact method #2: SimpleX

Public contact method #3: Matrix.

Public contact method #4: Website.

Public contact method #5: Website.

Public contact method #6: Telegram.

Public contact method #7: Twitter.

Public contact method #8: Reddit.

Federation Basis

RoboSats Federation Basis

By submitting this issue, you agree to accept the basis for the RoboSats Federation Basis