soc

Documentation

Overview

Package soc provides the single-owner chunk implementation and validator.

Index

• func CreateAddress(id ID, owner []byte) (swarm.Address, error)
• func UnwrapCAC(sch swarm.Chunk) (swarm.Chunk, error)
• func Valid(ch swarm.Chunk) bool
• type ID
• type SOC
  • func FromChunk(sch swarm.Chunk) (*SOC, error)
  • func New(id ID, ch swarm.Chunk) *SOC
  • func NewSigned(id ID, ch swarm.Chunk, owner, sig []byte) (*SOC, error)
  • func (s *SOC) Address() (swarm.Address, error)
  • func (s *SOC) Chunk() (swarm.Chunk, error)
  • func (s *SOC) ID() []byte
  • func (s *SOC) OwnerAddress() []byte
  • func (s *SOC) Sign(signer crypto.Signer) (swarm.Chunk, error)
  • func (s *SOC) Signature() []byte
  • func (s *SOC) WrappedChunk() swarm.Chunk

Functions

func CreateAddress

func CreateAddress(id ID, owner []byte) (swarm.Address, error)

CreateAddress creates a new SOC address from the id and the ethereum address of the owner.

func UnwrapCAC

func UnwrapCAC(sch swarm.Chunk) (swarm.Chunk, error)

UnwrapCAC extracts the CAC inside the SOC.

func Valid

func Valid(ch swarm.Chunk) bool

Valid checks if the chunk is a valid single-owner chunk.

Types

type ID

type ID []byte

ID is a SOC identifier

type SOC

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

SOC wraps a content-addressed chunk.

func FromChunk

func FromChunk(sch swarm.Chunk) (*SOC, error)

FromChunk recreates a SOC representation from swarm.Chunk data.

func New

func New(id ID, ch swarm.Chunk) *SOC

New creates a new SOC representation from arbitrary id and a content-addressed chunk.

func NewSigned

func NewSigned(id ID, ch swarm.Chunk, owner, sig []byte) (*SOC, error)

NewSigned creates a single-owner chunk based on already signed data.

func (*SOC) Address

func (s *SOC) Address() (swarm.Address, error)

Address returns the SOC chunk address.

func (*SOC) Chunk

func (s *SOC) Chunk() (swarm.Chunk, error)

Chunk returns the SOC chunk.

func (*SOC) ID

func (s *SOC) ID() []byte

ID returns the SOC id.

func (*SOC) OwnerAddress

func (s *SOC) OwnerAddress() []byte

OwnerAddress returns the ethereum address of the SOC owner.

func (*SOC) Sign

func (s *SOC) Sign(signer crypto.Signer) (swarm.Chunk, error)

Sign signs a SOC using the given signer. It returns a signed SOC chunk ready for submission to the network.

func (*SOC) Signature

func (s *SOC) Signature() []byte

Signature returns the SOC signature.

func (*SOC) WrappedChunk

func (s *SOC) WrappedChunk() swarm.Chunk

WrappedChunk returns the chunk wrapped by the SOC.