archive

Documentation

Overview

Package archive provides a client for the "archive" canister. Do NOT edit this file. It was automatically generated by https://github.com/aviate-labs/agent-go.

Index

• type AccountIdentifier
• type Agent
  • func NewAgent(canisterId principal.Principal, config agent.Config) (*Agent, error)
  • func (a Agent) GetBlocks(arg0 GetBlocksArgs) (*GetBlocksResult, error)
  • func (a Agent) GetEncodedBlocks(arg0 GetBlocksArgs) (*GetEncodedBlocksResult, error)
• type Block
• type BlockIndex
• type BlockRange
• type GetBlocksArgs
• type GetBlocksError
• type GetBlocksResult
• type GetEncodedBlocksResult
• type Memo
• type Operation
• type Timestamp
• type Tokens
• type Transaction

Types

type AccountIdentifier

type AccountIdentifier = []byte

type Agent

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

Agent is a client for the "archive" canister.

func NewAgent

func NewAgent(canisterId principal.Principal, config agent.Config) (*Agent, error)

NewAgent creates a new agent for the "archive" canister.

func (Agent) GetBlocks

func (a Agent) GetBlocks(arg0 GetBlocksArgs) (*GetBlocksResult, error)

GetBlocks calls the "get_blocks" method on the "archive" canister.

func (Agent) GetEncodedBlocks

func (a Agent) GetEncodedBlocks(arg0 GetBlocksArgs) (*GetEncodedBlocksResult, error)

GetEncodedBlocks calls the "get_encoded_blocks" method on the "archive" canister.

type Block

type Block = struct {
	ParentHash  *[]byte     `ic:"parent_hash,omitempty"`
	Transaction Transaction `ic:"transaction"`
	Timestamp   Timestamp   `ic:"timestamp"`
}

type BlockIndex

type BlockIndex = uint64

type BlockRange

type BlockRange = struct {
	Blocks []Block `ic:"blocks"`
}

type GetBlocksArgs

type GetBlocksArgs = struct {
	Start  BlockIndex `ic:"start"`
	Length uint64     `ic:"length"`
}

type GetBlocksError

type GetBlocksError = struct {
	BadFirstBlockIndex *struct {
		RequestedIndex  BlockIndex `ic:"requested_index"`
		FirstValidIndex BlockIndex `ic:"first_valid_index"`
	} `ic:"BadFirstBlockIndex,variant"`
	Other *struct {
		ErrorCode    uint64 `ic:"error_code"`
		ErrorMessage string `ic:"error_message"`
	} `ic:"Other,variant"`
}

type GetBlocksResult

type GetBlocksResult = struct {
	Ok  *BlockRange     `ic:"Ok,variant"`
	Err *GetBlocksError `ic:"Err,variant"`
}

type GetEncodedBlocksResult

type GetEncodedBlocksResult = struct {
	Ok  *[][]byte       `ic:"Ok,variant"`
	Err *GetBlocksError `ic:"Err,variant"`
}

type Memo

type Memo = uint64

type Operation

type Operation = struct {
	Mint *struct {
		To     AccountIdentifier `ic:"to"`
		Amount Tokens            `ic:"amount"`
	} `ic:"Mint,variant"`
	Burn *struct {
		From    AccountIdentifier  `ic:"from"`
		Spender *AccountIdentifier `ic:"spender,omitempty"`
		Amount  Tokens             `ic:"amount"`
	} `ic:"Burn,variant"`
	Transfer *struct {
		From    AccountIdentifier `ic:"from"`
		To      AccountIdentifier `ic:"to"`
		Amount  Tokens            `ic:"amount"`
		Fee     Tokens            `ic:"fee"`
		Spender *[]uint8          `ic:"spender,omitempty"`
	} `ic:"Transfer,variant"`
	Approve *struct {
		From              AccountIdentifier `ic:"from"`
		Spender           AccountIdentifier `ic:"spender"`
		AllowanceE8s      idl.Int           `ic:"allowance_e8s"`
		Allowance         Tokens            `ic:"allowance"`
		Fee               Tokens            `ic:"fee"`
		ExpiresAt         *Timestamp        `ic:"expires_at,omitempty"`
		ExpectedAllowance *Tokens           `ic:"expected_allowance,omitempty"`
	} `ic:"Approve,variant"`
}

type Timestamp

type Timestamp = struct {
	TimestampNanos uint64 `ic:"timestamp_nanos"`
}

type Tokens

type Tokens = struct {
	E8s uint64 `ic:"e8s"`
}

type Transaction

type Transaction = struct {
	Memo          Memo       `ic:"memo"`
	Icrc1Memo     *[]byte    `ic:"icrc1_memo,omitempty"`
	Operation     *Operation `ic:"operation,omitempty"`
	CreatedAtTime Timestamp  `ic:"created_at_time"`
}