api-reference.md

API Reference

Complete reference for all Guardian TypeScript SDK classes, methods, and types.

📚 Core Classes

SecureOwnable

The SecureOwnable class provides type-safe access to SecureOwnable contracts.

Constructor

constructor(
  client: PublicClient,
  walletClient?: WalletClient,
  contractAddress: Address,
  chain: Chain
)

Parameters:

• client: Viem public client for read operations
• walletClient: Optional wallet client for write operations
• contractAddress: Address of the deployed contract
• chain: Chain configuration

Read Methods

owner(): Promise<Address>

Returns the current owner of the contract.

const owner = await secureOwnable.owner()

getTimeLockPeriodSec(): Promise<bigint>

Returns the time lock period in seconds.

const period = await secureOwnable.getTimeLockPeriodSec()

broadcaster(): Promise<Address>

Returns the current broadcaster address.

const broadcaster = await secureOwnable.broadcaster()

recovery(): Promise<Address>

Returns the current recovery address.

const recovery = await secureOwnable.recovery()

eventForwarder(): Promise<Address>

Returns the current event forwarder address.

const forwarder = await secureOwnable.eventForwarder()

isInitialized(): Promise<boolean>

Checks if the contract is initialized.

const initialized = await secureOwnable.isInitialized()

Write Methods

transferOwnershipRequest(newOwner: Address, options?: TransactionOptions): Promise<Hash>

Requests a transfer of ownership.

const txHash = await secureOwnable.transferOwnershipRequest(
  '0x...',
  { from: account.address }
)

transferOwnershipDelayedApproval(txId: bigint, options?: TransactionOptions): Promise<Hash>

Approves a delayed ownership transfer.

const txHash = await secureOwnable.transferOwnershipDelayedApproval(
  1n,
  { from: account.address }
)

updateBroadcasterRequest(newBroadcaster: Address, options?: TransactionOptions): Promise<Hash>

Requests a broadcaster update.

const txHash = await secureOwnable.updateBroadcasterRequest(
  '0x...',
  { from: account.address }
)

updateRecoveryRequestAndApprove(newRecovery: Address, options?: TransactionOptions): Promise<Hash>

Requests and approves a recovery update.

const txHash = await secureOwnable.updateRecoveryRequestAndApprove(
  '0x...',
  { from: account.address }
)

updateTimeLockRequestAndApprove(newPeriod: bigint, options?: TransactionOptions): Promise<Hash>

Requests and approves a time lock period update.

const txHash = await secureOwnable.updateTimeLockRequestAndApprove(
  3600n, // 1 hour
  { from: account.address }
)

DynamicRBAC

The DynamicRBAC class provides type-safe access to DynamicRBAC contracts.

Constructor

constructor(
  client: PublicClient,
  walletClient?: WalletClient,
  contractAddress: Address,
  chain: Chain
)

Read Methods

roleEditingEnabled(): Promise<boolean>

Checks if role editing is enabled.

const enabled = await dynamicRBAC.roleEditingEnabled()

getRole(roleHash: string): Promise<Role>

Gets role information by hash.

const role = await dynamicRBAC.getRole('0x...')

hasRole(account: Address, roleHash: string): Promise<boolean>

Checks if an account has a specific role.

const hasRole = await dynamicRBAC.hasRole('0x...', '0x...')

getRoleCount(): Promise<bigint>

Returns the total number of roles.

const count = await dynamicRBAC.getRoleCount()

Write Methods

updateRoleEditingToggleRequestAndApprove(enabled: boolean, options?: TransactionOptions): Promise<Hash>

Requests and approves role editing toggle.

const txHash = await dynamicRBAC.updateRoleEditingToggleRequestAndApprove(
  true,
  { from: account.address }
)

📝 Types & Interfaces

Core Types

type Address = `0x${string}`
type Hash = `0x${string}`


type OperationType = 
  | 'OWNERSHIP_TRANSFER'
  | 'BROADCASTER_UPDATE'
  | 'RECOVERY_UPDATE'
  | 'TIMELOCK_UPDATE'
  | 'ROLE_EDITING_TOGGLE'
  | 'CUSTOM'

type TxAction = 
  | 'EXECUTE_TIME_DELAY_REQUEST'
  | 'EXECUTE_TIME_DELAY_APPROVE'
  | 'EXECUTE_META_REQUEST_AND_APPROVE'
  | 'EXECUTE_META_APPROVE'

type TxStatus = 
  | 'UNDEFINED'
  | 'PENDING'
  | 'COMPLETED'
  | 'CANCELLED'

🔧 Transaction Options

interface TransactionOptions {
  from?: Address
  value?: bigint
  gas?: bigint
  gasPrice?: bigint
  maxFeePerGas?: bigint
  maxPriorityFeePerGas?: bigint
  nonce?: number
}

📊 Error Types

class GuardianError extends Error {
  code: string
  details?: any
}

class ContractError extends GuardianError {
  contractAddress: Address
  method: string
}

class ValidationError extends GuardianError {
  field: string
  value: any
}

class ComplianceError extends GuardianError {
  violation: ComplianceViolation
}

🎯 Usage Examples

Basic Contract Interaction

import { SecureOwnable } from '@guardian/sdk/typescript'
import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http()
})

const secureOwnable = new SecureOwnable(
  client,
  undefined,
  '0x...',
  mainnet
)

// Read operations
const owner = await secureOwnable.owner()
const timeLock = await secureOwnable.getTimeLockPeriodSec()

console.log('Owner:', owner)
console.log('Time lock period:', timeLock)

---

Need more details? Check out the specific guides:

• SecureOwnable Guide
• DynamicRBAC Guide