opplasmairys

README

Optimism Plasma DA KVStore Store implementation(irys)

Introduction

This simple DA KVStore Store implementation based on irys. See the Irys doc for more information

Install

go get github.com/4everland/opplasmairys

Start

import (
  "github.com/4everland/opplasmairys"
)

config := opplasmairys.Config{
  //IrysPrivateKey
  IrysPrivateKey: os.Getenv("IRYS_PRIVATE_KEY"),
  //IrysPaymentNetwork supported networks: ethereum,matic,bnb,avalanche,arbitrum or fantom
  IrysPaymentNetwork: os.Getenv("IRYS_PAYMENT_NETWORK"),
  //IrysPaymentRPC, optional
  IrysPaymentRPC: os.Getenv("IRYS_PAYMENT_RPC"),
  //IrysFreeUpload, optional
  IrysFreeUpload: os.Getenv("IRYS_FREE_UPLOAD"),
}   
var (
  err error
  //backup kvstore, optional
  store opplasmairys.KVStore
)
//create a new irys store
store, err = opplasmairys.NewDAStore(config, store)

Simple Server

This simple DA server implementation supports irys. See the daserver for more information

Documentation

Index

• Constants
• type Config
• type DAStore
  • func NewDAStore(c Config, store KVStore) (*DAStore, error)
  • func (d *DAStore) Get(ctx context.Context, key []byte) (v []byte, err error)
  • func (d *DAStore) Put(ctx context.Context, key []byte, value []byte) error
• type IrysClient
  • func NewIrysClient(networkName, rpc, privateKey string, enableFreeUpload bool) (*IrysClient, error)
  • func (c *IrysClient) Download(ctx context.Context, id []byte) (io.ReadCloser, error)
  • func (c *IrysClient) Upload(ctx context.Context, id []byte, data []byte) error
• type KVStore
• type QueryTxResponse
  • func QueryTx(ctx_ context.Context, client_ graphql.Client, address []string, key string) (*QueryTxResponse, error)
  • func (v *QueryTxResponse) GetTransactions() QueryTxTransactionsEdges
• type QueryTxTransactionsEdges
  • func (v *QueryTxTransactionsEdges) GetEdges() []QueryTxTransactionsEdgesEdgesNode
• type QueryTxTransactionsEdgesEdgesNode
  • func (v *QueryTxTransactionsEdgesEdgesNode) GetNode() QueryTxTransactionsEdgesEdgesNodeNodeTransaction
• type QueryTxTransactionsEdgesEdgesNodeNodeTransaction
  • func (v *QueryTxTransactionsEdgesEdgesNodeNodeTransaction) GetId() string
  • func (v *QueryTxTransactionsEdgesEdgesNodeNodeTransaction) GetTags() []QueryTxTransactionsEdgesEdgesNodeNodeTransactionTagsTag
• type QueryTxTransactionsEdgesEdgesNodeNodeTransactionTagsTag
  • func (v *QueryTxTransactionsEdgesEdgesNodeNodeTransactionTagsTag) GetName() string
  • func (v *QueryTxTransactionsEdgesEdgesNodeNodeTransactionTagsTag) GetValue() string

Constants

const (
	Matic     = "matic"
	Bnb       = "bnb"
	Avalanche = "avalanche"
	Arbitrum  = "arbitrum"
	Fantom    = "fantom"
	Ethereum  = "ethereum"
)

const (
	GraphqlMainNet  = "https://arweave.mainnet.irys.xyz/graphql"
	GraphqlMainNet2 = "https://arweave.net/graphql"
)

const QueryTx_Operation = `` /* 214-byte string literal not displayed */

The query or mutation executed by QueryTx.

Types

type Config

type Config struct {
	NetworkName string
	PrivateKey  string
	NetWorkRpc  string

	FreeUpload bool
}

type DAStore

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

func NewDAStore

func NewDAStore(c Config, store KVStore) (*DAStore, error)

func (*DAStore) Get

func (d *DAStore) Get(ctx context.Context, key []byte) (v []byte, err error)

func (*DAStore) Put

func (d *DAStore) Put(ctx context.Context, key []byte, value []byte) error

type IrysClient

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

func NewIrysClient

func NewIrysClient(networkName, rpc, privateKey string, enableFreeUpload bool) (*IrysClient, error)

NewIrysClient support tokens ethereum,matic,bnb,avalanche,arbitrum,fantom

func (*IrysClient) Download

func (c *IrysClient) Download(ctx context.Context, id []byte) (io.ReadCloser, error)

func (*IrysClient) Upload

func (c *IrysClient) Upload(ctx context.Context, id []byte, data []byte) error

type KVStore

type KVStore interface {
	// Get retrieves the given key if it's present in the key-value data store.
	Get(ctx context.Context, key []byte) ([]byte, error)
	// Put inserts the given value into the key-value data store.
	Put(ctx context.Context, key []byte, value []byte) error
}

type QueryTxResponse

type QueryTxResponse struct {
	Transactions QueryTxTransactionsEdges `json:"transactions"`
}

QueryTxResponse is returned by QueryTx on success.

func QueryTx

func QueryTx(
	ctx_ context.Context,
	client_ graphql.Client,
	address []string,
	key string,
) (*QueryTxResponse, error)

func (*QueryTxResponse) GetTransactions

func (v *QueryTxResponse) GetTransactions() QueryTxTransactionsEdges

GetTransactions returns QueryTxResponse.Transactions, and is useful for accessing the field via an interface.

type QueryTxTransactionsEdges

type QueryTxTransactionsEdges struct {
	Edges []QueryTxTransactionsEdgesEdgesNode `json:"edges"`
}

QueryTxTransactionsEdges includes the requested fields of the GraphQL type Edges.

func (*QueryTxTransactionsEdges) GetEdges

func (v *QueryTxTransactionsEdges) GetEdges() []QueryTxTransactionsEdgesEdgesNode

GetEdges returns QueryTxTransactionsEdges.Edges, and is useful for accessing the field via an interface.

type QueryTxTransactionsEdgesEdgesNode

type QueryTxTransactionsEdgesEdgesNode struct {
	Node QueryTxTransactionsEdgesEdgesNodeNodeTransaction `json:"node"`
}

QueryTxTransactionsEdgesEdgesNode includes the requested fields of the GraphQL type Node.

func (*QueryTxTransactionsEdgesEdgesNode) GetNode

func (v *QueryTxTransactionsEdgesEdgesNode) GetNode() QueryTxTransactionsEdgesEdgesNodeNodeTransaction

GetNode returns QueryTxTransactionsEdgesEdgesNode.Node, and is useful for accessing the field via an interface.

type QueryTxTransactionsEdgesEdgesNodeNodeTransaction

type QueryTxTransactionsEdgesEdgesNodeNodeTransaction struct {
	Id   string                                                    `json:"id"`
	Tags []QueryTxTransactionsEdgesEdgesNodeNodeTransactionTagsTag `json:"tags"`
}

QueryTxTransactionsEdgesEdgesNodeNodeTransaction includes the requested fields of the GraphQL type Transaction.

func (*QueryTxTransactionsEdgesEdgesNodeNodeTransaction) GetId

func (v *QueryTxTransactionsEdgesEdgesNodeNodeTransaction) GetId() string

GetId returns QueryTxTransactionsEdgesEdgesNodeNodeTransaction.Id, and is useful for accessing the field via an interface.

func (*QueryTxTransactionsEdgesEdgesNodeNodeTransaction) GetTags

func (v *QueryTxTransactionsEdgesEdgesNodeNodeTransaction) GetTags() []QueryTxTransactionsEdgesEdgesNodeNodeTransactionTagsTag

GetTags returns QueryTxTransactionsEdgesEdgesNodeNodeTransaction.Tags, and is useful for accessing the field via an interface.

type QueryTxTransactionsEdgesEdgesNodeNodeTransactionTagsTag

type QueryTxTransactionsEdgesEdgesNodeNodeTransactionTagsTag struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

QueryTxTransactionsEdgesEdgesNodeNodeTransactionTagsTag includes the requested fields of the GraphQL type Tag.

func (*QueryTxTransactionsEdgesEdgesNodeNodeTransactionTagsTag) GetName

func (v *QueryTxTransactionsEdgesEdgesNodeNodeTransactionTagsTag) GetName() string

GetName returns QueryTxTransactionsEdgesEdgesNodeNodeTransactionTagsTag.Name, and is useful for accessing the field via an interface.

func (*QueryTxTransactionsEdgesEdgesNodeNodeTransactionTagsTag) GetValue

func (v *QueryTxTransactionsEdgesEdgesNodeNodeTransactionTagsTag) GetValue() string

GetValue returns QueryTxTransactionsEdgesEdgesNodeNodeTransactionTagsTag.Value, and is useful for accessing the field via an interface.