Giter Club home page Giter Club logo

hive.go's Introduction

A utility library for the GoShimmer and Hornet node software

Discord StackExchange Apache 2.0 license

AboutPrerequisitesInstallationGetting startedSupporting the projectJoining the discussion


About

Hive.go is a shared library that is used in the GoShimmer and Hornet node software. This library contains shared:

  • Data structures
  • Utility methods
  • Abstractions

This is beta software, so there may be performance and stability issues. Please report any issues in our issue tracker.

Prerequisites

To use the library, you need to have at least version 1.13 of Go installed on your device.

To check if you have Go installed, run the following command:

go version

If Go is installed, you should see the version that's installed.

Installation

To install Hive.go and its dependencies, you can use one of the following options:

  • If you use Go modules, just import the packages that you want to use

    import (
    "github.com/iotaledger/hive.go/logger"
    "github.com/iotaledger/hive.go/node"
    "github.com/iotaledger/iota.go/trinary"
    )
  • To download the library from GitHub, use the go get command

    go get github.com/iotaledger/hive.go

Getting started

After you've installed the library, you can use it in your project.

For example, to create a new logger instance:

import "github.com/iotaledger/hive.go/logger"

log = logger.NewLogger('myNewLoggerName')

Activating deadlock detection

To replace the mutexes in the syncutils package with Go deadlock, use the deadlock build flag when compiling your program.

Supporting the project

If this library has been useful to you and you feel like contributing, consider submitting a bug report, feature request or a pull request.

See our contributing guidelines for more information.

Joining the discussion

If you want to get involved in the community, need help with getting set up, have any issues related to the library or just want to discuss IOTA, Distributed Registry Technology (DRT), and IoT with other people, feel free to join our Discord.

hive.go's People

Contributors

acha-bill avatar alexsporn avatar capossele avatar hmoog avatar iotmod avatar jakescahill avatar jkrvivian avatar jonastheis avatar luca-moser avatar lzpap avatar muxxer avatar wollac avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.