Skip to content

index.md

Latest commit

 

History

History
54 lines (40 loc) · 1.58 KB

index.md

File metadata and controls

54 lines (40 loc) · 1.58 KB

React SDK Overview

React library exposing a provider, client access, and hooks for ACTA API and Soroban transactions. The network is inferred from the baseURL.

Exports

  • ActaConfig provider and useActaClient context accessor
  • Hooks: useVault, useCredential, useVaultRead
  • Base URLs: mainNet and testNet

Provider Setup

import { ActaConfig, mainNet } from "@acta-team/acta-sdk";

export function App() {
  return (
    <ActaConfig baseURL={mainNet}>
      {/* your app */}
    </ActaConfig>
  );
}

The API key is automatically read from environment variables:

  • ACTA_API_KEY_MAINNET (for mainnet)
  • ACTA_API_KEY_TESTNET (for testnet)
  • ACTA_API_KEY (fallback for both networks)

Accessing the Client

import { useActaClient } from "@acta-team/acta-sdk";

const client = useActaClient();
const config = await client.getConfig();
// config: { rpcUrl, networkPassphrase, actaContractId }

Hooks Summary

  • useVault: Vault operations - create vault, authorize issuer, revoke issuer

    • createVault: Initialize a vault for an owner
    • authorizeIssuer: Authorize an issuer in the vault
    • revokeIssuer: Revoke an authorized issuer from the vault

  • useCredential: Credential operations - issue and revoke

    • issue: Issue a credential (stores in vault and marks as valid)
    • revoke: Revoke a credential

  • useVaultRead: Vault read operations - list IDs, get VC, verify VC

    • listVcIds: List credential IDs owned by an owner
    • getVc: Get a credential from the vault
    • verifyVc: Verify the status of a credential in the vault