blocksutil

README

go-ipfs-blocksutil

go-ipfs-blocksutil provides provides utility functions for working with Blocks.

Table of Contents

• Install
• Usage
• Contribute
• License

Install

go-ipfs-blocksutil works like a regular Go module:

> go get github.com/ipfs/go-ipfs-blocksutil

Usage

import "github.com/ipfs/go-ipfs-blocksutil"

Check the GoDoc documentation

Contribute

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © Protocol Labs, Inc.

Documentation

Overview

Package blocksutil provides utility functions for working with Blocks.

Index

• type BlockGenerator
  • func NewBlockGenerator() BlockGenerator
  • func (bg *BlockGenerator) Blocks(n int) []blocks.Block
  • func (bg *BlockGenerator) Next() *blocks.BasicBlock

Types

type BlockGenerator

type BlockGenerator struct {
	// contains filtered or unexported fields
}

BlockGenerator generates BasicBlocks on demand. For each instace of BlockGenerator, each new block is different from the previous, although two different instances will produce the same.

func NewBlockGenerator

func NewBlockGenerator() BlockGenerator

NewBlockGenerator returns an object capable of producing blocks.

func (*BlockGenerator) Blocks

func (bg *BlockGenerator) Blocks(n int) []blocks.Block

Blocks generates as many BasicBlocks as specified by n.

func (*BlockGenerator) Next

func (bg *BlockGenerator) Next() *blocks.BasicBlock

Next generates a new BasicBlock.