natspec

Documentation

Index

• func FetchDocsForContract(contractAddress string, xeth *xeth.XEth, client *httpclient.HTTPClient) (content []byte, err error)
• func GetNotice(xeth *xeth.XEth, tx string, http *httpclient.HTTPClient) (notice string)
• type NatSpec
  • func New(xeth *xeth.XEth, jsontx string, http *httpclient.HTTPClient) (self *NatSpec, err error)
  • func NewWithDocs(infoDoc []byte, tx string, data string) (self *NatSpec, err error)
  • func (self *NatSpec) Notice() (notice string, err error)

Functions

func FetchDocsForContract

func FetchDocsForContract(contractAddress string, xeth *xeth.XEth, client *httpclient.HTTPClient) (content []byte, err error)

also called by admin.contractInfo.get

func GetNotice

func GetNotice(xeth *xeth.XEth, tx string, http *httpclient.HTTPClient) (notice string)

main entry point for to get natspec notice for a transaction the implementation is frontend friendly in that it always gives back a notice that is safe to display :FIXME: the second return value is an error, which can be used to fine-tune bahaviour

Types

type NatSpec

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

func New

func New(xeth *xeth.XEth, jsontx string, http *httpclient.HTTPClient) (self *NatSpec, err error)

func NewWithDocs

func NewWithDocs(infoDoc []byte, tx string, data string) (self *NatSpec, err error)

func (*NatSpec) Notice

func (self *NatSpec) Notice() (notice string, err error)