Prep for release (#24)

* Added EventRemarked and CallFulfillcall

* Added FetchKeysPaged for block storage

* Added Transaction State RPC

Author: markopoloparadox

documentation/src/SUMMARY.md

@@ -32,3 +32,4 @@
 - [RPC](./rpc.md)
 - [Validator](./validator.md)
 - [Proxy](./proxy.md)
+- [Transaction State](./transaction_state.md)

documentation/src/installation.md

@@ -25,19 +25,19 @@ go version
 #### To Existing Project
 
 ```bash
-# Fetches Avail-GO SDK v0.2.3. This might not be the newest version so make sure to check out the latest github avail-go-sdk release.
+# Fetches Avail-GO SDK v0.2.4. This might not be the newest version so make sure to check out the latest github avail-go-sdk release.
 # Link to Github: https://github.com/availproject/avail-go-sdk/releases
-go get github.com/availproject/[email protected].3
+go get github.com/availproject/[email protected].4
 ```
 
 #### To A New Project
 
 ```bash
 # Creates a new project with name myproject
 go mod init myproject
-# Fetches Avail-GO SDK v0.2.3. This might not be the newest version so make sure to check out the latest github avail-go-sdk release.
+# Fetches Avail-GO SDK v0.2.4. This might not be the newest version so make sure to check out the latest github avail-go-sdk release.
 # Link to Github: https://github.com/availproject/avail-go-sdk/releases
-go get github.com/availproject/[email protected].3
+go get github.com/availproject/[email protected].4
 ```
 
 #### First Time Running

documentation/src/start.md

@@ -1,3 +1,3 @@
 # SDK Version
 
-This Documentation is based upon avail-go version v0.2.3
+This Documentation is based upon avail-go version v0.2.4

documentation/src/transaction_state.md

@@ -0,0 +1,5 @@
+# Transaction State
+
+```go
+{{#include ./../../examples/transaction_state.go}}
+```

examples/mod.go

@@ -12,6 +12,7 @@ func Run() {
 	RunTransaction()
 	RunValidator()
 	RunProxy()
+	RunTransactionState()
 }
 
 func AssertTrue(v bool, message string) {

examples/transaction_state.go

@@ -0,0 +1,41 @@
+package examples
+
+import (
+	"fmt"
+	"time"
+
+	"github.com/availproject/avail-go-sdk/metadata"
+	SDK "github.com/availproject/avail-go-sdk/sdk"
+)
+
+func RunTransactionState() {
+	sdk, err := SDK.NewSDK(SDK.LocalEndpoint)
+	PanicOnError(err)
+
+	// Transaction will be signed, and sent.
+	//
+	// There is no guarantee that the transaction was executed at all. It might have been
+	// dropped or discarded for various reasons. The caller is responsible for querying future
+	// blocks in order to determine the execution status of that transaction.
+	tx := sdk.Tx.DataAvailability.SubmitData([]byte("MyData"))
+	txHash, err := tx.Execute(SDK.Account.Alice(), SDK.NewTransactionOptions().WithAppId(1))
+	PanicOnError(err)
+	fmt.Println("Tx Hash:", txHash)
+
+	details := []metadata.TransactionState{}
+	for {
+		details, err = sdk.Client.TransactionState(txHash, false)
+		PanicOnError(err)
+		if len(details) != 0 {
+			break
+		}
+
+		time.Sleep(time.Second)
+	}
+	AssertEq(len(details), 1, "")
+	detail := details[0]
+	fmt.Println(fmt.Sprintf(`Block Hash: %v, Block Height: %v, Tx Hash: %v, Tx Index: %v`, detail.BlockHash.ToHuman(), detail.BlockHeight, detail.TxHash.ToHuman(), detail.TxIndex))
+	fmt.Println(fmt.Sprintf(`Pallet Index: %v, Call Index: %v, Tx Success: %v, Is Finalized: %v`, detail.PalletIndex, detail.CallIndex, detail.TxSuccess, detail.IsFinalized))
+
+	fmt.Println("RunTransactionState finished correctly.")
+}

interfaces/mod.go

@@ -10,6 +10,7 @@ type EventT interface {
 }
 
 type BlockStorageT interface {
-	Fetch(storageEntryKey string) (primitives.Option[string], error)
+	Fetch(key string) (primitives.Option[string], error)
 	FetchKeys(key string) ([]string, error)
+	FetchKeysPaged(key string, count uint32, startKey primitives.Option[string]) ([]string, error)
 }

metadata/pallets/nomination_pools/calls.go

@@ -217,8 +217,6 @@ func (this CallWithdrawUnbonded) CallName() string {
 //   - `amount` - The amount of funds to delegate to the pool. This also acts of a sort of
 //     deposit since the pools creator cannot fully unbond funds until the pool is being
 //     destroyed.
-//   - `index` - A disambiguation index for creating the account. Likely only useful when
-//     creating multiple pools in the same extrinsic.
 //   - `root` - The account to set as [`PoolRoles::root`].
 //   - `nominator` - The account to set as the [`PoolRoles::nominator`].
 //   - `bouncer` - The account to set as the [`PoolRoles::bouncer`].
@@ -458,11 +456,6 @@ func (this CallBondExtraOther) CallName() string {
 // claim their pending rewards. If a pool member wishes so, they can set this to
 // `PermissionlessAll` to allow any account to claim their rewards and bond extra to the
 // pool.
-//
-// # Arguments
-//
-// * `origin` - Member of a pool.
-// * `actor` - Account to claim reward. // improve this
 type CallSetClaimPermission struct {
 	Permission metadata.PoolClaimPermission
 }

metadata/pallets/system/events.go

@@ -89,3 +89,25 @@ func (this EventKilledAccount) EventIndex() uint8 {
 func (this EventKilledAccount) EventName() string {
 	return "KilledAccount"
 }
+
+// On on-chain remark happened
+type EventRemarked struct {
+	Sender primitives.AccountId
+	Hash   primitives.H256
+}
+
+func (this EventRemarked) PalletIndex() uint8 {
+	return PalletIndex
+}
+
+func (this EventRemarked) PalletName() string {
+	return PalletName
+}
+
+func (this EventRemarked) EventIndex() uint8 {
+	return 5
+}
+
+func (this EventRemarked) EventName() string {
+	return "Remarked"
+}

metadata/pallets/vector/calls.go

@@ -2,10 +2,33 @@ package vector
 
 import (
 	"github.com/availproject/avail-go-sdk/metadata"
-	. "github.com/availproject/avail-go-sdk/metadata/pallets"
 	prim "github.com/availproject/avail-go-sdk/primitives"
 )
 
+type CallFulfillCall struct {
+	FunctionId prim.H256
+	Input      []byte
+	output     []byte
+	proof      []byte
+	slot       uint64 `scale:"compact"`
+}
+
+func (this CallFulfillCall) PalletIndex() uint8 {
+	return PalletIndex
+}
+
+func (this CallFulfillCall) PalletName() string {
+	return PalletName
+}
+
+func (this CallFulfillCall) CallIndex() uint8 {
+	return 0
+}
+
+func (this CallFulfillCall) CallName() string {
+	return "fulfill_call"
+}
+
 // Send a batch of dispatch calls.
 //
 // May be called from any origin except `None`.
@@ -30,15 +53,3 @@ func (this CallSendMessage) CallIndex() uint8 {
 func (this CallSendMessage) CallName() string {
 	return "send_message"
 }
-
-func (this *CallSendMessage) ToCall() prim.Call {
-	return ToCall(this)
-}
-
-func (this *CallSendMessage) ToPayload() metadata.Payload {
-	return ToPayload(this)
-}
-
-func (this *CallSendMessage) DecodeExtrinsic(tx *prim.DecodedExtrinsic) bool {
-	return Decode(this, tx)
-}

metadata/types.go

@@ -1629,3 +1629,14 @@ func (this *ProxyType) Decode(decoder *prim.Decoder) error {
 
 	return nil
 }
+
+type TransactionState struct {
+	BlockHash   prim.H256
+	BlockHeight uint32
+	TxHash      prim.H256
+	TxIndex     uint32
+	TxSuccess   bool
+	PalletIndex uint8
+	CallIndex   uint8
+	IsFinalized bool
+}

sdk/client.go

@@ -66,6 +66,10 @@ func (this *Client) FinalizedBlockHash() (prim.H256, error) {
 	return this.Rpc.Chain.GetFinalizedHead()
 }
 
+func (this *Client) TransactionState(txHash prim.H256, finalized bool) ([]meta.TransactionState, error) {
+	return this.Rpc.Transaction.State(txHash, finalized)
+}
+
 func (this *Client) EventsAt(at prim.Option[prim.H256]) (EventRecords, error) {
 	eventsRaw, err := this.Rpc.State.GetEvents(at)
 	if err != nil {

sdk/rpc.go

@@ -8,24 +8,26 @@ import (
 )
 
 type RPC struct {
-	client    *Client
-	System    systemRPC
-	State     stateRPC
-	Chain     chainRPC
-	ChainSpec chainSpecRPC
-	Kate      kateRPC
-	Author    authorRPC
+	client      *Client
+	System      systemRPC
+	State       stateRPC
+	Chain       chainRPC
+	ChainSpec   chainSpecRPC
+	Kate        kateRPC
+	Author      authorRPC
+	Transaction transactionRPC
 }
 
 func newRPC(client *Client) RPC {
 	return RPC{
-		client:    client,
-		System:    systemRPC{client: client},
-		State:     stateRPC{client: client},
-		Chain:     chainRPC{client: client},
-		ChainSpec: chainSpecRPC{client: client},
-		Kate:      kateRPC{client: client},
-		Author:    authorRPC{client: client},
+		client:      client,
+		System:      systemRPC{client: client},
+		State:       stateRPC{client: client},
+		Chain:       chainRPC{client: client},
+		ChainSpec:   chainSpecRPC{client: client},
+		Kate:        kateRPC{client: client},
+		Author:      authorRPC{client: client},
+		Transaction: transactionRPC{client: client},
 	}
 }
 
@@ -37,6 +39,14 @@ func (this *RPCParams) Add(value string) {
 	this.Values = append(this.Values, value)
 }
 
+func (this *RPCParams) AddBool(value bool) {
+	if value == true {
+		this.Add("true")
+	} else {
+		this.Add("false")
+	}
+}
+
 func (this *RPCParams) AddByteSlice(value []byte) {
 	if len(value) == 0 {
 		return

sdk/rpc_state.go

@@ -2,6 +2,8 @@ package sdk
 
 import (
 	"encoding/json"
+	"fmt"
+
 	prim "github.com/availproject/avail-go-sdk/primitives"
 )
 
@@ -53,6 +55,32 @@ func (this *stateRPC) GetKeys(key string, at prim.Option[prim.H256]) ([]string,
 	return res, nil
 }
 
+func (this *stateRPC) GetKeysPaged(key string, count uint32, startKey prim.Option[string], at prim.Option[prim.H256]) ([]string, error) {
+	params := RPCParams{}
+	params.Add("\"" + key + "\"")
+	params.Add(fmt.Sprintf(`%v`, count))
+	if startKey.IsSome() {
+		params.Add("\"" + startKey.Unwrap() + "\"")
+	} else {
+		params.Add("null")
+	}
+	if at.IsSome() {
+		params.AddH256(at.Unwrap())
+	}
+
+	value, err := this.client.RequestWithRetry("state_getKeysPaged", params.Build())
+	if err != nil {
+		return nil, err
+	}
+
+	res := []string{}
+	if err := json.Unmarshal([]byte(value), &res); err != nil {
+		return nil, newError(err, ErrorCode002)
+	}
+
+	return res, nil
+}
+
 func (this *stateRPC) GetMetadata(at prim.Option[prim.H256]) (string, error) {
 	params := RPCParams{}
 	if at.IsSome() {