https://github.com/bittorrent/go-btfs-common

https://github.com/bittorrent/go-btfs-common

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/bittorrent/go-btfs-common
• Owner: bittorrent
• License: mit
• Created: 2022-08-16T08:54:22.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-08-23T02:50:41.000Z (4 months ago)
• Last Synced: 2024-08-23T03:48:22.790Z (4 months ago)
• Language: JavaScript
• Size: 2.43 MB
• Stars: 0
• Watchers: 6
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# go-btfs-common

Common packages among various go-btfs projects.

| golang | protobuf  | prototool |

|--------|-----------|-----------|

| 1.13   | 3.10.0    | 1.9.0     |

## File Structure

```

.

├── LICENSE

├── Makefile

├── README.md

├── config

│   └── common.go

├── crypto

│   └── crypto.go

├── go.mod

├── go.sum

├── info

│   └── node.go (deprecating)

├── ledger

│   └── ledger.go

├── protos

│   ├── escrow

│   │   ├── escrow.pb.go

│   │   └── escrow.proto

│   ├── guard

│   │   ├── guard.pb.go

│   │   └── guard.proto

│   ├── ledger

│   │   ├── ledger.pb.go

│   │   └── ledger.proto

│   ├── node

│   │   ├── node.pb.go

│   │   └── node.proto

│   ├── shared

│   │   ├── shared.pb.go

│   │   └── shared.proto

│   └── status

│       ├── status.pb.go

│       └── status.proto

├── prototool.yaml

├── tree.txt

└── utils

    ├── grpc_health_check_provider.go

    ├── runtime.go

    └── runtime_test.go

```

## Install Tools

#### install TRON version(pg support) protobuf

```

cd github.com/bittorrent

```

```

git clone https://github.com/bittorrent/protobuf

```

```

cd protobuf && make

```

#### other tools

```

make install

```

## Lint and Format

```

make

```

or

```

make lintf

```

## Build/Complie

```

make build

```

## Use docker container to run 'git diff protos/'

```

$ docker build -f Dockerfile -t "go-btfs-common" .

$ docker run -i go-btfs-common

```

## Run interactive bash inside docker container for diagnosis

```

$ docker build -f Dockerfile -t "go-btfs-common" .

$ docker run -it go-btfs-common /bin/bash

```