HCS‑20 API Reference

Sources

• Module folder: https://github.com/hashgraph-online/standards-sdk/tree/main/src/hcs-20
• base-client.ts: https://github.com/hashgraph-online/standards-sdk/blob/main/src/hcs-20/base-client.ts
• sdk.ts: https://github.com/hashgraph-online/standards-sdk/blob/main/src/hcs-20/sdk.ts
• browser.ts: https://github.com/hashgraph-online/standards-sdk/blob/main/src/hcs-20/browser.ts
• points-indexer.ts: https://github.com/hashgraph-online/standards-sdk/blob/main/src/hcs-20/points-indexer.ts
• tx.ts: https://github.com/hashgraph-online/standards-sdk/blob/main/src/hcs-20/tx.ts
• types.ts: https://github.com/hashgraph-online/standards-sdk/blob/main/src/hcs-20/types.ts
• errors.ts: https://github.com/hashgraph-online/standards-sdk/blob/main/src/hcs-20/errors.ts

Import

import * as HCS20 from '@hashgraphonline/standards-sdk/hcs-20';

Barrel Exports

• types (all canonical types)
• errors
  • HCS20Error, HCS20ErrorCodes
• base-client
  • HCS20BaseClient
• browser
  • BrowserHCS20Client
• sdk
  • HCS20Client
• points-indexer
  • HCS20PointsIndexer (helper to compute balances from topic messages)
• tx
  • All HCS‑20 deploy/mint/transfer/burn builders

Clients

class HCS20BaseClient { /* shared config/mirror/logger */ }
class HCS20Client extends HCS20BaseClient { /* Node: deploy, mint, transfer, burn */ }
class BrowserHCS20Client { /* Wallet-signed equivalents */ }

Source

• https://github.com/hashgraph-online/standards-sdk/blob/main/src/hcs-20/sdk.ts

Indexer

class HCS20PointsIndexer {
  constructor(mirrorNodeUrl?: string)
  indexTopic(topicId: string, options?: { fromSeq?: number }): Promise<{ balances: Map<string, number> }>
}

Source

• https://github.com/hashgraph-online/standards-sdk/blob/main/src/hcs-20/points-indexer.ts

Builders (tx)

// Example signature pattern
function buildHcs20DeployTx(params: { name: string; symbol: string; decimals?: number }): import('@hashgraph/sdk').TopicMessageSubmitTransaction;
function buildHcs20MintTx(params: { topicId: string; account: string; amount: number }): import('@hashgraph/sdk').TopicMessageSubmitTransaction;

Notes

• See the source for exact builder names and types under src/hcs-20/tx.ts.
• The indexer is optional; you can compute balances ad‑hoc if preferred.