metadata_pointer

Documentation

Index

• Constants
• Variables
• func InstructionIDToName(id uint8) string
• func SetProgramID(pubkey common.PublicKey)
• type Initialize
  • func NewInitializeInstruction(authority common.PublicKey, metadataAddress common.PublicKey, ...) *Initialize
  • func NewInitializeInstructionBuilder() *Initialize
  • func (obj *Initialize) Build() *Instruction
  • func (obj *Initialize) EncodeToTree(parent treeout.Branches)
  • func (obj *Initialize) GetMintAccount() *common.AccountMeta
  • func (obj *Initialize) MarshalWithEncoder(encoder *binary.Encoder) (err error)
  • func (obj *Initialize) SetAuthority(authority common.PublicKey) *Initialize
  • func (obj *Initialize) SetMetadataAddress(metadataAddress common.PublicKey) *Initialize
  • func (obj *Initialize) SetMintAccount(mint common.PublicKey, multiSigners ...common.PublicKey) *Initialize
  • func (obj *Initialize) SetProgramId(programId *common.PublicKey) *Initialize
  • func (obj *Initialize) UnmarshalWithDecoder(decoder *binary.Decoder) (err error)
  • func (obj *Initialize) Validate() error
  • func (obj *Initialize) ValidateAndBuild() (*Instruction, error)
• type Instruction
  • func DecodeInstruction(accounts []*common.AccountMeta, data []byte) (*Instruction, error)
  • func (obj *Instruction) Accounts() (out []*common.AccountMeta)
  • func (obj *Instruction) Data() ([]byte, error)
  • func (obj *Instruction) EncodeToTree(parent treeout.Branches)
  • func (obj *Instruction) MarshalWithEncoder(encoder *binary.Encoder) error
  • func (obj *Instruction) ProgramID() common.PublicKey
  • func (obj *Instruction) TextEncode(encoder *text.Encoder, option *text.Option) error
  • func (obj *Instruction) UnmarshalWithDecoder(decoder *binary.Decoder) error
• type MetadataPointer
  • func (obj *MetadataPointer) MarshalWithEncoder(encoder *binary.Encoder) (err error)
  • func (obj *MetadataPointer) UnmarshalWithDecoder(decoder *binary.Decoder) (err error)
• type Update
  • func NewUpdateInstruction(metadataAddress common.PublicKey, mint common.PublicKey, ...) *Update
  • func NewUpdateInstructionBuilder() *Update
  • func (obj *Update) Build() *Instruction
  • func (obj *Update) EncodeToTree(parent treeout.Branches)
  • func (obj *Update) GetMintAccount() *common.AccountMeta
  • func (obj *Update) GetOwnerAccount() *common.AccountMeta
  • func (obj *Update) MarshalWithEncoder(encoder *binary.Encoder) (err error)
  • func (obj *Update) SetMetadataAddress(metadataAddress common.PublicKey) *Update
  • func (obj *Update) SetMintAccount(mint common.PublicKey) *Update
  • func (obj *Update) SetOwnerAccount(owner common.PublicKey, multiSigners ...common.PublicKey) *Update
  • func (obj *Update) SetProgramId(programId *common.PublicKey) *Update
  • func (obj *Update) UnmarshalWithDecoder(decoder *binary.Decoder) (err error)
  • func (obj *Update) Validate() error
  • func (obj *Update) ValidateAndBuild() (*Instruction, error)

Constants

const METADATA_POINTER_SIZE = 64

const ProgramName = "metadata_pointer"

Variables

var (
	Instruction_Initialize uint8 = 0
	Instruction_Update     uint8 = 1
)

var InstructionImplDef = binary.NewVariantDefinition(binary.Uint8TypeIDEncoding, []binary.VariantType{
	{
		"initialize", (*Initialize)(nil),
	},
	{
		"update", (*Update)(nil),
	},
})

var ProgramID common.PublicKey = common.MustPublicKeyFromBase58("11111111111111111111111111111111")

Functions

func InstructionIDToName

func InstructionIDToName(id uint8) string

InstructionIDToName returns the name of the instruction given its ID.

func SetProgramID

func SetProgramID(pubkey common.PublicKey)

Types

type Initialize

type Initialize struct {
	Authority       *common.PublicKey
	MetadataAddress *common.PublicKey
	// [0] = [WRITE] mint `The mint to initialize`
	common.AccountMetaSlice `bin:"-"`
	// contains filtered or unexported fields
}

Initialize Instruction

func NewInitializeInstruction

func NewInitializeInstruction(
	authority common.PublicKey,
	metadataAddress common.PublicKey,
	mint common.PublicKey,
) *Initialize

NewInitializeInstruction

Parameters:

authority:
metadataAddress:
mint: The mint to initialize

func NewInitializeInstructionBuilder

func NewInitializeInstructionBuilder() *Initialize

NewInitializeInstructionBuilder creates a new `Initialize` instruction builder.

func (*Initialize) Build

func (obj *Initialize) Build() *Instruction

func (*Initialize) EncodeToTree

func (obj *Initialize) EncodeToTree(parent treeout.Branches)

func (*Initialize) GetMintAccount

func (obj *Initialize) GetMintAccount() *common.AccountMeta

GetMintAccount gets the "mint" parameter. The mint to initialize

func (*Initialize) MarshalWithEncoder

func (obj *Initialize) MarshalWithEncoder(encoder *binary.Encoder) (err error)

func (*Initialize) SetAuthority

func (obj *Initialize) SetAuthority(authority common.PublicKey) *Initialize

SetAuthority sets the "authority" parameter.

func (*Initialize) SetMetadataAddress

func (obj *Initialize) SetMetadataAddress(metadataAddress common.PublicKey) *Initialize

SetMetadataAddress sets the "metadataAddress" parameter.

func (*Initialize) SetMintAccount

func (obj *Initialize) SetMintAccount(mint common.PublicKey, multiSigners ...common.PublicKey) *Initialize

SetMintAccount sets the "mint" parameter. The mint to initialize

func (*Initialize) SetProgramId

func (obj *Initialize) SetProgramId(programId *common.PublicKey) *Initialize

func (*Initialize) UnmarshalWithDecoder

func (obj *Initialize) UnmarshalWithDecoder(decoder *binary.Decoder) (err error)

func (*Initialize) Validate

func (obj *Initialize) Validate() error

func (*Initialize) ValidateAndBuild

func (obj *Initialize) ValidateAndBuild() (*Instruction, error)

ValidateAndBuild validates the instruction parameters and accounts; if there is a validation error, it returns the error. Otherwise, it builds and returns the instruction.

type Instruction

type Instruction struct {
	binary.BaseVariant
	// contains filtered or unexported fields
}

func DecodeInstruction

func DecodeInstruction(accounts []*common.AccountMeta, data []byte) (*Instruction, error)

func (*Instruction) Accounts

func (obj *Instruction) Accounts() (out []*common.AccountMeta)

func (*Instruction) Data

func (obj *Instruction) Data() ([]byte, error)

func (*Instruction) EncodeToTree

func (obj *Instruction) EncodeToTree(parent treeout.Branches)

func (*Instruction) MarshalWithEncoder

func (obj *Instruction) MarshalWithEncoder(encoder *binary.Encoder) error

func (*Instruction) ProgramID

func (obj *Instruction) ProgramID() common.PublicKey

func (*Instruction) TextEncode

func (obj *Instruction) TextEncode(encoder *text.Encoder, option *text.Option) error

func (*Instruction) UnmarshalWithDecoder

func (obj *Instruction) UnmarshalWithDecoder(decoder *binary.Decoder) error

type MetadataPointer

type MetadataPointer struct {
	// Authority that can set the metadata address
	Authority common.PublicKey
	// Account address that holds the metadata
	MetadataAddress common.PublicKey
}

MetadataPointer Struct

func (*MetadataPointer) MarshalWithEncoder

func (obj *MetadataPointer) MarshalWithEncoder(encoder *binary.Encoder) (err error)

func (*MetadataPointer) UnmarshalWithDecoder

func (obj *MetadataPointer) UnmarshalWithDecoder(decoder *binary.Decoder) (err error)

type Update

type Update struct {
	MetadataAddress *common.PublicKey
	// [0] = [WRITE] mint `The mint.`
	// [1] = [SIGNER] owner `The metadata pointer authority.`
	common.AccountMetaSlice `bin:"-"`
	// contains filtered or unexported fields
}

Update Instruction

func NewUpdateInstruction

func NewUpdateInstruction(
	metadataAddress common.PublicKey,
	mint common.PublicKey,
	owner common.PublicKey,
) *Update

NewUpdateInstruction

Parameters:

metadataAddress:
mint: The mint.
owner: The metadata pointer authority.

func NewUpdateInstructionBuilder

func NewUpdateInstructionBuilder() *Update

NewUpdateInstructionBuilder creates a new `Update` instruction builder.

func (*Update) Build

func (obj *Update) Build() *Instruction

func (*Update) EncodeToTree

func (obj *Update) EncodeToTree(parent treeout.Branches)

func (*Update) GetMintAccount

func (obj *Update) GetMintAccount() *common.AccountMeta

GetMintAccount gets the "mint" parameter. The mint.

func (*Update) GetOwnerAccount

func (obj *Update) GetOwnerAccount() *common.AccountMeta

GetOwnerAccount gets the "owner" parameter. The metadata pointer authority.

func (*Update) MarshalWithEncoder

func (obj *Update) MarshalWithEncoder(encoder *binary.Encoder) (err error)

func (*Update) SetMetadataAddress

func (obj *Update) SetMetadataAddress(metadataAddress common.PublicKey) *Update

SetMetadataAddress sets the "metadataAddress" parameter.

func (*Update) SetMintAccount

func (obj *Update) SetMintAccount(mint common.PublicKey) *Update

SetMintAccount sets the "mint" parameter. The mint.

func (*Update) SetOwnerAccount

func (obj *Update) SetOwnerAccount(owner common.PublicKey, multiSigners ...common.PublicKey) *Update

SetOwnerAccount sets the "owner" parameter. The metadata pointer authority.

func (*Update) SetProgramId

func (obj *Update) SetProgramId(programId *common.PublicKey) *Update

func (*Update) UnmarshalWithDecoder

func (obj *Update) UnmarshalWithDecoder(decoder *binary.Decoder) (err error)

func (*Update) Validate

func (obj *Update) Validate() error

func (*Update) ValidateAndBuild

func (obj *Update) ValidateAndBuild() (*Instruction, error)

ValidateAndBuild validates the instruction parameters and accounts; if there is a validation error, it returns the error. Otherwise, it builds and returns the instruction.