solana

package module
v0.3.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 20, 2021 License: Apache-2.0 Imports: 18 Imported by: 2,233

README

Solana SDK library for Go

GoDoc GitHub tag (latest SemVer pre-release) Build Status TODOs Go Report Card

Go library to interface with Solana nodes's JSON-RPC interface, Solana's SPL tokens and the Serum DEX instructions. More contracts to come.

solana-gopher-2_small

Installation

⚠ solana-go works using SemVer but in 0 version, which means that the 'minor' will be changed when some broken changes are introduced into the application, and the 'patch' will be changed when a new feature with new changes is added or for bug fixing. As soon as v1.0.0 be released, solana-go will start to use SemVer as usual.

$ go get github.com/gagliardetto/solana-go

Current development status

The SDK is actively developed and latest is an alpha release.

Features

  • Full JSON RPC API
  • Full WebSocket JSON streaming API
  • Wallet, account, and keys management
  • Clients for native programs
  • Clients for Solana Program Library
  • Client for Serum

RPC usage

TODO

Contributing

Any contributions are welcome, use your standard GitHub-fu to pitch in and improve.

License

Apache 2.0

Credits

  • Gopher logo was originally created by Takuya Ueda (https://twitter.com/tenntenn). Licensed under the Creative Commons 3.0 Attributions license.

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var InstructionDecoderRegistry = map[string]InstructionDecoder{}

Functions

func DecimalsInBigInt 

func DecimalsInBigInt(decimal uint32) *big.Int

func DecodeInstruction 

func DecodeInstruction(programID PublicKey, accounts []*AccountMeta, data []byte) (interface{}, error)

func NewRandomPrivateKey 

func NewRandomPrivateKey() (PublicKey, PrivateKey, error)

func RegisterInstructionDecoder 

func RegisterInstructionDecoder(programID PublicKey, decoder InstructionDecoder)

Types

type Account 

type Account struct {
	PrivateKey PrivateKey
}

func AccountFromPrivateKeyBase58 

func AccountFromPrivateKeyBase58(privateKey string) (*Account, error)

func NewAccount 

func NewAccount() *Account

func (*Account) PublicKey 

func (a *Account) PublicKey() PublicKey

type AccountMeta 

type AccountMeta struct {
	PublicKey  PublicKey
	IsSigner   bool
	IsWritable bool
}

type AccountSettable 

type AccountSettable interface {
	SetAccounts(accounts []*AccountMeta) error
}

type Base58 

type Base58 []byte

func (Base58) MarshalJSON 

func (t Base58) MarshalJSON() ([]byte, error)

func (Base58) String 

func (t Base58) String() string

func (*Base58) UnmarshalJSON 

func (t *Base58) UnmarshalJSON(data []byte) (err error)

type ByteWrapper 

type ByteWrapper struct {
	io.Reader
}

func (*ByteWrapper) ReadByte 

func (w *ByteWrapper) ReadByte() (byte, error)

type CompiledInstruction 

type CompiledInstruction struct {
	// Index into the message.accountKeys array indicating the program account that executes this instruction.
	ProgramIDIndex uint16 `json:"programIdIndex"`

	AccountCount bin.Varuint16 `json:"-" bin:"sizeof=Accounts"`
	DataLength   bin.Varuint16 `json:"-" bin:"sizeof=Data"`

	// List of ordered indices into the message.accountKeys array indicating which accounts to pass to the program.
	Accounts []uint16 `json:"accounts"`

	// The program input data encoded in a base-58 string.
	Data Base58 `json:"data"`
}

func (*CompiledInstruction) ResolveInstructionAccounts 

func (ci *CompiledInstruction) ResolveInstructionAccounts(message *Message) (out []*AccountMeta)

type Data 

type Data struct {
	Content  []byte
	Encoding EncodingType
}

func (Data) MarshalJSON 

func (t Data) MarshalJSON() ([]byte, error)

func (Data) String 

func (t Data) String() string

func (*Data) UnmarshalJSON 

func (t *Data) UnmarshalJSON(data []byte) (err error)

type EncodingType 

type EncodingType string
const (
	EncodingBase58     EncodingType = "base58"      // limited to Account data of less than 129 bytes
	EncodingBase64     EncodingType = "base64"      // will return base64 encoded data for Account data of any size
	EncodingBase64Zstd EncodingType = "base64+zstd" // compresses the Account data using Zstandard and base64-encodes the result

	// attempts to use program-specific state parsers to
	// return more human-readable and explicit account state data.
	// If "jsonParsed" is requested but a parser cannot be found,
	// the field falls back to "base64" encoding, detectable when the data field is type <string>.
	// Cannot be used if specifying dataSlice parameters (offset, length).
	EncodingJSONParsed EncodingType = "jsonParsed"

	EncodingJSON EncodingType = "json" // NOTE: not usable in almost-all places.
)

type Hash 

type Hash PublicKey

func HashFromBase58 

func HashFromBase58(in string) (Hash, error)

func MustHashFromBase58 

func MustHashFromBase58(in string) Hash

func (Hash) Equals 

func (ha Hash) Equals(pb Hash) bool

func (Hash) IsZero 

func (ha Hash) IsZero() bool

func (Hash) MarshalJSON 

func (ha Hash) MarshalJSON() ([]byte, error)

func (Hash) String 

func (ha Hash) String() string

func (*Hash) UnmarshalJSON 

func (ha *Hash) UnmarshalJSON(data []byte) (err error)

type Instruction 

type Instruction interface {
	Accounts() []*AccountMeta // returns the list of accounts the instructions requires
	ProgramID() PublicKey     // the programID the instruction acts on
	Data() ([]byte, error)    // the binary encoded instructions
}

type InstructionDecoder 

type InstructionDecoder func(instructionAccounts []*AccountMeta, data []byte) (interface{}, error)

InstructionDecoder receives the AccountMeta FOR THAT INSTRUCTION, and not the accounts of the *Message object. Resolve with CompiledInstruction.ResolveInstructionAccounts(message) beforehand.

type Message 

type Message struct {
	// List of base-58 encoded public keys used by the transaction,
	// including by the instructions and for signatures.
	// The first `message.header.numRequiredSignatures` public keys must sign the transaction.
	AccountKeys []PublicKey `json:"accountKeys"`

	// Details the account types and signatures required by the transaction.
	Header MessageHeader `json:"header"`

	// A base-58 encoded hash of a recent block in the ledger used to
	// prevent transaction duplication and to give transactions lifetimes.
	RecentBlockhash Hash `json:"recentBlockhash"`

	// List of program instructions that will be executed in sequence
	// and committed in one atomic transaction if all succeed.
	Instructions []CompiledInstruction `json:"instructions"`
}

func (*Message) AccountMetaList 

func (m *Message) AccountMetaList() (out []*AccountMeta)

func (*Message) IsSigner 

func (m *Message) IsSigner(account PublicKey) bool

func (*Message) IsWritable 

func (m *Message) IsWritable(account PublicKey) bool

func (*Message) ResolveProgramIDIndex 

func (m *Message) ResolveProgramIDIndex(programIDIndex uint16) (PublicKey, error)

func (*Message) TouchAccount 

func (m *Message) TouchAccount(account PublicKey) bool

type MessageHeader 

type MessageHeader struct {
	// The total number of signatures required to make the transaction valid.
	// The signatures must match the first `numRequiredSignatures` of `message.account_keys`.
	NumRequiredSignatures uint8 `json:"numRequiredSignatures"`

	// The last numReadonlySignedAccounts of the signed keys are read-only accounts.
	// Programs may process multiple transactions that load read-only accounts within
	// a single PoH entry, but are not permitted to credit or debit lamports or modify
	// account data.
	// Transactions targeting the same read-write account are evaluated sequentially.
	NumReadonlySignedAccounts uint8 `json:"numReadonlySignedAccounts"`

	// The last `numReadonlyUnsignedAccounts` of the unsigned keys are read-only accounts.
	NumReadonlyUnsignedAccounts uint8 `json:"numReadonlyUnsignedAccounts"`
}

type Padding 

type Padding []byte

type PrivateKey 

type PrivateKey []byte

func MustPrivateKeyFromBase58 

func MustPrivateKeyFromBase58(in string) PrivateKey

func PrivateKeyFromBase58 

func PrivateKeyFromBase58(privkey string) (PrivateKey, error)

func PrivateKeyFromSolanaKeygenFile 

func PrivateKeyFromSolanaKeygenFile(file string) (PrivateKey, error)

func (PrivateKey) PublicKey 

func (k PrivateKey) PublicKey() PublicKey

func (PrivateKey) Sign 

func (k PrivateKey) Sign(payload []byte) (Signature, error)

func (PrivateKey) String 

func (k PrivateKey) String() string

type PublicKey 

type PublicKey [32]byte

func MustPublicKeyFromBase58 

func MustPublicKeyFromBase58(in string) PublicKey

func PublicKeyFromBase58 

func PublicKeyFromBase58(in string) (out PublicKey, err error)

func PublicKeyFromBytes 

func PublicKeyFromBytes(in []byte) (out PublicKey)

func (PublicKey) Equals 

func (p PublicKey) Equals(pb PublicKey) bool

func (PublicKey) IsZero 

func (p PublicKey) IsZero() bool

func (PublicKey) MarshalJSON 

func (p PublicKey) MarshalJSON() ([]byte, error)

func (PublicKey) String 

func (p PublicKey) String() string

func (*PublicKey) UnmarshalJSON 

func (p *PublicKey) UnmarshalJSON(data []byte) (err error)

type Signature 

type Signature [64]byte

func MustSignatureFromBase58 

func MustSignatureFromBase58(in string) Signature

func SignatureFromBase58 

func SignatureFromBase58(in string) (out Signature, err error)

func (Signature) Equals 

func (sig Signature) Equals(pb Signature) bool

func (Signature) IsZero 

func (sig Signature) IsZero() bool

func (Signature) MarshalJSON 

func (p Signature) MarshalJSON() ([]byte, error)

func (Signature) String 

func (p Signature) String() string

func (*Signature) UnmarshalJSON 

func (p *Signature) UnmarshalJSON(data []byte) (err error)

type Transaction 

type Transaction struct {
	// A list of base-58 encoded signatures applied to the transaction.
	// The list is always of length `message.header.numRequiredSignatures` and not empty.
	// The signature at index `i` corresponds to the public key at index
	// `i` in `message.account_keys`. The first one is used as the transaction id.
	Signatures []Signature `json:"signatures"`

	// Defines the content of the transaction.
	Message Message `json:"message"`
}

func MustTransactionFromData 

func MustTransactionFromData(in []byte) *Transaction

func NewTransaction 

func NewTransaction(instructions []Instruction, blockHash Hash, opts ...TransactionOption) (*Transaction, error)

func TransactionFromData 

func TransactionFromData(in []byte) (*Transaction, error)

func (*Transaction) AccountMetaList 

func (t *Transaction) AccountMetaList() (out []*AccountMeta)

func (*Transaction) IsSigner 

func (t *Transaction) IsSigner(account PublicKey) bool

func (*Transaction) IsWritable 

func (t *Transaction) IsWritable(account PublicKey) bool

func (*Transaction) ResolveProgramIDIndex 

func (t *Transaction) ResolveProgramIDIndex(programIDIndex uint16) (PublicKey, error)

func (*Transaction) Sign 

func (t *Transaction) Sign(getter privateKeyGetter) (out []Signature, err error)

func (*Transaction) TouchAccount 

func (t *Transaction) TouchAccount(account PublicKey) bool

type TransactionOption 

type TransactionOption interface {
	// contains filtered or unexported methods
}

func TransactionPayer 

func TransactionPayer(payer PublicKey) TransactionOption

Source Files

View all Source files

Directories

Path Synopsis
cmd
slnc command
slnc/cmd
programs
serum
Code generated by rice embed-go; DO NOT EDIT.
 Code generated by rice embed-go; DO NOT EDIT.
system
token
Code generated by rice embed-go; DO NOT EDIT.
 Code generated by rice embed-go; DO NOT EDIT.
tokenregistry
rpc
jsonrpc
Package jsonrpc provides a JSON-RPC 2.0 client that sends JSON-RPC requests and receives JSON-RPC responses using HTTP.
 Package jsonrpc provides a JSON-RPC 2.0 client that sends JSON-RPC requests and receives JSON-RPC responses using HTTP.
ws

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.