bitnames

package
v0.0.0-...-4904f9a Latest Latest
Warning

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

 Go to latest Published: May 10, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package bitnames provides a JSON-RPC client for the BitNames sidechain.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BalanceResponse 

type BalanceResponse struct {
	TotalSats     int64 `json:"total_sats"`
	AvailableSats int64 `json:"available_sats"`
}

BalanceResponse is the reply from the "balance" RPC.

type BitNameData 

type BitNameData struct {
	Commitment       *string `json:"commitment,omitempty"`
	EncryptionPubkey *string `json:"encryption_pubkey,omitempty"`
	PaymailFeeSats   *int64  `json:"paymail_fee_sats,omitempty"`
	SigningPubkey    *string `json:"signing_pubkey,omitempty"`
	SocketAddrV4     *string `json:"socket_addr_v4,omitempty"`
	SocketAddrV6     *string `json:"socket_addr_v6,omitempty"`
}

BitNameData holds optional metadata fields attached to a BitName.

type BitnameDetails 

type BitnameDetails struct {
	SeqID            string  `json:"seq_id"`
	Commitment       *string `json:"commitment,omitempty"`
	SocketAddrV4     *string `json:"socket_addr_v4,omitempty"`
	SocketAddrV6     *string `json:"socket_addr_v6,omitempty"`
	EncryptionPubkey *string `json:"encryption_pubkey,omitempty"`
	SigningPubkey    *string `json:"signing_pubkey,omitempty"`
	PaymailFeeSats   *int64  `json:"paymail_fee_sats,omitempty"`
}

BitnameDetails describes the on-chain state of a registered BitName.

type BitnameEntry 

type BitnameEntry struct {
	Hash    string
	Details BitnameDetails
}

BitnameEntry is a [hash, details] pair returned by the "bitnames" RPC.

func (BitnameEntry) MarshalJSON 

func (e BitnameEntry) MarshalJSON() ([]byte, error)

MarshalJSON encodes as the [hash, details] tuple the node expects.

func (*BitnameEntry) UnmarshalJSON 

func (e *BitnameEntry) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes the [hash, details] tuple that the node returns.

type BmmResult 

type BmmResult struct {
	HashLastMainBlock      string  `json:"hash_last_main_block"`
	BmmBlockCreated        *string `json:"bmm_block_created,omitempty"`
	BmmBlockSubmitted      *string `json:"bmm_block_submitted,omitempty"`
	BmmBlockSubmittedBlind *string `json:"bmm_block_submitted_blind,omitempty"`
	Ntxn                   int     `json:"ntxn"`
	Nfees                  int     `json:"nfees"`
	Txid                   string  `json:"txid"`
	Error                  *string `json:"error,omitempty"`
}

BmmResult is the response from the "mine" RPC.

type Client 

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

Client is a JSON-RPC client for the BitNames sidechain node. It mirrors the RPC surface exposed in the Dart BitnamesRPC class.

func NewClient 

func NewClient(host string, port int) *Client

NewClient creates a BitNames RPC client pointed at host:port.

func (*Client) Balance 

func (c *Client) Balance(ctx context.Context) (*BalanceResponse, error)

Balance returns the node wallet balance.

func (*Client) BitNameData 

func (c *Client) BitNameData(ctx context.Context, name string) (*BitNameData, error)

BitNameData retrieves data for a single BitName.

func (*Client) ConnectPeer 

func (c *Client) ConnectPeer(ctx context.Context, address string) error

ConnectPeer connects to a peer at the given address.

func (*Client) CreateDeposit 

func (c *Client) CreateDeposit(ctx context.Context, address string, valueSats, feeSats int64) (string, error)

CreateDeposit creates a deposit transaction.

func (*Client) DecryptMsg 

func (c *Client) DecryptMsg(ctx context.Context, encryptionPubkey, ciphertext string) (string, error)

DecryptMsg decrypts a ciphertext with the given encryption public key. Returns the hex-encoded plaintext (caller must decode if needed).

func (*Client) EncryptMsg 

func (c *Client) EncryptMsg(ctx context.Context, encryptionPubkey, msg string) (string, error)

EncryptMsg encrypts a message to the given encryption public key.

func (*Client) GenerateMnemonic 

func (c *Client) GenerateMnemonic(ctx context.Context) (string, error)

GenerateMnemonic generates a new BIP-39 mnemonic.

func (*Client) GetBMMInclusions 

func (c *Client) GetBMMInclusions(ctx context.Context, blockHash string) (string, error)

GetBMMInclusions returns mainchain blocks that commit to the given block hash.

func (*Client) GetBestMainchainBlockHash 

func (c *Client) GetBestMainchainBlockHash(ctx context.Context) (*string, error)

GetBestMainchainBlockHash returns the best known mainchain block hash.

func (*Client) GetBestSidechainBlockHash 

func (c *Client) GetBestSidechainBlockHash(ctx context.Context) (*string, error)

GetBestSidechainBlockHash returns the best known sidechain block hash.

func (*Client) GetBlock 

func (c *Client) GetBlock(ctx context.Context, hash string) (json.RawMessage, error)

GetBlock returns block data for a given hash.

func (*Client) GetBlockCount 

func (c *Client) GetBlockCount(ctx context.Context) (int, error)

GetBlockCount returns the current block height.

func (*Client) GetNewAddress 

func (c *Client) GetNewAddress(ctx context.Context) (string, error)

GetNewAddress generates and returns a new wallet address.

func (*Client) GetNewEncryptionKey 

func (c *Client) GetNewEncryptionKey(ctx context.Context) (string, error)

GetNewEncryptionKey generates a new encryption keypair and returns the public key.

func (*Client) GetNewVerifyingKey 

func (c *Client) GetNewVerifyingKey(ctx context.Context) (string, error)

GetNewVerifyingKey generates a new signing keypair and returns the verifying key.

func (*Client) GetPaymail 

func (c *Client) GetPaymail(ctx context.Context) (json.RawMessage, error)

GetPaymail returns paymail information as raw JSON.

func (*Client) GetWalletAddresses 

func (c *Client) GetWalletAddresses(ctx context.Context) ([]string, error)

GetWalletAddresses returns all wallet addresses sorted by base58.

func (*Client) GetWalletUTXOs 

func (c *Client) GetWalletUTXOs(ctx context.Context) (json.RawMessage, error)

GetWalletUTXOs returns wallet UTXOs as raw JSON (schema varies).

func (*Client) LatestFailedWithdrawalBundleHeight 

func (c *Client) LatestFailedWithdrawalBundleHeight(ctx context.Context) (*int, error)

LatestFailedWithdrawalBundleHeight returns the height of the most recent failed withdrawal bundle, or nil if none.

func (*Client) ListBitNames 

func (c *Client) ListBitNames(ctx context.Context) ([]BitnameEntry, error)

ListBitNames returns all registered BitNames.

func (*Client) ListPeers 

func (c *Client) ListPeers(ctx context.Context) ([]PeerInfo, error)

ListPeers returns connected peers.

func (*Client) ListUTXOs 

func (c *Client) ListUTXOs(ctx context.Context) (json.RawMessage, error)

ListUTXOs returns all UTXOs as raw JSON.

func (*Client) Mine 

func (c *Client) Mine(ctx context.Context, feeSats int64) (*BmmResult, error)

Mine attempts to create and submit a BMM block.

func (*Client) MyUTXOs 

func (c *Client) MyUTXOs(ctx context.Context) (json.RawMessage, error)

MyUTXOs returns the caller's owned UTXOs as raw JSON.

func (*Client) OpenAPISchema 

func (c *Client) OpenAPISchema(ctx context.Context) (json.RawMessage, error)

OpenAPISchema returns the node's OpenAPI schema.

func (*Client) PendingWithdrawalBundle 

func (c *Client) PendingWithdrawalBundle(ctx context.Context) (json.RawMessage, error)

PendingWithdrawalBundle returns the current pending withdrawal bundle as raw JSON.

func (*Client) RegisterBitName 

func (c *Client) RegisterBitName(ctx context.Context, plainName string, data *BitNameData) (string, error)

RegisterBitName registers a new BitName with optional data.

func (*Client) ReserveBitName 

func (c *Client) ReserveBitName(ctx context.Context, name string) (string, error)

ReserveBitName reserves a BitName hash.

func (*Client) ResolveCommit 

func (c *Client) ResolveCommit(ctx context.Context, bitname string) (string, error)

ResolveCommit resolves a commitment from a BitName.

func (*Client) SetSeedFromMnemonic 

func (c *Client) SetSeedFromMnemonic(ctx context.Context, mnemonic string) error

SetSeedFromMnemonic sets the wallet seed from a mnemonic phrase.

func (*Client) SidechainWealthSats 

func (c *Client) SidechainWealthSats(ctx context.Context) (int64, error)

SidechainWealthSats returns the total sidechain wealth in satoshis.

func (*Client) SignArbitraryMsg 

func (c *Client) SignArbitraryMsg(ctx context.Context, msg, verifyingKey string) (string, error)

SignArbitraryMsg signs a message with the specified verifying key.

func (*Client) SignArbitraryMsgAsAddr 

func (c *Client) SignArbitraryMsgAsAddr(ctx context.Context, msg, address string) (*SignatureResponse, error)

SignArbitraryMsgAsAddr signs a message with the secret key for the given address.

func (*Client) Stop 

func (c *Client) Stop(ctx context.Context) error

Stop gracefully shuts down the BitNames node.

func (*Client) Transfer 

func (c *Client) Transfer(ctx context.Context, dest string, valueSats, feeSats int64, memo *string) (string, error)

Transfer sends funds.

func (*Client) Withdraw 

func (c *Client) Withdraw(ctx context.Context, mainchainAddr string, amountSats, sidechainFeeSats, mainchainFeeSats int64) (string, error)

Withdraw initiates a withdrawal to the mainchain.

type Handler 

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

Handler implements BitnamesServiceHandler by proxying to the bitnames binary's JSON-RPC. Common methods delegate to the embedded JSONRPCProxy; BitNames-specific methods are implemented directly using the proxy's Client.

func NewHandler 

func NewHandler(proxy *sidechain.JSONRPCProxy) *Handler

func (*Handler) CallRaw 

func (h *Handler) CallRaw(ctx context.Context, req *connect.Request[pb.CallRawRequest]) (*connect.Response[pb.CallRawResponse], error)

func (*Handler) ConnectPeer 

func (h *Handler) ConnectPeer(ctx context.Context, req *connect.Request[pb.ConnectPeerRequest]) (*connect.Response[pb.ConnectPeerResponse], error)

func (*Handler) CreateDeposit 

func (h *Handler) CreateDeposit(ctx context.Context, req *connect.Request[pb.CreateDepositRequest]) (*connect.Response[pb.CreateDepositResponse], error)

func (*Handler) DecryptMsg 

func (h *Handler) DecryptMsg(ctx context.Context, req *connect.Request[pb.DecryptMsgRequest]) (*connect.Response[pb.DecryptMsgResponse], error)

func (*Handler) EncryptMsg 

func (h *Handler) EncryptMsg(ctx context.Context, req *connect.Request[pb.EncryptMsgRequest]) (*connect.Response[pb.EncryptMsgResponse], error)

func (*Handler) GenerateMnemonic 

func (h *Handler) GenerateMnemonic(ctx context.Context, req *connect.Request[pb.GenerateMnemonicRequest]) (*connect.Response[pb.GenerateMnemonicResponse], error)

func (*Handler) GetBalance 

func (h *Handler) GetBalance(ctx context.Context, req *connect.Request[pb.GetBalanceRequest]) (*connect.Response[pb.GetBalanceResponse], error)

func (*Handler) GetBestMainchainBlockHash 

func (h *Handler) GetBestMainchainBlockHash(ctx context.Context, req *connect.Request[pb.GetBestMainchainBlockHashRequest]) (*connect.Response[pb.GetBestMainchainBlockHashResponse], error)

func (*Handler) GetBestSidechainBlockHash 

func (h *Handler) GetBestSidechainBlockHash(ctx context.Context, req *connect.Request[pb.GetBestSidechainBlockHashRequest]) (*connect.Response[pb.GetBestSidechainBlockHashResponse], error)

func (*Handler) GetBitNameData 

func (h *Handler) GetBitNameData(ctx context.Context, req *connect.Request[pb.GetBitNameDataRequest]) (*connect.Response[pb.GetBitNameDataResponse], error)

func (*Handler) GetBlock 

func (h *Handler) GetBlock(ctx context.Context, req *connect.Request[pb.GetBlockRequest]) (*connect.Response[pb.GetBlockResponse], error)

func (*Handler) GetBlockCount 

func (h *Handler) GetBlockCount(ctx context.Context, req *connect.Request[pb.GetBlockCountRequest]) (*connect.Response[pb.GetBlockCountResponse], error)

func (*Handler) GetBmmInclusions 

func (h *Handler) GetBmmInclusions(ctx context.Context, req *connect.Request[pb.GetBmmInclusionsRequest]) (*connect.Response[pb.GetBmmInclusionsResponse], error)

func (*Handler) GetLatestFailedWithdrawalBundleHeight 

func (h *Handler) GetLatestFailedWithdrawalBundleHeight(ctx context.Context, req *connect.Request[pb.GetLatestFailedWithdrawalBundleHeightRequest]) (*connect.Response[pb.GetLatestFailedWithdrawalBundleHeightResponse], error)

func (*Handler) GetNewAddress 

func (h *Handler) GetNewAddress(ctx context.Context, req *connect.Request[pb.GetNewAddressRequest]) (*connect.Response[pb.GetNewAddressResponse], error)

func (*Handler) GetNewEncryptionKey 

func (h *Handler) GetNewEncryptionKey(ctx context.Context, req *connect.Request[pb.GetNewEncryptionKeyRequest]) (*connect.Response[pb.GetNewEncryptionKeyResponse], error)

func (*Handler) GetNewVerifyingKey 

func (h *Handler) GetNewVerifyingKey(ctx context.Context, req *connect.Request[pb.GetNewVerifyingKeyRequest]) (*connect.Response[pb.GetNewVerifyingKeyResponse], error)

func (*Handler) GetPaymail 

func (h *Handler) GetPaymail(ctx context.Context, req *connect.Request[pb.GetPaymailRequest]) (*connect.Response[pb.GetPaymailResponse], error)

func (*Handler) GetPendingWithdrawalBundle 

func (h *Handler) GetPendingWithdrawalBundle(ctx context.Context, req *connect.Request[pb.GetPendingWithdrawalBundleRequest]) (*connect.Response[pb.GetPendingWithdrawalBundleResponse], error)

func (*Handler) GetSidechainWealth 

func (h *Handler) GetSidechainWealth(ctx context.Context, req *connect.Request[pb.GetSidechainWealthRequest]) (*connect.Response[pb.GetSidechainWealthResponse], error)

func (*Handler) GetWalletAddresses 

func (h *Handler) GetWalletAddresses(ctx context.Context, req *connect.Request[pb.GetWalletAddressesRequest]) (*connect.Response[pb.GetWalletAddressesResponse], error)

func (*Handler) GetWalletUtxos 

func (h *Handler) GetWalletUtxos(ctx context.Context, req *connect.Request[pb.GetWalletUtxosRequest]) (*connect.Response[pb.GetWalletUtxosResponse], error)

func (*Handler) ListBitNames 

func (h *Handler) ListBitNames(ctx context.Context, req *connect.Request[pb.ListBitNamesRequest]) (*connect.Response[pb.ListBitNamesResponse], error)

func (*Handler) ListPeers 

func (h *Handler) ListPeers(ctx context.Context, req *connect.Request[pb.ListPeersRequest]) (*connect.Response[pb.ListPeersResponse], error)

func (*Handler) ListUtxos 

func (h *Handler) ListUtxos(ctx context.Context, req *connect.Request[pb.ListUtxosRequest]) (*connect.Response[pb.ListUtxosResponse], error)

func (*Handler) Mine 

func (h *Handler) Mine(ctx context.Context, req *connect.Request[pb.MineRequest]) (*connect.Response[pb.MineResponse], error)

func (*Handler) MyUtxos 

func (h *Handler) MyUtxos(ctx context.Context, req *connect.Request[pb.MyUtxosRequest]) (*connect.Response[pb.MyUtxosResponse], error)

func (*Handler) OpenapiSchema 

func (h *Handler) OpenapiSchema(ctx context.Context, req *connect.Request[pb.OpenapiSchemaRequest]) (*connect.Response[pb.OpenapiSchemaResponse], error)

func (*Handler) RegisterBitName 

func (h *Handler) RegisterBitName(ctx context.Context, req *connect.Request[pb.RegisterBitNameRequest]) (*connect.Response[pb.RegisterBitNameResponse], error)

func (*Handler) ReserveBitName 

func (h *Handler) ReserveBitName(ctx context.Context, req *connect.Request[pb.ReserveBitNameRequest]) (*connect.Response[pb.ReserveBitNameResponse], error)

func (*Handler) ResolveCommit 

func (h *Handler) ResolveCommit(ctx context.Context, req *connect.Request[pb.ResolveCommitRequest]) (*connect.Response[pb.ResolveCommitResponse], error)

func (*Handler) SetSeedFromMnemonic 

func (h *Handler) SetSeedFromMnemonic(ctx context.Context, req *connect.Request[pb.SetSeedFromMnemonicRequest]) (*connect.Response[pb.SetSeedFromMnemonicResponse], error)

func (*Handler) SignArbitraryMsg 

func (h *Handler) SignArbitraryMsg(ctx context.Context, req *connect.Request[pb.SignArbitraryMsgRequest]) (*connect.Response[pb.SignArbitraryMsgResponse], error)

func (*Handler) SignArbitraryMsgAsAddr 

func (h *Handler) SignArbitraryMsgAsAddr(ctx context.Context, req *connect.Request[pb.SignArbitraryMsgAsAddrRequest]) (*connect.Response[pb.SignArbitraryMsgAsAddrResponse], error)

func (*Handler) Stop 

func (h *Handler) Stop(ctx context.Context, req *connect.Request[pb.StopRequest]) (*connect.Response[pb.StopResponse], error)

func (*Handler) Transfer 

func (h *Handler) Transfer(ctx context.Context, req *connect.Request[pb.TransferRequest]) (*connect.Response[pb.TransferResponse], error)

func (*Handler) Withdraw 

func (h *Handler) Withdraw(ctx context.Context, req *connect.Request[pb.WithdrawRequest]) (*connect.Response[pb.WithdrawResponse], error)

type PeerInfo 

type PeerInfo struct {
	Address string `json:"address"`
	Status  string `json:"status"`
}

PeerInfo describes a connected peer.

type SignatureResponse 

type SignatureResponse struct {
	VerifyingKey string `json:"verifying_key"`
	Signature    string `json:"signature"`
}

SignatureResponse is returned by "sign_arbitrary_msg_as_addr".

Source Files

View all Source files

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.