apollo

README

Apollo: Pure Golang Cardano Building blocks

Pure Golang Cardano Serialization

The Objective of this library is to give Developers Access to each and every needed resource for cardano development. The final goal is to be able to have this library interact directly with the node without intermediaries.

TODO:

• Ledger

  • Byron Support
    • Block
    • Transaction
    • TxOutputs
    • TxInputs
    • Serialization/deserialization
    • Interfacing
    • Tests
  • Shelley Support
    • Block
    • Transaction
    • TxOutputs
    • TxInputs
    • Serialization/deserialization
    • Tests
  • ShelleyMary Support
    • Block
    • Transaction
    • TxOutputs
    • TxInputs
    • Serialization/deserialization
    • Tests
  • Allegra Support
    • Block
    • Transaction
    • TxOutputs
    • TxInputs
    • Serialization/deserialization
    • Tests
  • Alonzo Support
    • Block
    • Transaction
    • TxOutputs
    • TxInputs
    • Serialization/deserialization
    • Tests
  • Babbage Support
    • Block
    • Transaction
    • TxOutputs
    • TxInputs
    • Serialization/deserialization
    • Tests
  • Conway Support
    • Block
    • Transaction
    • TxOutputs
    • TxInputs
    • Serialization/deserialization
    • Tests

• Serialization/Deserialization

  • Address
    • Enterprise Address
    • Staked Address
    • SC Address
    • Others...
  • Amount
    • Serialization/Deserialization
    • Basic Functionality
    • Utility functions
    • Constructors
  • Asset
    • Serialization/Deserialization
    • Basic Functionality
    • Utility functions
    • Constructors
  • AssetName
    • Serialization/Deserialization
    • Basic Functionality
    • Utility functions
    • Constructors
  • MultiAsset
    • Serialization/Deserialization
    • Basic Functionality
    • Utility functions
    • Constructors
  • Policy
    • Serialization/Deserialization
    • Basic Functionality
    • Utility functions
    • Constructors
  • Value
    • Serialization/Deserialization
    • Basic Functionality
    • Utility functions
    • Constructors
  • NativeScript
    • Serialization/Deserialization
    • Basic Functionality
    • Utility functions
    • Constructors
  • PlutusData
    • Serialization/Deserialization
    • Basic Functionality
    • Utility functions
    • Constructors
  • Redeemer
    • Serialization/Deserialization
    • Basic Functionality
    • Utility functions
    • Constructors
  • Keys
    • Serialization/Deserialization
    • Basic Functionality
    • Utility functions
    • Constructors

• TxBuilding

  • Basic Tx Building
  • Basic Smart Contract Interaction
  • Advanced Smart Contract Interaction
  • Coin Selectors
    • LargestFirst
    • RandomImprove
    • Greedy
  • Utility Functions
  • Backends
    • Blockfrost
    • Ogmios + Kupo
    • DBSync
    • Carybdis
    • Koios

If you have any questions or requests feel free to drop into this discord and ask :) https://discord.gg/MH4CmJcg49

By: Edoardo Salvioni - Zhaata

Documentation

Index

• Constants
• func NewBlockfrostBackend(projectId string, network Network) apollotypes.Backend
• type Apollo
  • func New(cc apollotypes.Backend, network Network) *Apollo
  • func (a *Apollo) CheckTx(txHash serialization.TransactionId, checkInterval int) chan bool
  • func (a *Apollo) DatumOf(utxo UTxO.UTxO) *PlutusData.PlutusData
  • func (a *Apollo) FromTx(tx any) builder
  • func (a *Apollo) MetadataOf(asset string) *Metadata.Metadata
  • func (a *Apollo) NewTx(utils any) builder
  • func (a *Apollo) SetWalletFromMnemonic(mnemonic string) *Apollo
  • func (a *Apollo) SetWalletFromPrivateKeyBytes(privateKey []byte) *Apollo
  • func (a *Apollo) SetWalletFromPrivateKeyHex(privateKey string) *Apollo
  • func (a *Apollo) SwitchBackend(backend apollotypes.Backend) *Apollo
  • func (a *Apollo) SwitchNetwork(network Network) *Apollo
  • func (a *Apollo) UtxosAt(address Address.Address) []UTxO.UTxO
  • func (a *Apollo) UtxosByAsset(asset string) []UTxO.UTxO
• type ApolloTransaction
  • func (tx *ApolloTransaction) Sign() *ApolloTransaction
  • func (tx *ApolloTransaction) Submit()
• type Network

Constants

const BLOCKFROST_BASE_URL_MAINNET = "https://cardano-mainnet.blockfrost.io/api"

const BLOCKFROST_BASE_URL_PREPROD = "https://cardano-preprod.blockfrost.io/api"

const BLOCKFROST_BASE_URL_PREVIEW = "https://cardano-preview.blockfrost.io/api"

const BLOCKFROST_BASE_URL_TESTNET = "https://cardano-testnet.blockfrost.io/api"

Functions

func NewBlockfrostBackend

func NewBlockfrostBackend(projectId string, network Network) apollotypes.Backend

Types

type Apollo

type Apollo struct {
	// contains filtered or unexported fields
}

func New

func New(cc apollotypes.Backend, network Network) *Apollo

func (*Apollo) CheckTx

func (a *Apollo) CheckTx(txHash serialization.TransactionId, checkInterval int) chan bool

func (*Apollo) DatumOf

func (a *Apollo) DatumOf(utxo UTxO.UTxO) *PlutusData.PlutusData

func (*Apollo) FromTx

func (a *Apollo) FromTx(tx any) builder

func (*Apollo) MetadataOf

func (a *Apollo) MetadataOf(asset string) *Metadata.Metadata

func (*Apollo) NewTx

func (a *Apollo) NewTx(utils any) builder

func (*Apollo) SetWalletFromMnemonic

func (a *Apollo) SetWalletFromMnemonic(mnemonic string) *Apollo

func (*Apollo) SetWalletFromPrivateKeyBytes

func (a *Apollo) SetWalletFromPrivateKeyBytes(privateKey []byte) *Apollo

func (*Apollo) SetWalletFromPrivateKeyHex

func (a *Apollo) SetWalletFromPrivateKeyHex(privateKey string) *Apollo

func (*Apollo) SwitchBackend

func (a *Apollo) SwitchBackend(backend apollotypes.Backend) *Apollo

func (*Apollo) SwitchNetwork

func (a *Apollo) SwitchNetwork(network Network) *Apollo

func (*Apollo) UtxosAt

func (a *Apollo) UtxosAt(address Address.Address) []UTxO.UTxO

func (*Apollo) UtxosByAsset

func (a *Apollo) UtxosByAsset(asset string) []UTxO.UTxO

type ApolloTransaction

type ApolloTransaction struct {
	Apollo *Apollo
	Tx     Transaction.Transaction
}

func (*ApolloTransaction) Sign

func (tx *ApolloTransaction) Sign() *ApolloTransaction

func (*ApolloTransaction) Submit

func (tx *ApolloTransaction) Submit()

type Network

type Network int

const (
	MAINNET Network = iota
	TESTNET
	PREVIEW
	PREPROD
)