Merge pull request #355 from datmedevil17/dev

feat: Introduce  instruction to upgrade legacy nonce accounts.

Author: HealthyBuilder

programs/system/UpgradeNonceAccount.go

@@ -0,0 +1,114 @@
+// Copyright 2021 github.com/gagliardetto
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package system
+
+import (
+	"encoding/binary"
+	"fmt"
+
+	ag_binary "github.com/gagliardetto/binary"
+	ag_solanago "github.com/gagliardetto/solana-go"
+	ag_format "github.com/gagliardetto/solana-go/text/format"
+	ag_treeout "github.com/gagliardetto/treeout"
+)
+
+// One-time idempotent upgrade of legacy nonce versions in order to bump
+// them out of chain blockhash domain.
+type UpgradeNonceAccount struct {
+
+	// [0] = [WRITE] NonceAccount
+	// ··········· Nonce account
+	ag_solanago.AccountMetaSlice `bin:"-" borsh_skip:"true"`
+}
+
+// NewUpgradeNonceAccountInstructionBuilder creates a new `UpgradeNonceAccount` instruction builder.
+func NewUpgradeNonceAccountInstructionBuilder() *UpgradeNonceAccount {
+	nd := &UpgradeNonceAccount{
+		AccountMetaSlice: make(ag_solanago.AccountMetaSlice, 1),
+	}
+	return nd
+}
+
+// Nonce account
+func (inst *UpgradeNonceAccount) SetNonceAccount(nonceAccount ag_solanago.PublicKey) *UpgradeNonceAccount {
+	inst.AccountMetaSlice[0] = ag_solanago.Meta(nonceAccount).WRITE()
+	return inst
+}
+
+func (inst *UpgradeNonceAccount) GetNonceAccount() *ag_solanago.AccountMeta {
+	return inst.AccountMetaSlice[0]
+}
+
+func (inst UpgradeNonceAccount) Build() *Instruction {
+	return &Instruction{BaseVariant: ag_binary.BaseVariant{
+		Impl:   inst,
+		TypeID: ag_binary.TypeIDFromUint32(Instruction_UpgradeNonceAccount, binary.LittleEndian),
+	}}
+}
+
+// ValidateAndBuild validates the instruction parameters and accounts;
+// if there is a validation error, it returns the error.
+// Otherwise, it builds and returns the instruction.
+func (inst UpgradeNonceAccount) ValidateAndBuild() (*Instruction, error) {
+	if err := inst.Validate(); err != nil {
+		return nil, err
+	}
+	return inst.Build(), nil
+}
+
+func (inst *UpgradeNonceAccount) Validate() error {
+	// Check whether all accounts are set:
+	for accIndex, acc := range inst.AccountMetaSlice {
+		if acc == nil {
+			return fmt.Errorf("ins.AccountMetaSlice[%v] is not set", accIndex)
+		}
+	}
+	return nil
+}
+
+func (inst *UpgradeNonceAccount) EncodeToTree(parent ag_treeout.Branches) {
+	parent.Child(ag_format.Program(ProgramName, ProgramID)).
+		//
+		ParentFunc(func(programBranch ag_treeout.Branches) {
+			programBranch.Child(ag_format.Instruction("UpgradeNonceAccount")).
+				//
+				ParentFunc(func(instructionBranch ag_treeout.Branches) {
+
+					// Parameters of the instruction:
+					instructionBranch.Child("Params").ParentFunc(func(paramsBranch ag_treeout.Branches) {})
+
+					// Accounts of the instruction:
+					instructionBranch.Child("Accounts").ParentFunc(func(accountsBranch ag_treeout.Branches) {
+						accountsBranch.Child(ag_format.Meta("Nonce", inst.AccountMetaSlice[0]))
+					})
+				})
+		})
+}
+
+func (inst UpgradeNonceAccount) MarshalWithEncoder(encoder *ag_binary.Encoder) error {
+	return nil
+}
+
+func (inst *UpgradeNonceAccount) UnmarshalWithDecoder(decoder *ag_binary.Decoder) error {
+	return nil
+}
+
+// NewUpgradeNonceAccountInstruction declares a new UpgradeNonceAccount instruction with the provided parameters and accounts.
+func NewUpgradeNonceAccountInstruction(
+	// Accounts:
+	nonceAccount ag_solanago.PublicKey) *UpgradeNonceAccount {
+	return NewUpgradeNonceAccountInstructionBuilder().
+		SetNonceAccount(nonceAccount)
+}

programs/system/UpgradeNonceAccount_test.go

@@ -0,0 +1,46 @@
+// Copyright 2021 github.com/gagliardetto
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package system
+
+import (
+	"bytes"
+	"strconv"
+	"testing"
+
+	ag_gofuzz "github.com/gagliardetto/gofuzz"
+	ag_require "github.com/stretchr/testify/require"
+)
+
+func TestEncodeDecode_UpgradeNonceAccount(t *testing.T) {
+	fu := ag_gofuzz.New().NilChance(0)
+	for i := 0; i < 1; i++ {
+		t.Run("UpgradeNonceAccount"+strconv.Itoa(i), func(t *testing.T) {
+			{
+				params := new(UpgradeNonceAccount)
+				fu.Fuzz(params)
+				params.AccountMetaSlice = nil
+				buf := new(bytes.Buffer)
+				err := encodeT(*params, buf)
+				ag_require.NoError(t, err)
+				//
+				got := new(UpgradeNonceAccount)
+				err = decodeT(got, buf.Bytes())
+				got.AccountMetaSlice = nil
+				ag_require.NoError(t, err)
+				ag_require.Equal(t, params, got)
+			}
+		})
+	}
+}

programs/system/instructions.go

@@ -78,6 +78,10 @@ const (
 
 	// Transfer lamports from a derived address
 	Instruction_TransferWithSeed
+
+	// One-time idempotent upgrade of legacy nonce versions in order to bump
+	// them out of chain blockhash domain.
+	Instruction_UpgradeNonceAccount
 )
 
 // InstructionIDToName returns the name of the instruction given its ID.
@@ -107,6 +111,8 @@ func InstructionIDToName(id uint32) string {
 		return "AssignWithSeed"
 	case Instruction_TransferWithSeed:
 		return "TransferWithSeed"
+	case Instruction_UpgradeNonceAccount:
+		return "UpgradeNonceAccount"
 	default:
 		return ""
 	}
@@ -163,6 +169,9 @@ var InstructionImplDef = ag_binary.NewVariantDefinition(
 		{
 			"TransferWithSeed", (*TransferWithSeed)(nil),
 		},
+		{
+			"UpgradeNonceAccount", (*UpgradeNonceAccount)(nil),
+		},
 	},
 )