Document fire-and-forget transaction mode

Add godoc to Create and CreateBulk explaining they return immediately
without waiting for block inclusion. Update package-level example to show
both fire-and-forget and wait-for-block patterns. Add Transaction Modes
section to README with code examples.
This commit is contained in:
2026-02-17 13:24:35 -05:00
parent c3d6d017df
commit 4dabbcd23a
3 changed files with 93 additions and 31 deletions

View File

@@ -65,6 +65,57 @@ func main() {
} }
``` ```
## Transaction Modes
`Create` and `CreateBulk` return **immediately** with the assigned transaction ID(s). They do **not** wait for block inclusion. Blocks are assembled asynchronously on a ~5-second cycle.
### Fire and Forget
Most use cases only need the transaction ID. No polling required.
```go
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
resp, err := client.Transaction.Create(ctx, &models.TransactionCreateRequest{
TxnType: "my-transaction-type",
Payload: `{"message": "Hello Dragonchain"}`,
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("Transaction ID: %s\n", resp.TransactionID)
// Done — no need to wait for a block.
```
### Wait for Block
If you need the block ID (e.g. for interchain verification or Daria), poll `Get` until `Header.BlockId` is populated.
```go
resp, err := client.Transaction.Create(ctx, &models.TransactionCreateRequest{
TxnType: "my-transaction-type",
Payload: `{"message": "Hello Dragonchain"}`,
})
if err != nil {
log.Fatal(err)
}
// Poll until the transaction is included in a block.
ticker := time.NewTicker(2 * time.Second)
defer ticker.Stop()
for range ticker.C {
txn, err := client.Transaction.Get(ctx, resp.TransactionID)
if err != nil {
log.Fatal(err)
}
if txn.Header.BlockId != "" {
fmt.Printf("Block ID: %s\n", txn.Header.BlockId)
break
}
}
```
## Available Endpoints ## Available Endpoints
All API methods accept a `context.Context` as their first parameter for timeout and cancellation control. All API methods accept a `context.Context` as their first parameter for timeout and cancellation control.

View File

@@ -2,47 +2,50 @@
// //
// All API methods require a context.Context parameter for timeout and cancellation control. // All API methods require a context.Context parameter for timeout and cancellation control.
// //
// Example usage: // Example — fire and forget (most use cases):
// //
// package main // client := sdk.NewDragonchainSDK(
// // "your-public-id",
// import ( // "your-auth-key-id",
// "context" // "your-auth-key",
// "fmt" // "https://your-dragonchain-endpoint.com",
// "log"
// "time"
//
// "git.dragonchain.com/dragonchain/prime-sdk-go"
// "git.dragonchain.com/dragonchain/prime-sdk-go/models"
// ) // )
// //
// func main() { // ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
// client := sdk.NewDragonchainSDK( // defer cancel()
// "your-public-id",
// "your-auth-key-id",
// "your-auth-key",
// "https://your-dragonchain-endpoint.com",
// )
// //
// ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second) // resp, err := client.Transaction.Create(ctx, &models.TransactionCreateRequest{
// defer cancel() // TxnType: "my-transaction-type",
// Payload: `{"message": "Hello Dragonchain"}`,
// })
// if err != nil {
// log.Fatal(err)
// }
// fmt.Printf("Transaction ID: %s\n", resp.TransactionID)
// // Done — no need to wait for a block.
// //
// // Check system health // Example — wait for block inclusion (interchain / Daria):
// if err := client.System.Health(ctx); err != nil {
// log.Fatal(err)
// }
// //
// // Create a transaction // resp, err := client.Transaction.Create(ctx, &models.TransactionCreateRequest{
// txn := &models.TransactionCreateRequest{ // TxnType: "my-transaction-type",
// TxnType: "my-transaction-type", // Payload: `{"message": "Hello Dragonchain"}`,
// Payload: map[string]interface{}{"message": "Hello Dragonchain"}, // })
// } // if err != nil {
// log.Fatal(err)
// }
// //
// resp, err := client.Transaction.Create(ctx, txn) // // Poll until the transaction is included in a block.
// ticker := time.NewTicker(2 * time.Second)
// defer ticker.Stop()
// for range ticker.C {
// txn, err := client.Transaction.Get(ctx, resp.TransactionID)
// if err != nil { // if err != nil {
// log.Fatal(err) // log.Fatal(err)
// } // }
// fmt.Printf("Created transaction: %s\n", resp.TransactionID) // if txn.Header.BlockId != "" {
// fmt.Printf("Block ID: %s\n", txn.Header.BlockId)
// break
// }
// } // }
package sdk package sdk

View File

@@ -16,6 +16,10 @@ func NewTransactionClient(c *client.Client) *TransactionClient {
return &TransactionClient{client: c} return &TransactionClient{client: c}
} }
// Create submits a new transaction and returns immediately with the assigned transaction ID.
// It does NOT wait for the transaction to be included in a block. Block processing happens
// asynchronously on a ~5-second cycle. If you need the block ID (e.g. for interchain
// verification), poll Get until Header.BlockId is populated.
func (tc *TransactionClient) Create(ctx context.Context, req *models.TransactionCreateRequest) (*models.TransactionCreateResponse, error) { func (tc *TransactionClient) Create(ctx context.Context, req *models.TransactionCreateRequest) (*models.TransactionCreateResponse, error) {
var resp models.TransactionCreateResponse var resp models.TransactionCreateResponse
err := tc.client.Post(ctx, "/api/v1/transaction", models.ContentTypeJSON, req, &resp) err := tc.client.Post(ctx, "/api/v1/transaction", models.ContentTypeJSON, req, &resp)
@@ -25,6 +29,10 @@ func (tc *TransactionClient) Create(ctx context.Context, req *models.Transaction
return &resp, nil return &resp, nil
} }
// CreateBulk submits multiple transactions and returns immediately with the assigned transaction IDs.
// It does NOT wait for the transactions to be included in a block. Block processing happens
// asynchronously on a ~5-second cycle. If you need block IDs, poll Get for each transaction
// until Header.BlockId is populated.
func (tc *TransactionClient) CreateBulk(ctx context.Context, req *models.TransactionBulkRequest) (*models.TransactionBulkResponse, error) { func (tc *TransactionClient) CreateBulk(ctx context.Context, req *models.TransactionBulkRequest) (*models.TransactionBulkResponse, error) {
var resp models.TransactionBulkResponse var resp models.TransactionBulkResponse
err := tc.client.Post(ctx, "/api/v1/transaction/bulk", models.ContentTypeJSON, req, &resp) err := tc.client.Post(ctx, "/api/v1/transaction/bulk", models.ContentTypeJSON, req, &resp)