Class BitBadgesAPI<T>

This is the BitBadgesAPI class which provides all typed API calls to the BitBadges API. See official documentation for more details and examples. Must pass in a valid API key.

convertFunction is used to convert any responses returned by the API to your desired NumberType.

import { BigIntify, Stringify, Numberify, BitBadgesAPI } from "bitbadgesjs-sdk";
const BitBadgesApi = new BitBadgesAPI({ convertFunction: BigIntify, ....})
const collections = await BitBadgesApi.getCollections(...);

By default, we use the official API URL (https://api.bitbadges.io). You can override this by passing in a custom apiUrl.

Index

Constructors

constructor

Properties

BACKEND_URL ConvertFunction accessToken apiKey axios

Methods

addBalancesToOffChainStorage addReview assertPositiveInteger broadcastTx checkIfSignedIn completeClaim createAddressLists createAttestation createAttestationProof createClaim createSIWBBRequest deleteAddressLists deleteAttestation deleteAttestationProof deleteClaim deleteReview deleteSIWBBRequest exchangeSIWBBAuthorizationCode filterBadgesInCollection filterSuggestions getAccounts getAddressLists getAttestation getAttestationProof getBadgeActivity getBadgeBalanceByAddress getBrowseCollections getClaimAlerts getClaimAttemptStatus getClaims getCollections getMapValues getMaps getOwnersForBadge getRefreshStatus getReservedClaimCodes getSIWBBRequestsForDeveloperApp getSearchResults getStatus handleApiError refreshMetadata revokeOauthAuthorization rotateSIWBBRequest sendClaimAlert setAccessToken simulateClaim simulateTx unsetAccessToken updateAccountInfo updateAddressLists updateAttestation updateClaim updateUserSeenActivity verifyOwnershipRequirements verifySIWBBRequest

Constructors

constructor

new BitBadgesAPI<T>(apiDetails): BitBadgesAPI<T>
Type Parameters
- T extends NumberType
Parameters
- apiDetails: iBitBadgesApi<T>
Returns BitBadgesAPI<T>
Overrides BaseBitBadgesApi.constructor
- Defined in src/api-indexer/BitBadgesApi.ts:196

Properties

BACKEND_URL

BACKEND_URL: string = ...

ConvertFunction

ConvertFunction: ((num) => T)

Type declaration

- (num): T
- Parameters
  - num: NumberType
  Returns T

accessToken

accessToken: string = ''

apiKey

apiKey: undefined | string = process.env.BITBADGES_API_KEY

axios

axios: AxiosInstance = ...

Methods

addBalancesToOffChainStorage

addBalancesToOffChainStorage(payload): Promise<AddBalancesToOffChainStorageSuccessResponse>
Adds a balance map to off-chain storage. Mode can either be 'ipfs" for storing on IPFS or 'centralized' for storing on DigitalOcean.
Parameters
- payload: AddBalancesToOffChainStoragePayload
Returns Promise<AddBalancesToOffChainStorageSuccessResponse>
Remarks
- API Route: POST /api/v0/addBalancesToOffChainStorage
- SDK Function Call: await BitBadgesApi.addBalancesToOffChainStorage(payload);
- CORS: Restricted to only BitBadges official site. Otherwise, you will need to self-host.
Example
```
const res = await BitBadgesApi.addBalancesToOffChainStorage(payload);
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:1337

addReview

addReview(payload): Promise<AddReviewSuccessResponse>
Adds a new review for a collection or address.
Parameters
- payload: AddReviewPayload
Returns Promise<AddReviewSuccessResponse>
Remarks
- API Route: POST /api/v0/reviews/add
- SDK Function Call: await BitBadgesApi.addReview(collectionId, payload);
- Authentication: Must be signed in.
Example
```
const res = await BitBadgesApi.addReview(collectionId, payload);
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:548

assertPositiveInteger

assertPositiveInteger(num): void
Parameters
- num: NumberType
Returns void
Inherited from BaseBitBadgesApi.assertPositiveInteger
- Defined in src/api-indexer/base.ts:104

broadcastTx

broadcastTx(payload): Promise<BroadcastTxSuccessResponse>
Broadcasts a transaction to the blockchain.
Parameters
- payload: string | BroadcastPostBody
Returns Promise<BroadcastTxSuccessResponse>
Remarks
- API Route: POST /api/v0/broadcast
- SDK Function Call: await BitBadgesApi.broadcastTx(payload);
- Tutorial: See Broadcasting Transactions tutorial on the official docs.
Also, consider checking out Broadcast UI, so you can simply copy and paste your transaction to a UI. All signing, API communication, etc is outsourced to the UI.
- Defined in src/api-indexer/BitBadgesApi.ts:679

checkIfSignedIn

checkIfSignedIn(payload): Promise<CheckSignInStatusSuccessResponse>
Checks if the user is signed in.
Parameters
- payload: CheckSignInStatusPayload
Returns Promise<CheckSignInStatusSuccessResponse>
Remarks
- API Route: POST /api/v0/auth/status
- SDK Function Call: await BitBadgesApi.checkIfSignedIn(payload);
- Tutorial: See Authentication tutorial on the official docs.
- Defined in src/api-indexer/BitBadgesApi.ts:626

completeClaim

completeClaim(claimId, cosmosAddress, payload): Promise<CompleteClaimSuccessResponse>
For password based approvals, we hand out codes behind the scenes whenever a user requests a password. This is to prevent replay attacks on the blockchain. This API call will return a valid code if a valid password is provided.

Each address is limited to one code per password. If the password is provided again, they will receive the same code.
Parameters
- claimId: string
- cosmosAddress: string
- payload: CompleteClaimPayload
Returns Promise<CompleteClaimSuccessResponse>
Remarks
- API Route: POST /api/v0/claims/complete/:claimId/:cosmosAddress
- SDK Function Call: await BitBadgesApi.completeClaim(claimId, address, { ...body });
- Authentication: Must be signed in.
Example
```
const res = await BitBadgesApi.completeClaim(claimId, address, { ...body });
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:375

createAddressLists

createAddressLists(payload): Promise<CreateAddressListsSuccessResponse>
Creates address lists stored by BitBadges centralized servers.
Parameters
- payload: CreateAddressListsPayload
Returns Promise<CreateAddressListsSuccessResponse>
Remarks
- API Route: POST /api/v0/addressLists
- SDK Function Call: await BitBadgesApi.updateAddressLists(payload);
Must be created off-chain. For on-chain, they must be created through MsgCreateAddressMappings. Creator can update their created lists with no restrictions. Else, requires an edit key.
- Defined in src/api-indexer/BitBadgesApi.ts:728

createAttestation

createAttestation(payload): Promise<CreateAttestationSuccessResponse>
Creates an off-chain attestation signature (typically a credential).
Parameters
- payload: CreateAttestationPayload
Returns Promise<CreateAttestationSuccessResponse>
Remarks
- API Route: POST /api/v0/attestation
- SDK Function Call: await BitBadgesApi.createAttestation(payload);
- Authentication: Must be signed in.
- Defined in src/api-indexer/BitBadgesApi.ts:1161

createAttestationProof

createAttestationProof(payload): Promise<CreateAttestationProofSuccessResponse>
Creates an off-chain attestation proof (typically a credential).
Parameters
- payload: CreateAttestationProofPayload
Returns Promise<CreateAttestationProofSuccessResponse>
Remarks
- API Route: POST /api/v0/attestationProof
- SDK Function Call: await BitBadgesApi.createAttestationProof(payload);
- Authentication: Must be signed in.
- Defined in src/api-indexer/BitBadgesApi.ts:1388

createClaim

createClaim(payload): Promise<CreateClaimSuccessResponse>
Creates a claim.
Parameters
- payload: CreateClaimPayload
Returns Promise<CreateClaimSuccessResponse>
Remarks
- API Route: POST /api/v0/claims
- SDK Function Call: await BitBadgesApi.createClaim(payload);
- Authentication: Must be signed in.
- Defined in src/api-indexer/BitBadgesApi.ts:1238

createSIWBBRequest

createSIWBBRequest(payload?): Promise<CreateSIWBBRequestSuccessResponse>
Creates a SIWBB request.
Parameters
- Optional payload: CreateSIWBBRequestPayload
Returns Promise<CreateSIWBBRequestSuccessResponse>
Remarks
- API Route: POST /api/v0/siwbbRequest
- SDK Function Call: await BitBadgesApi.createSIWBBRequest(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:834

deleteAddressLists

deleteAddressLists(payload): Promise<DeleteAddressListsSuccessResponse>
Deletes address lists. Must be created off-chain.
Parameters
- payload: DeleteAddressListsPayload
Returns Promise<DeleteAddressListsSuccessResponse>
Remarks
- API Route: DELETE /api/v0/addressLists
- SDK Function Call: await BitBadgesApi.deleteAddressLists(payload);
- Authentication: Must be signed in and the creator of the address list.
- Defined in src/api-indexer/BitBadgesApi.ts:765

deleteAttestation

deleteAttestation(payload): Promise<DeleteAttestationSuccessResponse>
Deletes an off-chain attestation signature (typically a credential).
Parameters
- payload: DeleteAttestationPayload
Returns Promise<DeleteAttestationSuccessResponse>
Remarks
- API Route: DELETE /api/v0/attestation
- SDK Function Call: await BitBadgesApi.deleteAttestation(payload);
- Authentication: Must be signed in.
- Defined in src/api-indexer/BitBadgesApi.ts:1187

deleteAttestationProof

deleteAttestationProof(payload): Promise<DeleteAttestationProofSuccessResponse>
Deletes an off-chain attestation proof (typically a credential).
Parameters
- payload: DeleteAttestationProofPayload
Returns Promise<DeleteAttestationProofSuccessResponse>
Remarks
- API Route: DELETE /api/v0/attestationProof
- SDK Function Call: await BitBadgesApi.deleteAttestationProof(payload);
- Authentication: Must be signed in.
- Defined in src/api-indexer/BitBadgesApi.ts:1414

deleteClaim

deleteClaim(payload): Promise<DeleteClaimSuccessResponse>
Deletes a claim.
Parameters
- payload: DeleteClaimPayload
Returns Promise<DeleteClaimSuccessResponse>
Remarks
- API Route: DELETE /api/v0/claims
- SDK Function Call: await BitBadgesApi.deleteClaim(payload);
- Authentication: Must be signed in.
- Defined in src/api-indexer/BitBadgesApi.ts:1261

deleteReview

deleteReview(reviewId, payload?): Promise<DeleteReviewSuccessResponse>
Deletes a review.
Parameters
- reviewId: string
- Optional payload: DeleteReviewPayload
Returns Promise<DeleteReviewSuccessResponse>
Remarks
- API Route: DELETE /api/v0/deleteReview/:reviewId
- SDK Function Call: await BitBadgesApi.deleteReview(reviewId, payload);
- Authentication: Must be signed in and the owner of the review.
Example
```
const res = await BitBadgesApi.deleteReview(reviewId);
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:517

deleteSIWBBRequest

deleteSIWBBRequest(payload?): Promise<DeleteSIWBBRequestSuccessResponse>
Deletes a SIWBB request.
Parameters
- Optional payload: DeleteSIWBBRequestPayload
Returns Promise<DeleteSIWBBRequestSuccessResponse>
Remarks
- API Route: DELETE /api/v0/siwbbRequest
- SDK Function Call: await BitBadgesApi.deleteSIWBBRequest(payload);
- Authentication: Must be signed in and the owner of the requesy.
- Defined in src/api-indexer/BitBadgesApi.ts:885

exchangeSIWBBAuthorizationCode

exchangeSIWBBAuthorizationCode(payload?): Promise<ExchangeSIWBBAuthorizationCodeSuccessResponse<T>>
Gets and verifies a SIWBB request.
Parameters
- Optional payload: ExchangeSIWBBAuthorizationCodePayload
Returns Promise<ExchangeSIWBBAuthorizationCodeSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/siwbbRequest
- SDK Function Call: await BitBadgesApi.exchangeSIWBBAuthorizationCode(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:776

filterBadgesInCollection

filterBadgesInCollection(collectionId, payload): Promise<FilterBadgesInCollectionSuccessResponse<T>>
Filters badges in a collection based on multiple filter values.
Parameters
- collectionId: T
- payload: FilterBadgesInCollectionPayload
Returns Promise<FilterBadgesInCollectionSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/collection/:collectionId/filter
- SDK Function Call: await BitBadgesApi.filterBadgesInCollection(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:1068

filterSuggestions

filterSuggestions(collectionId, payload?): Promise<FilterSuggestionsSuccessResponse>
Gets the filter suggestions based on attributes in a collection.
Parameters
- collectionId: T
- Optional payload: FilterSuggestionsPayload
Returns Promise<FilterSuggestionsSuccessResponse>
Remarks
- API Route: POST /api/v0/collection/:collectionId/filterSuggestions
- SDK Function Call: await BitBadgesApi.filterSuggestions(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:1082

getAccounts

getAccounts(payload): Promise<GetAccountsSuccessResponse<T>>
Gets accounts and accompying details.
Parameters
- payload: GetAccountsPayload
Returns Promise<GetAccountsSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/users
- SDK Function Call: await BitBadgesApi.getAccounts(payload);
- Tutorial: See the Fetching Accounts tutoral on the official docs.
- Authentication: Must be signed in, if fetching private information such as private lists or auth codes. If fetching public information only, no sign in required.
Example
```
const res = await BitBadgesApi.getAccounts([{ address, fetchSequence: true, fetchBalance: true }]);
console.log(res);
```
Note
This function is used to fetch accounts and their details. It is your responsibility to join the data together (paginations, etc). Use getAccountsAndUpdate for a more convenient way to handle paginations and appending metadata.
- Defined in src/api-indexer/BitBadgesApi.ts:582

getAddressLists

getAddressLists(payload): Promise<GetAddressListsSuccessResponse<T>>
Gets address lists. Can be on-chain or off-chain.
Parameters
- payload: GetAddressListsPayload
Returns Promise<GetAddressListsSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/addressLists
- SDK Function Call: await BitBadgesApi.getAddressLists(payload);
Note for reserved lists, you can use getReservedAddressList from the SDK.
- Defined in src/api-indexer/BitBadgesApi.ts:753

getAttestation

getAttestation(payload): Promise<GetAttestationSuccessResponse<T>>
Get an off-chain attestation signature (typically a credential).
Parameters
- payload: GetAttestationPayload
Returns Promise<GetAttestationSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/attestation
- SDK Function Call: await BitBadgesApi.getAttestation(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:1135

getAttestationProof

getAttestationProof(payload): Promise<GetAttestationProofSuccessResponse<T>>
Get an off-chain attestation proof (typically a credential).
Parameters
- payload: GetAttestationProofPayload
Returns Promise<GetAttestationProofSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/attestationProof
- SDK Function Call: await BitBadgesApi.getAttestationProof(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:1362

getBadgeActivity

getBadgeActivity(collectionId, badgeId, payload): Promise<GetBadgeActivitySuccessResponse<T>>
Gets the activity for a specific badge in a collection
Parameters
- collectionId: NumberType
- badgeId: NumberType
- payload: GetBadgeActivityPayload
Returns Promise<GetBadgeActivitySuccessResponse<T>>
Remarks
- API Route: POST /api/v0/collection/:collectionId/:badgeId/activity
- SDK Function Call: await BitBadgesApi.getBadgeActivity(collectionId, badgeId, payload);
Example
```
const res = await BitBadgesApi.getBadgeActivity(collectionId, badgeId, { bookmark: 'prev' });
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:331

getBadgeBalanceByAddress

getBadgeBalanceByAddress(collectionId, address, payload?): Promise<GetBadgeBalanceByAddressSuccessResponse<T>>
Gets the balance of a specific badge for a specific address
Parameters
- collectionId: NumberType
- address: string
- Optional payload: GetBadgeBalanceByAddressPayload
Returns Promise<GetBadgeBalanceByAddressSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/collection/:collectionId/balance/:cosmosAddress
- SDK Function Call: await BitBadgesApi.getBadgeBalanceByAddress(collectionId, cosmosAddress);
Example
```
const res = await BitBadgesApi.getBadgeBalanceByAddress(collectionId, cosmosAddress);
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:310

getBrowseCollections

getBrowseCollections(payload?): Promise<GetBrowseCollectionsSuccessResponse<T>>
Gets details for a browse / explore page.
Parameters
- Optional payload: GetBrowseCollectionsPayload
Returns Promise<GetBrowseCollectionsSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/browse
- SDK Function Call: await BitBadgesApi.getBrowseCollections(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:651

getClaimAlerts

getClaimAlerts(payload): Promise<GetClaimAlertsForCollectionSuccessResponse<T>>
Gets claim alerts for a collection.
Parameters
- payload: GetClaimAlertsForCollectionPayload
Returns Promise<GetClaimAlertsForCollectionSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/claimAlerts
- SDK Function Call: await BitBadgesApi.getClaimAlerts(payload);
- Authentication: Must be signed in and the manager of the collection.
- Defined in src/api-indexer/BitBadgesApi.ts:988

getClaimAttemptStatus

getClaimAttemptStatus(claimAttemptId): Promise<GetClaimAttemptStatusSuccessResponse>
Gets the status of a claim attempt.
Parameters
- claimAttemptId: string
Returns Promise<GetClaimAttemptStatusSuccessResponse>
Remarks
- API Route: POST /api/v0/claims/status/:claimId
- SDK Function Call: await BitBadgesApi.getClaimAttemptStatus(claimAttemptId);
Example
```
const res = await BitBadgesApi.getClaimAttemptStatus(claimAttemptId);
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:486

getClaims

getClaims(payload): Promise<GetClaimsSuccessResponse<T>>
Gets the claim by ID.
Parameters
- payload: GetClaimsPayload
Returns Promise<GetClaimsSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/claims
- SDK Function Call: await BitBadgesApi.getClaims(payload);
Example
```
const res = await BitBadgesApi.getClaims(payload);
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:1113

getCollections

getCollections(payload): Promise<GetCollectionsSuccessResponse<T>>
This function retrieves badge collections and accompanying details. Consider using the getCollectionsAndUpdate function instead for native support in handling paginations, appending metadata, and more.
Parameters
- payload: GetCollectionsPayload
Returns Promise<GetCollectionsSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/collections
- Tutorial: Refer to the Fetching Collections tutorial on the official documentation.
Example
```
const res = await BitBadgesApi.getCollections([{ collectionId, metadataToFetch: { badgeIds: [{ start: 1n, end: 10n }] } }]);
const collection = res.collections[0];
```
- Defined in src/api-indexer/BitBadgesApi.ts:272

getMapValues

getMapValues(payload): Promise<GetMapValuesSuccessResponse>
Get map values
Parameters
- payload: GetMapValuesPayload
Returns Promise<GetMapValuesSuccessResponse>
Remarks
- API Route: POST /api/v0/mapValues
- SDK Function Call: await BitBadgesApi.getMapValues(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:1046

getMaps

getMaps(payload): Promise<GetMapsSuccessResponse<T>>
Get maps by ID
Parameters
- payload: GetMapsPayload
Returns Promise<GetMapsSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/maps
- SDK Function Call: await BitBadgesApi.getMaps(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:1024

getOwnersForBadge

getOwnersForBadge(collectionId, badgeId, payload): Promise<GetOwnersForBadgeSuccessResponse<T>>
Gets the owners for a specific badge in a collection
Parameters
- collectionId: NumberType
- badgeId: NumberType
- payload: GetOwnersForBadgePayload
Returns Promise<GetOwnersForBadgeSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/collection/:collectionId/:badgeId/owners
- SDK Function Call: await BitBadgesApi.getOwnersForBadge(collectionId, badgeId, payload);
Example
```
const res = await BitBadgesApi.getOwnersForBadge(collectionId, badgeId, { bookmark: 'prev' });
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:289

getRefreshStatus

getRefreshStatus(collectionId): Promise<RefreshStatusSuccessResponse<NumberType>>
Gets the refresh status for a collection. Used to track if any errors occur during a refresh, or if it is in the queue or not.
Parameters
- collectionId: NumberType
Returns Promise<RefreshStatusSuccessResponse<NumberType>>
Remarks
- API Route: POST /api/v0/collection/:collectionId/refreshStatus
- SDK Function Call: await BitBadgesApi.getRefreshStatus(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:1013

getReservedClaimCodes

getReservedClaimCodes(claimId, cosmosAddress, payload): Promise<GetReservedClaimCodesSuccessResponse>
For on-chain claims where codes are "reserved" for a specific address, this function will return all codes reserved.
Parameters
- claimId: string
- cosmosAddress: string
- payload: GetReservedClaimCodesPayload
Returns Promise<GetReservedClaimCodesSuccessResponse>
Remarks
- API Route: POST /api/v0/claims/reserved/:claimId/:cosmosAddress
- SDK Function Call: await BitBadgesApi.getReservedClaimCodes(claimId, address, { ...body });
- Authentication: Must be signed in.
Example
```
const res = await BitBadgesApi.getReservedClaimCodes(claimId, address, { ...body });
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:447

getSIWBBRequestsForDeveloperApp

getSIWBBRequestsForDeveloperApp(payload): Promise<GetSIWBBRequestsForDeveloperAppSuccessResponse<T>>
Gets the SIWBB requests for a specific developer app.
Parameters
- payload: GetSIWBBRequestsForDeveloperAppPayload
Returns Promise<GetSIWBBRequestsForDeveloperAppSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/developerApp/siwbbRequests
- SDK Function Call: await BitBadgesApi.getSIWBBRequestsForDeveloperApp(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:805

getSearchResults

getSearchResults(searchValue, payload?): Promise<GetSearchSuccessResponse<T>>
Search collections, badges, accounts, address lists based on a search value.
Parameters
- searchValue: string
- Optional payload: GetSearchPayload
Returns Promise<GetSearchSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/search/:searchValue
- SDK Function Call: await BitBadgesApi.getSearchResults(searchValue);
Example
```
const res = await BitBadgesApi.getSearchResults('vitalik.eth', { noAddressLists: true, noCollections: true, noBadges: true });
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:241

getStatus

getStatus(): Promise<GetStatusSuccessResponse<T>>
Gets the current status details about the blockchain / indexer (gas, block height, etc).

Returns Promise<GetStatusSuccessResponse<T>>
Remarks
- API Route: POST /api/v0/status
- SDK Function Call: await BitBadgesApi.getStatus();
Example
```
const res = await BitBadgesApi.getStatus();
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:213

handleApiError

handleApiError(error): Promise<void>
Parameters
- error: any
Returns Promise<void>
Inherited from BaseBitBadgesApi.handleApiError
- Defined in src/api-indexer/base.ts:93

refreshMetadata

refreshMetadata(collectionId, payload?): Promise<RefreshMetadataSuccessResponse>
Triggers a metadata refresh for a specific collection. BitBadges API uses a refresh queue system for fetching anything off-chain. This will refetch any details for the collection (such as metadata, balances, approval details, etc). Note it will reject if recently refreshed. Uses a cooldown of 5 minutes.
Parameters
- collectionId: NumberType
- Optional payload: RefreshMetadataPayload
Returns Promise<RefreshMetadataSuccessResponse>
Remarks
- API Route: POST /api/v0/collection/:collectionId/refresh
- SDK Function Call: await BitBadgesApi.refreshMetadata(collectionId, payload);
Example
```
const res = await BitBadgesApi.refreshMetadata(collectionId);
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:354

revokeOauthAuthorization

revokeOauthAuthorization(payload): Promise<OauthRevokeSuccessResponse>
Revokes an access token for a user.
Parameters
- payload: OauthRevokePayload
Returns Promise<OauthRevokeSuccessResponse>
Remarks
- API Route: POST /api/v0/siwbb/token/revoke
- SDK Function Call: await BitBadgesApi.oauthRevoke(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:1308

rotateSIWBBRequest

rotateSIWBBRequest(payload): Promise<RotateSIWBBRequestSuccessResponse>
Rotates a SIWBB request.
Parameters
- payload: RotateSIWBBRequestPayload
Returns Promise<RotateSIWBBRequestSuccessResponse>
Remarks
- API Route: POST /api/v0/siwbbRequest/rotate
- SDK Function Call: await BitBadgesApi.rotateSIWBBRequest(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:859

sendClaimAlert

sendClaimAlert(payload): Promise<SendClaimAlertsSuccessResponse>
Sends claim alert notifications out.
Parameters
- payload: SendClaimAlertsPayload
Returns Promise<SendClaimAlertsSuccessResponse>
Remarks
- API Route: POST /api/v0/claimAlerts/send
- SDK Function Call: await BitBadgesApi.sendClaimAlert(payload);
- Authentication: Must be signed in and the manager of the collection.
- CORS: Restricted to only BitBadges official site.
- Defined in src/api-indexer/BitBadgesApi.ts:962

setAccessToken

setAccessToken(token): void
Parameters
- token: string
Returns void
Inherited from BaseBitBadgesApi.setAccessToken
- Defined in src/api-indexer/base.ts:83

simulateClaim

simulateClaim(claimId, cosmosAddress, payload): Promise<SimulateClaimSuccessResponse>
Simulates a claim attempt. A success response means the claim is valid and can be completed.
Parameters
- claimId: string
- cosmosAddress: string
- payload: SimulateClaimPayload
Returns Promise<SimulateClaimSuccessResponse>
Remarks
- API Route: POST /api/v0/claims/simulate/:claimId/:cosmosAddress
- SDK Function Call: await BitBadgesApi.simulateClaim(claimId, address, { ...body });
- Authentication: Must be signed in.
Example
```
const res = await BitBadgesApi.simulateClaim(claimId, address, { ...body });
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:411

simulateTx

simulateTx(payload): Promise<SimulateTxSuccessResponse>
Simulates a transaction on the blockchain.
Parameters
- payload: string | BroadcastPostBody
Returns Promise<SimulateTxSuccessResponse>
Remarks
- API Route: POST /api/v0/simulate
- SDK Function Call: await BitBadgesApi.simulateTx(payload);
- Tutorial: See Broadcasting Transactions tutorial on the official docs.
This means that it will return the gas used and any errors that occur on a dry run. Should be used before broadcasting a transaction. Does not require signatures.
- Defined in src/api-indexer/BitBadgesApi.ts:704

unsetAccessToken

unsetAccessToken(): void
Returns void
Inherited from BaseBitBadgesApi.unsetAccessToken
- Defined in src/api-indexer/base.ts:88

updateAccountInfo

updateAccountInfo(payload): Promise<UpdateAccountInfoSuccessResponse>
Updates the profile / account information for a user. We will only update the provided fields.
Parameters
- payload: UpdateAccountInfoPayload
Returns Promise<UpdateAccountInfoSuccessResponse>
Remarks
- API Route: POST /api/v0/user/updateAccount
- SDK Function Call: await BitBadgesApi.updateAccountInfo(payload);
- Authentication: Must be signed in.
Example
```
const res = await BitBadgesApi.updateAccountInfo(payload);
console.log(res);
```
- Defined in src/api-indexer/BitBadgesApi.ts:600

updateAddressLists

updateAddressLists(payload): Promise<UpdateAddressListsSuccessResponse>
Updates address lists stored by BitBadges centralized servers.
Parameters
- payload: UpdateAddressListsPayload
Returns Promise<UpdateAddressListsSuccessResponse>
Remarks
- API Route: PUT /api/v0/addressLists
- SDK Function Call: await BitBadgesApi.updateAddressLists(payload);
Must be created off-chain. For on-chain, they must be created through MsgCreateAddressMappings. Creator can update their created lists with no restrictions. Else, requires an edit key.
- Defined in src/api-indexer/BitBadgesApi.ts:740

updateAttestation

updateAttestation(payload): Promise<UpdateAttestationSuccessResponse>
Update a attestation.
Parameters
- payload: UpdateAttestationPayload
Returns Promise<UpdateAttestationSuccessResponse>
Remarks
- API Route: PUT /api/v0/attestation
- SDK Function Call: await BitBadgesApi.updateUserAttestations(payload);
- Authentication: Must be signed in.
- Defined in src/api-indexer/BitBadgesApi.ts:1212

updateClaim

updateClaim(payload): Promise<UpdateClaimSuccessResponse>
Update an claim.
Parameters
- payload: UpdateClaimPayload
Returns Promise<UpdateClaimSuccessResponse>
Remarks
- API Route: PUT /api/v0/claims
- SDK Function Call: await BitBadgesApi.updateClaim(payload);
- Authentication: Must be signed in.
- Defined in src/api-indexer/BitBadgesApi.ts:1286

updateUserSeenActivity

updateUserSeenActivity(): Promise<UpdateAccountInfoSuccessResponse>
Update Helper Functions for Pagination and Dynamic Fetches

Returns Promise<UpdateAccountInfoSuccessResponse>
- Defined in src/api-indexer/BitBadgesApi.ts:1435

verifyOwnershipRequirements

verifyOwnershipRequirements(payload): Promise<GenericVerifyAssetsSuccessResponse>
A generic route for verifying asset ownership requirements. Asset requirements support AND / OR / NOT logic.
Parameters
- payload: GenericVerifyAssetsPayload
Returns Promise<GenericVerifyAssetsSuccessResponse>
Remarks
- API Route: POST /api/v0/verifyOwnershipRequirements
- SDK Function Call: await BitBadgesApi.verifyOwnershipRequirements(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:935

verifySIWBBRequest

verifySIWBBRequest(payload): Promise<GenericBlockinVerifySuccessResponse>
A generic route for verifying SIWBB requests. Used as a helper if implementing on your own.
Parameters
- payload: GenericBlockinVerifyPayload
Returns Promise<GenericBlockinVerifySuccessResponse>
Remarks
- API Route: POST /api/v0/siwbbRequest/verify
- SDK Function Call: await BitBadgesApi.verifySIWBBRequest(payload);
- Defined in src/api-indexer/BitBadgesApi.ts:910

Class BitBadgesAPI<T>

See

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BitBadgesAPI<T>

Properties

BACKEND_URL

ConvertFunction

Type declaration

Parameters

Returns T

accessToken

apiKey

axios

Methods

addBalancesToOffChainStorage

Parameters

Returns Promise<AddBalancesToOffChainStorageSuccessResponse>

Remarks

Example

addReview

Parameters

Returns Promise<AddReviewSuccessResponse>

Remarks

Example

assertPositiveInteger

Parameters

Returns void

broadcastTx

Parameters

Returns Promise<BroadcastTxSuccessResponse>

Remarks

checkIfSignedIn

Parameters

Returns Promise<CheckSignInStatusSuccessResponse>

Remarks

completeClaim

Parameters

Returns Promise<CompleteClaimSuccessResponse>

Remarks

Example

createAddressLists

Parameters

Returns Promise<CreateAddressListsSuccessResponse>

Remarks

createAttestation

Parameters

Returns Promise<CreateAttestationSuccessResponse>

Remarks

createAttestationProof

Parameters

Returns Promise<CreateAttestationProofSuccessResponse>

Remarks

createClaim

Parameters

Returns Promise<CreateClaimSuccessResponse>

Remarks

createSIWBBRequest

Parameters

Returns Promise<CreateSIWBBRequestSuccessResponse>

Remarks

deleteAddressLists

Parameters

Returns Promise<DeleteAddressListsSuccessResponse>

Remarks

deleteAttestation

Parameters

Returns Promise<DeleteAttestationSuccessResponse>

Remarks

deleteAttestationProof

Parameters

Returns Promise<DeleteAttestationProofSuccessResponse>