crec-sdk-ext-dta

CREC SDK Extension: DTA

A Go SDK extension for Digital Transfer Agent (DTA) operations on CREC (Chainlink Runtime Environment Connect).

Installation

go get github.com/smartcontractkit/crec-sdk-ext-dta

Versioning

This SDK uses contract versioning (e.g., v1/, v2/) to match deployed smart contract ABI versions. This is separate from the Go module's semantic versioning.

import dtav1 "github.com/smartcontractkit/crec-sdk-ext-dta/v1"
import dtav2 "github.com/smartcontractkit/crec-sdk-ext-dta/v2"

Both versions share the same package layout (events/, operations/, watcher/, decode.go) and the same enum/struct types (TokenMintType, TokenBurnType, RequestStatus, FundTokenData, DistributorRequest). The differences are strictly ABI-driven.

Overview

This extension provides utilities for preparing DTA operations for fund subscriptions, redemptions, and management on blockchain networks. It works with DTARequestManagement and DTARequestSettlement smart contracts.

Usage (v1)

import (
    dtav1 "github.com/smartcontractkit/crec-sdk-ext-dta/v1"
)

ext, err := dtav1.New(&dtav1.Options{
    DTARequestManagementAddress: "0x...",
    DTARequestSettlementAddress: "0x...",
    AccountAddress:              "0x...",
})

op, err := ext.PrepareRequestSubscriptionOperation(fundAdminAddr, fundTokenId, amount)

Usage (v2)

import (
    dtav2 "github.com/smartcontractkit/crec-sdk-ext-dta/v2"
)

ext, err := dtav2.New(&dtav2.Options{
    DTARequestManagementAddress: "0x...",
    DTARequestSettlementAddress: "0x...",
    AccountAddress:              "0x...",
})

// v2 operations accept a referenceID parameter
op, err := ext.PrepareRequestSubscriptionOperation(fundAdminAddr, fundTokenId, amount, referenceID)

v2 Changes from v1

New referenceID parameter

Subscription and redemption operations now accept a referenceID [32]byte parameter for correlating on-chain requests with off-chain records:

The corresponding events (SubscriptionRequested, RedemptionRequested) now include a ReferenceID common.Hash field.

New event: DistributorAuthorizationUpdated

Emitted when a distributor's authorization status changes for a fund token:

New operations

Removed operations (v1 only)

Available Operations (v1)

DTARequestManagement Operations

DTARequestSettlement Operations

Generic Operations

For contract methods not covered by the type-safe functions:

op, err := ext.PrepareDTARequestManagementOperation("methodName", arg1, arg2, ...)
op, err := ext.PrepareDTARequestSettlementOperation("methodName", arg1, arg2, ...)

Types

Types are shared across both v1 and v2 (defined in <version>/events/types.go).

Token Mint Types

Token Burn Types

Request Status

Decoding Events

Both v1 and v2 provide a DecodeFromEvent function that extracts typed events and enrichment data from raw CREC events:

decoded, err := dtav2.DecodeFromEvent(ctx, event)
fmt.Println(decoded.EventName())        // e.g. EventSubscriptionRequested
fmt.Println(decoded.ConcreteEvent)      // typed event struct
fmt.Println(decoded.FundTokenData)      // enrichment: fund token metadata (if available)
fmt.Println(decoded.DistributorRequest) // enrichment: request details (if available)

Project Structure

crec-sdk-ext-dta/
├── v1/                              # DTA v1 contract SDK
│   ├── events/                      # Event types and decoders
│   │   ├── types.go                 # Enum and struct types
│   │   ├── events_gen.go            # Generated: Event structs
│   │   └── decode_gen.go            # Generated: Event decoders
│   ├── operations/                  # Operations SDK
│   │   ├── operations.go            # Custom operations (multi-tx, complex types)
│   │   ├── abi_gen.go               # Generated: ABI embedding
│   │   ├── extension_gen.go         # Generated: Options, Extension, New()
│   │   ├── operations_gen.go        # Generated: Type-safe Prepare* functions
│   │   └── operations_helpers_gen.go # Generated: Helper methods
│   ├── watcher/                     # CRE watcher workflow
│   │   ├── handler/                 # Workflow handler (enrichment logic)
│   │   ├── bundle/                  # Bundle definition and schemas
│   │   └── values/                  # Configuration values
│   ├── doc.go                       # Package documentation
│   └── decode.go                    # Event decoding + enrichment
├── v2/                              # DTA v2 contract SDK (same layout as v1)
│   ├── events/
│   ├── operations/
│   ├── watcher/
│   ├── doc.go
│   └── decode.go
├── abi/                             # Contract ABI files
│   ├── v1/
│   └── v2/
├── mocks/                           # Mock server for local testing
└── Taskfile.yaml                    # Task runner commands

Development

Prerequisites

Install Task:

brew install go-task  # macOS

Running Tests

task test

Watcher Workflow

The watcher workflow monitors DTA contract events:

# Configure watcher (specify VERSION)
task watcher:config VERSION=v2

# Deploy to CRE
task watcher:deploy VERSION=v2

# Config + deploy
task watcher:release VERSION=v2

# Simulate with a transaction
task watcher:simulate VERSION=v2 TX_HASH=0x...

Mock server for local simulation:

task mock:start
task mock:stop
task mock:logs

Related

• crec-sdk — CREC client for channels, events, watchers, and operations
• crec-workflow-utils — Shared utilities for event-listener workflows

License

MIT