EndAuction.go

// Code generated by https://github.com/gagliardetto/anchor-go. DO NOT EDIT.

package metaplex

import (
	"errors"
	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"
)

// Ends an auction, regardless of end timing conditions.
type EndAuction struct {
	Args *EndAuctionArgs

	// [0] = [WRITE] auctionManager
	// ··········· Auction manager
	//
	// [1] = [WRITE] auction
	// ··········· Auction
	//
	// [2] = [] auctionExtendedData
	// ··········· Auction extended data account (pda relative to auction of ['auction', program id, vault key, 'extended']).
	//
	// [3] = [SIGNER] auctionManagerAuthority
	// ··········· Auction manager authority
	//
	// [4] = [] storeKey
	// ··········· Store key
	//
	// [5] = [] auctionProgram
	// ··········· Auction program
	//
	// [6] = [] clockSysvar
	// ··········· Clock sysvar
	ag_solanago.AccountMetaSlice `bin:"-"`
}

// NewEndAuctionInstructionBuilder creates a new `EndAuction` instruction builder.
func NewEndAuctionInstructionBuilder() *EndAuction {
	nd := &EndAuction{
		AccountMetaSlice: make(ag_solanago.AccountMetaSlice, 7),
	}
	return nd
}

// SetArgs sets the "args" parameter.
func (inst *EndAuction) SetArgs(args EndAuctionArgs) *EndAuction {
	inst.Args = &args
	return inst
}

// SetAuctionManagerAccount sets the "auctionManager" account.
// Auction manager
func (inst *EndAuction) SetAuctionManagerAccount(auctionManager ag_solanago.PublicKey) *EndAuction {
	inst.AccountMetaSlice[0] = ag_solanago.Meta(auctionManager).WRITE()
	return inst
}

// GetAuctionManagerAccount gets the "auctionManager" account.
// Auction manager
func (inst *EndAuction) GetAuctionManagerAccount() *ag_solanago.AccountMeta {
	return inst.AccountMetaSlice.Get(0)
}

// SetAuctionAccount sets the "auction" account.
// Auction
func (inst *EndAuction) SetAuctionAccount(auction ag_solanago.PublicKey) *EndAuction {
	inst.AccountMetaSlice[1] = ag_solanago.Meta(auction).WRITE()
	return inst
}

// GetAuctionAccount gets the "auction" account.
// Auction
func (inst *EndAuction) GetAuctionAccount() *ag_solanago.AccountMeta {
	return inst.AccountMetaSlice.Get(1)
}

// SetAuctionExtendedDataAccount sets the "auctionExtendedData" account.
// Auction extended data account (pda relative to auction of ['auction', program id, vault key, 'extended']).
func (inst *EndAuction) SetAuctionExtendedDataAccount(auctionExtendedData ag_solanago.PublicKey) *EndAuction {
	inst.AccountMetaSlice[2] = ag_solanago.Meta(auctionExtendedData)
	return inst
}

// GetAuctionExtendedDataAccount gets the "auctionExtendedData" account.
// Auction extended data account (pda relative to auction of ['auction', program id, vault key, 'extended']).
func (inst *EndAuction) GetAuctionExtendedDataAccount() *ag_solanago.AccountMeta {
	return inst.AccountMetaSlice.Get(2)
}

// SetAuctionManagerAuthorityAccount sets the "auctionManagerAuthority" account.
// Auction manager authority
func (inst *EndAuction) SetAuctionManagerAuthorityAccount(auctionManagerAuthority ag_solanago.PublicKey) *EndAuction {
	inst.AccountMetaSlice[3] = ag_solanago.Meta(auctionManagerAuthority).SIGNER()
	return inst
}

// GetAuctionManagerAuthorityAccount gets the "auctionManagerAuthority" account.
// Auction manager authority
func (inst *EndAuction) GetAuctionManagerAuthorityAccount() *ag_solanago.AccountMeta {
	return inst.AccountMetaSlice.Get(3)
}

// SetStoreKeyAccount sets the "storeKey" account.
// Store key
func (inst *EndAuction) SetStoreKeyAccount(storeKey ag_solanago.PublicKey) *EndAuction {
	inst.AccountMetaSlice[4] = ag_solanago.Meta(storeKey)
	return inst
}

// GetStoreKeyAccount gets the "storeKey" account.
// Store key
func (inst *EndAuction) GetStoreKeyAccount() *ag_solanago.AccountMeta {
	return inst.AccountMetaSlice.Get(4)
}

// SetAuctionProgramAccount sets the "auctionProgram" account.
// Auction program
func (inst *EndAuction) SetAuctionProgramAccount(auctionProgram ag_solanago.PublicKey) *EndAuction {
	inst.AccountMetaSlice[5] = ag_solanago.Meta(auctionProgram)
	return inst
}

// GetAuctionProgramAccount gets the "auctionProgram" account.
// Auction program
func (inst *EndAuction) GetAuctionProgramAccount() *ag_solanago.AccountMeta {
	return inst.AccountMetaSlice.Get(5)
}

// SetClockSysvarAccount sets the "clockSysvar" account.
// Clock sysvar
func (inst *EndAuction) SetClockSysvarAccount(clockSysvar ag_solanago.PublicKey) *EndAuction {
	inst.AccountMetaSlice[6] = ag_solanago.Meta(clockSysvar)
	return inst
}

// GetClockSysvarAccount gets the "clockSysvar" account.
// Clock sysvar
func (inst *EndAuction) GetClockSysvarAccount() *ag_solanago.AccountMeta {
	return inst.AccountMetaSlice.Get(6)
}

func (inst EndAuction) Build() *Instruction {
	return &Instruction{BaseVariant: ag_binary.BaseVariant{
		Impl:   inst,
		TypeID: ag_binary.TypeIDFromUint8(Instruction_EndAuction),
	}}
}

// 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 EndAuction) ValidateAndBuild() (*Instruction, error) {
	if err := inst.Validate(); err != nil {
		return nil, err
	}
	return inst.Build(), nil
}

func (inst *EndAuction) Validate() error {
	// Check whether all (required) parameters are set:
	{
		if inst.Args == nil {
			return errors.New("Args parameter is not set")
		}
	}

	// Check whether all (required) accounts are set:
	{
		if inst.AccountMetaSlice[0] == nil {
			return errors.New("accounts.AuctionManager is not set")
		}
		if inst.AccountMetaSlice[1] == nil {
			return errors.New("accounts.Auction is not set")
		}
		if inst.AccountMetaSlice[2] == nil {
			return errors.New("accounts.AuctionExtendedData is not set")
		}
		if inst.AccountMetaSlice[3] == nil {
			return errors.New("accounts.AuctionManagerAuthority is not set")
		}
		if inst.AccountMetaSlice[4] == nil {
			return errors.New("accounts.StoreKey is not set")
		}
		if inst.AccountMetaSlice[5] == nil {
			return errors.New("accounts.AuctionProgram is not set")
		}
		if inst.AccountMetaSlice[6] == nil {
			return errors.New("accounts.ClockSysvar is not set")
		}
	}
	return nil
}

func (inst *EndAuction) EncodeToTree(parent ag_treeout.Branches) {
	parent.Child(ag_format.Program(ProgramName, ProgramID)).
		//
		ParentFunc(func(programBranch ag_treeout.Branches) {
			programBranch.Child(ag_format.Instruction("EndAuction")).
				//
				ParentFunc(func(instructionBranch ag_treeout.Branches) {

					// Parameters of the instruction:
					instructionBranch.Child("Params[len=1]").ParentFunc(func(paramsBranch ag_treeout.Branches) {
						paramsBranch.Child(ag_format.Param("Args", *inst.Args))
					})

					// Accounts of the instruction:
					instructionBranch.Child("Accounts[len=7]").ParentFunc(func(accountsBranch ag_treeout.Branches) {
						accountsBranch.Child(ag_format.Meta("         auctionManager", inst.AccountMetaSlice.Get(0)))
						accountsBranch.Child(ag_format.Meta("                auction", inst.AccountMetaSlice.Get(1)))
						accountsBranch.Child(ag_format.Meta("    auctionExtendedData", inst.AccountMetaSlice.Get(2)))
						accountsBranch.Child(ag_format.Meta("auctionManagerAuthority", inst.AccountMetaSlice.Get(3)))
						accountsBranch.Child(ag_format.Meta("               storeKey", inst.AccountMetaSlice.Get(4)))
						accountsBranch.Child(ag_format.Meta("         auctionProgram", inst.AccountMetaSlice.Get(5)))
						accountsBranch.Child(ag_format.Meta("            clockSysvar", inst.AccountMetaSlice.Get(6)))
					})
				})
		})
}

func (obj EndAuction) MarshalWithEncoder(encoder *ag_binary.Encoder) (err error) {
	// Serialize `Args` param:
	err = encoder.Encode(obj.Args)
	if err != nil {
		return err
	}
	return nil
}
func (obj *EndAuction) UnmarshalWithDecoder(decoder *ag_binary.Decoder) (err error) {
	// Deserialize `Args`:
	err = decoder.Decode(&obj.Args)
	if err != nil {
		return err
	}
	return nil
}

// NewEndAuctionInstruction declares a new EndAuction instruction with the provided parameters and accounts.
func NewEndAuctionInstruction(
	// Parameters:
	args EndAuctionArgs,
	// Accounts:
	auctionManager ag_solanago.PublicKey,
	auction ag_solanago.PublicKey,
	auctionExtendedData ag_solanago.PublicKey,
	auctionManagerAuthority ag_solanago.PublicKey,
	storeKey ag_solanago.PublicKey,
	auctionProgram ag_solanago.PublicKey,
	clockSysvar ag_solanago.PublicKey) *EndAuction {
	return NewEndAuctionInstructionBuilder().
		SetArgs(args).
		SetAuctionManagerAccount(auctionManager).
		SetAuctionAccount(auction).
		SetAuctionExtendedDataAccount(auctionExtendedData).
		SetAuctionManagerAuthorityAccount(auctionManagerAuthority).
		SetStoreKeyAccount(storeKey).
		SetAuctionProgramAccount(auctionProgram).
		SetClockSysvarAccount(clockSysvar)
}