Developer Docs

Appearance

getTagInfo ​

Get tag information.

$holytag is a unique identifier which can have account, card and multiple Ethereum and/or Solana addresses bound to it. $holytag is alphanumeric string with a few special characters allowed. A valid holytag can be as short as one (1) and as long as thirty one (31) characters.

🔔

Please note! The only two special characters allowed are: dash - and underscore _.

$holytag is usually displayed prepended with a $ prefix, for example: $JohnSmith holytag is JohnSmith or $PEPE holytag PEPE, etc.

Tags are stored case-sensitive for display, but not case-sensitive for search, and are not allowed to have multiple case variants registered. It means that if there is a holytag $ToTheMoon registered, other case sensitive variations are not allowed (e.g. $toTHEmoon).

Test $holytag

You can use SDKTEST as a test $holytag. All transactions to this $holytag will NOT trigger an actual fiat-corresponding transaction, but will return a fully valid response. There is no minimum amount set for the test $holytag. SDKTEST test $holytag works across all supported networks and tokens.

🔔

Please note! Funds from test transactions to SDKTEST can NOT be retrieved. Do not initiate large test transactions.

A tag name could be preset by the developer (you) or inputted by the user. It depends on the user flow you want to have.

Usage ​

typescript
const data = await holyheldSDK.getTagInfo('SDKTEST');

Parameters ​

$holytag ​

The holytag

  • Type: String
typescript
const data = await holyheldSDK.getTagInfo(
  'SDKTEST'
);

Returns ​

typescript
type TagInfo = {
  found: boolean;
  tag?: string;
  avatarSrc?: string;
}

found ​

true if the holytag exists and active

  • Type: Boolean
typescript
type TagInfo = {
  found: boolean; 
  tag?: string;
  avatarSrc?: string;
}

tag (optional) ​

The $holytag name, if found is true

🔔

Case sensitive, as registered

  • Type: String
  • Example: SDKTEST
typescript
type TagInfo = {
  found: boolean;
  tag?: string; 
  avatarSrc?: string;
}

avatarSrc (optional) ​

Link to avatar image, if found is true

🔔

Case sensitive, as registered

  • Type: String
  • Example: https://brrr.network/static/avatar.png
typescript
type TagInfo = {
  found: boolean;
  tag?: string;
  avatarSrc?: string; 
}