tx3sdk

Documentation

Overview

Package tx3sdk is the Tx3 SDK for Go — a client library for defining and executing UTxO-based blockchain transactions declaratively using the Tx3 protocol.

Quick start:

protocol, _ := tx3sdk.ProtocolFromFile("transfer.tii")
trpClient := tx3sdk.NewTRPClient(tx3sdk.TRPClientOptions{Endpoint: "http://localhost:3000"})

client := tx3sdk.NewClient(protocol, trpClient).
    WithProfile("preprod").
    WithParty("sender", tx3sdk.SignerParty(mySigner)).
    WithParty("receiver", tx3sdk.AddressParty("addr_test1..."))

status, _ := client.Tx("transfer").
    Arg("quantity", 10_000_000).
    Resolve(ctx).
    Sign().
    Submit(ctx).
    WaitForConfirmed(ctx, tx3sdk.DefaultPollConfig())

Index

• func NewTRPClient(options TRPClientOptions) *trp.Client
• func ProtocolFromBytes(data []byte) (*tii.Protocol, error)
• func ProtocolFromFile(path string) (*tii.Protocol, error)
• func ProtocolFromString(jsonStr string) (*tii.Protocol, error)
• type CardanoSigner
  • func CardanoSignerFromHex(address, privateKeyHex string) (*CardanoSigner, error)
  • func CardanoSignerFromMnemonic(address, phrase string) (*CardanoSigner, error)
• type Ed25519Signer
  • func Ed25519SignerFromHex(address, privateKeyHex string) (*Ed25519Signer, error)
  • func Ed25519SignerFromMnemonic(address, phrase string) (*Ed25519Signer, error)
  • func NewEd25519Signer(address string, privateKey [32]byte) *Ed25519Signer
• type Party
  • func AddressParty(address string) Party
  • func SignerParty(s signer.Signer) Party
• type PollConfig
  • func DefaultPollConfig() PollConfig
• type Profile
• type ResolvedTx
• type SignedTx
• type Signer
• type SubmittedTx
• type TRPClientOptions
• type Tx3Client
• type Tx3ClientBuilder
  • func FromParts(transactions map[string]core.TirEnvelope, profiles map[string]facade.Profile, ...) *Tx3ClientBuilder
  • func ProtocolClient(protocol *tii.Protocol) *Tx3ClientBuilder
• type TxBuilder

Functions

func NewTRPClient

func NewTRPClient(options TRPClientOptions) *trp.Client

NewTRPClient creates a new low-level TRP JSON-RPC client.

func ProtocolFromBytes

func ProtocolFromBytes(data []byte) (*tii.Protocol, error)

ProtocolFromBytes loads a Protocol from raw JSON bytes.

func ProtocolFromFile

func ProtocolFromFile(path string) (*tii.Protocol, error)

ProtocolFromFile loads a Protocol from a .tii file at the given path.

func ProtocolFromString

func ProtocolFromString(jsonStr string) (*tii.Protocol, error)

ProtocolFromString loads a Protocol from a JSON string.

Types

type CardanoSigner

type CardanoSigner = signer.CardanoSigner

CardanoSigner is a Cardano-specific signer using BIP32-Ed25519 key derivation.

func CardanoSignerFromHex

func CardanoSignerFromHex(address, privateKeyHex string) (*CardanoSigner, error)

CardanoSignerFromHex creates a CardanoSigner from a hex-encoded extended private key.

func CardanoSignerFromMnemonic

func CardanoSignerFromMnemonic(address, phrase string) (*CardanoSigner, error)

CardanoSignerFromMnemonic creates a CardanoSigner from a BIP39 mnemonic phrase. Keys are derived at the standard Cardano path m/1852'/1815'/0'/0/0.

type Ed25519Signer

type Ed25519Signer = signer.Ed25519Signer

Ed25519Signer is a generic raw-key signer using Ed25519.

func Ed25519SignerFromHex

func Ed25519SignerFromHex(address, privateKeyHex string) (*Ed25519Signer, error)

Ed25519SignerFromHex creates an Ed25519Signer from a hex-encoded private key.

func Ed25519SignerFromMnemonic

func Ed25519SignerFromMnemonic(address, phrase string) (*Ed25519Signer, error)

Ed25519SignerFromMnemonic creates an Ed25519Signer from a BIP39 mnemonic phrase.

func NewEd25519Signer

func NewEd25519Signer(address string, privateKey [32]byte) *Ed25519Signer

NewEd25519Signer creates an Ed25519Signer from a 32-byte private key seed and address.

type Party

type Party = facade.Party

Party represents a named participant in a transaction.

func AddressParty

func AddressParty(address string) Party

AddressParty creates a read-only party that provides only an address.

func SignerParty

func SignerParty(s signer.Signer) Party

SignerParty creates a signer party. The address is read from the signer.

type PollConfig

type PollConfig = facade.PollConfig

PollConfig controls the polling behaviour of wait methods.

func DefaultPollConfig

func DefaultPollConfig() PollConfig

DefaultPollConfig returns a PollConfig with sensible defaults (20 attempts, 5s delay).

type Profile

type Profile = facade.Profile

Profile is the value type embedded in a Tx3Client's selected profile slot.

type ResolvedTx

type ResolvedTx = facade.ResolvedTx

ResolvedTx is a transaction resolved by TRP, ready for signing.

type SignedTx

type SignedTx = facade.SignedTx

SignedTx is a signed transaction ready for submission.

type Signer

type Signer = signer.Signer

Signer is the interface for transaction signing.

type SubmittedTx

type SubmittedTx = facade.SubmittedTx

SubmittedTx is a submitted transaction that can be polled for status.

type TRPClientOptions

type TRPClientOptions = trp.ClientOptions

TRPClientOptions configures a TRP client.

type Tx3Client

type Tx3Client = facade.Tx3Client

Tx3Client is the high-level entry point for building and submitting transactions.

type Tx3ClientBuilder

type Tx3ClientBuilder = facade.Tx3ClientBuilder

Tx3ClientBuilder builds a Tx3Client. Obtained via Protocol.Client() or facade.FromParts.

func FromParts

func FromParts(
	transactions map[string]core.TirEnvelope,
	profiles map[string]facade.Profile,
	knownParties []string,
) *Tx3ClientBuilder

FromParts seeds a builder with already-deconstructed protocol fragments (the codegen flow's entry point).

func ProtocolClient

func ProtocolClient(protocol *tii.Protocol) *Tx3ClientBuilder

ProtocolClient returns a fresh Tx3ClientBuilder seeded with the protocol's transactions, profiles, and declared parties. Equivalent to facade.FromProtocol(protocol). Idiomatic entry point for the dynamic flow.

type TxBuilder

type TxBuilder = facade.TxBuilder

TxBuilder collects transaction arguments and resolves the transaction.