js-libp2p connection

connection.js

const STATUS = {
  OPEN: 0,
  CLOSED: 1,
  CLOSING: 2,
}

const ROLE = {
  INITIATOR: 0,
  RESPONDER: 1
}

class Connection {
  constructor (peerInfo, remoteMa, isInitiator) {
    /**
     * Connection identifier
     */
    this.id = (~~(Math.random() * 1e9)).toString(36) + Date.now()

    /**
     * Remote peer info
     */
    this.peerInfo = peerInfo

    /**
     * Status of the connection
     */
    this.status = STATUS.OPEN

    /**
     * Endpoints multiaddrs
     */
    this.endpoints = {
      local: undefined,
      remote: remoteMa
    }

    /** 
     * Connection timeline
     */
    this.timeline = {
      openTs: Date.now(),
      closeTs: undefined
    }

    /**
     * Role in the connection, initiator or responder
     */
    this.role = isInitiator ? ROLE.INITIATOR : ROLE.RESPONDER

    /** 
     * The multiplexer being used
     */
    this.multiplexer = undefined

    /**
     * The encryption method being used
     */
    this.encryption = undefined

    /**
     * Connection streams
     */
    this.streams = []

    /** 
     * User provided tags
     */
    this.tags = []
  }

  newStream () {
    if (!this.multiplexer) {
      // await hasMultiplexerOrErrored()  // magic ensues
    }
    // ... new stream creation
  }

  getStreams () {

  }

  close () {
    this.timeline.closeTs = Date.now()
  }

  setLocalAddress (ma) {
    this.endpoints.local = ma
  }
}

So would this just be the protocol for encryption then? ie: "/secio/1.0.0" If so, I wonder if connection.tags is a better place to record that?

Yes, it would be the encryption protocol! I only prefer to have its own property because it should be always present and the tags would probably be an array of string with no context (the encryption should be always easy to get from the connection)

I only prefer to have its own property because it should be always present and the tags would probably be an array of string with no context

Fair enough. We can always revisit when we add more than 1 encryption. Right now if the switch has encryption turned on it's going to be secio, otherwise it's plaintext. Once tls or quic support is added it will become more important for this.