ergo

type Address interface {
	// Base58 converts an Address to a base58 string using the provided networkPrefix.
	Base58(prefix networkPrefix) string
	// TypePrefix returns the addressTypePrefix for the Address.
	// 0x01 - Pay-to-PublicKey(P2PK) address.
	// 0x02 - Pay-to-Script-Hash(P2SH).
	// 0x03 - Pay-to-Script(P2S).
	TypePrefix() addressTypePrefix
	// Tree returns the Address as Tree
	Tree() Tree
	// contains filtered or unexported methods
}

type BatchMerkleProof interface {
	Valid(expectedRoot []byte) bool
}

type BlockHeader interface {
	// BlockId returns the BlockId of the BlockHeader
	BlockId() BlockId
	// Equals checks if provided BlockHeader is same
	Equals(blockHeader BlockHeader) bool
	// contains filtered or unexported methods
}

type BlockHeaders interface {
	// Len returns the length of the collection
	Len() int
	// Get returns the BlockHeader at the provided index if it exists
	Get(index int) (BlockHeader, error)
	// Add adds provided BlockHeader to the end of the collection
	Add(blockHeader BlockHeader)
	// All returns an iterator over all BlockHeader inside the collection
	All() iter.Seq2[int, BlockHeader]
	// contains filtered or unexported methods
}

type BlockId interface {
	// Equals checks if provided BlockId is same
	Equals(blockId BlockId) bool
	// contains filtered or unexported methods
}

type BlockIds interface {
	// Len returns the length of the collection
	Len() int
	// Get returns the BlockId at the provided index if it exists
	Get(index int) (BlockId, error)
	// Add adds provided BlockId to the end of the collection
	Add(blockId BlockId)
	// All returns an iterator over all BlockId inside the collection
	All() iter.Seq2[int, BlockId]
}

type Box interface {
	// BoxId returns the BoxId of the Box
	BoxId() BoxId
	// RegisterValue returns value (Constant) stored in the register or nil if the register is empty
	RegisterValue(registerId nonMandatoryRegisterId) (Constant, error)
	// CreationHeight returns the creation height of the Box
	CreationHeight() uint32
	// Tokens returns the ergo Tokens for the Box
	Tokens() Tokens
	// Tree returns the ergo Tree for the Box
	Tree() Tree
	// BoxValue returns the BoxValue of the Box
	BoxValue() BoxValue
	// Json returns json representation of Box as string (compatible with Ergo Node/Explorer API, numbers are encoded as numbers)
	Json() (string, error)
	// JsonEIP12 returns json representation of Box as string according to EIP-12 https://github.com/ergoplatform/eips/pull/23
	JsonEIP12() (string, error)
	// Size calculates serialized box size(in bytes)
	Size() uint32
	// Equals checks if provided Box is same
	Equals(box Box) bool
	// contains filtered or unexported methods
}

type BoxAssetsData interface {
	// BoxValue returns the BoxValue of the BoxAssetsData
	BoxValue() BoxValue
	// Tokens returns the Tokens of the BoxAssetsData
	Tokens() Tokens
	// Equals checks if provided BoxAssetsData is same
	Equals(boxAssetsData BoxAssetsData) bool
	// contains filtered or unexported methods
}

type BoxAssetsDataList interface {
	// Len returns the length of the collection
	Len() int
	// Get returns the BoxAssetsData at the provided index if it exists
	Get(index int) (BoxAssetsData, error)
	// Add adds provided BoxAssetsData to the end of the collection
	Add(boxAssetsData BoxAssetsData)
	// All returns an iterator over all BoxAssetsData inside the collection
	All() iter.Seq2[int, BoxAssetsData]
	// contains filtered or unexported methods
}

type BoxCandidate interface {
	// RegisterValue returns value (Constant) stored in the register or nil if the register is empty
	RegisterValue(registerId nonMandatoryRegisterId) (Constant, error)
	// CreationHeight returns the creation height of the BoxCandidate
	CreationHeight() uint32
	// Tokens returns the ergo Tokens for the BoxCandidate
	Tokens() Tokens
	// Tree returns the ergo Tree for the BoxCandidate
	Tree() Tree
	// BoxValue returns the BoxValue of the BoxCandidate
	BoxValue() BoxValue
	// Equals checks if provided BoxCandidate is same
	Equals(candidate BoxCandidate) bool
	// contains filtered or unexported methods
}

type BoxCandidateBuilder interface {
	// SetMinBoxValuePerByte sets minimal value (per byte of the serialized box size)
	SetMinBoxValuePerByte(minBoxValuePerByte uint32)
	// MinBoxValuePerByte returns minimal value (per byte of the serialized box size)
	MinBoxValuePerByte() uint32
	// SetValue sets new box value
	SetValue(boxValue BoxValue)
	// Value returns box value
	Value() BoxValue
	// CalcBoxSizeBytes calculates serialized box size(in bytes)
	CalcBoxSizeBytes() (uint32, error)
	// CalcMinBoxValue calculates minimal box value for the current box serialized size(in bytes)
	CalcMinBoxValue() (BoxValue, error)
	// SetRegisterValue sets register with a given id (R4 - R9) to the given value
	SetRegisterValue(registerId nonMandatoryRegisterId, constant Constant)
	// RegisterValue returns register value for the given register id (R4 - R9), or nil if the register is empty
	RegisterValue(registerId nonMandatoryRegisterId) (Constant, error)
	// DeleteRegisterValue deletes register value(make register empty) for the given register id (R4 - R9)
	DeleteRegisterValue(registerId nonMandatoryRegisterId)
	// MintToken mints token, as defined in https://github.com/ergoplatform/eips/blob/master/eip-0004.md
	// Parameters:
	// token - token id(box id of the first input box in transaction) and token amount
	// tokenName - token name (will be encoded in R4)
	// tokenDesc - token description (will be encoded in R5)
	// numDecimals - number of decimals (will be encoded in R6)
	MintToken(token Token, tokenName string, tokenDesc string, numDecimals uint32)
	// AddToken adds given token id and token amount
	AddToken(tokenId TokenId, tokenAmount TokenAmount)
	// Build builds the box candidate
	Build() (BoxCandidate, error)
}

type BoxCandidates interface {
	// Len returns the length of the collection
	Len() int
	// Get returns the BoxCandidate at the provided index if it exists
	Get(index int) (BoxCandidate, error)
	// Add adds provided BoxCandidate to the end of the collection
	Add(boxCandidate BoxCandidate)
	// All returns an iterator over all BoxCandidate inside the collection
	All() iter.Seq2[int, BoxCandidate]
	// contains filtered or unexported methods
}

type BoxId interface {
	// Base16 returns the BoxId as base16 encoded string
	Base16() string
	// Equals checks if provided BoxId is same
	Equals(boxId BoxId) bool
	// contains filtered or unexported methods
}

type BoxSelection interface {
	// Boxes returns selected boxes to spend as transaction inputs
	Boxes() Boxes
	// ChangeBoxes returns selected boxes to use as change
	ChangeBoxes() BoxAssetsDataList
	// Equals checks if provided BoxSelection is same
	Equals(boxSelection BoxSelection) bool
	// contains filtered or unexported methods
}

type BoxValue interface {
	// Int64 returns BoxValue value as int64
	Int64() int64
	// Equals checks if provided BoxValue is same
	Equals(boxValue BoxValue) bool
	// contains filtered or unexported methods
}

type Boxes interface {
	// Len returns the length of the collection
	Len() int
	// Get returns the Box at the provided index if it exists
	Get(index int) (Box, error)
	// Add adds provided Box to the end of the collection
	Add(box Box)
	// All returns an iterator over all Box inside the collection
	All() iter.Seq2[int, Box]
	// contains filtered or unexported methods
}

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

type ByteArrays interface {
	Len() int
	Get(index int) (ByteArray, error)
	Add(byteArray ByteArray)
	All() iter.Seq2[int, ByteArray]
	// contains filtered or unexported methods
}

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

type Constant interface {
	// Base16 encode as Base16-encoded ErgoTree serialized value or throw an error if serialization failed
	Base16() (string, error)
	// Type returns the Constant type as string
	Type() (string, error)
	// Value returns the Constant value as string
	Value() (string, error)
	// Int16 extracts int16 value and returns error if wrong Constant type
	Int16() (int16, error)
	// Int32 extracts int32 value and returns error if wrong Constant type
	Int32() (int32, error)
	// Int64 extracts int64 value and returns error if wrong Constant type
	Int64() (int64, error)
	// Bytes extracts byte array and returns error if wrong Constant type
	Bytes() ([]byte, error)
	// Equals checks if provided Constant is same
	Equals(constant Constant) bool
	// contains filtered or unexported methods
}

type ContextExtension interface {
	// Keys returns iterator over all keys in the ContextExtension
	Keys() iter.Seq[uint8]
	// Get returns Constant at provided key or nil if it doesn't exist
	Get(key uint8) (Constant, error)
	// Set adds Constant at provided key
	Set(key uint8, constant Constant)
	// All returns iterator over all key,value pairs in the ContextExtension
	All() iter.Seq2[uint8, Constant]
	// Values returns iterator over all Constant in the ContextExtension
	Values() iter.Seq[Constant]
	// contains filtered or unexported methods
}

type Contract interface {
	// Tree returns the ergo Tree of the Contract
	Tree() Tree
	// Equals checks if provided Contract is same
	Equals(contract Contract) bool
	// contains filtered or unexported methods
}

type DataInput interface {
	// BoxId returns the BoxId of the DataInput
	BoxId() BoxId
	// contains filtered or unexported methods
}

type DataInputs interface {
	// Len returns the length of the collection
	Len() int
	// Get returns the Input at the provided index if it exists
	Get(index int) (DataInput, error)
	// Add adds provided DataInput to the end of the collection
	Add(dataInput DataInput)
	// All returns an iterator over all DataInput inside the collection
	All() iter.Seq2[int, DataInput]
	// contains filtered or unexported methods
}

type DerivationPath interface {
	// String returns the DerivationPath formatted as string in the m/44/429/acc'/0/addr format
	String() string
	// Depth returns the length of the DerivationPath
	Depth() uint32
	// Next returns a new DerivationPath with the last element of the derivation path being increased, e.g. m/1/2 -> m/1/3
	Next() (DerivationPath, error)
	// contains filtered or unexported methods
}

type ExtendedPublicKey interface {
	// Child derives a new ExtendedPublicKey from the provided index
	Child(childIndex uint32) (ExtendedPublicKey, error)
	// Derive derives a new ExtendedPublicKey from the supplied DerivationPath
	Derive(derivationPath DerivationPath) (ExtendedPublicKey, error)
	// Address returns the Address associated with the ExtendedPublicKey
	Address() Address
	// contains filtered or unexported methods
}

type ExtendedSecretKey interface {
	// Child derives a new ExtendedSecretKey from the provided index
	// The index is in the form of soft or hardened indices
	// For example: 4 or 4' respectively
	Child(index string) (ExtendedSecretKey, error)
	// Path returns the DerivationPath of the ExtendedSecretKey
	Path() DerivationPath
	// SecretKey returns the SecretKey of the ExtendedSecretKey
	SecretKey() SecretKey
	// ExtendedPublicKey returns the ExtendedPublicKey associated with the ExtendedSecretKey
	ExtendedPublicKey() ExtendedPublicKey
	// Derive derives a new ExtendedSecretKey from the supplied DerivationPath
	Derive(derivationPath DerivationPath) (ExtendedSecretKey, error)
}

type HintsBag interface {
	// Add adds CommitmentHint to the bag
	Add(hint CommitmentHint)
	// Len returns the length of the HintsBag
	Len() int
	// Get returns the CommitmentHint at the provided index if it exists
	Get(index int) (CommitmentHint, error)
	// All returns an iterator over all CommitmentHint inside the collection
	All() iter.Seq2[int, CommitmentHint]
	// contains filtered or unexported methods
}

type Input interface {
	// BoxId returns BoxId of Input
	BoxId() BoxId
	// SpendingProof returns spending proof of Input as ProverResult
	SpendingProof() ProverResult
	// contains filtered or unexported methods
}

type Inputs interface {
	// Len returns the length of the collection
	Len() int
	// Get returns the Input at the provided index if it exists
	Get(index int) (Input, error)
	// Add adds provided Input to the end of the collection
	Add(input Input)
	// All returns an iterator over all Input inside the collection
	All() iter.Seq2[int, Input]
}

type MerkleProof interface {
	// AddNode adds a new node and it's hash to the MerkleProof. Hash must be 32 bytes in size
	AddNode(hash []byte, side nodeSide) error
	// Valid validates the MerkleProof against the provided root hash
	Valid(expectedRoot []byte) bool
	// ValidBase16 validates the MerkleProof against the provided base16 root hash
	ValidBase16(expectedRoot string) bool
}

type MnemonicGenerator interface {
	// Generate a new mnemonic sentence using random entropy
	Generate() (string, error)
	// GenerateFromEntropy generates a new mnemonic sentence using provided entropy
	GenerateFromEntropy(entropy []byte) (string, error)
}

type NipopowProof interface {
	// IsBetterThan implementation of the ≥ algorithm from KMZ17, see Algorithm 4
	// https://fc20.ifca.ai/preproceedings/74.pdf
	IsBetterThan(otherProof NipopowProof) (bool, error)
	// SuffixHead returns suffix head
	SuffixHead() PoPowHeader
	// Json returns json representation of NipopowProof as text
	Json() (string, error)
	// contains filtered or unexported methods
}

type NipopowVerifier interface {
	// BestProof returns the best NipopowProof
	BestProof() NipopowProof
	// BestChain returns chain of BlockHeaders from the best proof
	BestChain() BlockHeaders
	// Process given NipopowProof
	Process(newProof NipopowProof) error
}

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

type PoPowHeader interface {
	// Header returns BlockHeader of PoPowHeader
	Header() (BlockHeader, error)
	// Interlinks returns BlockIds of PoPowHeader
	Interlinks() (BlockIds, error)
	// InterlinksProof returns BatchMerkleProof of PoPowHeader
	InterlinksProof() (BatchMerkleProof, error)
	// CheckInterlinksProof checks interlinks proof
	CheckInterlinksProof() bool
	// Json returns json representation of PoPowHeader as string
	Json() (string, error)
	// Equals checks if provided PoPowHeader is same
	Equals(poPowHeader PoPowHeader) bool
	// contains filtered or unexported methods
}

type PreHeader interface {
	// Equals checks if provided PreHeader is same
	Equals(preHeader PreHeader) bool
	// contains filtered or unexported methods
}

type Propositions interface {
	// Add adds new proposition
	Add(bytes []byte) error
	// contains filtered or unexported methods
}

type ProverResult interface {
	// Bytes returns proof bytes
	Bytes() []byte
	// ContextExtension returns ContextExtension of ProverResult
	ContextExtension() ContextExtension
	// Json representation as text (compatible with Ergo Node/Explorer API, numbers are encoded as numbers)
	Json() (string, error)
}

type ReducedTransaction interface {
	// UnsignedTransaction returns the UnsignedTransaction
	UnsignedTransaction() UnsignedTransaction
	// contains filtered or unexported methods
}

type SecretKey interface {
	// Address returns address of the SecretKey
	Address() Address
	// Bytes returns SecretKey encoded to bytes
	Bytes() []byte
	// contains filtered or unexported methods
}

type SecretKeys interface {
	// Len returns the length of the collection
	Len() int
	// Get returns the SecretKey at the provided index if it exists
	Get(index int) (SecretKey, error)
	// Add adds provided SecretKey to the end of the collection
	Add(secretKey SecretKey)
	// All returns an iterator over all SecretKey inside the collection
	All() iter.Seq2[int, SecretKey]
	// contains filtered or unexported methods
}

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

type SimpleBoxSelector interface {
	// Select selects inputs to satisfy target balance and tokens
	// Parameters:
	// inputs - available inputs (returns an error, if empty)
	// targetBalance - coins (in nanoERGs) needed
	// targetTokens - amount of tokens needed
	// Returns: selected inputs and box assets(value+tokens) with change
	Select(inputs Boxes, targetBalance BoxValue, targetTokens Tokens) (BoxSelection, error)
}

type StateContext interface {
	// Equals checks if provided StateContext is same
	Equals(stateContext StateContext) bool
	// contains filtered or unexported methods
}

type Token interface {
	// Id returns TokenId of the Token
	Id() TokenId
	// Amount returns TokenAmount of the Token
	Amount() TokenAmount
	// JsonEIP12 returns json representation of Token as string according to EIP-12 https://github.com/ergoplatform/eips/pull/23
	JsonEIP12() (string, error)
	// Equals checks if provided Token is same
	Equals(token Token) bool
	// contains filtered or unexported methods
}

type TokenAmount interface {
	// Int64 converts TokenAmount to int64
	Int64() int64
	// Equals checks if provided TokenAmount is same
	Equals(tokenAmount TokenAmount) bool
	// contains filtered or unexported methods
}

type TokenId interface {
	// Base16 returns the TokenId as base16 encoded string
	Base16() string
	// Equals checks if provided TokenId is same
	Equals(tokenId TokenId) bool
	// contains filtered or unexported methods
}

type Tokens interface {
	// Len returns the length of the collection
	Len() int
	// Get returns the Token at the provided index if it exists
	Get(index int) (Token, error)
	// Add adds provided Token to the end of the collection
	Add(token Token)
	// All returns an iterator over all Token inside the collection
	All() iter.Seq2[int, Token]
	// contains filtered or unexported methods
}

type Transaction interface {
	// TxId returns TxId for this Transaction
	TxId() TxId
	// Inputs returns Inputs for this Transaction
	Inputs() Inputs
	// DataInputs returns DataInputs for this Transaction
	DataInputs() DataInputs
	// OutputCandidates returns BoxCandidates for this Transaction
	OutputCandidates() BoxCandidates
	// Outputs returns Boxes for this Transaction
	Outputs() Boxes
	// Json returns json representation of Transaction as string (compatible with Ergo Node/Explorer API, numbers are encoded as numbers)
	Json() (string, error)
	// JsonEIP12 returns json representation of Transaction as string according to EIP-12 https://github.com/ergoplatform/eips/pull/23
	JsonEIP12() (string, error)
	// Validate validates the current Transaction
	Validate(stateContext StateContext, boxesToSpent Boxes, dataBoxes Boxes) error
	// contains filtered or unexported methods
}

type TransactionHintsBag interface {
	// AddHintsForInput adds hints for input
	AddHintsForInput(index uint32, hintsBag HintsBag)
	// AllHintsForInput gets HintsBag corresponding to input index
	AllHintsForInput(index uint32) HintsBag
	// contains filtered or unexported methods
}

type Tree interface {
	// Base16 converts the Tree to a base16 encoded string.
	Base16() (string, error)
	// Address converts the Tree to an Address.
	Address() (Address, error)
	// TemplateBytesLength determines the length of the byte array
	TemplateBytesLength() (int, error)
	// TemplateHash returns the hash of the template bytes as string
	TemplateHash() (string, error)
	// ConstantsLength returns the number of constants stored in the serialized ErgoTree or throws error if the parsing of constants failed
	ConstantsLength() (int, error)
	// Constant returns Constant with given index (as stored in serialized ErgoTree) if it exists or throws error if the parsing of constants failed
	Constant(index int) (Constant, error)
	// Constants returns all Constant within the Tree or throws error if the parsing of constants failed
	Constants() ([]Constant, error)
	// Equals checks if provided Tree is same
	Equals(tree Tree) bool
	// contains filtered or unexported methods
}

type TxBuilder interface {
	// SetDataInputs set data inputs for transaction
	SetDataInputs(dataInputs DataInputs)
	// SetContextExtension sets context extension for a given input
	SetContextExtension(boxId BoxId, contextExtension ContextExtension)
	// SetTokenBurnPermit permits the burn of the given token amount, i.e. allows this token amount to be omitted in the outputs
	SetTokenBurnPermit(tokens Tokens)
	// DataInputs returns DataInputs of the TxBuilder
	DataInputs() DataInputs
	// BoxSelection returns BoxSelection of the TxBuilder
	BoxSelection() BoxSelection
	// OutputCandidates returns BoxCandidates of the TxBuilder
	OutputCandidates() BoxCandidates
	// CurrentHeight returns the current height
	CurrentHeight() uint32
	// FeeAmount returns the fee amount of the TxBuilder
	FeeAmount() BoxValue
	// ChangeAddress returns the change address of the TxBuilder
	ChangeAddress() Address
	// Build builds the UnsignedTransaction
	Build() (UnsignedTransaction, error)
}

type TxId interface {
	// String returns TxId as string
	String() (string, error)
	// Equals checks if provided TxId is same
	Equals(txId TxId) bool
	// contains filtered or unexported methods
}

type UnsignedInput interface {
	// BoxId returns the BoxId of the UnsignedInput
	BoxId() BoxId
	// ContextExtension returns the ContextExtension of the UnsignedInput
	ContextExtension() ContextExtension
	// contains filtered or unexported methods
}

type UnsignedInputs interface {
	// Len returns the length of the collection
	Len() int
	// Get returns the UnsignedInput at the provided index if it exists
	Get(index int) (UnsignedInput, error)
	// Add adds provided UnsignedInput to the end of the collection
	Add(unsignedInput UnsignedInput)
	// All returns an iterator over all UnsignedInput inside the collection
	All() iter.Seq2[int, UnsignedInput]
}

type UnsignedTransaction interface {
	// TxId returns TxId for this UnsignedTransaction
	TxId() TxId
	// UnsignedInputs returns UnsignedInputs for this UnsignedTransaction
	UnsignedInputs() UnsignedInputs
	// DataInputs returns DataInputs for this UnsignedTransaction
	DataInputs() DataInputs
	// OutputCandidates returns BoxCandidates for this UnsignedTransaction
	OutputCandidates() BoxCandidates
	// Json returns json representation of UnsignedTransaction as string (compatible with Ergo Node/Explorer API, numbers are encoded as numbers)
	Json() (string, error)
	// JsonEIP12 returns json representation of UnsignedTransaction as string according to EIP-12 https://github.com/ergoplatform/eips/pull/23
	JsonEIP12() (string, error)
	// contains filtered or unexported methods
}

type Wallet interface {
	// AddSecret adds a secret to the wallets prover
	AddSecret(secret SecretKey) error
	// SignTransaction signs a transaction
	SignTransaction(stateContext StateContext, unsignedTx UnsignedTransaction, boxesToSpend Boxes, dataBoxes Boxes) (Transaction, error)
	// SignTransactionMulti signs a multi signature transaction
	SignTransactionMulti(stateContext StateContext, unsignedTx UnsignedTransaction, boxesToSpend Boxes, dataBoxes Boxes, txHints TransactionHintsBag) (Transaction, error)
	// SignReducedTransaction signs a reduced transaction (generating proofs for inputs)
	SignReducedTransaction(reducedTx ReducedTransaction) (Transaction, error)
	// SignReducedTransactionMulti signs a multi signature reduced transaction
	SignReducedTransactionMulti(reducedTx ReducedTransaction, txHints TransactionHintsBag) (Transaction, error)
	// GenerateCommitments generates Commitments for unsigned tx
	GenerateCommitments(stateContext StateContext, unsignedTx UnsignedTransaction, boxesToSpend Boxes, dataBoxes Boxes) (TransactionHintsBag, error)
	// GenerateCommitmentsForReducedTransaction generates Commitments for reduced transaction
	GenerateCommitmentsForReducedTransaction(reducedTx ReducedTransaction) (TransactionHintsBag, error)
	// SignMessageUsingP2PK signs an arbitrary message using a P2PK address
	SignMessageUsingP2PK(address Address, message []byte) (SignedMessage, error)
}