HCS‑15 API Reference

Sources

• Module folder: GitHub
• base-client.ts: GitHub
• sdk.ts: GitHub
• browser.ts: GitHub
• tx.ts: GitHub
• types.ts: GitHub

Import Paths

TypeScript

import {
  HCS15Client,
  HCS15BrowserClient,
  type SDKHCS15ClientConfig,
  type BrowserHCS15ClientConfig,
  buildHcs15BaseAccountCreateTx,
  buildHcs15PetalAccountCreateTx,
} from '@hashgraphonline/standards-sdk';

Go

NewClient(config ClientConfig) (*Client, error)
Client.CreateBaseAccount(ctx, BaseAccountCreateOptions) (BaseAccountCreateResult, error)
Client.CreatePetalAccount(ctx, PetalAccountCreateOptions) (PetalAccountCreateResult, error)
Client.VerifyPetalAccount(ctx, ...)
BuildBaseAccountCreateTx(BaseAccountCreateTxParams) (*hedera.AccountCreateTransaction, error)
BuildPetalAccountCreateTx(PetalAccountCreateTxParams) (*hedera.AccountCreateTransaction, error)

Python

# NewClient(config ClientConfig) (*Client, error)
Client.create_base_account(BaseAccountCreateOptions) (BaseAccountCreateResult, error)
Client.create_petal_account(PetalAccountCreateOptions) (PetalAccountCreateResult, error)
Client.verify_petal_account(...)
# BuildBaseAccountCreateTx(BaseAccountCreateTxParams) (*hedera.AccountCreateTransaction, error)
# BuildPetalAccountCreateTx(PetalAccountCreateTxParams) (*hedera.AccountCreateTransaction, error)

Server Client (HCS15Client)

TypeScript

constructor(config: SDKHCS15ClientConfig)
getKeyType(): 'ed25519' | 'ecdsa'
close(): Promise<void>

createBaseAccount(options?: { initialBalance?: number; maxAutomaticTokenAssociations?: number; accountMemo?: string }): Promise<{
  accountId: string; privateKey: import('@hashgraph/sdk').PrivateKey; privateKeyHex: string; publicKey: import('@hashgraph/sdk').PublicKey; evmAddress: string; receipt: import('@hashgraph/sdk').TransactionReceipt;
}>

createPetalAccount(params: { basePrivateKey: string | import('@hashgraph/sdk').PrivateKey; initialBalance?: number; maxAutomaticTokenAssociations?: number; accountMemo?: string }): Promise<{ accountId: string; receipt: import('@hashgraph/sdk').TransactionReceipt }>

Go

// See standards-sdk-go for full Go API types and methods

Python

from standards_sdk_py.hcs15 import Hcs15Client

# Equivalent Python usage — see Python SDK docs for details

Browser Client (HCS15BrowserClient)

Wallet‑signed counterparts for creating base and petal accounts. Returns similar shapes; accountId may be provided by wallet flows.

Base Client

TypeScript

verifyPetalAccount(petalAccountId: string, baseAccountId: string): Promise<boolean> // compares mirror‑node key material

Go

// See standards-sdk-go for full Go API types and methods

Python

from standards_sdk_py.hcs15 import Hcs15Client

# Equivalent Python usage — see Python SDK docs for details

Builders

TypeScript

function buildHcs15BaseAccountCreateTx(params: { publicKey: import('@hashgraph/sdk').PublicKey; initialBalance?: import('@hashgraph/sdk').Hbar|number; maxAutomaticTokenAssociations?: number; accountMemo?: string }): import('@hashgraph/sdk').AccountCreateTransaction;

function buildHcs15PetalAccountCreateTx(params: { publicKey: import('@hashgraph/sdk').PublicKey; initialBalance?: import('@hashgraph/sdk').Hbar|number; maxAutomaticTokenAssociations?: number; accountMemo?: string }): import('@hashgraph/sdk').AccountCreateTransaction;

Go

// See standards-sdk-go for full Go API types and methods

Python

from standards_sdk_py.hcs15 import Hcs15Client

# Equivalent Python usage — see Python SDK docs for details

Errors

• HCS-15 BASE_ACCOUNT_CREATE_FAILED
• HCS-15 PETAL_ACCOUNT_CREATE_FAILED

Example

TypeScript

const c = new HCS15Client({ network: 'testnet', operatorId, operatorKey });
const base = await c.createBaseAccount({ initialBalance: 10 });
await c.createPetalAccount({ basePrivateKey: base.privateKey });

Go

// See standards-sdk-go for full Go API types and methods

Python

from standards_sdk_py.hcs15 import Hcs15Client

# Equivalent Python usage — see Python SDK docs for details