irys

README

irys-go

Go Implementation SDK of Irys network, irys is the only provenance layer. It enables users to scale permanent data and precisely attribute its origin (arweave bundlr).

Install

go get -u  github.com/Ja7ad/irys

Examples

example of irys sdk in golang

Upload

package main

import (
	"context"
	"fmt"
	"github.com/Ja7ad/irys"
	"github.com/Ja7ad/irys/currency"
	"log"
	"os"
)

func main() {
	matic, err := currency.NewMatic(
		"foo",
		"https://exampleRPC.com")
	if err != nil {
		log.Fatal(err)
	}

	c, err := irys.New(irys.DefaultNode2, matic, false)
	if err != nil {
		log.Fatal(err)
	}

	file, err := os.Open("image.jpeg")
	if err != nil {
		log.Fatal(err)
	}

	tx, err := c.BasicUpload(context.Background(), file)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(tx)

}

Download

package main

import (
	"context"
	"fmt"
	"github.com/Ja7ad/irys"
	"github.com/Ja7ad/irys/currency"
	"io"
	"log"
)

func main() {
	matic, err := currency.NewMatic("foo", "https://exampleRPC.com")
	if err != nil {
		log.Fatal(err)
	}
	c, err := irys.New(irys.DefaultNode2, matic, false)
	if err != nil {
		log.Fatal(err)
	}

	file, err := c.Download(context.Background(), "XjzDyneweD_Dmhuaipbi7HyXXvsY6IkMcIsumlB0G2M")
	if err != nil {
		log.Fatal(err)
	}
	defer file.Data.Close()

	b, err := io.ReadAll(file.Data)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(string(b), file.Header, file.ContentLength, file.ContentType)
}

Calculate Price

package main

import (
	"context"
	"fmt"
	"github.com/Ja7ad/irys"
	"github.com/Ja7ad/irys/currency"
	"log"
)

func main() {
	matic, err := currency.NewMatic("foo", "https://exampleRPC.com")
	if err != nil {
		log.Fatal(err)
	}
	c, err := irys.New(irys.DefaultNode1, matic, false)
	if err != nil {
		log.Fatal(err)
	}

	p, err := c.GetPrice(context.Background(), 100000)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(p.Int64())
}

Get Metadata

package main

import (
	"context"
	"fmt"
	"github.com/Ja7ad/irys"
	"github.com/Ja7ad/irys/currency"
	"log"
)

func main() {
	matic, err := currency.NewMatic("foo", "https://exampleRPC.com")
	if err != nil {
		log.Fatal(err)
	}
	c, err := irys.New(irys.DefaultNode2, matic, false)
	if err != nil {
		log.Fatal(err)
	}

	tx, err := c.GetMetaData(context.Background(), "XjzDyneweD_Dmhuaipbi7HyXXvsY6IkMcIsumlB0G2M")
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(tx)
}

Todo

• arweave network
• ethereum network
• polygon matic network
• concurrent and chunk upload
• get chunk upload transaction response
• unit test
• found API
• upload folder
• withdraw balance
• get loaded balance

Documentation

Index

• type Client
  • func (i *Client) BasicUpload(ctx context.Context, file io.Reader, tags ...types.Tag) (types.Transaction, error)
  • func (i *Client) ChunkUpload(ctx context.Context, file io.Reader, price *big.Int, tags ...types.Tag) (types.Transaction, error)
  • func (i *Client) Download(ctx context.Context, hash string) (*types.File, error)
  • func (i *Client) GetBalance(ctx context.Context) (*big.Int, error)
  • func (i *Client) GetMetaData(ctx context.Context, hash string) (types.Transaction, error)
  • func (i *Client) GetPrice(ctx context.Context, fileSize int) (*big.Int, error)
  • func (i *Client) TopUpBalance(ctx context.Context, amount *big.Int) (types.TopUpConfirmation, error)
  • func (i *Client) Upload(ctx context.Context, file io.Reader, price *big.Int, tags ...types.Tag) (types.Transaction, error)
• type Irys
  • func New(node Node, currency currency.Currency, debug bool, options ...Option) (Irys, error)
• type Node
• type Option
  • func WithCustomClient(c *http.Client) Option
  • func WithCustomLogging(logging logger.Logger) Option
  • func WithCustomRetryMax(retry int) Option
  • func WithCustomRetryWaitMax(waitMax time.Duration) Option
  • func WithCustomRetryWaitMin(waitMin time.Duration) Option

Examples

• New

Types

type Client

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

func (*Client) BasicUpload

func (i *Client) BasicUpload(ctx context.Context, file io.Reader, tags ...types.Tag) (types.Transaction, error)

func (*Client) ChunkUpload

func (i *Client) ChunkUpload(ctx context.Context, file io.Reader, price *big.Int, tags ...types.Tag) (types.Transaction, error)

func (*Client) Download

func (i *Client) Download(ctx context.Context, hash string) (*types.File, error)

func (*Client) GetBalance

func (i *Client) GetBalance(ctx context.Context) (*big.Int, error)

func (*Client) GetMetaData

func (i *Client) GetMetaData(ctx context.Context, hash string) (types.Transaction, error)

func (*Client) GetPrice

func (i *Client) GetPrice(ctx context.Context, fileSize int) (*big.Int, error)

func (*Client) TopUpBalance

func (i *Client) TopUpBalance(ctx context.Context, amount *big.Int) (types.TopUpConfirmation, error)

func (*Client) Upload

func (i *Client) Upload(ctx context.Context, file io.Reader, price *big.Int, tags ...types.Tag) (types.Transaction, error)

type Irys

type Irys interface {
	// GetPrice return fee base on fileSize in byte for selected currency
	GetPrice(ctx context.Context, fileSize int) (*big.Int, error)

	// BasicUpload file with calculate price and topUp balance base on price (this is slower for upload)
	BasicUpload(ctx context.Context, file io.Reader, tags ...types.Tag) (types.Transaction, error)
	// Upload file with check balance
	Upload(ctx context.Context, file io.Reader, price *big.Int, tags ...types.Tag) (types.Transaction, error)
	// ChunkUpload upload file chunk concurrent
	ChunkUpload(ctx context.Context, file io.Reader, price *big.Int, tags ...types.Tag) (types.Transaction, error)

	// Download get file with header details
	Download(ctx context.Context, hash string) (*types.File, error)
	// GetMetaData get transaction details
	GetMetaData(ctx context.Context, hash string) (types.Transaction, error)

	// GetBalance return current balance in irys node
	GetBalance(ctx context.Context) (*big.Int, error)
	// TopUpBalance top up your balance base on your amount in selected node
	TopUpBalance(ctx context.Context, amount *big.Int) (types.TopUpConfirmation, error)
}

func New

func New(node Node, currency currency.Currency, debug bool, options ...Option) (Irys, error)

New create IrysClient object

Example

matic, err := currency.NewMatic("foo", "bar")
if err != nil {
	log.Fatal(err)
}
c, err := New(DefaultNode1, matic, false)
if err != nil {
	log.Fatal(err)
}

p, err := c.GetPrice(context.Background(), 100000)
if err != nil {
	log.Fatal(err)
}

fmt.Println(p.Int64())

type Node

type Node string

const (
	DefaultNode1  Node = "https://node1.irys.xyz"  // DefaultNode1 is node 1 irys
	DefaultNode2  Node = "https://node2.irys.xyz"  // DefaultNode2 is node 2 irys
	DefaultDevNet Node = "https://devnet.irys.xyz" // DefaultDevNet is a testnet for test irys
)

type Option

type Option func(irys *Client)

func WithCustomClient

func WithCustomClient(c *http.Client) Option

WithCustomClient set custom http client for irys

func WithCustomLogging

func WithCustomLogging(logging logger.Logger) Option

WithCustomLogging create custom logging

func WithCustomRetryMax

func WithCustomRetryMax(retry int) Option

WithCustomRetryMax maximum number of retries

func WithCustomRetryWaitMax

func WithCustomRetryWaitMax(waitMax time.Duration) Option

WithCustomRetryWaitMax maximum time to wait

func WithCustomRetryWaitMin

func WithCustomRetryWaitMin(waitMin time.Duration) Option

WithCustomRetryWaitMin minimum time to wait