Merge pull request #37 from everFinance/bundle

Bundle

Author: zyjblockchain

README.md

@@ -162,7 +162,9 @@ Package for Arweave develop toolkit.
 - [x] GetSignatureData
 - [x] VerifyTransaction
 - [x] NewBundle
-- [x] GenerateIndepHash
+- [x] NewBundleItem
+- [x] SubmitItemToBundlr
+- [x] SubmitItemToArSeed
 
 #### RSA Threshold Cryptography
 
@@ -309,58 +311,84 @@ assert.NoError(t, uploader.Once())
 ### About Arweave Bundles
 1. `goar` implemented creating,editing,reading and verifying bundles tx
 2. This is the [ANS-104](https://github.com/joshbenaron/arweave-standards/blob/ans104/ans/ANS-104.md) standard protocol and refers to the [arbundles](https://github.com/Bundler-Network/arbundles) js-lib implement
-3. more example can be viewed in path `./example/bundle_test.go`
 
-#### CreateBundle
+#### Create Bundle Item
 ```go
-w, err := goar.NewWalletFromPath(privateKey, arNode)
-if err != nil {
-  panic(err)
-}
+signer, err := goar.NewSignerFromPath("./testKey.json") // rsa signer
+// or 
+signer, err := goether.NewSigner("0x.....") // ecdsa signer
 
 // Create Item
-data := []byte("upload update...")   
-signatureType := 1 // currently only supply type 1
+data := []byte("aa bb cc dd")
 target := "" // option 
 anchor := "" // option
-tags := []types.Tags{}{} // bundle item tags
-item01, err := w.CreateAndSignBundleItem(data, 1, target, anchor, tags)    
+tags := []types.Tags{}{} // option bundle item tags
+item01, err := itemSigner.CreateAndSignItem(data, target, anchor, tags)    
 // Same as create item
 item02
 item03
 ....
 
-items := []types.BundleItem{item01, item02, item03 ...}	
+```
+#### assemble bundle and send to arweave network 
+You can send items directly to the arweave network
+```go
 
+items := []types.BundleItem{item01, item02, item03 ...}
 bundle, err := utils.NewBundle(items...)
 
+w, err := goar.NewWalletFromPath("./key.json", arNode)
+
+arTxTags := []types.Tags{}{} // option
+tx, err := w.SendBundleTx(bd.BundleBinary, arTxtags)
+
 ```
 
-#### Send Item to Bundler
-Bundler network provides guaranteed data seeding and instant data accessibility
+#### Send Item to [Arseeding](https://github.com/everFinance/arseeding) gateway
+Arseeding provides guaranteed data seeding and instant data accessibility
 ```go
-resp, err := w.Client.BatchSendItemToBundler(items,"") // The second parameter is the bundler gateway url，"" means use default url
+arseedUrl := "https://seed.everpay.io"
+currency := "USDC" // used for payment fee currency
+resp, err := utils.SubmitItemToArSeed(item01,currency,arseedUrl)
 ```
 
-#### Send Bundle Tx
+#### Send Item to Bundler gateway
+Bundler provides guaranteed data seeding and instant data accessibility
 ```go
-tx, err := w.SendBundleTx(bd.BundleBinary, arTxtags)
+bundlrUrl := "https://node1.bundlr.network"
+resp, err := utils.SubmitItemToBundlr(item01, bundlrUrl)
 ```
 
-#### Get Bundle and Verify
+#### Verify Bundle Items
 ```go
-id := "lt24bnUGms5XLZeVamSPHePl4M2ClpLQyRxZI7weH1k"
-bundle, err := cli.GetBundle(id)
 
 // verify
 for _, item := range bundle.Items {
   err = utils.VerifyBundleItem(item)
   assert.NoError(t, err)
 }
 ```
+check [bundle example](./example/bundle_test.go) 
 
-### notice
-if you call `w.Client.BatchSendItemToBundler(items,"")` 
+#### About Arseeding
+if you can `utils.SubmitItemToArseed(item,currency,arseedUrl)` 
+and you will get the following return response   
+```go
+{
+    "ItemId": "5rEb7c6OjMQIYjl6P7AJIb4bB9CLMBSxhZ9N7BVbRCk",
+    "bundler": "Fkj5J8CDLC9Jif4CzgtbiXJBnwXLSrp5AaIllleH_yY",
+    "currency": "USDT",
+    "decimals": 6,
+    "fee": "701",
+    "paymentExpiredTime": 1656044994,
+    "expectedBlock": 960751
+}
+```
+After you transfer 0.000701 USDT to bundler using everpay, arseeding will upload the item to arweave.   
+For more usage, jump to [docs](https://github.com/everFinance/arseeding/blob/main/README.md)
+
+#### About Bundlr
+if you call `utils.SubmitItemToBundlr(item,bundlrUrl)` 
 and return `panic: send to bundler request failed; http code: 402`        
 means that you have to pay ar to the bundler service address    
 must use item signature address to transfer funds   
@@ -371,13 +399,28 @@ curl --location --request GET 'https://node1.bundlr.network/info'
 
 response:
 {
-"uptime": 275690.552536824,
-"address": "OXcT1sVRSA5eGwt2k6Yuz8-3e3g9WJi5uSE99CWqsBs",
-"gateway": "arweave.net"
+    "version": "0.2.0",
+    "addresses": {
+        "arweave": "OXcT1sVRSA5eGwt2k6Yuz8-3e3g9WJi5uSE99CWqsBs",
+        "ethereum": "0xb4DE0833771eae55040b698aF5eB06d59E142C82",
+        "matic": "0xb4DE0833771eae55040b698aF5eB06d59E142C82",
+        "bnb": "0xb4DE0833771eae55040b698aF5eB06d59E142C82",
+        "avalanche": "0xb4DE0833771eae55040b698aF5eB06d59E142C82",
+        "solana": "DHyDV2ZjN3rB6qNGXS48dP5onfbZd3fAEz6C5HJwSqRD",
+        "arbitrum": "0xb4DE0833771eae55040b698aF5eB06d59E142C82",
+        "boba-eth": "0xb4DE0833771eae55040b698aF5eB06d59E142C82",
+        "boba": "0xb4DE0833771eae55040b698aF5eB06d59E142C82",
+        "chainlink": "0xb4DE0833771eae55040b698aF5eB06d59E142C82",
+        "kyve": "0xb4DE0833771eae55040b698aF5eB06d59E142C82",
+        "fantom": "0xb4DE0833771eae55040b698aF5eB06d59E142C82",
+        "near": "bundlr1.near",
+        "algorand": "DL7ZTTQMTFNXRF3367OTSNAZ3L2X676OJ4GGB3DXMUJ37CCKJ5RJMEO6RI"
+    },
+    "gateway": "arweave.net"
 }
 ```
-This "address" is the bundler service receive ar address.    
-You need to transfer a certain amount of ar to this address    
+This "addresses" are the bundler service receive address.    
+You need to transfer a certain amount of token to this address    
 and wait for 25 blocks to confirm the transaction before you can use the bundler service.    
 
 You can also use the following api to query the balance in the bundler service.   

bundleItem.go

@@ -0,0 +1,97 @@
+package goar
+
+import (
+	"crypto/sha256"
+	"errors"
+	"github.com/everFinance/goar/types"
+	"github.com/everFinance/goar/utils"
+	"github.com/everFinance/goether"
+)
+
+type ItemSigner struct {
+	signType   int
+	signer     interface{}
+	owner      string // only rsa has owner
+	signerAddr string
+}
+
+func NewItemSigner(signer interface{}) (*ItemSigner, error) {
+	signType, signerAddr, owner, err := reflectSigner(signer)
+	if err != nil {
+		return nil, err
+	}
+	return &ItemSigner{
+		signType:   signType,
+		signer:     signer,
+		owner:      owner,
+		signerAddr: signerAddr,
+	}, nil
+}
+
+func (i *ItemSigner) CreateAndSignItem(data []byte, target string, anchor string, tags []types.Tag) (types.BundleItem, error) {
+	bundleItem, err := utils.NewBundleItem(i.owner, i.signType, target, anchor, data, tags)
+	if err != nil {
+		return types.BundleItem{}, err
+	}
+	// sign
+	if err := SignBundleItem(i.signType, i.signer, bundleItem); err != nil {
+		return types.BundleItem{}, err
+	}
+	if err := utils.GenerateItemBinary(bundleItem); err != nil {
+		return types.BundleItem{}, err
+	}
+	return *bundleItem, nil
+}
+
+func reflectSigner(signer interface{}) (signType int, signerAddr, owner string, err error) {
+	if s, ok := signer.(*Signer); ok {
+		signType = types.ArweaveSignType
+		signerAddr = s.Address
+		owner = s.Owner()
+		return
+	}
+	if s, ok := signer.(*goether.Signer); ok {
+		signType = types.EthereumSignType
+		signerAddr = s.Address.String()
+		owner = utils.Base64Encode(s.GetPublicKey())
+		return
+	}
+	err = errors.New("not support this signer")
+	return
+}
+
+func SignBundleItem(signatureType int, signer interface{}, item *types.BundleItem) error {
+	signMsg, err := utils.BundleItemSignData(*item)
+	if err != nil {
+		return err
+	}
+	var sigData []byte
+	switch signatureType {
+	case types.ArweaveSignType:
+		arSigner, ok := signer.(*Signer)
+		if !ok {
+			return errors.New("signer must be goar signer")
+		}
+		sigData, err = utils.Sign(signMsg, arSigner.PrvKey)
+		if err != nil {
+			return err
+		}
+
+	case types.EthereumSignType:
+		ethSigner, ok := signer.(*goether.Signer)
+		if !ok {
+			return errors.New("signer not goether signer")
+		}
+		sigData, err = ethSigner.SignMsg(signMsg)
+		if err != nil {
+			return err
+		}
+	default:
+		// todo come soon supprot ed25519
+		return errors.New("not supprot this signType")
+	}
+	id := sha256.Sum256(sigData)
+	item.Id = utils.Base64Encode(id[:])
+	item.Signature = utils.Base64Encode(sigData)
+	return nil
+}

client.go

@@ -13,6 +13,7 @@ import (
 	"path"
 	"strconv"
 	"strings"
+	"time"
 
 	"github.com/everFinance/goar/types"
 	"github.com/everFinance/goar/utils"
@@ -54,6 +55,10 @@ func (c *Client) SetTempConnUrl(url string) {
 	c.url = url
 }
 
+func (c *Client) SetTimeout(timeout time.Duration) {
+	c.client.Timeout = timeout
+}
+
 func (c *Client) GetInfo() (info *types.NetworkInfo, err error) {
 	body, code, err := c.httpGet("info")
 	if err != nil {

client_bundle.go

@@ -6,10 +6,6 @@ import (
 	"testing"
 )
 
-// import (
-// 	"fmt"
-// 	"testing"
-
 // func TestGetTransactionByID(t *testing.T) {
 // 	client := NewClient("https://arweave.net")
 // 	fmt.Println(client.GetTransactionByID("FgcKlptyDXSgEonYfy5cNBimq7GJ4h8h6L6pxuuYOBc"))
@@ -265,3 +261,19 @@ func TestNewClient(t *testing.T) {
 	assert.NoError(t, err)
 	t.Log("pending tx number:", len(res))
 }
+
+func TestNewTempConn(t *testing.T) {
+	c := NewClient("https://arweave.net")
+	peers, err := c.GetPeers()
+	assert.NoError(t, err)
+	pNode := NewTempConn()
+	for _, peer := range peers {
+		pNode.SetTempConnUrl("http://" + peer)
+		offset, err := pNode.getTransactionOffset("pEYudvF0HjIU-2vKdhNZ9Dgr_bueucXaeRrbPhI90ew")
+		if err != nil {
+			t.Log("err", err, "perr", peer)
+			continue
+		}
+		t.Logf("offset: %s, peer: %s", offset.Offset, peer)
+	}
+}