Merge pull request #107 from IntersectMBO/feat/add-txbuilder-api-certificates

feat/add txbuilder api certificates

Author: solidsnakedev

.changeset/bitter-pets-pay.md

@@ -0,0 +1,51 @@
+---
+"@evolution-sdk/evolution": patch
+"@evolution-sdk/devnet": patch
+---
+
+### Added: Redeemer Labels for Script Debugging
+
+Added optional `label` property to redeemer operations (`collectFrom`, `withdraw`, `mint`, and stake operations) to help identify which script failed during evaluation.
+
+```typescript
+client.newTx()
+  .collectFrom({
+    inputs: [utxo],
+    redeemer: makeSpendRedeemer(999n),
+    label: "coordinator-spend-utxo"  // Shows in failure output
+  })
+  .withdraw({
+    stakeCredential,
+    amount: 0n,
+    redeemer: makeWithdrawRedeemer([999n]),
+    label: "coordinator-withdrawal"
+  })
+```
+
+When scripts fail, the `EvaluationError` now includes a structured `failures` array:
+
+```typescript
+interface ScriptFailure {
+  purpose: "spend" | "mint" | "withdraw" | "cert"
+  index: number
+  label?: string           // User-provided label
+  redeemerKey: string      // e.g., "spend:0", "withdraw:0"
+  utxoRef?: string         // For spend failures
+  credential?: string      // For withdraw/cert failures
+  policyId?: string        // For mint failures
+  validationError: string
+  traces: string[]
+}
+```
+
+### Added: Stake Operations
+
+Full support for Conway-era stake operations:
+
+- `registerStake` - Register stake credential (RegCert)
+- `deregisterStake` - Deregister stake credential (UnregCert)
+- `delegateTo` - Delegate to pool and/or DRep (StakeDelegation, VoteDelegCert, StakeVoteDelegCert)
+- `registerAndDelegateTo` - Combined registration + delegation (StakeRegDelegCert, VoteRegDelegCert, StakeVoteRegDelegCert)
+- `withdraw` - Withdraw staking rewards (supports coordinator pattern with amount: 0n)
+
+All operations support script-controlled credentials with RedeemerBuilder for deferred redeemer resolution.

docs/content/docs/modules/core/Address.mdx

@@ -89,8 +89,8 @@ export interface AddressDetails {
     readonly bech32: string
     readonly hex: string
   }
-  readonly paymentCredential: Credential.CredentialSchema
-  readonly stakingCredential?: Credential.CredentialSchema
+  readonly paymentCredential: Credential.Credential
+  readonly stakingCredential?: Credential.Credential
 }
 ```
 
@@ -258,7 +258,7 @@ Returns undefined if the address cannot be parsed
 **Signature**
 
 ```ts
-export declare const getPaymentCredential: (address: string) => Credential.CredentialSchema | undefined
+export declare const getPaymentCredential: (address: string) => Credential.Credential | undefined
 ```
 
 Added in v1.0.0
@@ -271,7 +271,7 @@ Returns undefined if the address has no staking credential or cannot be parsed
 **Signature**
 
 ```ts
-export declare const getStakingCredential: (address: string) => Credential.CredentialSchema | undefined
+export declare const getStakingCredential: (address: string) => Credential.Credential | undefined
 ```
 
 Added in v1.0.0

docs/content/docs/modules/core/Credential.mdx

@@ -14,20 +14,20 @@ parent: Modules
   - [toCBORBytes](#tocborbytes)
   - [toCBORHex](#tocborhex)
 - [model](#model)
-  - [CredentialSchema (type alias)](#credentialschema-type-alias)
+  - [Credential (type alias)](#credential-type-alias)
 - [parsing](#parsing)
   - [fromCBORBytes](#fromcborbytes)
   - [fromCBORHex](#fromcborhex)
 - [predicates](#predicates)
   - [is](#is)
 - [schemas](#schemas)
-  - [CredentialSchema](#credentialschema)
+  - [Credential](#credential)
   - [FromCDDL](#fromcddl)
 - [testing](#testing)
   - [arbitrary](#arbitrary)
 - [utils](#utils)
   - [CDDLSchema](#cddlschema)
-  - [Credential (type alias)](#credential-type-alias)
+  - [CredentialEncoded (type alias)](#credentialencoded-type-alias)
   - [FromCBORBytes](#fromcborbytes-1)
   - [FromCBORHex](#fromcborhex-1)
   - [makeKeyHash](#makekeyhash)
@@ -44,7 +44,7 @@ Convert a Credential to CBOR bytes.
 **Signature**
 
 ```ts
-export declare const toCBORBytes: (credential: CredentialSchema, options?: CBOR.CodecOptions) => Uint8Array
+export declare const toCBORBytes: (credential: Credential, options?: CBOR.CodecOptions) => Uint8Array
 ```
 
 Added in v2.0.0
@@ -56,22 +56,22 @@ Convert a Credential to CBOR hex string.
 **Signature**
 
 ```ts
-export declare const toCBORHex: (credential: CredentialSchema, options?: CBOR.CodecOptions) => string
+export declare const toCBORHex: (credential: Credential, options?: CBOR.CodecOptions) => string
 ```
 
 Added in v2.0.0
 
 # model
 
-## CredentialSchema (type alias)
+## Credential (type alias)
 
 Type representing a credential that can be either a key hash or script hash
 Used in various address formats to identify ownership
 
 **Signature**
 
 ```ts
-export type CredentialSchema = typeof CredentialSchema.Type
+export type Credential = typeof Credential.Type
 ```
 
 Added in v2.0.0
@@ -85,7 +85,7 @@ Parse a Credential from CBOR bytes.
 **Signature**
 
 ```ts
-export declare const fromCBORBytes: (bytes: Uint8Array, options?: CBOR.CodecOptions) => CredentialSchema
+export declare const fromCBORBytes: (bytes: Uint8Array, options?: CBOR.CodecOptions) => Credential
 ```
 
 Added in v2.0.0
@@ -97,7 +97,7 @@ Parse a Credential from CBOR hex string.
 **Signature**
 
 ```ts
-export declare const fromCBORHex: (hex: string, options?: CBOR.CodecOptions) => CredentialSchema
+export declare const fromCBORHex: (hex: string, options?: CBOR.CodecOptions) => Credential
 ```
 
 Added in v2.0.0
@@ -121,7 +121,7 @@ Added in v2.0.0
 
 # schemas
 
-## CredentialSchema
+## Credential
 
 Credential schema representing either a key hash or script hash
 credential = [0, addr_keyhash // 1, script_hash]
@@ -130,7 +130,7 @@ Used to identify ownership of addresses or stake rights
 **Signature**
 
 ```ts
-export declare const CredentialSchema: Schema.Union<[typeof KeyHash.KeyHash, typeof ScriptHash.ScriptHash]>
+export declare const Credential: Schema.Union<[typeof KeyHash.KeyHash, typeof ScriptHash.ScriptHash]>
 ```
 
 Added in v2.0.0
@@ -177,12 +177,12 @@ Added in v2.0.0
 export declare const CDDLSchema: Schema.Tuple2<Schema.Literal<[0n, 1n]>, typeof Schema.Uint8ArrayFromSelf>
 ```
 
-## Credential (type alias)
+## CredentialEncoded (type alias)
 
 **Signature**
 
 ```ts
-export type Credential = typeof CredentialSchema.Encoded
+export type CredentialEncoded = typeof Credential.Encoded
 ```
 
 ## FromCBORBytes
@@ -235,13 +235,13 @@ export declare const FromCBORHex: (
 **Signature**
 
 ```ts
-export declare const makeKeyHash: (hash: Uint8Array) => CredentialSchema
+export declare const makeKeyHash: (hash: Uint8Array) => Credential
 ```
 
 ## makeScriptHash
 
 **Signature**
 
 ```ts
-export declare const makeScriptHash: (hash: Uint8Array) => CredentialSchema
+export declare const makeScriptHash: (hash: Uint8Array) => Credential
 ```

docs/content/docs/modules/core/GovernanceAction.mdx

@@ -217,11 +217,8 @@ export declare const match: <R>(
     NoConfidenceAction: (govActionId: GovActionId | null) => R
     UpdateCommitteeAction: (
       govActionId: GovActionId | null,
-      membersToRemove: ReadonlyArray<typeof CommiteeColdCredential.CommitteeColdCredential.CredentialSchema.Type>,
-      membersToAdd: ReadonlyMap<
-        typeof CommiteeColdCredential.CommitteeColdCredential.CredentialSchema.Type,
-        EpochNo.EpochNo
-      >,
+      membersToRemove: ReadonlyArray<typeof CommiteeColdCredential.CommitteeColdCredential.Credential.Type>,
+      membersToAdd: ReadonlyMap<typeof CommiteeColdCredential.CommitteeColdCredential.Credential.Type, EpochNo.EpochNo>,
       threshold: UnitInterval.UnitInterval
     ) => R
     NewConstitutionAction: (govActionId: GovActionId | null, constitution: Constituion.Constitution) => R

docs/content/docs/modules/core/VotingProcedures.mdx

@@ -292,7 +292,7 @@ Pattern match on a Voter.
 
 ```ts
 export declare const matchVoter: <R>(patterns: {
-  ConstitutionalCommitteeVoter: (credential: Credential.CredentialSchema) => R
+  ConstitutionalCommitteeVoter: (credential: Credential.Credential) => R
   DRepVoter: (drep: DRep.DRep) => R
   StakePoolVoter: (poolKeyHash: PoolKeyHash.PoolKeyHash) => R
 }) => (voter: Voter) => R

docs/content/docs/modules/sdk/Credential.mdx

@@ -1,6 +1,6 @@
 ---
 title: sdk/Credential.ts
-nav_order: 177
+nav_order: 179
 parent: Modules
 ---
 
@@ -26,7 +26,7 @@ parent: Modules
 **Signature**
 
 ```ts
-export type Credential = typeof CoreCredential.CredentialSchema.Encoded
+export type Credential = typeof CoreCredential.Credential.Encoded
 ```
 
 ## KeyHash (type alias)

docs/content/docs/modules/sdk/Datum.mdx

@@ -1,6 +1,6 @@
 ---
 title: sdk/Datum.ts
-nav_order: 178
+nav_order: 180
 parent: Modules
 ---
 

docs/content/docs/modules/sdk/Delegation.mdx

@@ -1,6 +1,6 @@
 ---
 title: sdk/Delegation.ts
-nav_order: 179
+nav_order: 181
 parent: Modules
 ---
 

docs/content/docs/modules/sdk/EvalRedeemer.mdx

@@ -1,6 +1,6 @@
 ---
 title: sdk/EvalRedeemer.ts
-nav_order: 180
+nav_order: 182
 parent: Modules
 ---
 

docs/content/docs/modules/sdk/Network.mdx

@@ -1,6 +1,6 @@
 ---
 title: sdk/Network.ts
-nav_order: 181
+nav_order: 183
 parent: Modules
 ---