doc.go 670 B

12345678910111213141516
  1. // Package identity provides functionality for generating and managing
  2. // identifiers within a swarm. This includes entity identification, such as for
  3. // Services, Tasks and Networks but also cryptographically-secure Node identities.
  4. //
  5. // Random Identifiers
  6. //
  7. // Identifiers provided by this package are cryptographically-strong, random
  8. // 128 bit numbers encoded in Base36. This method is preferred over UUID4 since
  9. // it requires less storage and leverages the full 128 bits of entropy.
  10. //
  11. // Generating an identifier is simple. Simply call the `NewID` function:
  12. //
  13. // id := NewID()
  14. //
  15. // If an error occurs while generating the ID, it will panic.
  16. package identity